SpriteAnimationAPI
Defined in: animation/SpriteAnimator.ts:66
Owns one App’s sprite-animation clip registry and frame-event listeners,
advances SpriteAnimator components, and drives goto-frame/label. Published as
the SpriteAnimation resource; read it as
app.getResource(SpriteAnimation).
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SpriteAnimationAPI():
SpriteAnimationAPI
Returns
Section titled “Returns”SpriteAnimationAPI
Methods
Section titled “Methods”aliasClip()
Section titled “aliasClip()”aliasClip(
name,clip):void
Defined in: animation/SpriteAnimator.ts:84
Register an EXISTING clip object under an additional lookup name. Loaders register a clip under its resolved load path, which in some realms is an absolute URL — components reference the serialized project-relative ref, so the two must alias to the SAME object (events attached through one name fire for the other).
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
clearClips()
Section titled “clearClips()”clearClips():
void
Defined in: animation/SpriteAnimator.ts:96
Returns
Section titled “Returns”void
getClip()
Section titled “getClip()”getClip(
name):SpriteAnimClip|undefined
Defined in: animation/SpriteAnimator.ts:92
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”SpriteAnimClip | undefined
gotoFrame()
Section titled “gotoFrame()”gotoFrame(
animator,frameIndex,andPlay?):void
Defined in: animation/SpriteAnimator.ts:233
Parameters
Section titled “Parameters”animator
Section titled “animator”frameIndex
Section titled “frameIndex”number
andPlay?
Section titled “andPlay?”boolean = true
Returns
Section titled “Returns”void
gotoLabel()
Section titled “gotoLabel()”gotoLabel(
animator,label,andPlay?):void
Defined in: animation/SpriteAnimator.ts:243
Parameters
Section titled “Parameters”animator
Section titled “animator”string
andPlay?
Section titled “andPlay?”boolean = true
Returns
Section titled “Returns”void
onEvent()
Section titled “onEvent()”onEvent(
entity,handler): () =>void
Defined in: animation/SpriteAnimator.ts:102
Parameters
Section titled “Parameters”entity
Section titled “entity”number
handler
Section titled “handler”Returns
Section titled “Returns”() => void
onEventGlobal()
Section titled “onEventGlobal()”onEventGlobal(
handler): () =>void
Defined in: animation/SpriteAnimator.ts:119
Parameters
Section titled “Parameters”handler
Section titled “handler”Returns
Section titled “Returns”() => void
registerClip()
Section titled “registerClip()”registerClip(
clip):void
Defined in: animation/SpriteAnimator.ts:73
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
removeEntityListeners()
Section titled “removeEntityListeners()”removeEntityListeners(
entity):void
Defined in: animation/SpriteAnimator.ts:127
Parameters
Section titled “Parameters”entity
Section titled “entity”number
Returns
Section titled “Returns”void
unregisterClip()
Section titled “unregisterClip()”unregisterClip(
name):void
Defined in: animation/SpriteAnimator.ts:88
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
update()
Section titled “update()”update(
world,deltaTime):void
Defined in: animation/SpriteAnimator.ts:151
Parameters
Section titled “Parameters”deltaTime
Section titled “deltaTime”number
Returns
Section titled “Returns”void