docs.unity3d.com
    Show / Hide Table of Contents

    Class CharacterControllerDriver

    Drives a height upon locomotion events of a LocomotionProvider.

    Inheritance
    Object
    CharacterControllerDriver
    Namespace: UnityEngine.XR.Interaction.Toolkit
    Syntax
    public class CharacterControllerDriver : MonoBehaviour

    Properties

    characterController

    (Read Only) The that this class drives.

    Declaration
    protected CharacterController characterController { get; }
    Property Value
    Type Description
    CharacterController

    locomotionProvider

    The LocomotionProvider object to listen to.

    Declaration
    public LocomotionProvider locomotionProvider { get; set; }
    Property Value
    Type Description
    LocomotionProvider

    maxHeight

    The maximum height of the character's capsule that will be set by this behavior.

    Declaration
    public float maxHeight { get; set; }
    Property Value
    Type Description
    Single
    See Also
    minHeight

    minHeight

    The minimum height of the character's capsule that will be set by this behavior.

    Declaration
    public float minHeight { get; set; }
    Property Value
    Type Description
    Single
    See Also
    maxHeight

    xrRig

    (Read Only) The XRRig used for driving the .

    Declaration
    protected XRRig xrRig { get; }
    Property Value
    Type Description
    XRRig

    Methods

    Awake()

    See .

    Declaration
    protected void Awake()

    OnDisable()

    See .

    Declaration
    protected void OnDisable()

    OnEnable()

    See .

    Declaration
    protected void OnEnable()

    Start()

    See .

    Declaration
    protected void Start()

    UpdateCharacterController()

    Update the and based on the camera's position.

    Declaration
    protected virtual void UpdateCharacterController()
    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