Strata - v1.4.10
    Preparing search index...

    Interface CharacterControllerRef

    Ref interface for CharacterController imperative control.

    interface CharacterControllerRef {
        applyImpulse: (impulse: [number, number, number]) => void;
        getPosition: () => Vector3;
        getRigidBody: () => RigidBody | null;
        getVelocity: () => Vector3;
        isGrounded: () => boolean;
        jump: () => void;
        setPosition: (position: [number, number, number]) => void;
    }
    Index

    Properties

    applyImpulse getPosition getRigidBody getVelocity isGrounded jump setPosition

    Properties

    applyImpulse: (impulse: [number, number, number]) => void

    Apply an external impulse to the character.

    getPosition: () => Vector3

    Get the current world position.

    getRigidBody: () => RigidBody | null

    Get the underlying Rapier rigid body.

    getVelocity: () => Vector3

    Get the current velocity vector.

    isGrounded: () => boolean

    Check if the character is currently on the ground.

    jump: () => void

    Trigger a jump manually.

    setPosition: (position: [number, number, number]) => void

    Manually set the character's position.

    Settings

    Member Visibility

    On This Page

    Properties