TiltFive.Input Class Reference

Provides access to Wand inputs More...

Public Types
enum class	WandButton : UInt32 {   T5 = 1 << 0 , One = 1 << 1 , Two = 1 << 2 , Three = 1 << 7 ,   Y = 1 << 3 , B = 1 << 4 , A = 1 << 5 , X = 1 << 6 ,   System = T5 , Z = Three }

Static Public Member Functions
static bool	GetButton (WandButton button, ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Whether the indicated wand button is currently being pressed. More...
static bool	TryGetButton (WandButton button, out bool pressed, ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Whether the indicated wand button is currently being pressed. Fails if the wand is unavailable. More...
static bool	GetButtonDown (WandButton button, ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Whether the indicated wand button was pressed during this frame. More...
static bool	TryGetButtonDown (WandButton button, out bool buttonDown, ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Whether the indicated wand button was pressed during this frame. Fails if the wand is unavailable. More...
static bool	GetButtonUp (WandButton button, ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Whether the indicated wand button was released during this frame. More...
static bool	TryGetButtonUp (WandButton button, out bool buttonUp, ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Whether the indicated wand button was released during this frame. Fails if the wand is unavailable. More...
static Vector2	GetStickTilt (ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Gets the direction and magnitude of the stick's tilt for the indicated wand. More...
static bool	TryGetStickTilt (out Vector2 stickTilt, ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Gets the direction and magnitude of the stick's tilt for the indicated wand. Fails if the wand is unavailable. More...
static float	GetTrigger (ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Gets the degree to which the trigger is depressed, from 0.0 (released) to 1.0 (fully depressed). More...
static bool	TryGetTrigger (out float triggerDisplacement, ControllerIndex controllerIndex=ControllerIndex.Right, PlayerIndex playerIndex=PlayerIndex.One)
	Gets the degree to which the trigger is depressed, from 0.0 (released) to 1.0 (fully depressed). Fails if the wand is unavailable. More...
static bool	GetWandAvailability (ControllerIndex controllerIndex=ControllerIndex.Right)
	Gets the connection status of the indicated wand. More...
static bool	SetRumbleMotor (uint motor, float intensity)
static void	Update ()

Static Private Member Functions
static	Input ()

Detailed Description

Provides access to Wand inputs

Definition at line 30 of file Input.cs.

Member Enumeration Documentation

WandButton

enum TiltFive.Input.WandButton : UInt32

strong

Enumerator
T5
One
Two
Three
Y
B
A
X
System
Z

Definition at line 34 of file Input.cs.

        {
            T5      = 1 << 0,
            One     = 1 << 1,
            Two     = 1 << 2,
            Three   = 1 << 7,
            Y       = 1 << 3,
            B       = 1 << 4,
            A       = 1 << 5,
            X       = 1 << 6,
            [Obsolete("WandButton.System is deprecated, please use Wandbutton.T5 instead.")]
            System  = T5,
            [Obsolete("WandButton.Z is deprecated, please use Wandbutton.Three instead.")]
            Z       = Three,
        }

Constructor & Destructor Documentation

Input()

static TiltFive.Input.Input ( )

staticprivate

Definition at line 340 of file Input.cs.

        {
            Wand.ScanForWands();
        }

References TiltFive.Wand.ScanForWands().

Member Function Documentation

GetButton()

static bool TiltFive.Input.GetButton ( WandButton  button, ControllerIndex  controllerIndex = ControllerIndex.Right, PlayerIndex  playerIndex = PlayerIndex.One  )

static

Whether the indicated wand button is currently being pressed.

Parameters

button	The wand button to check.
controllerIndex	Unless specified, the state of the right-hand wand is returned.

If the wand is unavailable, this function returns a default value of false.

Returns

Returns true if the button is being pressed

Parameters

playerIndex

The index of the player using the wand we want to query.

Returns

Definition at line 73 of file Input.cs.

        {
            return TryGetButton(button, out var pressed, controllerIndex, playerIndex) && pressed;
        }

References TiltFive.Input.TryGetButton().

GetButtonDown()

static bool TiltFive.Input.GetButtonDown ( WandButton  button, ControllerIndex  controllerIndex = ControllerIndex.Right, PlayerIndex  playerIndex = PlayerIndex.One  )

static

Whether the indicated wand button was pressed during this frame.

Parameters

button	The wand button to check.
controllerIndex	Unless specified, the state of the right-hand wand is returned.
playerIndex	The index of the player using the wand we want to query.

If the wand is unavailable, this function returns a default value of false.

Returns

Returns true if the button was pressed during this frame.

Definition at line 108 of file Input.cs.

        {
            return TryGetButtonDown(button, out var buttonDown, controllerIndex, playerIndex) && buttonDown;
        }

References TiltFive.Input.TryGetButtonDown().

GetButtonUp()

static bool TiltFive.Input.GetButtonUp ( WandButton  button, ControllerIndex  controllerIndex = ControllerIndex.Right, PlayerIndex  playerIndex = PlayerIndex.One  )

static

Whether the indicated wand button was released during this frame.

Parameters

button	The wand button to check.
controllerIndex	Unless specified, the state of the right-hand wand is returned.
playerIndex	The index of the player using the wand we want to query.

Returns

Returns true if the button was released this frame, or false if the wand is unavailable.

Definition at line 143 of file Input.cs.

        {
            return TryGetButtonUp(button, out var buttonUp, controllerIndex, playerIndex) && buttonUp;
        }

References TiltFive.Input.TryGetButtonUp().

GetStickTilt()

static Vector2 TiltFive.Input.GetStickTilt ( ControllerIndex  controllerIndex = ControllerIndex.Right, PlayerIndex  playerIndex = PlayerIndex.One  )

static

Gets the direction and magnitude of the stick's tilt for the indicated wand.

Parameters

controllerIndex	Unless specified, the state of the right-hand wand joystick is used.
playerIndex	The index of the player using the wand we want to query.

Returns

Returns a vector representing the direction and magnitude of the stick's tilt.

Definition at line 179 of file Input.cs.

        {
            if(TryGetStickTilt(out var stickTilt, controllerIndex, playerIndex))
            {
                return stickTilt;
            }
            return Vector2.zero;
        }

References TiltFive.Input.TryGetStickTilt().

GetTrigger()

static float TiltFive.Input.GetTrigger ( ControllerIndex  controllerIndex = ControllerIndex.Right, PlayerIndex  playerIndex = PlayerIndex.One  )

static

Gets the degree to which the trigger is depressed, from 0.0 (released) to 1.0 (fully depressed).

Parameters

controllerIndex	Unless specified, the state of the right-hand wand trigger is used.
playerIndex	The index of the player using the wand we want to query.

Returns

Returns a float representing how much the trigger has depressed by the user, from 0.0 (released) to 1.0 (fully depressed).

Definition at line 213 of file Input.cs.

        {
            if(TryGetTrigger(out var triggerDisplacement, controllerIndex, playerIndex))
            {
                return triggerDisplacement;
            }
            return 0f;
        }

References TiltFive.Input.TryGetTrigger().

GetWandAvailability()

static bool TiltFive.Input.GetWandAvailability ( ControllerIndex  controllerIndex = ControllerIndex.Right )

static

Gets the connection status of the indicated wand.

Parameters

controllerIndex

Unless specified, the right-hand wand is queried.

Returns

Returns true if connected, false otherwise.

Definition at line 246 of file Input.cs.

        {
            return Wand.TryCheckConnected(out var connected, PlayerIndex.One, controllerIndex) && connected;
        }

References TiltFive.Wand.TryCheckConnected().

Referenced by TiltFive.Wand.TryScanForWands().

SetRumbleMotor()

static bool TiltFive.Input.SetRumbleMotor ( uint  motor, float  intensity  )

static

Definition at line 252 of file Input.cs.

        {
 
            int result = 0;
            try
            {
                result = NativePlugin.SetRumbleMotor(motor, intensity);
            }
            catch (Exception e)
            {
                Log.Error(e.Message);
            }
 
            return (0 != result);
        }

References TiltFive.Logging.Log.Error(), and TiltFive.NativePlugin.SetRumbleMotor().

TryGetButton()

static bool TiltFive.Input.TryGetButton ( WandButton  button, out bool  pressed, ControllerIndex  controllerIndex = ControllerIndex.Right, PlayerIndex  playerIndex = PlayerIndex.One  )

static

Whether the indicated wand button is currently being pressed. Fails if the wand is unavailable.

Parameters

button	The wand button to check.
pressed
controllerIndex	Unless specified, the state of the right-hand wand is returned.
playerIndex	The index of the player using the wand we want to query.

If the wand is unavailable, this function returns false and pressed is set to a default value of false.

Returns

Returns true if the button state was successfully obtained.

Definition at line 88 of file Input.cs.

        {
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                pressed = false;
                return false;
            }
 
            return Wand.TryGetButton(button, out pressed, glassesHandle, controllerIndex);
        }

Referenced by TiltFive.Input.GetButton().

TryGetButtonDown()

static bool TiltFive.Input.TryGetButtonDown ( WandButton  button, out bool  buttonDown, ControllerIndex  controllerIndex = ControllerIndex.Right, PlayerIndex  playerIndex = PlayerIndex.One  )

static

Whether the indicated wand button was pressed during this frame. Fails if the wand is unavailable.

Parameters

button	The wand button to check.
buttonDown	Whether the button was pressed during this frame.
controllerIndex	Unless specified, the state of the right-hand wand is returned.
playerIndex	The index of the player using the wand we want to query.

If the wand is unavailable, this function returns false and buttonDown is given a default value of false.

Returns

Returns true if the button state was successfully obtained.

Definition at line 123 of file Input.cs.

        {
            // The specified player's glasses aren't even connected, let alone the wand. No way to get a rising edge here.
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                buttonDown = false;
                return false;
            }
 
            return Wand.TryGetButtonDown(button, out buttonDown, glassesHandle, controllerIndex);
        }

Referenced by TiltFive.Input.GetButtonDown().

TryGetButtonUp()

static bool TiltFive.Input.TryGetButtonUp ( WandButton  button, out bool  buttonUp, ControllerIndex  controllerIndex = ControllerIndex.Right, PlayerIndex  playerIndex = PlayerIndex.One  )

static

Whether the indicated wand button was released during this frame. Fails if the wand is unavailable.

Parameters

button	The wand button to check.
buttonUp	Whether the button was released during this frame.
controllerIndex	Unless specified, the state of the right-hand wand is returned.
playerIndex	The index of the player using the wand we want to query.

If the wand is unavailable, this function returns false and buttonUp is set to the return value of GetButtonUp(WandButton, WandTarget) GetButtonUp.

Returns

Returns true if the button state was successfully obtained.

Definition at line 159 of file Input.cs.

        {
            // TODO: Tweak the Wand.cs TryGetButtonDown to check if the glasses disconnected this frame.
            // If it did, and the button was held last frame, then buttonUp can be true.
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                buttonUp = false;
                return false;
            }
 
            return Wand.TryGetButtonUp(button, out buttonUp, glassesHandle, controllerIndex);
        }

Referenced by TiltFive.Input.GetButtonUp().

TryGetStickTilt()

static bool TiltFive.Input.TryGetStickTilt ( out Vector2  stickTilt, ControllerIndex  controllerIndex = ControllerIndex.Right, PlayerIndex  playerIndex = PlayerIndex.One  )

static

Gets the direction and magnitude of the stick's tilt for the indicated wand. Fails if the wand is unavailable.

Parameters

stickTilt	A vector representing the direction and magnitude of the stick's tilt.
controllerIndex	Unless specified, the state of the right-hand wand joystick is used.
playerIndex	The index of the player using the wand we want to query.

Returns

Returns true if the joystick state was successfully obtained.

Definition at line 195 of file Input.cs.

        {
            if(!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                stickTilt = Vector2.zero;
                return false;
            }
            return Wand.TryGetStickTilt(out stickTilt, glassesHandle, controllerIndex);
        }

Referenced by TiltFive.Input.GetStickTilt().

TryGetTrigger()

static bool TiltFive.Input.TryGetTrigger ( out float  triggerDisplacement, ControllerIndex  controllerIndex = ControllerIndex.Right, PlayerIndex  playerIndex = PlayerIndex.One  )

static

Gets the degree to which the trigger is depressed, from 0.0 (released) to 1.0 (fully depressed). Fails if the wand is unavailable.

Parameters

triggerDisplacement	A float representing how much the trigger has depressed by the user, from 0.0 (released) to 1.0 (fully depressed).
controllerIndex	Unless specified, the state of the right-hand wand trigger is used.
playerIndex	The index of the player using the wand we want to query.

Returns

Returns true if the trigger state was successfully obtained.

Definition at line 230 of file Input.cs.

        {
            if (!Player.TryGetGlassesHandle(playerIndex, out var glassesHandle))
            {
                triggerDisplacement = 0f;
                return false;
            }
            return Wand.TryGetTrigger(out triggerDisplacement, glassesHandle, controllerIndex);
        }

Referenced by TiltFive.Input.GetTrigger().

Update()

static void TiltFive.Input.Update ( )

static

Definition at line 268 of file Input.cs.

        {
            // Deleting this function would be appropriate, but since it's public,
            // there's a small chance it could break someone's code...
            // ...not that I can think of a use-case that involves calling TiltFive.Input.Update()
        }

---

The documentation for this class was generated from the following file:

• C:/Users/mail1/Documents/TiltFive/t5sw/sdk/unity/unity_package/Runtime/Player/Wand/Input.cs