TextInit

A font asset the game SHIPS (.ttf / .otf / .woff). When set it wins over fontFamily: the loader registers the file with the platform’s text stack and this handle resolves back to that family. Leave it empty to name a font the host already has, through fontFamily.

Inherited from

TextData.font

fontFamily?

optional fontFamily?: string

Defined in: ui/core/text.ts:88

Font family resolved by the platform’s text stack — a font the HOST already has. For a font you ship, use font instead.

Inherited from

TextData.fontFamily

fontSize?

optional fontSize?: number

Defined in: ui/core/text.ts:89

Inherited from

TextData.fontSize

i18nKey?

optional i18nKey?: string

Defined in: ui/core/text.ts:78

Localization key. Non-empty ⇒ content is DERIVED: every frame the text-localization system resolves the key through the app’s Localization resource (opt-in plugin) and writes the result into content, so a setLocale re-flows every bound label. Empty (default) or no Localization resource ⇒ content stands as authored.

Inherited from

TextData.i18nKey

italic?

optional italic?: boolean

Defined in: ui/core/text.ts:97

Inherited from

TextData.italic

layer?

optional layer?: number

Defined in: ui/core/text.ts:120

Draw layer, for a text with NO layout box — a label standing in the world rather than inside a Canvas. It is read the same way Sprite.layer and ShapeRenderer.layer are, so a label can be put in front of (or behind) the world content around it.

Ignored under a UINode: inside a Canvas the UI render order decides, and a second knob there would let a text sort against its own panel.

It exists because world text was pinned to layer 0 with no way off it, so any ShapeRenderer or Sprite that also sat on layer 0 and drew later simply covered it — a board hiding its own pieces, a name tag behind the character it names — with nothing in the component to reach for.