SpriteComponentOptions
Defined in: renderer/src/SpriteComponent.ts:10
Options for creating a SpriteComponent.
Extends
Section titled “Extends”Properties
Section titled “Properties”alpha?
Section titled “alpha?”
optionalalpha?:number
Defined in: renderer/src/VisualComponent.ts:47
Alpha (opacity). Default: 1.
Inherited from
Section titled “Inherited from”anchor?
Section titled “anchor?”
optionalanchor?:object
Defined in: renderer/src/SpriteComponent.ts:17
Anchor point (0-1).
x:
number
y:
number
blendMode?
Section titled “blendMode?”
optionalblendMode?: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".
Inherited from
Section titled “Inherited from”VisualComponentOptions.blendMode
interactive?
Section titled “interactive?”
optionalinteractive?: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.
Inherited from
Section titled “Inherited from”VisualComponentOptions.interactive
layer?
Section titled “layer?”
optionallayer?:string
Defined in: renderer/src/VisualComponent.ts:41
Render layer name. Default: “default”.
Inherited from
Section titled “Inherited from”renderAboveEffects?
Section titled “renderAboveEffects?”
optionalrenderAboveEffects?: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.
Inherited from
Section titled “Inherited from”VisualComponentOptions.renderAboveEffects
texture
Section titled “texture”texture:
TextureRef
Defined in: renderer/src/SpriteComponent.ts:15
Texture asset key or typed handle. Runtime-created textures are
referenced by registering them under a key first (registerTexture).
optionaltint?:ColorSource
Defined in: renderer/src/VisualComponent.ts:45
Tint color.
Inherited from
Section titled “Inherited from”visible?
Section titled “visible?”
optionalvisible?:boolean
Defined in: renderer/src/VisualComponent.ts:43
Initial visibility. Default: true.
Inherited from
Section titled “Inherited from”Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/renderer.md.