Class ClimbProvider
Locomotion provider that allows the user to climb a Climb
Inherited Members
Namespace: UnityEngine .XR.Interaction.Toolkit.Locomotion.Climbing
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
[AddComponentMenu("XR/Locomotion/Climb Provider", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.0/api/UnityEngine.XR.Interaction.Toolkit.Locomotion.Climbing.ClimbProvider.html")]
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public class ClimbProvider : LocomotionProvider
Properties
climbAnchorInteractable
The interactable that is currently grabbed and driving movement. This will be null if there is no active climb.
Declaration
public ClimbInteractable climbAnchorInteractable { get; }
Property Value
Type | Description |
---|---|
Climb |
See Also
climbAnchorInteractor
The interactor that is currently grabbing and driving movement. This will be null if there is no active climb.
Declaration
public IXRSelectInteractor climbAnchorInteractor { get; }
Property Value
Type | Description |
---|---|
IXRSelect |
See Also
climbSettings
Climb locomotion settings. Can be overridden by the Climb
Declaration
public ClimbSettingsDatumProperty climbSettings { get; set; }
Property Value
Type | Description |
---|---|
Climb |
See Also
transformation
The transformation that is used by this component to apply climb movement.
Declaration
public XROriginMovement transformation { get; set; }
Property Value
Type | Description |
---|---|
XROrigin |
See Also
Methods
Awake()
See Mono
Declaration
protected override void Awake()
Overrides
See Also
FinishClimbGrab(IXRSelectInteractor)
Finishes the grab driven by interactor
. If this was the most recent grab then movement
will now be driven by the next most recent grab.
Declaration
public void FinishClimbGrab(IXRSelectInteractor interactor)
Parameters
Type | Name | Description |
---|---|---|
IXRSelect |
interactor | The interactor whose grab to finish. |
Remarks
If there is no other active grab to fall back on, this will put the locomotion
See Also
StartClimbGrab(ClimbInteractable, IXRSelectInteractor)
Starts a grab as part of climbing climbInteractable
, using the position of
interactor
to drive movement.
Declaration
public void StartClimbGrab(ClimbInteractable climbInteractable, IXRSelectInteractor interactor)
Parameters
Type | Name | Description |
---|---|---|
Climb |
climbInteractable | The object to climb. |
IXRSelect |
interactor | The interactor that initiates the grab and drives movement. |
Remarks
This puts the locomotion
See Also
Update()
See Mono
Declaration
protected virtual void Update()
See Also
Events
climbAnchorUpdated
Calls the methods in its invocation list when the provider updates climb
Declaration
public event Action<ClimbProvider> climbAnchorUpdated
Event Type
Type | Description |
---|---|
Action<Climb |