Brighterscript Game Engine

AnimatedImage

Extends: Image

Properties

  • index (integer) — The current index of image - this would not normally be changed manually, but if you wanted to stop on a specific image in the spritesheet this could be set.
  • animationDurationMs (float) — The time in milliseconds for a single cycle through the animation to play.
  • animationTween (string) — The name of the tween to use for choosing the next image
  • regions (dynamic) — ------------Never To Be Manually Changed----------------- ' These values should never need to be manually changed.
  • animationTimer (dynamic)
  • tweensReference (dynamic)

Constructor

new AnimatedImage( owner: GameEntity, regions: dynamic, args?: roAssociativeArray, ): AnimatedImage

Parameters

  • owner (GameEntity)
  • regions (dynamic)
  • args (roAssociativeArray, optional, default: "{}")

Instance Methods

update(): void

Returns

  • void

draw(additionalRotation?: BGE.Math.Vector): dynamic

Parameters

  • additionalRotation (BGE.Math.Vector, optional, default: "invalid")

Returns

  • dynamic

getCellDrawIndex(): integer

protected

Returns

  • integer

onResume(pausedTime: integer): dynamic

Parameters

  • pausedTime (integer)

Returns

  • dynamic

addToScene(renderObj: Renderer): void

Parameters

Returns

  • void