newspaperAbout
infoAbout s&box newspaperLatest News published_with_changesChanges mapRoadmap monitoringMetrics
gamesGames
sports_esportsBrowse Games rocketDiscover Games
business_centerWorkshop
sports_esportsGames landscapeMaps chairModels textureMaterials apparelClothing constructionMore..
forumForum docsDocs
docsDocumentation dashboardApi Reference schoolTutorials
Api
Classes
VRController
chevron_left Classes
class
VRController

Properties

data_objectAimTransformdata_objectButtonAdata_objectButtonBdata_objectGripdata_objectIsHandTrackeddata_objectJoystickdata_objectJoystickPressdata_objectTransformdata_objectTrigger

Methods

functions<Clone>$functionsGetFingerCurlfunctionsGetFingerSplayfunctionsGetFingerValueremove_circleGetJointDatafunctionsGetJointsfunctionsGetModelfunctionsStopAllHapticsfunctionsStopAllVibrationsfunctionsTriggerHapticsremove_circleTriggerHapticVibration
VRController
Represents a VR controller, along with its transform, velocity, and inputs.
class Sandbox.VR .account_tree extends TrackedObject
sealedSandbox.Engine

data_object Properties 9

AimTransform
Transform
The aim pose transform in world space (pointing forward).
ButtonA
DigitalInput
The primary button on this controller (Usually A, can be X for Oculus Touch)
ButtonB
DigitalInput
The secondary button on this controller (Usually B, can be Y for Oculus Touch)
Grip
AnalogInput
The grip input on this controller
IsHandTracked
bool
Is this controller currently being represented using full hand tracking?
Joystick
AnalogInput2D
The primary joystick input on this controller
JoystickPress
DigitalInput
The primary joystick press on this controller
Transform
Transform
The grip pose transform in world space (centered on palm/grip).
Trigger
AnalogInput
The trigger input on this controller

functions Methods 11

<Clone>$ ()
VRController
GetFingerCurl (index)
float
Get the skeletal value (from 0 to 1) of a specified finger curl index.
GetFingerSplay (index)
float
Get the skeletal value (from 0 to 1) of a specified finger splay index.
GetFingerValue (value)
float
Get the skeletal value (from 0 to 1) of a specified Sandbox.VR.FingerValue - includes curl and splay.
GetJointData ()
obsoleteList`1
GetJoints (motionRange)
VRHandJointData[]
Returns joint data for a specific motion range.
GetModel ()
Model
Retrieves or creates a cached model that can be used to render this controller.
StopAllHaptics ()
Stops all rumble and haptic events on this controller.
StopAllVibrations ()
Stop all vibration events on this controller.
TriggerHaptics (effect, lengthScale, frequencyScale, amplitudeScale)
Trigger a vibration based on a predefined Sandbox.HapticPattern. All Sandbox.HapticPatterns are normalized (start at 0, peak at 1).
TriggerHapticVibration (duration, frequency, amplitude)
obsolete
Triggers a haptic vibration event on the controller for this hand.

Inheritance

TrackedObject
VRController
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.