AnimatedSpriteComponentOptions

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

Options for creating an AnimatedSpriteComponent.

Extends

VisualComponentOptions

Properties

alpha?

optional alpha?: number

Defined in: renderer/src/VisualComponent.ts:47

Alpha (opacity). Default: 1.

Inherited from

VisualComponentOptions.alpha

anchor?

optional anchor?: Vec2Like

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

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

blendMode?

optional blendMode?: BLEND_MODES

Defined in: renderer/src/VisualComponent.ts:53

How this object’s pixels combine with what is drawn beneath it. Default: "normal". See BlendMode for the modes that need import "pixi.js/advanced-blend-modes".

Inherited from

VisualComponentOptions.blendMode

interactive?

optional interactive?: VisualInteractiveOptions

Defined in: renderer/src/VisualComponent.ts:66

Make the container interactive. When set, Pixi eventMode is configured so it participates in pointer hit-testing — required for any .on("pointerdown", ...) listener to fire.

consumeOnInteraction: true additionally marks it as a UI-input surface (via @yagejs/core’s consume registry), so a pointerdown landing on it is auto-claimed by @yagejs/input — preventing the same press from also firing gameplay action-map edges like MouseLeft. Default false: an interactive container still propagates the action, matching the “I want both Pixi events AND the action map” use case.