Text

RenderingScripts: TextComponent

From a script

import { TextComponent } from "mmpx";

const text = this.entity.TryGetComponent(TextComponent);

Full API: TextComponent.

Fields

Field	Type	Default	Description
Text text	string	—
Material material	material asset	—	A sprite-domain material — a shader drawing this component

Font

Field	Type	Default	Description
Font fontAssetId	font asset	—
Font Family fontFamily	string	"sans-serif"
Size fontSize	number (1 … ∞) (px)	24
Line Height lineHeight	number (1 … ∞) (px)	40
Color color	colour	#FFFFFF
Align align	"left" | "center" | "right"	"left"

Layout

Field	Type	Default	Description
Wrap wrapEnabled	boolean	false
Shrink To Fit shrinkToFit	boolean	false
Crisp Text crispText	boolean	false	Renders at device resolution — sharper, costs more texture memory

Stroke

Field	Type	Default	Description
Color strokeColor	colour	#000000
Width strokeWidth	number (px)	2

Shadow

Field	Type	Default	Description
Color dropShadowColor	colour	#000000
Blur dropShadowBlur	number (0 … ∞)	2
Distance dropShadowDistance	number (px)	6