Class Sprite

Index

Constructors

Accessors

data context width height

Methods

addAnimation enqueueSingle enqueueSequence run stop isAnimating setEndOfQueueListener

Constructors

constructor

new Sprite(id, spriteSheet, hFrameOffset, vFrameOffset): Sprite
Parameters
- id: string
- spriteSheet: ImageBitmap
- hFrameOffset: number
  Distance between each frame (horizontally)
- vFrameOffset: number
  Distance between each frame (vertically)
Returns Sprite
- Defined in src/utils/sprite.ts:41

Accessors

data

get data(): HTMLCanvasElement
Return current image

Returns HTMLCanvasElement
- Defined in src/utils/sprite.ts:242

context

get context(): CanvasRenderingContext2D
Get output buffer context

Returns CanvasRenderingContext2D
- Defined in src/utils/sprite.ts:249

width

get width(): number
Get sprite width

Returns number
- Defined in src/utils/sprite.ts:256

height

get height(): number
Get sprite height

Returns number
- Defined in src/utils/sprite.ts:263

Methods

addAnimation

addAnimation(id, animationParams): void
Parameters
- id: string
  Name of the animation (used to run/stop it)
- animationParams: SpriteAnimation
Returns void
- Defined in src/utils/sprite.ts:65

enqueueSingle

enqueueSingle(id, nbLoop): void
Play a single animation
Parameters
- id: string
- nbLoop: number
Returns void
- Defined in src/utils/sprite.ts:188

enqueueSequence

enqueueSequence(seq, loop?): void
Parameters
- seq: SpriteSequenceItem[]
- Optional loop: boolean
Returns void
- Defined in src/utils/sprite.ts:202

run

run(): void
Returns void
- Defined in src/utils/sprite.ts:222

stop

stop(): void
Stop the current animation. The pending queue is preserved so run() can restart it: a looping sequence re-queues its current animation as it plays, but a non-looping one has already shifted it out, so put it back at the head of the queue for the restart.

Returns void
- Defined in src/utils/sprite.ts:232

isAnimating

isAnimating(): boolean
Is the sprite currently animating ?

Returns boolean
boolean
- Defined in src/utils/sprite.ts:271

setEndOfQueueListener

setEndOfQueueListener(listener): void
Set the End of queue listener that will be called when current queue is empty
Parameters
- listener: ((id) => void)
  - - (id): void
    - Parameters
      id: string
      Returns void
Returns void
- Defined in src/utils/sprite.ts:279