Docsv2.2.5
Back to API Reference
Class

UniTextWorld

World-space text rendering component with full Unicode support.

Remarks

The component is self-contained — it publishes its state through events and does not know about any specific renderer. An invisible batcher (UniTextWorldBatcher) subscribes to the Activated / Deactivated static events and to per-instance events (RenderDataAvailable, RenderDataCleared, SortingChanged, ParentChanged) to assemble combined meshes. Conceptual analogy: UniTextWorld is to UniTextWorldBatcher what CanvasRenderer is to Canvas — a data provider; the batcher observes and draws.

Nested Types

C
AnimationHandler
Animation handler for [[UniTextWorld]]. Adds diff coverage for [[SortingOrder]] and [[SortingLayerID]] on top of the base text fields, and re-fires [[SortingChanged]] so observers (e.g. [[UniTextWorldBatcher]]) react to animated sorting just as they would to a setter call.
public static IReadOnlyList<UniTextWorld> Active{ get }

Gets all currently enabled UniTextWorld instances. Populated by OnEnable/OnDisable. Used by UniTextWorldRaycaster to iterate hit-testable components without Unity scene scans.

public int SortingOrder{ get; set }

Gets or sets the sorting order for render ordering.

public int SortingLayerID{ get; set }

Gets or sets the sorting layer ID.

public bool RaycastTarget{ get; set }

When true, this text receives pointer events from UniTextWorldRaycaster (clicks, hover, interactive ranges). Set to false for purely decorative text — the raycaster will skip it entirely. Default: true.

public override void SetAllDirty()
public override void SetVerticesDirty()
public override void SetMaterialDirty()
protected override void OnCanvasHierarchyChanged()
protected override void UpdateGeometry()
protected override void UpdateRendering()
protected override void ClearAllRenderers()
protected override void OnEnable()
protected override void OnDisable()
protected override void OnDestroy()
protected override void OnTransformParentChanged()
protected override void HandleAnimation()
protected override Camera ResolveEventCamera()
public static Action<UniTextWorld> Activated

Raised when a UniTextWorld instance becomes active (OnEnable).

public static Action<UniTextWorld> Deactivated

Raised when a UniTextWorld instance becomes inactive (OnDisable).

public Action<UniTextWorld> RenderDataAvailable

Raised right after the component's mesh has been generated and render data is available through MeshGenerator.CollectRenderData.

public Action<UniTextWorld> RenderDataCleared

Raised when the component's render data should be discarded (e.g. empty text, disabled).

public Action<UniTextWorld> SortingChanged

Raised when SortingOrder or SortingLayerID changes.

public Action<UniTextWorld> ParentChanged

Raised when the component's transform parent changes (may invalidate SortingGroup inheritance).

Back to API Reference