TextStudioBinding

ClassTextStudioTextStudio

public sealed class TextStudioBinding : CustomBinding, ITextStudioReactionUIParticleHost, ITextStudioReactionPendingAnchorHost, ITextStudioAnimationPlayback, IDataSourceProvider, ITextStudioContent, ITextStudioPlayback, ITextStudioVisibility, ITextStudioEffectControl, ITextStudioReactionActionHost, ITextStudioReactionUnitTextSource

Binds Text Studio markup, reveal playback, effects, placement, and visibility control to an existing UI Toolkit UnityEngine.UIElements.TextElement without requiring a MonoBehaviour.

Methods

RefreshReactionTargets()

public void RefreshReactionTargets()

Clears cached UI Toolkit target elements so future reaction target lookups resolve them again.

TryGetReactionTarget(string, out TextStudioReactionAnchor)

public bool TryGetReactionTarget(string key, out TextStudioReactionAnchor anchor)

Attempts to resolve a configured UI Toolkit target to an anchor on the binding’s attached panel using its binding key.

Parameters

Name	Type
key	System.String
anchor	TextStudio.TextStudioReactionAnchor

Returns

System.Boolean

ResolveReactionTargetSlot(string)

public int ResolveReactionTargetSlot(string key)

Finds the exact named reaction target binding, or returns -1 when no binding matches.

Parameters

Name	Type
key	System.String

Returns

System.Int32

TryGetReactionTarget(int, out TextStudioReactionAnchor)

public bool TryGetReactionTarget(int slot, out TextStudioReactionAnchor anchor)

Attempts to resolve a configured UI Toolkit target to an anchor on the binding’s attached panel using its slot.

Parameters

Name	Type
slot	System.Int32
anchor	TextStudio.TextStudioReactionAnchor

Returns

System.Boolean

TryCaptureReactionOutput(in TextStudioReactionCaptureRequest, out TextStudioReactionLease)

public bool TryCaptureReactionOutput(in TextStudioReactionCaptureRequest request, out TextStudioReactionLease lease)

Attempts to retain reaction output from an attached Play Mode panel, recording a diagnostic if capture fails.

Parameters

Name	Type
request	TextStudio.TextStudioReactionCaptureRequest
lease	TextStudio.TextStudioReactionLease

Returns

System.Boolean

TryGetReactionAnchor(in TextStudioReactionContext, out TextStudioReactionAnchor)

public bool TryGetReactionAnchor(in TextStudioReactionContext context, out TextStudioReactionAnchor anchor)

Resolves a reaction’s semantic unit to UI Toolkit panel coordinates. A context without a unit index resolves to the center of the current text layout.

Parameters

Name	Type
context	TextStudio.TextStudioReactionContext
anchor	TextStudio.TextStudioReactionAnchor

Returns

System.Boolean

PlayReaction(string, float, int)

public void PlayReaction(string signal, float intensity = 1, int unitIndex = -1)

Invokes matching named responses on an attached Play Mode panel and wakes their automatic driver.

Parameters

Name	Type
signal	System.String
intensity	System.Single
unitIndex	System.Int32

StopReactions()

public void StopReactions()

Stops accepting new reaction triggers while existing finite responses finish.

CancelReactions()

public void CancelReactions()

Cancels all active responses and invalidates their pending callbacks.

TryGetReactionUnitCharacter(in TextStudioReactionContext, out char)

public bool TryGetReactionUnitCharacter(in TextStudioReactionContext context, out char character)

Returns the primary character only when the reaction context belongs to the current compiled text unit.

Parameters

Name	Type
context	TextStudio.TextStudioReactionContext
character	System.Char

Returns

System.Boolean

PauseAnimation()

public void PauseAnimation()

Pauses Text Studio-owned presentation time and wakes the driver to apply the pause while layout remains live.

ResumeAnimation()

public void ResumeAnimation()

Resumes paused presentation time and wakes the binding’s automatic driver.

CollectCapabilities(TextStudioCapabilityReport)

public void CollectCapabilities(TextStudioCapabilityReport report)

Collects the active UI Toolkit strategy and its actual fallback behavior.

Parameters

Name	Type
report	TextStudio.TextStudioCapabilityReport

ApplyConverterGroupToUI(ConverterGroup)

public void ApplyConverterGroupToUI(ConverterGroup group)

Adds a source-to-string converter group for this binding.

Parameters

Name	Type
group	UnityEngine.UIElements.ConverterGroup

RegisterExtensionTagProcessor(ITextStudioExtensionTagProcessor)

public void RegisterExtensionTagProcessor(ITextStudioExtensionTagProcessor processor)

Registers a component-local processor for plan and reveal extension-tag callbacks.

Parameters

Name	Type
processor	TextStudio.ITextStudioExtensionTagProcessor

UnregisterExtensionTagProcessor(ITextStudioExtensionTagProcessor)

public void UnregisterExtensionTagProcessor(ITextStudioExtensionTagProcessor processor)

Stops dispatching extension-tag callbacks to a component-local processor.

Parameters

Name	Type
processor	TextStudio.ITextStudioExtensionTagProcessor

OnActivated(in BindingActivationContext)

protected override void OnActivated(in BindingActivationContext context)

Attaches the binding runtime to its validated UI Toolkit text target.

Parameters

Name	Type
context	UnityEngine.UIElements.BindingActivationContext

OnDeactivated(in BindingActivationContext)

protected override void OnDeactivated(in BindingActivationContext context)

Detaches runtime state when UI Toolkit deactivates this binding.

Parameters

Name	Type
context	UnityEngine.UIElements.BindingActivationContext

OnDataSourceChanged(in DataSourceContextChanged)

protected override void OnDataSourceChanged(in DataSourceContextChanged context)

Refreshes authored text when UI Toolkit replaces the active data source.

Parameters

Name	Type
context	UnityEngine.UIElements.DataSourceContextChanged

Attach(TextElement)

public void Attach(TextElement element)

Attaches the binding directly for hosts that do not use VisualElement.SetBinding.

Parameters

Name	Type
element	UnityEngine.UIElements.TextElement

Detach()

public void Detach()

Stops scheduling, restores the target element, and releases all attachment callbacks.

RefreshBehaviorProfile()

public void RefreshBehaviorProfile()

Refreshes effective behavior after an assigned profile asset changes.

SetText(string)

public void SetText(string markup)

Replaces the current markup using the host’s configured text-change policy.

Parameters

Name	Type	Description
markup	System.String	Markup to compile. A null value is treated as empty text.

SetText(string, TextStudioTextChangeScope)

public void SetText(string markup, TextStudioTextChangeScope scope)

Replaces markup using a scope for this change only, preserving the authored settings and start policy.

Parameters

Name	Type
markup	System.String
scope	TextStudio.TextStudioTextChangeScope

SetTextDeferred(string)

public void SetTextDeferred(string markup)

Replaces pending markup without compiling it until the next automatic or manual update. Repeated calls before that update compile only the newest value.

Parameters

Name	Type
markup	System.String

AppendText(string)

public void AppendText(string markup)

Appends markup and recompiles the combined content.

Parameters

Name	Type	Description
markup	System.String	Markup to append. Null or empty input leaves the content unchanged.

AppendTextDeferred(string)

public void AppendTextDeferred(string markup)

Appends markup and defers compilation until the next automatic or host update.

Parameters

Name	Type
markup	System.String

ClearText()

public void ClearText()

Clears authored content, compiled state, and visible output.

ShowText(string)

public void ShowText(string markup)

Replaces the content and begins reveal playback using the current settings.

Parameters

Name	Type	Description
markup	System.String	Markup to compile and reveal.

ShowText(string, TextStudioTextChangeScope)

public void ShowText(string markup, TextStudioTextChangeScope scope)

Reveals markup using a scope for this change only, without modifying the authored settings.

Parameters

Name	Type
markup	System.String
scope	TextStudio.TextStudioTextChangeScope

Remarks

Scopes that retain matching glyphs reveal only changed glyphs, so a change that leaves every glyph matching keeps the current reveal. TextStudio.TextStudioTextChangeScope.WholeText replays the complete text.

ShowTextInstant(string)

public void ShowTextInstant(string markup)

Replaces the content and displays it completely without advancing a reveal clock.

Parameters

Name	Type	Description
markup	System.String	Markup to compile and display.

StartReveal()

public void StartReveal()

Starts reveal playback for the current compiled content.

ContinueReveal()

public void ContinueReveal()

Continues a prepared text change without replaying retained glyphs.

SkipReveal()

public void SkipReveal()

Completes reveal immediately, including remaining reveal events.

StopReveal()

public void StopReveal()

Stops reveal at its current visibility without completing it.

TriggerRemainingEvents()

public void TriggerRemainingEvents()

Dispatches pending marker and cue events without advancing the reveal animation.

AdvanceOrSkip()

public bool AdvanceOrSkip()

Advances a paused or waiting reveal when possible; otherwise completes the active reveal.

Returns

System.Boolean: true when the call changed playback state.

StartDisappear()

public void StartDisappear()

Starts hide playback for the current content.

SkipDisappear()

public void SkipDisappear()

Completes hide playback immediately.

StopDisappear()

public void StopDisappear()

Stops hide playback at its current visibility.

GetApproximateHideDuration()

public float GetApproximateHideDuration()

Estimates hide duration using the current content and timing configuration.

Returns

System.Single: Approximate duration in seconds.

SetRevealSpeed(float)

public void SetRevealSpeed(float multiplier)

Changes the playback-rate multiplier used by subsequent reveal updates.

Parameters

Name	Type	Description
multiplier	System.Single	Non-negative speed multiplier, where 1 uses authored timing.

PauseReveal()

public void PauseReveal()

Pauses reveal playback while retaining its current position.

ResumeReveal()

public void ResumeReveal()

Resumes reveal playback from its paused position.

SkipCurrentWait()

public void SkipCurrentWait()

Requests cooperative cancellation of the active wait and resumes reveal. Custom non-skippable action coroutines may continue running.

SetRevealProgress(float)

public void SetRevealProgress(float progress)

Sets reveal to an explicit normalized position without changing authored content.

Parameters

Name	Type	Description
progress	System.Single	Requested progress, clamped to the 0 to 1 range.

SetGlyphVisibility(int, bool, bool)

public bool SetGlyphVisibility(int glyphIndex, bool visible, bool playTransition = true)

Overrides visibility for one visible glyph.

Parameters

Name	Type	Description
glyphIndex	System.Int32	Zero-based visible-glyph index in the current compiled plan.
visible	System.Boolean	Whether the glyph should be visible.
playTransition	System.Boolean	Whether configured transitions should be used.

Returns

System.Boolean: false when glyphIndex is outside the current plan.

SetWordVisibility(int, bool, bool)

public bool SetWordVisibility(int wordIndex, bool visible, bool playTransition = true)

Overrides visibility for one semantic word.

Parameters

Name	Type	Description
wordIndex	System.Int32	Zero-based word index in the current compiled plan.
visible	System.Boolean	Whether glyphs in the word should be visible.
playTransition	System.Boolean	Whether configured transitions should be used.

Returns

System.Boolean: false when wordIndex is outside the current plan.

SetTextVisibility(bool, bool)

public bool SetTextVisibility(bool visible, bool playTransition = true)

Overrides visibility for the complete text without modifying its markup.

Parameters

Name	Type	Description
visible	System.Boolean	Whether all glyphs should be visible.
playTransition	System.Boolean	Whether configured reveal or hide transitions should be used.

Returns

System.Boolean: true when the override was accepted.

ClearGlyphVisibilityOverride(int)

public bool ClearGlyphVisibilityOverride(int glyphIndex)

Restores authored visibility for one glyph.

Parameters

Name	Type	Description
glyphIndex	System.Int32	Zero-based visible-glyph index in the current compiled plan.

Returns

System.Boolean: true when an existing override was removed.

ClearVisibilityOverrides()

public bool ClearVisibilityOverrides()

Restores authored visibility for every glyph.

Returns

System.Boolean: true when at least one override was removed.

ConfigureEffectFamilies(bool, bool, bool)

public void ConfigureEffectFamilies(bool reveal, bool active, bool hide)

Enables or disables evaluation of reveal, active, and hide effect families.

Parameters

Name	Type
reveal	System.Boolean
active	System.Boolean
hide	System.Boolean

RestartEffects()

public void RestartEffects()

Resets effect-local clocks and state while preserving text and reveal progress.

RefreshEffectBindings()

public void RefreshEffectBindings()

Re-resolves effect definitions and parameters after registry or asset changes.

ApplyExternalEffect(ITextStudioEffectDefinition, float, float, TextStudioTextRange)

public bool ApplyExternalEffect(ITextStudioEffectDefinition effect, float progress, float intensity = 1, TextStudioTextRange range = default)

Adds an externally driven effect layer for the current frame. Submit it every frame while active; normal effects are evaluated first and remain intact on untouched channels.

Parameters

Name	Type
effect	TextStudio.ITextStudioEffectDefinition
progress	System.Single
intensity	System.Single
range	TextStudio.TextStudioTextRange

Returns

System.Boolean

RegisterExternalEffectSource(ITextStudioExternalEffectSource)

public void RegisterExternalEffectSource(ITextStudioExternalEffectSource source)

Registers an ordered external effect source with this binding.

Parameters

Name	Type
source	TextStudio.ITextStudioExternalEffectSource

UnregisterExternalEffectSource(ITextStudioExternalEffectSource)

public void UnregisterExternalEffectSource(ITextStudioExternalEffectSource source)

Stops polling a previously registered external effect source.

Parameters

Name	Type
source	TextStudio.ITextStudioExternalEffectSource

SetRevealLoop(bool, float)

public void SetRevealLoop(bool loop, float delay = 0.75)

Controls whether reveal restarts after completion and configures the delay before restarting.

Parameters

Name	Type
loop	System.Boolean
delay	System.Single

UpdateFromHost(float)

public void UpdateFromHost(float deltaTime)

Advances a Manual binding from a host-owned clock. Automatic bindings already advance through the target panel scheduler and ignore duplicate work within one player frame.

Parameters

Name	Type
deltaTime	System.Single

GetBasicVisibleText()

public string GetBasicVisibleText()

Gets plain visible text suitable for UI Toolkit fallback rendering without Text Studio tags.

Returns

System.String

ConfigureLinearPlacement()

public void ConfigureLinearPlacement()

Selects source-linear placement without changing the current orientation policy.

ConfigureCurvePlacement(in TextStudioCurveDefinition, float, TextStudioApplicationSelector, TextStudioCurveMapping)

public void ConfigureCurvePlacement(in TextStudioCurveDefinition definition, float height = 0.5, TextStudioApplicationSelector selection = default, TextStudioCurveMapping mapping = TextStudioCurveMapping.EachMatch)

Selects curve placement with a copied inline definition and updates its height, text selection, and match mapping.

Parameters

Name	Type
definition	TextStudio.TextStudioCurveDefinition
height	System.Single
selection	TextStudio.TextStudioApplicationSelector
mapping	TextStudio.TextStudioCurveMapping

ConfigureCurvePlacement(TextStudioCurveProfile, float, TextStudioApplicationSelector, TextStudioCurveMapping)

public void ConfigureCurvePlacement(TextStudioCurveProfile profile, float height = 0.5, TextStudioApplicationSelector selection = default, TextStudioCurveMapping mapping = TextStudioCurveMapping.EachMatch)

Selects curve placement with a linked shared profile and updates its height, text selection, and match mapping.

Parameters

Name	Type
profile	TextStudio.TextStudioCurveProfile
height	System.Single
selection	TextStudio.TextStudioApplicationSelector
mapping	TextStudio.TextStudioCurveMapping

MakeCurvePlacementLocal()

public void MakeCurvePlacementLocal()

Copies the linked curve profile into local placement settings and updates the binding.

ConfigureArcPlacement(float, float, float, PathSpacing, float, bool, float, PathPosition)

public void ConfigureArcPlacement(float radius, float arcAngle, float startAngle = 0, PathSpacing spacing = PathSpacing.Even, float fill = 1, bool reverse = false, float radiusChange = 0, PathPosition pathPosition = PathPosition.Above)

Configures planar arc placement in local units and degrees without changing orientation.

Parameters

Name	Type
radius	System.Single
arcAngle	System.Single
startAngle	System.Single
spacing	TextStudio.PathSpacing
fill	System.Single
reverse	System.Boolean
radiusChange	System.Single
pathPosition	TextStudio.PathPosition

ConfigureWavePlacement(float, float, float, float)

public void ConfigureWavePlacement(float amplitude, float frequency, float speed, float phase = 0)

Configures animated planar wave placement in local units and cycles per second.

Parameters

Name	Type
amplitude	System.Single
frequency	System.Single
speed	System.Single
phase	System.Single

ConfigureSpatialWavePlacement(float, float, float, float, float, float, float)

public void ConfigureSpatialWavePlacement(float amplitude, float depthAmplitude, float frequency, float speed, float spinSpeed = 0, float spinStagger = 0, float phase = 0)

Configures vertical/depth wave placement and glyph roll using the host playback clock. Spin values are revolutions per second and revolutions across the text.

Parameters

Name	Type
amplitude	System.Single
depthAmplitude	System.Single
frequency	System.Single
speed	System.Single
spinSpeed	System.Single
spinStagger	System.Single
phase	System.Single

ConfigureCirclePlacement(float, float, PathSpacing, bool, float, PathPosition)

public void ConfigureCirclePlacement(float radius, float startAngle = 0, PathSpacing spacing = PathSpacing.Even, bool reverse = false, float radiusChange = 0, PathPosition pathPosition = PathPosition.Above)

Configures circular placement in local units and degrees without changing orientation.

Parameters

Name	Type
radius	System.Single
startAngle	System.Single
spacing	TextStudio.PathSpacing
reverse	System.Boolean
radiusChange	System.Single
pathPosition	TextStudio.PathPosition

ConfigureGridPlacement(int, GridCellSizing, Vector2, Vector2, GridFlow, bool, bool)

public void ConfigureGridPlacement(int columns, GridCellSizing sizing = GridCellSizing.Auto, Vector2 cellSize = null, Vector2 gap = null, GridFlow flow = GridFlow.RowsFirst, bool reverse = false, bool respectSourceLines = false)

Configures row- or column-major grid placement with explicit or automatic cell sizing.

Parameters

Name	Type
columns	System.Int32
sizing	TextStudio.GridCellSizing
cellSize	UnityEngine.Vector2
gap	UnityEngine.Vector2
flow	TextStudio.GridFlow
reverse	System.Boolean
respectSourceLines	System.Boolean

SetArcStartAngle(float)

public void SetArcStartAngle(float startAngle)

Changes the arc’s start angle in degrees and refreshes placement.

Parameters

Name	Type
startAngle	System.Single

SetCircleStartAngle(float)

public void SetCircleStartAngle(float startAngle)

Changes the circle’s start angle in degrees and refreshes placement.

Parameters

Name	Type
startAngle	System.Single

SetPlacementOrientation(TextStudioPlacementOrientation, Vector3)

public void SetPlacementOrientation(TextStudioPlacementOrientation orientation, Vector3 fineRotation = null)

Sets glyph orientation along the selected placement plus an optional local Euler rotation in degrees.

Parameters

Name	Type
orientation	TextStudio.TextStudioPlacementOrientation
fineRotation	UnityEngine.Vector3

Constructors

TextStudioBinding()

public TextStudioBinding()

Properties

LastReactionCaptureDiagnostic

public string LastReactionCaptureDiagnostic { get; }

Returns

System.String

ReactionTargets

public List<TextStudioReactionPanelTargetBinding> ReactionTargets { get; set; }

Returns

System.Collections.Generic.List{TextStudio.TextStudioReactionPanelTargetBinding}

ReactionSource

public TextStudioReactionSource ReactionSource { get; set; }

Returns

TextStudio.TextStudioReactionSource

BuiltInReactionPresetId

public string BuiltInReactionPresetId { get; set; }

Returns

System.String

InlineReactionCapacity

public int InlineReactionCapacity { get; set; }

Returns

System.Int32

InlineReactionSeed

public int InlineReactionSeed { get; set; }

Returns

System.Int32

ReactionAsset

public TextStudioReactionAsset ReactionAsset { get; set; }

Returns

TextStudio.TextStudioReactionAsset

InlineReactionLayers

public List<TextStudioReactionLayer> InlineReactionLayers { get; set; }

Returns

System.Collections.Generic.List{TextStudio.TextStudioReactionLayer}

Reactions

public TextStudioReactionRecipe Reactions { get; set; }

Returns

TextStudio.TextStudioReactionRecipe

HasActiveReactions

public bool HasActiveReactions { get; }

Returns

System.Boolean

SuppressedReactionCount

public int SuppressedReactionCount { get; }

Returns

System.Int32

CancelledReactionCount

public int CancelledReactionCount { get; }

Returns

System.Int32

LastReactionCancellationReason

public TextStudioReactionCancelReason LastReactionCancellationReason { get; }

Returns

TextStudio.TextStudioReactionCancelReason

IsAnimationPaused

public bool IsAnimationPaused { get; }

Whether Text Studio-owned presentation time is paused. Native bindings and layout continue to update.

Returns

System.Boolean

bindingMode

public BindingMode bindingMode { get; set; }

The only supported target binding mode.

Returns

UnityEngine.UIElements.BindingMode

updateTrigger

public BindingUpdateTrigger updateTrigger { get; set; }

The only supported source update trigger.

Returns

UnityEngine.UIElements.BindingUpdateTrigger

dataSource

public object dataSource { get; set; }

Optional local source used by Data source mode.

Returns

System.Object

dataSourceType

public Type dataSourceType { get; set; }

Optional design-time type hint for an inherited Data source.

Returns

System.Type

dataSourcePath

public PropertyPath dataSourcePath { get; set; }

Path from the effective Data source to the markup value.

Returns

Unity.Properties.PropertyPath

sourceToUiConverters

public ConverterGroup sourceToUiConverters { get; }

Converters applied before global source-to-string converters.

Returns

UnityEngine.UIElements.ConverterGroup

SourceMode

[TextStudioSourceModeAuthoring]
public TextStudioBindingSourceMode SourceMode { get; set; }

Selects Label text, a named element, or native inherited data as the markup source.

Returns

TextStudio.TextStudioBindingSourceMode

SourceElementName

public string SourceElementName { get; set; }

The unique same-panel element name used by Element source mode.

Returns

System.String

SourcePropertyPath

public string SourcePropertyPath { get; set; }

The property path read from the named source element. Defaults to value.

Returns

System.String

AuthoredMarkup

public string AuthoredMarkup { get; }

The latest canonical markup captured from Label text in direct mode.

Returns

System.String

Diagnostic

public TextStudioBindingDiagnostic Diagnostic { get; }

The latest actionable binding diagnostic.

Returns

TextStudio.TextStudioBindingDiagnostic

Element

public TextElement Element { get; }

Returns

UnityEngine.UIElements.TextElement

FeatureSet

public TextStudioUITKFeatureSet FeatureSet { get; }

Returns

TextStudio.TextStudioUITKFeatureSet

Plan

public TextStudioPlanView Plan { get; }

Gets a transient, allocation-free view of the compiled semantic plan. Do not retain the view after the current callback or frame.

Returns

TextStudio.TextStudioPlanView

Preview

public TextStudioPreview Preview { get; }

Returns

TextStudio.TextStudioPreview

Content

public ITextStudioContent Content { get; }

Focused content view for integrations that do not control playback.

Returns

TextStudio.ITextStudioContent

Playback

public ITextStudioPlayback Playback { get; }

Focused reveal and hide playback view.

Returns

TextStudio.ITextStudioPlayback

Visibility

public ITextStudioVisibility Visibility { get; }

Focused runtime visibility view.

Returns

TextStudio.ITextStudioVisibility

Effects

public ITextStudioEffectControl Effects { get; }

Focused renderer-neutral effect control view.

Returns

TextStudio.ITextStudioEffectControl

EvaluatedGlyphStates

public TextStudioReadOnlyBuffer<EvaluatedGlyphState> EvaluatedGlyphStates { get; }

Zero-allocation transient view over the currently evaluated glyph states. Do not retain the view after the next binding update.

Returns

TextStudio.TextStudioReadOnlyBuffer{TextStudio.EvaluatedGlyphState}

StateCount

public int StateCount { get; }

Returns

System.Int32

Markup

public string Markup { get; }

Gets the authored markup, including Text Studio tags.

Returns

System.String

Text

public string Text { get; }

Gets the visible plain-text content after markup processing.

Returns

System.String

DisplayText

public string DisplayText { get; }

Returns

System.String

ResolvedText

public string ResolvedText { get; }

Returns

System.String

RevealProgress

public float RevealProgress { get; }

Gets normalized reveal progress from 0 (hidden) to 1 (fully revealed).

Returns

System.Single

WordBoundaryProvider

public ITextStudioWordBoundaryProvider WordBoundaryProvider { get; set; }

Optional language-specific word segmentation. Null uses Unicode default word boundaries.

Returns

TextStudio.ITextStudioWordBoundaryProvider

RevealedCount

public int RevealedCount { get; }

Returns

System.Int32

RevealedGlyphCount

public int RevealedGlyphCount { get; }

Gets the number of semantic glyphs currently revealed.

Returns

System.Int32

TotalGlyphCount

public int TotalGlyphCount { get; }

Gets the number of visible semantic glyphs in the compiled content.

Returns

System.Int32

WordCount

public int WordCount { get; }

Returns

System.Int32

HasVisibilityOverrides

public bool HasVisibilityOverrides { get; }

Gets whether any runtime visibility override currently differs from authored visibility.

Returns

System.Boolean

IsRevealing

public bool IsRevealing { get; }

Gets whether reveal playback is currently advancing.

Returns

System.Boolean

IsRevealPaused

public bool IsRevealPaused { get; }

Gets whether reveal playback is paused without being stopped.

Returns

System.Boolean

IsWaitingForAction

public bool IsWaitingForAction { get; }

Whether reveal is paused while an action is still executing.

Returns

System.Boolean

IsDisappearing

public bool IsDisappearing { get; }

Gets whether hide playback is currently advancing.

Returns

System.Boolean

IsFullParity

public bool IsFullParity { get; }

Returns

System.Boolean

PlacementMode

public PlacementMode PlacementMode { get; set; }

Returns

TextStudio.PlacementMode

CurveProfile

public TextStudioCurveProfile CurveProfile { get; set; }

Returns

TextStudio.TextStudioCurveProfile

CurveHeight

public float CurveHeight { get; set; }

Returns

System.Single

CurveMapping

public TextStudioCurveMapping CurveMapping { get; set; }

Returns

TextStudio.TextStudioCurveMapping

CurveRange

public string CurveRange { get; set; }

Returns

System.String

CurveRangeDiagnostic

public string CurveRangeDiagnostic { get; }

Returns

System.String

ArcRadius

public float ArcRadius { get; set; }

Returns

System.Single

ArcAutoFitRadius

public bool ArcAutoFitRadius { get; set; }

Returns

System.Boolean

ArcAutoFitPadding

public float ArcAutoFitPadding { get; set; }

Returns

System.Single

ArcAngle

public float ArcAngle { get; set; }

Returns

System.Single

ArcStartAngle

public float ArcStartAngle { get; set; }

Returns

System.Single

ArcPathPosition

public PathPosition ArcPathPosition { get; set; }

Returns

TextStudio.PathPosition

ArcSpacing

public PathSpacing ArcSpacing { get; set; }

Returns

TextStudio.PathSpacing

ArcFill

public float ArcFill { get; set; }

Returns

System.Single

ArcReverse

public bool ArcReverse { get; set; }

Returns

System.Boolean

ArcRadiusChange

public float ArcRadiusChange { get; set; }

Returns

System.Single

WaveAmplitude

public float WaveAmplitude { get; set; }

Returns

System.Single

WaveDepthAmplitude

public float WaveDepthAmplitude { get; set; }

Returns

System.Single

WaveSpinSpeed

public float WaveSpinSpeed { get; set; }

Returns

System.Single

WaveSpinStagger

public float WaveSpinStagger { get; set; }

Returns

System.Single

WaveFrequency

public float WaveFrequency { get; set; }

Returns

System.Single

WaveSpeed

public float WaveSpeed { get; set; }

Returns

System.Single

WavePhase

public float WavePhase { get; set; }

Returns

System.Single

CircleRadius

public float CircleRadius { get; set; }

Returns

System.Single

CircleAutoFitRadius

public bool CircleAutoFitRadius { get; set; }

Returns

System.Boolean

CircleAutoFitPadding

public float CircleAutoFitPadding { get; set; }

Returns

System.Single

CircleStartAngle

public float CircleStartAngle { get; set; }

Returns

System.Single

CirclePathPosition

public PathPosition CirclePathPosition { get; set; }

Returns

TextStudio.PathPosition

CircleSpacing

public PathSpacing CircleSpacing { get; set; }

Returns

TextStudio.PathSpacing

CircleReverse

public bool CircleReverse { get; set; }

Returns

System.Boolean

CircleRadiusChange

public float CircleRadiusChange { get; set; }

Returns

System.Single

GridColumns

public int GridColumns { get; set; }

Returns

System.Int32

GridCellSizing

public GridCellSizing GridCellSizing { get; set; }

Returns

TextStudio.GridCellSizing

GridCellSize

public Vector2 GridCellSize { get; set; }

Returns

UnityEngine.Vector2

GridGap

public Vector2 GridGap { get; set; }

Returns

UnityEngine.Vector2

GridFlow

public GridFlow GridFlow { get; set; }

Returns

TextStudio.GridFlow

GridReverse

public bool GridReverse { get; set; }

Returns

System.Boolean

GridRespectSourceLines

public bool GridRespectSourceLines { get; set; }

Returns

System.Boolean

PlacementOrientation

public TextStudioPlacementOrientation PlacementOrientation { get; set; }

Returns

TextStudio.TextStudioPlacementOrientation

PlacementFineRotation

public Vector3 PlacementFineRotation { get; set; }

Returns

UnityEngine.Vector3

BehaviorProfile

public TextStudioBehaviorProfile BehaviorProfile { get; set; }

Gets or applies the renderer-neutral behavior profile for this binding. Assigning null restores the binding’s retained local behavior.

Returns

TextStudio.TextStudioBehaviorProfile

UsesBehaviorProfileTypewriter

public bool UsesBehaviorProfileTypewriter { get; }

Returns

System.Boolean

TypewriterSource

public TextStudioTypewriterSource TypewriterSource { get; set; }

Returns

TextStudio.TextStudioTypewriterSource

TypewriterPresetId

public string TypewriterPresetId { get; set; }

Returns

System.String

TypewriterPreset

public TextStudioTypewriterPreset TypewriterPreset { get; set; }

Returns

TextStudio.TextStudioTypewriterPreset

DefaultEffectsMode

public TextStudioDefaultEffectMode DefaultEffectsMode { get; set; }

Returns

TextStudio.TextStudioDefaultEffectMode

DefaultEffects

public string DefaultEffects { get; set; }

Returns

System.String

DefaultRevealEffects

public string DefaultRevealEffects { get; set; }

Returns

System.String

DefaultActiveEffects

public string DefaultActiveEffects { get; set; }

Returns

System.String

DefaultHideEffects

public string DefaultHideEffects { get; set; }

Returns

System.String

TextChangeMode

public TextStudioTextChangeMode TextChangeMode { get; set; }

Returns

TextStudio.TextStudioTextChangeMode

TextChangeScope

public TextStudioTextChangeScope TextChangeScope { get; set; }

Returns

TextStudio.TextStudioTextChangeScope

MarkupSyntaxOverride

public TextStudioMarkupSyntax MarkupSyntaxOverride { get; set; }

Optional syntax settings for this binding. Null inherits the active project syntax.

Returns

TextStudio.TextStudioMarkupSyntax

ResolvedAuthoringProfile

public TextStudioAuthoringProfile ResolvedAuthoringProfile { get; }

Gets the effective authoring profile after binding and project settings are resolved.

Returns

TextStudio.TextStudioAuthoringProfile

UpdateMode

public TextStudioUITKUpdateMode UpdateMode { get; set; }

Gets or sets whether the binding advances from its panel scheduler or from host calls.

Returns

TextStudio.TextStudioUITKUpdateMode

PlayOnAttach

public bool PlayOnAttach { get; set; }

Gets or sets whether a locally configured binding starts its reveal when attached. A behavior profile’s typewriter start mode takes precedence when it owns Typewriter.

Returns

System.Boolean

TextGeneratorPreference

public TextStudioUITKTextGeneratorPreference TextGeneratorPreference { get; set; }

Returns

TextStudio.TextStudioUITKTextGeneratorPreference

Timings

public TypingTimingsBase Timings { get; set; }

Returns

TextStudio.TypingTimingsBase

BuiltInTimingsPreset

public RevealTimingsPreset BuiltInTimingsPreset { get; set; }

Returns

TextStudio.RevealTimingsPreset

WaitAfterFinalReveal

public bool WaitAfterFinalReveal { get; set; }

Returns

System.Boolean

RevealMode

public RevealMode RevealMode { get; set; }

Returns

TextStudio.RevealMode

SpeedMultiplier

public float SpeedMultiplier { get; set; }

Returns

System.Single

LoopReveal

public bool LoopReveal { get; set; }

Returns

System.Boolean

LoopRevealDelay

public float LoopRevealDelay { get; set; }

Returns

System.Single

RevealAppearanceDuration

public float RevealAppearanceDuration { get; set; }

Returns

System.Single

RevealDisappearanceDuration

public float RevealDisappearanceDuration { get; set; }

Returns

System.Single

TypewriterStartMode

public TextStudioTypewriterStartMode TypewriterStartMode { get; set; }

Returns

TextStudio.TextStudioTypewriterStartMode

ResetSpeedOnNewText

public bool ResetSpeedOnNewText { get; set; }

Returns

System.Boolean

SkipRevealMode

public TextStudioTypewriterSkipRevealMode SkipRevealMode { get; set; }

Returns

TextStudio.TextStudioTypewriterSkipRevealMode

TriggerRemainingMarkersOnSkip

public bool TriggerRemainingMarkersOnSkip { get; set; }

Returns

System.Boolean

SkipCurrentWaitOnSkip

public bool SkipCurrentWaitOnSkip { get; set; }

Returns

System.Boolean

SkipHideMode

public TextStudioTypewriterSkipHideMode SkipHideMode { get; set; }

Returns

TextStudio.TextStudioTypewriterSkipHideMode

TypewriterTiming

public TextStudioTypewriterTimingMode TypewriterTiming { get; set; }

Returns

TextStudio.TextStudioTypewriterTimingMode

RevealSequenceDirection

public TextStudioSequenceDirection RevealSequenceDirection { get; set; }

Returns

TextStudio.TextStudioSequenceDirection

HideSequenceDirection

public TextStudioSequenceDirection HideSequenceDirection { get; set; }

Returns

TextStudio.TextStudioSequenceDirection

RevealSequenceOrder

public TextStudioSequenceOrder RevealSequenceOrder { get; set; }

Returns

TextStudio.TextStudioSequenceOrder

RevealSequenceSpread

public float RevealSequenceSpread { get; set; }

Returns

System.Single

RevealSequenceSeed

public int RevealSequenceSeed { get; set; }

Returns

System.Int32

HideSequenceOrder

public TextStudioSequenceOrder HideSequenceOrder { get; set; }

Returns

TextStudio.TextStudioSequenceOrder

HideSequenceSpread

public float HideSequenceSpread { get; set; }

Returns

System.Single

HideSequenceSeed

public int HideSequenceSeed { get; set; }

Returns

System.Int32

TypewriterRevealEffect

public TextStudioEffectDefinitionAsset TypewriterRevealEffect { get; set; }

Returns

TextStudio.TextStudioEffectDefinitionAsset

TypewriterHideEffect

public TextStudioEffectDefinitionAsset TypewriterHideEffect { get; set; }

Returns

TextStudio.TextStudioEffectDefinitionAsset

TypewriterRevealEffectTags

public string TypewriterRevealEffectTags { get; set; }

Returns

System.String

TypewriterHideEffectTags

public string TypewriterHideEffectTags { get; set; }

Returns

System.String

MotionPolicy

public TextStudioMotionPolicy MotionPolicy { get; set; }

Returns

TextStudio.TextStudioMotionPolicy

RevealEffectsEnabled

public bool RevealEffectsEnabled { get; set; }

Returns

System.Boolean

ActiveEffectsEnabled

public bool ActiveEffectsEnabled { get; set; }

Returns

System.Boolean

HideEffectsEnabled

public bool HideEffectsEnabled { get; set; }

Returns

System.Boolean

EnableInEditMode

public bool EnableInEditMode { get; set; }

Returns

System.Boolean

TextChangeLayoutDuration

public float TextChangeLayoutDuration { get; set; }

Returns

System.Single

NumericDecimalSeparator

public string NumericDecimalSeparator { get; set; }

Decimal separator used by Numeric Value matching. Set this to the formatter’s NumberDecimalSeparator.

Returns

System.String

Events

OnReactionSignal

public event Action<TextStudioReactionContext> OnReactionSignal

Raised when a reaction emits a named signal, with the triggering text context.

Returns

System.Action{TextStudio.TextStudioReactionContext}

OnReactionAudioCue

public event Action<TextStudioReactionContext> OnReactionAudioCue

Raised after the retained text state commits when a reaction requests an Audio Set cue.

Returns

System.Action{TextStudio.TextStudioReactionContext}

DiagnosticChanged

public event Action<TextStudioBindingDiagnostic> DiagnosticChanged

Raised only when the diagnostic code or message changes.

Returns

System.Action{TextStudio.TextStudioBindingDiagnostic}

OnTextSet

public event Action<string> OnTextSet

Occurs after markup is replaced and accepted by the runtime.

Returns

System.Action{System.String}

OnTypewriterStarted

public event Action OnTypewriterStarted

Occurs when reveal playback starts or restarts.

Returns

System.Action

OnGlyphRevealed

public event Action<int, char> OnGlyphRevealed

Occurs when a visible glyph crosses its reveal boundary.

Returns

System.Action{System.Int32,System.Char}

OnGlyphDisappeared

public event Action<int> OnGlyphDisappeared

Occurs when a visible glyph crosses its disappearance boundary.

Returns

System.Action{System.Int32}

OnTextUnitRevealed

public event Action<int, string> OnTextUnitRevealed

Occurs when a semantic text unit becomes visible.

Returns

System.Action{System.Int32,System.String}

OnMarkerReached

public event Action<string, string[]> OnMarkerReached

Occurs when reveal reaches an authored marker.

Returns

System.Action{System.String,System.String[]}

OnExtensionTagsChanged

public event Action<TextStudioPlanView> OnExtensionTagsChanged

Occurs after compilation changes the set of extension tags.

Returns

System.Action{TextStudio.TextStudioPlanView}

OnExtensionTagReached

public event Action<TextStudioExtensionTag> OnExtensionTagReached

Occurs when reveal reaches an extension tag configured for reveal dispatch.

Returns

System.Action{TextStudio.TextStudioExtensionTag}

OnTypewriterWaitStarted

public event Action<TextStudioTypewriterWaitInfo> OnTypewriterWaitStarted

Occurs immediately before a typewriter wait suspends playback.

Returns

System.Action{TextStudio.TextStudioTypewriterWaitInfo}

OnTypewriterWaitFinished

public event Action<TextStudioTypewriterWaitInfo> OnTypewriterWaitFinished

Occurs when a typewriter wait completes or is skipped.

Returns

System.Action{TextStudio.TextStudioTypewriterWaitInfo}

OnShowComplete

public event Action OnShowComplete

Occurs after the final reveal delay has completed and the text is fully shown.

Returns

System.Action

OnDisappearComplete

public event Action OnDisappearComplete

Occurs after hide playback has made the complete text invisible.

Returns

System.Action