class VRController

in global :: Sandbox . VR

Represents a VR controller, along with its transform, velocity, and inputs.

public bool IsHandTracked { get; }

Is this controller currently being represented using full hand tracking?

public void TriggerHapticVibration( float duration, float frequency, float amplitude )

Triggers a haptic vibration event on the controller for this hand.

Remarks: If a haptic event is already running it will be interrupted immediately.

  • duration How long the haptic action should last (in seconds - can be 0 to "pulse" it)
  • frequency How often the haptic motor should bounce (0 - 320 in hz. The lower end being more useful)
  • amplitude How intense the haptic should be (0 - 1)

public void TriggerHaptics( HapticEffect effect, float lengthScale = 1, float frequencyScale = 1, float amplitudeScale = 1 )

Trigger a vibration based on a predefined . All s are normalized (start at 0, peak at 1).

  • effect The pattern to use
  • lengthScale The amount to scale the pattern's length by.
  • frequencyScale The amount to scale the pattern's frequency by.
  • amplitudeScale The amount to scale the pattern's amplitude by.

public AnalogInput Trigger { get; }

The trigger input on this controller

public AnalogInput Grip { get; }

The grip input on this controller

public AnalogInput2D Joystick { get; }

The primary joystick input on this controller

public DigitalInput JoystickPress { get; }

The primary joystick press on this controller

public DigitalInput ButtonA { get; }

The primary button on this controller (Usually A, can be X for Oculus Touch)

public DigitalInput ButtonB { get; }

The secondary button on this controller (Usually B, can be Y for Oculus Touch)

public VRHandJointData[] GetJoints( MotionRange motionRange = Hand )

Returns joint data for a specific motion range.

  • motionRange Whether the joints returned represent a raw hand pose, or one that represents the hand wrapping around the controller.

public float GetFingerValue( FingerValue value )

Get the skeletal value (from 0 to 1) of a specified - includes curl and splay.

public float GetFingerCurl( int index )

Get the skeletal value (from 0 to 1) of a specified finger curl index.

public float GetFingerSplay( int index )

Get the skeletal value (from 0 to 1) of a specified finger splay index.

public Angles AngularVelocity { get; }

😔 No documentation found.

public TrackedDeviceRole Role { get; }

😔 No documentation found.

public TrackedDeviceType Type { get; }

😔 No documentation found.

public Vector3 Velocity { get; }

😔 No documentation found.

public bool Active { get; }

😔 No documentation found.

public VRController <Clone>$( )

😔 No documentation found.

public bool Equals( VRController other )

😔 No documentation found.

public bool Equals( TrackedObject other )

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.

public Type GetType( )

😔 No documentation found.

public static bool op_Equality( VRController left, VRController right )

😔 No documentation found.

public static bool op_Inequality( VRController left, VRController right )

😔 No documentation found.

public string ToString( )

😔 No documentation found.

public List<VRHandJointData> GetJointData( )

😔 No documentation found.

public TrackedObject <Clone>$( )

😔 No documentation found.

public void StopAllHaptics( )

😔 No documentation found.

public void StopAllVibrations( )

😔 No documentation found.

public Model GetModel( )

😔 No documentation found.

public int GetHashCode( )

😔 No documentation found.

public Transform Transform { get; }

😔 No documentation found.