Class Visual

constructor

• new Visual(): Visual

  Returns Visual

vx

vy

x

y

ani

• get ani(): Ani

  Current animation.

  Returns Ani

• set ani(val: Ani): void

  Parameters

  • val: Ani

  Returns void

anis

• get anis(): Anis

  Stores animations. Keys are the animation label, values are Ani objects

  Returns Anis

img

• get img(): Image

  Current image or frame of animation being displayed.

  Returns Image

• set img(image: string | Image): void

  Parameters

  • image: string | Image

  Returns void

addAni

• addAni(spriteSheetURL: string, frameCount: number): Promise<void>

  Adds an animation to the Sprite or Visual.

  Parameters

  • spriteSheetURL: string

    the URL of the sprite sheet image

  • frameCount: number

    the number of frames in the sprite sheet

  Returns Promise<void>

  A promise that fulfills when the animation is loaded

• addAni(
      spriteSheetURL: string,
      frameCount: number,
      frameSize: string,
  ): Promise<void>

  Adds an animation to the Sprite or Visual.

  Parameters

  • spriteSheetURL: string

    the URL of the sprite sheet image

  • frameCount: number

    the number of frames in the sprite sheet

  • frameSize: string

    the size of each frame in the sprite sheet in the format "WIDTHxHEIGHT" (example: "32x32")

  Returns Promise<void>

  A promise that fulfills when the animation is loaded

• addAni(firstFrameURL: string, lastFrameIdx: string): Promise<void>

  Adds an animation to the Sprite or Visual.

  Parameters

  • firstFrameURL: string

    the URL of the first animation frame

  • lastFrameIdx: string

    the index of the last animation frame, must be given as a string

  Returns Promise<void>

  A promise that fulfills when the animation is loaded

addAnis

• addAnis(atlases: {}): Promise<void>

  Add multiple animations to the Sprite or Visual.

  Parameters

  • atlases: {}

    an object with animation names as keys and an animation or animation atlas as values

  Returns Promise<void>

  A promise that fulfills when the animations are loaded

• addAnis(spriteSheetURL: string, atlases: {}): Promise<void>

  Add multiple animations to the Sprite or Visual.

  Parameters

  • spriteSheetURL: string

    the URL of the sprite sheet image

  • atlases: {}

    an object with animation names as keys and an animation or animation atlas as values

  Returns Promise<void>

  A promise that fulfills when the animations are loaded

• addAnis(spriteSheetURL: string, frameSize: string, atlases: {}): Promise<void>

  Add multiple animations to the Sprite or Visual.

  Parameters

  • spriteSheetURL: string

    the URL of the sprite sheet image

  • frameSize: string

    the size of each frame in the sprite sheet in the format "WIDTHxHEIGHT" (example: "32x32")

  • atlases: {}

    an object with animation names as keys and an animation or animation atlas as values

  Returns Promise<void>

  A promise that fulfills when the animations are loaded

changeAni

• changeAni(name: string): void

  Changes the sprite's animation. Use addAni to define the animation(s) first.

  Parameters

  • name: string

    the name of the animation to switch to

  Returns void

draw

• draw(): void

  Draws the visual on the canvas.

  Returns void

playAni

• playAni(name: string): Promise<void>

  Plays an animation.

  You can put special modifier characters before the name:

  • "!" plays it backwards
  • ">" or "<" horizontally flips it
  • "^" vertically flips it

  Parameters

  • name: string

    the name of the animation to play

  Returns Promise<void>

  A promise that fulfills when the animation completes

playAnis

• playAnis(...sequence: string[]): Promise<void>

  Plays a sequence of animations.

  You can put special modifier characters before each ani name:

  • "!" plays it backwards
  • ">" or "<" horizontally flips it
  • "^" vertically flips it

  You can put sequence modifiers at the end of the sequence:

  • "**" loops it indefinitely
  • ";;" stops it on the last ani's last frame

  Parameters

  • ...sequence: string[]

    the names of animations

  Returns Promise<void>

  A promise that fulfills when the sequence completes