Docsv2.12.12
Back to API Reference
Class

RevealModifier

Inherits:BaseModifier

Shows only the leading part of each covered range and hides the rest — the engine piece behind typewriter-style text reveal.

Remarks

Visibility is controlled by properties on the modifier (Fill, VisibleClusters, Collapse), not by tag parameters. Clusters are revealed in logical order, whole grapheme clusters at a time, independently per range. Line breaks are never hidden, so the line structure stays stable while text reveals.
public float Fill{ get; set }

Visible fraction of each range: 0 hides everything, 1 shows everything. Ignored while VisibleClusters is set.

public int VisibleClusters{ get; set }

Number of visible grapheme clusters from the start of each range; values beyond the range length show everything. -1 disables the count and lets Fill govern.

public bool Collapse{ get; set }

When, hidden clusters are excluded from shaping and layout and the text reflows (CSS display: none); when, they keep their space and are only not drawn (CSS visibility: hidden).

protected override void OnEnable()
protected override void OnDisable()
protected override void OnDestroy()
protected override void OnApply()
Back to API Reference