 | InputModule Methods |
The InputModule type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CustomHandStateToggle |
When true the following will happen:
- If in the default (or other exitable) hand state, then the first available custom hand state will be shown.
- If already in a custom hand state, then the next available custom hand state will be shown.
- If no further custom hand states are available, then the previous built in state will be returned to.
|
| GesturePoint |
Indicates whether a pointing gesture should be entered on the hand associated with this controller
|
| GestureUnPoint |
Indicates whether a pointing gesture should be exited on the hand associated with this controller
|
| HandGrab |
Indicates whether input on this controller has caused a grabbing state to be entered on the associated hand
|
| HandGripAmount |
Indicates the amount of grip the hand associated with this controller has from inputs in the current frame. Returns a float value between 0 (no grip) and 1 (fully gripped)
|
| HandRelease |
Indicates whether input on this controller has caused a grabbing state to be exited on the associated hand
|
| HandReleaseToolPickup |
Indicates whether input on this controller has caused a grabbing state for ToolPickup classes to be exited on the associated hand
|
| HasFrameBeenHandled |
This in only used in testing by the sdk. Please do not call this method manually.
|
| Initialize |
Called during Avatar setup, when this component is added to the avatars hand / controller gameObjects
|
| InputFrameHandled |
This in only used in testing by the sdk. Please do not call this method manually.
|
| IsControllerPresent |
Checks if a controller is connected, switched on and active for this hand.
The controller is considered present if it has changed position or rotation since the last call to this method.
|
| ResetState |
Resets the internal state of this input module. This is called by the SDK whenever the hand enters the default state.
|
| TeleportCancel |
Indicates whether controller input has caused the teleport seek state to be cancelled
|
| TeleportChoose |
Indicates whether controller input has caused a teleport target to be chosen
|
| TeleportSeek |
Indicates whether controller input has caused the teleport seek state to be entered
|
| UIPress |
Indicates whether controller input should cause a Menu UI press event
|
| UIRelease |
Indicates whether controller input should cause a Menu UI release event
|
| Vibrate |
Causes haptic feedback vibration on the controller to start this frame and continue for a specified amount of time
|
| VibrateOverTime |
Causes Vibration over time for when you need a longer vibration than the base
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetCopyOf |
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.) |
| WaitForT |
Waits for a singleton on a coroutine
(Defined by SingletonManager.) |
See Also