Documentation / @debuffjp/core / Sprite
Class: Sprite
Defined in: core/src/sprite.ts:35
Drawable frame sequence with transform, tint flash and named animations.
Constructors
Constructor
new Sprite(
options):Sprite
Defined in: core/src/sprite.ts:58
Parameters
options
Returns
Sprite
Properties
alpha
alpha:
number=1
Defined in: core/src/sprite.ts:41
animations
readonlyanimations:Record<string,AnimationClip>
Defined in: core/src/sprite.ts:52
flash
flash:
number=0
Defined in: core/src/sprite.ts:45
0..1 white overlay, for impact flashes.
flipX
flipX:
boolean=false
Defined in: core/src/sprite.ts:42
frame
frame:
number=0
Defined in: core/src/sprite.ts:49
frames
readonlyframes: readonlyFrame[]
Defined in: core/src/sprite.ts:51
origin
origin:
Origin
Defined in: core/src/sprite.ts:48
rotation
rotation:
number=0
Defined in: core/src/sprite.ts:38
scaleX
scaleX:
number=1
Defined in: core/src/sprite.ts:39
scaleY
scaleY:
number=1
Defined in: core/src/sprite.ts:40
tint
tint:
Color|undefined
Defined in: core/src/sprite.ts:47
Colour multiplier.
visible
visible:
boolean=true
Defined in: core/src/sprite.ts:43
x
x:
number
Defined in: core/src/sprite.ts:36
y
y:
number
Defined in: core/src/sprite.ts:37
Accessors
animation
Get Signature
get animation():
string|undefined
Defined in: core/src/sprite.ts:67
Returns
string | undefined
done
Get Signature
get done():
boolean
Defined in: core/src/sprite.ts:72
True once a non-looping animation reaches its last frame.
Returns
boolean
Methods
draw()
draw(
draw):void
Defined in: core/src/sprite.ts:101
Parameters
draw
Returns
void
play()
play(
name,restart?):void
Defined in: core/src/sprite.ts:77
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: core/src/sprite.ts:88
Parameters
dt
number
Returns
void