Communicator.Animation.Manager

 Manager

Top-level interface for the animation system.

Methods

clear

  • clear(): void
  • Removes all players from control of the manager.

    Returns void

createPlayer

  • Creates a new animation player for the supplied animation.

    Parameters

    Returns Player

removePlayer

  • removePlayer(player: Player): boolean
  • Removes the provided player from control of the manager. Returns true is a player was removed

    Parameters

    Returns boolean

removePlayerByIndex

  • removePlayerByIndex(index: number): boolean
  • Removes the player at the provided index from control of the manager. Returns true if a player was removed

    Parameters

    • index: number

    Returns boolean

setTickInterval

  • setTickInterval(milliseconds: number): void
  • Sets the interval at which animations are updated.

    Parameters

    • milliseconds: number

      number of milliseconds between update intervals

    Returns void