Class AnimationManager

constructor

• new AnimationManager(game, settings?): AnimationManager

• Parameters

  • game: Game

    the BGA game class, usually it will be this

  • Optional settings: AnimationManagerSettings

  Returns AnimationManager

game

animationsActive

• animationsActive(): boolean

• Returns if the animations are active. Animation aren't active when the window is not visible (document.visibilityState === 'hidden'), or game.instantaneousMode is true.

  Returns boolean

  if the animations are active.

attachWithAnimation

• attachWithAnimation(animation, attachElement): Promise<BgaAnimation<any>>

• Attach an element to a parent, then play animation from element's origin to its new position.

  Parameters

  • animation: BgaAnimation<BgaAnimationSettings>

    the animation function

  • attachElement: HTMLElement

    the destination parent

  Returns Promise<BgaAnimation<any>>

  a promise when animation ends

getSettings

• getSettings(): AnimationManagerSettings

• Returns AnimationManagerSettings

getZoomManager

• getZoomManager(): IZoomManager

• Returns IZoomManager

play

• play(animation): Promise<BgaAnimation<BgaAnimationSettings>>

• Plays an animation if the animations are active. Animation aren't active when the window is not visible (document.visibilityState === 'hidden'), or game.instantaneousMode is true.

  Parameters

  • animation: BgaAnimation<BgaAnimationSettings>

    the animation to play

  Returns Promise<BgaAnimation<BgaAnimationSettings>>

  the animation promise.

playParallel

• playParallel(animations): Promise<BgaAnimation<BgaAnimationSettings>[]>

• Plays multiple animations in parallel.

  Parameters

  • animations: BgaAnimation<BgaAnimationSettings>[]

    the animations to play

  Returns Promise<BgaAnimation<BgaAnimationSettings>[]>

  a promise for all animations.

playSequence

• playSequence(animations): Promise<BgaAnimation<BgaAnimationSettings>[]>

• Plays multiple animations in sequence (the second when the first ends, ...).

  Parameters

  • animations: BgaAnimation<BgaAnimationSettings>[]

    the animations to play

  Returns Promise<BgaAnimation<BgaAnimationSettings>[]>

  a promise for all animations.

playWithDelay

• playWithDelay(animations, delay): Promise<BgaAnimation<BgaAnimationSettings>[]>

• Plays multiple animations with a delay between each animation start.

  Parameters

  • animations: BgaAnimation<BgaAnimationSettings>[]

    the animations to play

  • delay: number

    the delay (in ms)

  Returns Promise<BgaAnimation<BgaAnimationSettings>[]>

  a promise for all animations.

setZoomManager

• setZoomManager(zoomManager): void

• Set the zoom manager, to get the scale of the current game.

  Parameters

  • zoomManager: IZoomManager

    the zoom manager

  Returns void