Click or drag to resize

ScriptedInputModule Methods

The ScriptedInputModule type exposes the following members.

Methods
  NameDescription
Public methodCustomHandStateToggle
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.
(Overrides InputModuleCustomHandStateToggle.)
Public methodGesturePoint
Indicates whether a pointing gesture should be entered on the hand associated with this controller
(Overrides InputModuleGesturePoint(Boolean).)
Public methodGestureUnPoint
Indicates whether a pointing gesture should be exited on the hand associated with this controller
(Overrides InputModuleGestureUnPoint(Boolean).)
Public methodHandGrab
Indicates whether input on this controller has caused a grabbing state to be entered on the associated hand
(Overrides InputModuleHandGrab.)
Public methodHandGripAmount
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)
(Overrides InputModuleHandGripAmount.)
Public methodHandRelease
Indicates whether input on this controller has caused a grabbing state to be exited on the associated hand
(Overrides InputModuleHandRelease.)
Public methodHandReleaseToolPickup
Indicates whether input on this controller has caused a grabbing state for ToolPickup classes to be exited on the associated hand
(Overrides InputModuleHandReleaseToolPickup.)
Public methodHasFrameBeenHandled
Returns true if the frame has been processed since the last clear
(Overrides InputModuleHasFrameBeenHandled.)
Public methodInitialize
Initialises the input module. This is called by our internal system.
(Overrides InputModuleInitialize(ControllerLocal).)
Public methodInputFrameHandled
This in only used in testing by the sdk. Please do not call this method manually.
(Overrides InputModuleInputFrameHandled.)
Public methodIsVibrating
Public methodSelectionEnd
Indicates whether controller input has caused the selection tool to stop selecting objects
(Overrides InputModule.SelectionEnd.)
Public methodSelectionStart
Indicates whether controller input should cause the selection tool to begin selecting objects
(Overrides InputModule.SelectionStart.)
Public methodSelectionToolDisable
Indicates whether the "Collaborate" selection tool should be hidden on the hand associated with this controller
(Overrides InputModule.SelectionToolDisable.)
Public methodSelectionToolEnable
Indicates whether the "Collaborate" selection tool should be displayed on the hand associated with this controller
(Overrides InputModule.SelectionToolEnable.)
Public methodSelectionToolOrbAmount
Indicates the amount the selection tool orb should change in size this frame based on controller input
(Overrides InputModule.SelectionToolOrbAmount.)
Public methodSelectionToolTriggerAmount
Indicates how far the selection tool trigger should be pressed based on controller input from the current frame
(Overrides InputModule.SelectionToolTriggerAmount.)
Public methodSelectionUpdate
Indicates whether controller input has enabled the selection tool to continue selecting objects
(Overrides InputModule.SelectionUpdate.)
Public methodSetCustomHandStateToggle
Set the value
Public methodSetGesturePoint
Set the value
Public methodSetGestureUnPoint
Set the value
Public methodSetHandGrab
Set the value
Public methodSetHandGripAmount
Set the value
Public methodSetHandRelease
Set the value
Public methodSetHandReleaseToolPickup
Set the value
Public methodSetIsVibrating
Set the value
Public methodSetSelectionEnd
Set the value
Public methodSetSelectionStart
Set the value
Public methodSetSelectionToolDisable
Set the value
Public methodSetSelectionToolEnable
Set the value
Public methodSetSelectionToolOrbAmount
Set the value
Public methodSetSelectionToolTriggerAmount
Set the value
Public methodSetSelectionUpdate
Set the value
Public methodSetTeleportCancel
Set the value
Public methodSetTeleportChoose
Set the value
Public methodSetTeleportSeek
Set the value
Public methodSetUIPress
Set the value
Public methodSetUIRelease
Set the value
Public methodTeleportCancel
Indicates whether controller input has caused the teleport seek state to be cancelled
(Overrides InputModuleTeleportCancel.)
Public methodTeleportChoose
Indicates whether controller input has caused a teleport target to be chosen
(Overrides InputModuleTeleportChoose.)
Public methodTeleportSeek
Indicates whether controller input has caused the teleport seek state to be entered
(Overrides InputModuleTeleportSeek.)
Public methodToString
Helps in debugging and console output. Prints out the device index.
(Overrides UnityEngine.Object.ToString.)
Public methodUIPress
Indicates whether controller input should cause a Menu UI press event
(Overrides InputModuleUIPress.)
Public methodUIRelease
Indicates whether controller input should cause a Menu UI release event
(Overrides InputModuleUIRelease.)
Protected methodUpdate
Unity component method
Public methodVibrate
Vibrates the controller
(Overrides InputModuleVibrate(Single).)
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also