Class LocomotionProvider | XR Interaction Toolkit | 0.0.6-preview
docs.unity3d.com
    Show / Hide Table of Contents

    Class LocomotionProvider

    The locomotion provider is the base class for various locomotion implementations. this class provides simple ways to interrogate the locomotion system for whether a locomotion can begin and simple events for hooking into a start/end locomotion.

    Inheritance
    Object
    LocomotionProvider
    SnapTurnProvider
    TeleportationProvider
    Namespace: UnityEngine.XR.Interaction.Toolkit
    Syntax
    public abstract class LocomotionProvider : MonoBehaviour

    Properties

    system

    The Locomotion system that this locomotion provider will communicate with for exclusive access to an XR Rig. If one is not provided, the system will attempt to locate one during its Awake call

    Declaration
    public LocomotionSystem system { get; set; }
    Property Value
    Type Description
    LocomotionSystem

    Methods

    Awake()

    Declaration
    protected virtual void Awake()

    BeginLocomotion()

    Declaration
    protected bool BeginLocomotion()
    Returns
    Type Description
    Boolean

    CanBeginLocomotion()

    Declaration
    protected bool CanBeginLocomotion()
    Returns
    Type Description
    Boolean

    EndLocomotion()

    Declaration
    protected bool EndLocomotion()
    Returns
    Type Description
    Boolean

    Events

    endLocomotion

    The endingLocomotion action will be called when a Locomotion Provider stops a locomotion event

    Declaration
    public event Action<LocomotionSystem> endLocomotion
    Event Type
    Type Description
    Action<LocomotionSystem>

    startLocomotion

    The startingLocomotion action will be called when a Locomotion Provider starts a locomotion event

    Declaration
    public event Action<LocomotionSystem> startLocomotion
    Event Type
    Type Description
    Action<LocomotionSystem>
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023