Documentation / @debuffjp/core / Sprite

Class: Sprite

Defined in: sprite.ts:37

Drawable frame sequence with transform, tint flash and named animations.

Constructors

Constructor

new Sprite(options): Sprite

Defined in: sprite.ts:60

Parameters

options

SpriteOptions

Returns

Sprite

Properties

alpha

alpha: number = 1

Defined in: sprite.ts:43

---

animations

readonly animations: Record<string, AnimationClip>

Defined in: sprite.ts:54

---

flash

flash: number = 0

Defined in: sprite.ts:47

0..1 white overlay, for impact flashes.

---

flipX

flipX: boolean = false

Defined in: sprite.ts:44

---

frame

frame: number = 0

Defined in: sprite.ts:51

---

frames

readonly frames: readonly Frame[]

Defined in: sprite.ts:53

---

origin

origin: Origin

Defined in: sprite.ts:50

---

rotation

rotation: number = 0

Defined in: sprite.ts:40

---

scaleX

scaleX: number = 1

Defined in: sprite.ts:41

---

scaleY

scaleY: number = 1

Defined in: sprite.ts:42

---

tint

tint: Color | undefined

Defined in: sprite.ts:49

Colour multiplier.

---

visible

visible: boolean = true

Defined in: sprite.ts:45

---

x

x: number

Defined in: sprite.ts:38

---

y

y: number

Defined in: sprite.ts:39

Accessors

animation

Get Signature

get animation(): string | undefined

Defined in: sprite.ts:69

Returns

string | undefined

---

done

Get Signature

get done(): boolean

Defined in: sprite.ts:74

True once a non-looping animation reaches its last frame.

Returns

boolean

Methods

draw()

draw(draw): void

Defined in: sprite.ts:103

Parameters

draw

Draw

Returns

void

---

play()

play(name, restart?): void

Defined in: sprite.ts:79

Play a named animation. Re-playing the current one does nothing unless restart.

Parameters

name

string

restart?

boolean = false

Returns

void

---

update()

update(dt): void

Defined in: sprite.ts:90

Parameters

dt

number

Returns

void