Hilo3d API - v2.0.0-alpha.8
    Preparing search index...

    Class Animation

    Character-local pose mixer. Assets are shared; bindings, clocks, layers and scratch storage are isolated.

    Index
    className: "Animation" = 'Animation'
    isAnimation: true
    paused: boolean = true
    • get timeScale(): number

      Playback rate, including transitions; zero freezes time while allowing explicit pose evaluation.

      Returns number

    • set timeScale(value: number): void

      Parameters

      • value: number

      Returns void

    • Release node references and remove this instance from automatic ticking. Shared assets remain valid.

      Returns void

    • Current scalar parameter value, defaulting to zero.

      Parameters

      • name: string

      Returns number

    • Suspend automatic ticking, retaining the displayed pose and playback state.

      Returns void

    • Enroll in automatic ticking. Do not also update manually in the same frame.

      Returns void

    • Set a blend parameter immediately, or exponentially damp it using a half-life and elapsed seconds.

      Parameters

      • name: string
      • value: number
      • halfLife: number = 0
      • seconds: number = 0

      Returns void

    • Stop all motions and automatic ticking, optionally restoring captured reference properties.

      Parameters

      • restore: boolean = false

      Returns void

    • Advance from a millisecond Ticker. Manually controlled characters can call update(seconds).

      Parameters

      • milliseconds: number

      Returns void

    • Evaluate one pose and write each bound property once. Call before physics/render transform collection.

      Parameters

      • seconds: number

      Returns void

    • Advances automatically playing characters from a Ticker (milliseconds).

      Parameters

      • milliseconds: number

      Returns void