docs.unity3d.com
    Show / Hide Table of Contents

    Class ContinuousMoveProviderBase

    Locomotion provider that allows the user to smoothly move their rig continuously over time.

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    LocomotionProvider
    ContinuousMoveProviderBase
    ActionBasedContinuousMoveProvider
    DeviceBasedContinuousMoveProvider
    Inherited Members
    LocomotionProvider.beginLocomotion
    LocomotionProvider.endLocomotion
    LocomotionProvider.system
    LocomotionProvider.locomotionPhase
    LocomotionProvider.Awake()
    LocomotionProvider.CanBeginLocomotion()
    LocomotionProvider.BeginLocomotion()
    LocomotionProvider.EndLocomotion()
    LocomotionProvider.startLocomotion
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    MonoBehaviour.CancelInvoke(String)
    MonoBehaviour.IsInvoking(String)
    MonoBehaviour.StartCoroutine(String)
    MonoBehaviour.StartCoroutine(String, Object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(String)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(Object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(String)
    Component.SendMessageUpwards(String, Object, SendMessageOptions)
    Component.SendMessageUpwards(String, Object)
    Component.SendMessageUpwards(String)
    Component.SendMessageUpwards(String, SendMessageOptions)
    Component.SendMessage(String, Object)
    Component.SendMessage(String)
    Component.SendMessage(String, Object, SendMessageOptions)
    Component.SendMessage(String, SendMessageOptions)
    Component.BroadcastMessage(String, Object, SendMessageOptions)
    Component.BroadcastMessage(String, Object)
    Component.BroadcastMessage(String)
    Component.BroadcastMessage(String, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(Object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, Boolean)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEngine.XR.Interaction.Toolkit
    Syntax
    public abstract class ContinuousMoveProviderBase : LocomotionProvider

    Properties

    enableStrafe

    Controls whether to enable strafing (sideways movement).

    Declaration
    public bool enableStrafe { get; set; }
    Property Value
    Type Description
    Boolean

    forwardSource

    The source Transform that defines the forward direction.

    Declaration
    public Transform forwardSource { get; set; }
    Property Value
    Type Description
    Transform

    gravityApplicationMode

    Controls when gravity begins to take effect.

    Declaration
    public ContinuousMoveProviderBase.GravityApplicationMode gravityApplicationMode { get; set; }
    Property Value
    Type Description
    ContinuousMoveProviderBase.GravityApplicationMode
    See Also
    ContinuousMoveProviderBase.GravityApplicationMode

    moveSpeed

    The speed, in units per second, to move forward.

    Declaration
    public float moveSpeed { get; set; }
    Property Value
    Type Description
    Single

    useGravity

    Controls whether gravity affects this provider when a CharacterController is used.

    Declaration
    public bool useGravity { get; set; }
    Property Value
    Type Description
    Boolean

    Methods

    ComputeDesiredMove(Vector2)

    Determines how much to slide the rig due to input vector.

    Declaration
    protected virtual Vector3 ComputeDesiredMove(Vector2 input)
    Parameters
    Type Name Description
    Vector2 input

    Input vector, such as from a thumbstick.

    Returns
    Type Description
    Vector3

    Returns the translation amount in world space to move the rig.

    MoveRig(Vector3)

    Creates a locomotion event to move the rig by translationInWorldSpace, and optionally applies gravity.

    Declaration
    protected virtual void MoveRig(Vector3 translationInWorldSpace)
    Parameters
    Type Name Description
    Vector3 translationInWorldSpace

    The translation amount in world space to move the rig (pre-gravity).

    ReadInput()

    Reads the current value of the move input.

    Declaration
    protected abstract Vector2 ReadInput()
    Returns
    Type Description
    Vector2

    Returns the input vector, such as from a thumbstick.

    Update()

    See MonoBehaviour.

    Declaration
    protected void Update()

    See Also

    LocomotionProvider
    Back to top
    Terms of use
    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