Interface HumanoidAnimationBeta

Describes animation data for a humanoid model. To add animation data to an item, register an AnimationClip to a HumanoidAnimationList. This can be obtained using ClusterScript.humanoidAnimation.

For details on HumanoidAnimationList, refer to the documentation.

Hierarchy

  • HumanoidAnimation

Methods

getLength getSample

Methods

getLength

  • Beta

    Obtains the duration of the animation, in seconds.

    If the animation does not exist, this method will return 0.

    Returns number

getSample

  • Beta

    Obtains the pose data of a humanoid model at a given playback position. The playback position value will be 0 for the beginning of the animation, and the value of getLength() for the end.

    If the animation does not exist, this method will return an empty HumanoidPose.

    Parameters

    • time: number

      Playback position within the animation (in seconds)

    Returns HumanoidPose

Settings

Member Visibility

Theme

Generated using TypeDoc