VisualComponentOptions

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

Options shared by all five visual components.

Extended by

Properties

alpha?

optional alpha?: number

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

Alpha (opacity). Default: 1.

blendMode?

optional blendMode?: BLEND_MODES

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

How this object’s pixels combine with what is drawn beneath it. Default: "inherit" — the mode of the nearest ancestor that sets one, which is "normal" unless a parent changed it. Set it explicitly to "normal" inside a group that uses another mode. See BlendMode for the modes that need import "pixi.js/advanced-blend-modes".

interactive?

optional interactive?: VisualInteractiveOptions

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

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.

layer?

optional layer?: string

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

Render layer name. Default: “default”.

renderAboveEffects?

optional renderAboveEffects?: boolean

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

Draw this visual after the scene’s layers, outside every layer- and scene-scope effect and mask. Default false. See VisualComponent.renderAboveEffects.

tint?

optional tint?: ColorSource

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

Tint color.

visible?

optional visible?: boolean

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

Initial visibility. Default: true.