Skip to content
@pierre/ecs

SpriteClipAnimationSystemOptions

Defined in: src/modules/animation/sprite-clip.ts:137

Options for makeSpriteClipAnimationSystem.

Properties

Section titled “Properties”

animatorDef?

Section titled “animatorDef?”

optional animatorDef?: ComponentDef<SpriteAnimator>

Defined in: src/modules/animation/sprite-clip.ts:139

name?

Section titled “name?”

optional name?: string

Defined in: src/modules/animation/sprite-clip.ts:138

onMissingClip?

Section titled “onMissingClip?”

optional onMissingClip?: (entityId, clip) => void

Defined in: src/modules/animation/sprite-clip.ts:144

Reports an animator whose clip key is not in the registry; the entity is skipped that tick.

Parameters

Section titled “Parameters”
entityId
Section titled “entityId”

EntityId

clip
Section titled “clip”

string

Returns

Section titled “Returns”

void

registry

Section titled “registry”

registry: SpriteClipRegistry

Defined in: src/modules/animation/sprite-clip.ts:141

The clip registry animators resolve their clip key against.

runAfter?

Section titled “runAfter?”

optional runAfter?: string[]

Defined in: src/modules/animation/sprite-clip.ts:142