AnimatedSprite
Defined in: display/AnimatedSprite.ts:15
Extends
AnimatedSprite
Constructors
new AnimatedSprite()
new AnimatedSprite(
config
?):AnimatedSprite
Defined in: display/AnimatedSprite.ts:31
Parameters
config?
Partial
<AnimatedSpriteProps
>
Returns
Overrides
PIXIAnimatedSprite.constructor
Properties
autoPlay
autoPlay:
boolean
Defined in: display/AnimatedSprite.ts:27
currentAnimation
currentAnimation:
string
Defined in: display/AnimatedSprite.ts:28
defaultAnimation
defaultAnimation:
string
Defined in: display/AnimatedSprite.ts:24
defaultAnimationSpeed
defaultAnimationSpeed:
number
Defined in: display/AnimatedSprite.ts:25
defaultSheet
defaultSheet:
undefined
|string
Defined in: display/AnimatedSprite.ts:23
defaultTexturePrefix
defaultTexturePrefix:
string
=''
Defined in: display/AnimatedSprite.ts:22
defaultZeroPad
defaultZeroPad:
undefined
|number
Defined in: display/AnimatedSprite.ts:26
onAnimationChange
onAnimationChange:
Signal
<(currentAnimation
) =>void
>
Defined in: display/AnimatedSprite.ts:16
onAnimationComplete
onAnimationComplete:
Signal
<() =>void
>
Defined in: display/AnimatedSprite.ts:20
onAnimationFrameChange
onAnimationFrameChange:
Signal
<() =>void
>
Defined in: display/AnimatedSprite.ts:21
onAnimationLoop
onAnimationLoop:
Signal
<() =>void
>
Defined in: display/AnimatedSprite.ts:19
onAnimationStart
onAnimationStart:
Signal
<() =>void
>
Defined in: display/AnimatedSprite.ts:17
onAnimationStop
onAnimationStop:
Signal
<() =>void
>
Defined in: display/AnimatedSprite.ts:18
Accessors
isReversed
Get Signature
get isReversed():
boolean
Defined in: display/AnimatedSprite.ts:85
Returns
boolean
paused
Get Signature
get paused():
boolean
Defined in: display/AnimatedSprite.ts:67
Returns
boolean
Set Signature
set paused(
value
):void
Defined in: display/AnimatedSprite.ts:71
Parameters
value
boolean
Returns
void
speed
Get Signature
get speed():
number
Defined in: display/AnimatedSprite.ts:75
Returns
number
Set Signature
set speed(
value
):void
Defined in: display/AnimatedSprite.ts:79
Parameters
value
number
Returns
void
Methods
nextAnimation()
nextAnimation():
void
Defined in: display/AnimatedSprite.ts:161
Returns
void
play()
play():
void
Defined in: display/AnimatedSprite.ts:151
Plays the AnimatedSprite.
Returns
void
Overrides
PIXIAnimatedSprite.play
previousAnimation()
previousAnimation():
void
Defined in: display/AnimatedSprite.ts:168
Returns
void
reverse()
reverse():
void
Defined in: display/AnimatedSprite.ts:123
Returns
void
setAnimation()
setAnimation(
animationName
,autoPlay
):void
Defined in: display/AnimatedSprite.ts:132
Parameters
animationName
string
autoPlay
boolean
= true
Returns
void
stop()
stop():
void
Defined in: display/AnimatedSprite.ts:156
Stops the AnimatedSprite.
Returns
void
Overrides
PIXIAnimatedSprite.stop
update()
update(
ticker
):void
Defined in: display/AnimatedSprite.ts:175
Updates the object transform for rendering.
Parameters
ticker
Ticker
the ticker to use to update the object.
Returns
void
Overrides
PIXIAnimatedSprite.update
generateTexturesFromProps()
static
generateTexturesFromProps(animationName
,props
?,defaultTexturePrefix
?,defaultSheet
?,defaultZeroPad
?,defaultStartIndex
?):Texture
[]
Defined in: display/AnimatedSprite.ts:89
Parameters
animationName
string
props?
Partial
<AnimatedSpriteProps
>
defaultTexturePrefix?
string
= ''
defaultSheet?
SpriteSheetLike
= undefined
defaultZeroPad?
number
defaultStartIndex?
number
Returns
Texture
[]