Docsv3.31.0
Back to API Reference
Class

UniTextInteractions

sealed
Implements:IDisposable

Per-component router for interactive text entities. It owns host input subscriptions, final-geometry hit testing, overlap arbitration, per-pointer leases and channel routing.

public bool HasTargets{ get }

Whether at least one enabled interactive entity currently has hit geometry.

public RangeIdentity FocusedEntity{ get }

Stable identity of the currently focused entity, or an invalid value.

public int EntityCount{ get }

Number of enabled logical entities in navigation order.

public static UniTextInteractions For(UniTextBase owner)

Returns the interaction router attached to a text component.

public static bool TryGet(UniTextBase owner, out UniTextInteractions interactions)

Returns an existing router without creating one.

public RangeInteractionEvents Get(RangeChannel channel)

Returns the stable subscription surface for one semantic range channel.

public InteractiveRange GetEntity(int index)

Returns one representative range in logical navigation order.

public bool TryGetBounds(RangeIdentity identity, out Rect bounds)

Returns the union of final hit geometry for one stable entity.

public bool ScrollIntoView(RangeIdentity identity)

Publishes a viewport-neutral reveal request for one stable entity.

public bool Focus(RangeIdentity identity)

Focuses one entity and selects the owning UniText GameObject in the EventSystem.

public bool FocusFirst()

Focuses the first enabled logical entity.

public bool MoveFocus(RangeNavigationDirection direction, RangeNavigationOrder order = RangeNavigationOrder.Logical, RangeChannel channel = null, bool wrap = false)

Moves focus in logical or final-geometry order, optionally constrained to one channel. Home and End select a boundary without requiring an existing focus origin.

public void Blur()

Clears the internal entity focus without changing EventSystem selection.

public bool ActivateFocused()

Activates the focused entity through the same routed event and default action as a pointer.

public bool ContextForFocused()

Requests contextual actions for the focused entity.

public bool CancelPointer(int pointerId)

Cancels one platform pointer lifecycle, releasing Pressed/Hovered leases and emitting Canceled instead of translating capture loss into a pointer exit.

public void Dispose()

Releases pointer leases, host subscriptions and retained geometry capture.

public RangeInteractionHandler Capturing

Runs before a target channel and may stop later routing through RangeInteraction.Handled.

public RangeInteractionHandler Bubbling

Runs after the target channel and modifier unless an earlier handler stopped routing.

public Action<RangeScrollRequest> ScrollIntoViewRequested

Asks the viewport owner to reveal an entity. The router publishes geometry but does not assume ScrollRect, world-camera or custom document scrolling ownership.

Back to API Reference