TextComponentOptions
Defined in: renderer/src/TextComponent.ts:14
Options for creating a TextComponent.
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/TextComponent.ts:36
Anchor point (0-1). Default: { x: 0, y: 0 } (top-left).
x:
number
y:
number
bitmap?
Section titled “bitmap?”
optionalbitmap?:boolean
Defined in: renderer/src/TextComponent.ts:26
Render with a bitmap font instead of canvas-rasterised Text — the
pixel-art escape hatch that stays crisp at non-integer scale. Pixi bakes
or looks up the glyph atlas from style.fontFamily (the name an
installBitmapFont call registered, or any font for a dynamic
bake) at style.fontSize.
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
resolution?
Section titled “resolution?”
optionalresolution?:number
Defined in: renderer/src/TextComponent.ts:34
Per-text render resolution. Mirrors the Pixi v8 Text constructor
option — note resolution is NOT a TextStyle property in v8, so
setting it here is the only way to get crisp canvas text without a
prototype patch. Ignored when bitmap is set (bitmap resolution is
fixed at font-bake time).
style?
Section titled “style?”
optionalstyle?:TextStyleOptions
Defined in: renderer/src/TextComponent.ts:18
Text style — forwards to PixiJS TextStyleOptions (CSS-like font properties).
text:
string
Defined in: renderer/src/TextComponent.ts:16
The text string to render.
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.