Docsv3.7.2
Back to API Reference
Class

UniTextWorld

Inherits:UniTextBase

World-space text component. Renders via UniTextWorldBatcher with full Unicode support — bidirectional scripts, complex shaping, color emoji, markup.

Remarks

For Canvas-space (UI) text, use UniText.
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 Lit{ get; set }

Gets or sets whether this text receives scene lighting.

public bool CastShadows{ get; set }

Gets or sets whether this text casts shadows onto other objects.

public bool Standalone{ get; set }

Gets or sets whether this text renders through a renderer of its own instead of joining the shared batch mesh.

public static IReadOnlyList<UniTextWorld> Active{ get }

All currently enabled UniTextWorld instances, maintained by OnEnable / OnDisable. Iterate this instead of FindObjectsOfType.

public bool IsWorldSpace{ get }
public bool RaycastTarget{ get; set }

When, this text receives pointer events (clicks, hover, interactive ranges) from UniTextWorldRaycaster. Disable for purely decorative text — the raycaster will skip it.

protected bool PositionFollowsGeometry{ get }

World text is a plane a camera looks at: its document position is where the camera looks.

protected override void OnCanvasHierarchyChanged()
protected override void UpdateGeometry()
protected override void UpdateRendering()
protected override void ClearAllRenderers()
protected override void ApplyVisibility()
protected override void OnEnable()
protected override void OnDisable()
protected override void OnDestroy()
protected override void OnTransformParentChanged()
protected override void OnDeInit()
protected override Nullable<Rect> ResolveDisplayBounds()

A camera's view on the text's plane is all it can show: the main camera, or in the editor the scene view's camera when no main camera exists. A camera adapter that supplies the projected scale owns the display and its window already is the camera's projection, so nothing narrows it. With no camera at all nothing displays the text and only the document's top is materialized.

protected override float ProjectedEmPixels()
protected override Camera ResolveEventCamera()
public static Action<UniTextWorld> Activated

Occurs when a UniTextWorld instance has become active (OnEnable).

public static Action<UniTextWorld> Deactivated

Occurs when a UniTextWorld instance has become inactive (OnDisable).

public Action<UniTextWorld> RenderDataAvailable

Occurs when the component's mesh has been generated and render data is available through MeshGenerator.CollectRenderData.

public Action<UniTextWorld> RenderDataCleared

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

public Action<UniTextWorld> RenderSuppressionChanged

Occurs when RenderSuppressed has toggled (user Hide/Show or scene-visibility). The batcher reads the live state and flips this component's batch membership without a structural rebuild.

public Action<UniTextWorld> SortingChanged

Occurs when a sorting-context input has changed: SortingOrder, SortingLayerID, CastShadows or Standalone (all are batch-key components).

public Action<UniTextWorld> ParentChanged

Occurs when the component's transform parent has changed (may invalidate SortingGroup inheritance).

Back to API Reference