Skip to content

AnimatedSpriteComponentOptions

Defined in: renderer/src/AnimatedSpriteComponent.ts:23

Options for creating an AnimatedSpriteComponent.

optional anchor?: Vec2Like | readonly [number, number]

Defined in: renderer/src/AnimatedSpriteComponent.ts:34

Default sprite anchor (0,0 = top-left, 0.5,0.5 = center, 1,1 = bottom-right). Per-AnimationController AnimationDef.anchor overrides this when set.


optional interactive?: object

Defined in: renderer/src/AnimatedSpriteComponent.ts:44

Make the sprite interactive. See SpriteComponentOptions.interactive — the shape and semantics are identical here.

optional consumeOnInteraction?: boolean

optional eventMode?: "static" | "dynamic"


optional layer?: string

Defined in: renderer/src/AnimatedSpriteComponent.ts:29

Render layer name. Default: “default”.


optional source?: FrameSource

Defined in: renderer/src/AnimatedSpriteComponent.ts:25

Serializable frame source (sprite strip or atlas).


optional textures?: readonly TextureInput[]

Defined in: renderer/src/AnimatedSpriteComponent.ts:27

Raw texture array (not serializable, backward compat).


optional tint?: string | number

Defined in: renderer/src/AnimatedSpriteComponent.ts:39

Tint applied to the sprite. Pixi v8 accepts a numeric color (0xff0000) or any string color it understands ("#ff0000", "red").