Class ClimbProvider
Locomotion provider that allows the user to climb a ClimbInteractable by selecting it. Climb locomotion moves the XR Origin counter to movement of the last selecting interactor, with optional movement constraints along each axis of the interactable.
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 : LocomotionProviderProperties
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 |
|---|---|
| ClimbInteractable |
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 |
|---|---|
| IXRSelectInteractor |
See Also
climbSettings
Climb locomotion settings. Can be overridden by the ClimbInteractable used for locomotion.
Declaration
public ClimbSettingsDatumProperty climbSettings { get; set; }Property Value
| Type | Description |
|---|---|
| ClimbSettingsDatumProperty |
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 |
|---|---|
| XROriginMovement |
See Also
Methods
Awake()
See MonoBehaviour.
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 |
|---|---|---|
| IXRSelectInteractor | interactor | The interactor whose grab to finish. |
Remarks
If there is no other active grab to fall back on, this will put the locomotionPhase in the Done state in the next Update().
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 |
|---|---|---|
| ClimbInteractable | climbInteractable | The object to climb. |
| IXRSelectInteractor | interactor | The interactor that initiates the grab and drives movement. |
Remarks
This puts the locomotionPhase in the Started state if locomotion has not already started. The phase will then enter the Moving state in the next Update().
See Also
Update()
See MonoBehaviour.
Declaration
protected virtual void Update()See Also
Events
climbAnchorUpdated
Calls the methods in its invocation list when the provider updates climbAnchorInteractable and climbAnchorInteractor. This can be invoked from either StartClimbGrab(ClimbInteractable, IXRSelectInteractor) or FinishClimbGrab(IXRSelectInteractor). This is not invoked when climb locomotion ends.
Declaration
public event Action<ClimbProvider> climbAnchorUpdatedEvent Type
| Type | Description |
|---|---|
| Action<ClimbProvider> |