This is the documentation for the Scripting APIs of this package.
Show / Hide Table of Contents
-
Unity
Engine. XR. Interaction. Toolkit -
Action
Based Continuous Move Provider -
Action
Based Continuous Turn Provider -
Action
Based Controller -
Action
Based Snap Turn Provider -
Activate
Event -
Activate
Event Args -
Base
Interaction Event Args -
Base
Registration Event Args -
Base
Teleportation Interactable -
Base
Teleportation Interactable. Teleport Trigger -
Can
Focus Multiple Attribute -
Can
Select Multiple Attribute -
Character
Controller Driver -
Climb
Interactable -
Climb
Provider -
Climb
Settings -
Climb
Settings Datum -
Climb
Settings Datum Property -
Constrained
Move Provider -
Constrained
Move Provider. Gravity Application Mode -
Continuous
Move Provider Base -
Continuous
Move Provider Base. Gravity Application Mode -
Continuous
Turn Provider Base -
Deactivate
Event -
Deactivate
Event Args -
Device
Based Continuous Move Provider -
Device
Based Continuous Move Provider. Input Axes -
Device
Based Continuous Turn Provider -
Device
Based Continuous Turn Provider. Input Axes -
Device
Based Snap Turn Provider -
Device
Based Snap Turn Provider. Input Axes -
Distance
Info -
Ease
State -
Focus
Enter Event -
Focus
Enter Event Args -
Focus
Exit Event -
Focus
Exit Event Args -
Gizmo
Helpers -
Grab
Move Provider -
Hover
Enter Event -
Hover
Enter Event Args -
Hover
Exit Event -
Hover
Exit Event Args -
IAdvanced
Line Renderable -
ILine
Renderable -
ITunneling
Vignette Provider -
IXRActivate
Interactable -
IXRActivate
Interactor -
IXRAim
Assist -
IXRCustom
Reticle Provider -
IXRFilter
List<T> -
IXRFocus
Interactable -
IXRGroup
Member -
IXRHover
Interactable -
IXRHover
Interactor - IXRInteractable
-
IXRInteractable
Custom Reticle -
IXRInteraction
Group -
IXRInteraction
Override Group -
IXRInteraction
Strength Interactable -
IXRInteraction
Strength Interactor - IXRInteractor
-
IXROverrides
Gaze Auto Select -
IXRRay
Provider -
IXRReticle
Direction Provider -
IXRScale
Value Provider -
IXRSelect
Interactable -
IXRSelect
Interactor -
IXRTarget
Priority Interactor -
Input
Helpers -
Input
Helpers. Axis2D -
Input
Helpers. Button -
Interactable
Focus Mode -
Interactable
Registered Event Args -
Interactable
Select Mode -
Interactable
Unregistered Event Args -
Interaction
Group Registered Event Args -
Interaction
Group Unregistered Event Args -
Interaction
Layer Mask -
Interaction
State -
Interactor
Registered Event Args -
Interactor
Unregistered Event Args -
Locomotion
Phase -
Locomotion
Provider -
Locomotion
System -
Locomotion
Vignette Provider -
Match
Orientation -
Request
Result -
Scale
Mode -
Select
Enter Event -
Select
Enter Event Args -
Select
Exit Event -
Select
Exit Event Args -
Snap
Turn Provider Base -
Socket
Scale Mode -
Target
Priority Mode -
Teleport
Request -
Teleportation
Anchor -
Teleportation
Area -
Teleportation
Provider -
Teleporting
Event -
Teleporting
Event Args -
Tunneling
Vignette Controller -
Two
Handed Grab Move Provider -
Vignette
Parameters -
XRBase
Controller -
XRBase
Controller. Update Type -
XRBase
Controller Interactor -
XRBase
Controller Interactor. Input Trigger Type -
XRBase
Interactable -
XRBase
Interactable. Distance Calculation Mode -
XRBase
Interactable. Movement Type -
XRBase
Interactor - XRController
-
XRController
Recorder -
XRController
Recording -
XRController
State -
XRDirect
Interactor -
XRFocus
Interactable Extensions -
XRGaze
Assistance -
XRGaze
Assistance. Interactor Data -
XRGaze
Interactor -
XRGaze
Interactor. Gaze Assistance Calculation -
XRGrab
Interactable -
XRGrab
Interactable. Attach Point Compatibility Mode -
XRGroup
Member Extensions -
XRHover
Interactable Extensions -
XRHover
Interactor Extensions -
XRInteractable
Snap Volume -
XRInteraction
Group -
XRInteraction
Group. Group Names -
XRInteraction
Manager -
XRInteraction
Update Order -
XRInteraction
Update Order. Update Phase -
XRInteractor
Extensions -
XRInteractor
Line Visual -
XRInteractor
Reticle Visual -
XRPoke
Interactor -
XRRay
Interactor -
XRRay
Interactor. Anchor Rotation Mode -
XRRay
Interactor. Hit Detection Type -
XRRay
Interactor. Line Type -
XRRay
Interactor. Query Snap Volume Interaction -
XRRay
Interactor. Raycast Hit Comparer -
XRScreen
Space Controller -
XRSelect
Interactable Extensions -
XRSelect
Interactor Extensions -
XRSimple
Interactable -
XRSocket
Interactor -
XRTint
Interactable Visual
-
Action
-
Unity
Engine. XR. Interaction. Toolkit. AR - ARAnnotation
-
ARAnnotation
Interactable -
ARBase
Gesture Interactable -
ARGesture
Interactor -
ARObject
Placement Event -
ARObject
Placement Event Args -
ARPlacement
Interactable -
ARRotation
Interactable -
ARScale
Interactable -
ARSelection
Interactable -
ARTranslation
Interactable -
Drag
Gesture -
Drag
Gesture Recognizer -
Gesture
Recognizer<T> -
Gesture
Transformation Utility -
Gesture
Transformation Utility. Gesture Translation Mode -
Gesture
Transformation Utility. Placement - Gesture<T>
-
Pinch
Gesture -
Pinch
Gesture Recognizer -
Tap
Gesture -
Tap
Gesture Recognizer -
Twist
Gesture -
Twist
Gesture Recognizer -
Two
Finger Drag Gesture -
Two
Finger Drag Gesture Recognizer
-
Unity
Engine. XR. Interaction. Toolkit. AR. Inputs -
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Jobs -
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Receiver -
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Receiver. Audio -
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Receiver. Primitives -
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Receiver. Rendering -
Blend
Shape Affordance Receiver -
Color
Gradient Line Renderer Affordance Receiver -
Color
Gradient Line Renderer Affordance Receiver. Line Color Property -
Color
Material Property Affordance Receiver -
Float
Material Property Affordance Receiver -
Vector2Material
Property Affordance Receiver -
Vector3Material
Property Affordance Receiver -
Vector4Material
Property Affordance Receiver
-
Blend
-
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Receiver. Transformation -
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Receiver. UI -
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Rendering -
Unity
Engine. XR. Interaction. Toolkit. Affordance System. State -
Affordance
State Data -
Affordance
State Shortcuts -
Base
Affordance State Provider -
IMulti
Poke State Data Provider -
IPoke
State Data Provider -
XRInteractable
Affordance State Provider -
XRInteractable
Affordance State Provider. Activate Click Animation Mode -
XRInteractable
Affordance State Provider. Select Click Animation Mode -
XRInteractor
Affordance State Provider -
XRInteractor
Affordance State Provider. Activate Click Animation Mode -
XRInteractor
Affordance State Provider. Select Click Animation Mode
-
Affordance
-
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Theme -
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Theme. Audio -
Unity
Engine. XR. Interaction. Toolkit. Affordance System. Theme. Primitives -
Color
Affordance Theme -
Color
Affordance Theme Datum -
Color
Affordance Theme Datum Property -
Color
Blend Mode -
Float
Affordance Theme -
Float
Affordance Theme Datum -
Float
Affordance Theme Datum Property -
Vector2Affordance
Theme -
Vector2Affordance
Theme Datum -
Vector2Affordance
Theme Datum Property -
Vector3Affordance
Theme -
Vector3Affordance
Theme Datum -
Vector3Affordance
Theme Datum Property -
Vector4Affordance
Theme -
Vector4Affordance
Theme Datum -
Vector4Affordance
Theme Datum Property
-
Color
-
Unity
Engine. XR. Interaction. Toolkit. Attachment -
Unity
Engine. XR. Interaction. Toolkit. Filtering -
IXRHover
Filter -
IXRInteraction
Strength Filter -
IXRPoke
Filter -
IXRSelect
Filter -
IXRTarget
Evaluator Linkable -
IXRTarget
Filter -
Poke
Axis -
Poke
State Data -
Poke
Threshold Data -
Poke
Threshold Datum -
Poke
Threshold Datum Property -
XRAngle
Gaze Evaluator -
XRBase
Target Filter -
XRDistance
Evaluator -
XRHover
Filter Delegate -
XRInteraction
Strength Filter Delegate -
XRLast
Selected Evaluator -
XRPoke
Filter -
XRSelect
Filter Delegate -
XRTarget
Evaluator -
XRTarget
Filter
-
IXRHover
-
Unity
Engine. XR. Interaction. Toolkit. Inputs -
Unity
Engine. XR. Interaction. Toolkit. Inputs. Composites -
Unity
Engine. XR. Interaction. Toolkit. Inputs. Interactions -
Unity
Engine. XR. Interaction. Toolkit. Inputs. Simulation -
Controller
Button -
Simulated
Input Layout Loader -
XRDevice
Simulator -
XRDevice
Simulator. Axis2DTargets -
XRDevice
Simulator. Device Mode -
XRDevice
Simulator. Simulated Hand Expression -
XRDevice
Simulator. Space -
XRDevice
Simulator. Transformation Mode -
XRDevice
Simulator Loader -
XRSimulated
Controller -
XRSimulated
Controller State -
XRSimulated
HMD -
XRSimulated
HMDState
-
Controller
-
Unity
Engine. XR. Interaction. Toolkit. Locomotion. Climbing -
Unity
Engine. XR. Interaction. Toolkit. Locomotion. Teleportation -
Unity
Engine. XR. Interaction. Toolkit. Transformers - ARTransformer
-
ARTransformer.
Plane Translation Mode -
Drop
Event Args -
IXRDrop
Transformer -
IXRGrab
Transformer -
XRBase
Grab Transformer -
XRBase
Grab Transformer. Registration Mode -
XRDual
Grab Free Transformer -
XRDual
Grab Free Transformer. Pose Contributor -
XRGeneral
Grab Transformer -
XRGeneral
Grab Transformer. Constrained Axis Displacement Mode -
XRGeneral
Grab Transformer. Manipulation Axes -
XRGeneral
Grab Transformer. Two Handed Rotation Mode -
XRSingle
Grab Free Transformer -
XRSocket
Grab Transformer
-
Unity
Engine. XR. Interaction. Toolkit. UI -
Button
Delta State -
Canvas
Optimizer -
Canvas
Tracker -
IUIHover
Interactor - IUIInteractor
-
Lazy
Follow -
Lazy
Follow. Position Follow Mode -
Lazy
Follow. Rotation Follow Mode -
Mouse
Button Model -
Tracked
Device Event Data -
Tracked
Device Graphic Raycaster -
Tracked
Device Model -
Tracked
Device Physics Raycaster -
UIHover
Enter Event -
UIHover
Event Args -
UIHover
Exit Event -
UIInput
Module -
UIInteraction
Type -
XRUIInput
Module -
XRUIInput
Module. Active Input Mode
-
Button
-
Unity
Engine. XR. Interaction. Toolkit. UI. Body UI -
Unity
Engine. XR. Interaction. Toolkit. Utilities -
Unity
Engine. XR. Interaction. Toolkit. Utilities. Collections -
Unity
Engine. XR. Interaction. Toolkit. Utilities. Tweenables -
Unity
Engine. XR. Interaction. Toolkit. Utilities. Tweenables. Primitives -
Unity
Engine. XR. Interaction. Toolkit. Utilities. Tweenables. Smart Tweenable Variables