TextStudioRevealDebugSnapshot
public readonly struct TextStudioRevealDebugSnapshotImmutable reveal/timing snapshot for inspectors, diagnostics, and integration health checks. Reading this type does not mutate the text pipeline.
Fields
Section titled “Fields”
HasPlan
Section titled “HasPlan”public readonly bool HasPlanReturns
System.Boolean
Markup
Section titled “Markup”public readonly string MarkupReturns
System.String
ResolvedText
Section titled “ResolvedText”public readonly string ResolvedTextReturns
System.String
RevealMode
Section titled “RevealMode”public readonly RevealMode RevealModeReturns
TextStudio.RevealMode
PlacementMode
Section titled “PlacementMode”public readonly PlacementMode PlacementModeReturns
TextStudio.PlacementMode
RevealedGlyphCount
Section titled “RevealedGlyphCount”public readonly int RevealedGlyphCountReturns
System.Int32
TotalGlyphCount
Section titled “TotalGlyphCount”public readonly int TotalGlyphCountReturns
System.Int32
RevealProgress
Section titled “RevealProgress”public readonly float RevealProgressReturns
System.Single
SpeedMultiplier
Section titled “SpeedMultiplier”public readonly float SpeedMultiplierReturns
System.Single
ApproximateDuration
Section titled “ApproximateDuration”public readonly float ApproximateDurationReturns
System.Single
IsRevealing
Section titled “IsRevealing”public readonly bool IsRevealingReturns
System.Boolean
IsComplete
Section titled “IsComplete”public readonly bool IsCompleteReturns
System.Boolean
IsPaused
Section titled “IsPaused”public readonly bool IsPausedReturns
System.Boolean
IsLoopWaiting
Section titled “IsLoopWaiting”public readonly bool IsLoopWaitingReturns
System.Boolean
ActiveActionCount
Section titled “ActiveActionCount”public readonly int ActiveActionCountReturns
System.Int32
ActionMarkerCount
Section titled “ActionMarkerCount”public readonly int ActionMarkerCountReturns
System.Int32
EffectBindingCount
Section titled “EffectBindingCount”public readonly int EffectBindingCountReturns
System.Int32
RendererCount
Section titled “RendererCount”public readonly int RendererCountReturns
System.Int32
HasExternalTextSource
Section titled “HasExternalTextSource”public readonly bool HasExternalTextSourceReturns
System.Boolean
ExternalTextSourceCount
Section titled “ExternalTextSourceCount”public readonly int ExternalTextSourceCountReturns
System.Int32
WordCount
Section titled “WordCount”public readonly int WordCountReturns
System.Int32
HasVisibilityOverrides
Section titled “HasVisibilityOverrides”public readonly bool HasVisibilityOverridesReturns
System.Boolean
RevealEffectsEnabled
Section titled “RevealEffectsEnabled”public readonly bool RevealEffectsEnabledReturns
System.Boolean
ActiveEffectsEnabled
Section titled “ActiveEffectsEnabled”public readonly bool ActiveEffectsEnabledReturns
System.Boolean
HideEffectsEnabled
Section titled “HideEffectsEnabled”public readonly bool HideEffectsEnabledReturns
System.Boolean
Constructors
Section titled “Constructors”
TextStudioRevealDebugSnapshot(bool, string, string, RevealMode, PlacementMode, int, int, float, float, float, bool, bool, bool, bool, int, int, int, int, bool, int, int, bool, bool, bool, bool)
Section titled “TextStudioRevealDebugSnapshot(bool, string, string, RevealMode, PlacementMode, int, int, float, float, float, bool, bool, bool, bool, int, int, int, int, bool, int, int, bool, bool, bool, bool)”public TextStudioRevealDebugSnapshot(bool hasPlan, string markup, string resolvedText, RevealMode revealMode, PlacementMode placementMode, int revealedGlyphCount, int totalGlyphCount, float revealProgress, float speedMultiplier, float approximateDuration, bool isRevealing, bool isComplete, bool isPaused, bool isLoopWaiting, int activeActionCount, int actionMarkerCount, int effectBindingCount, int rendererCount, bool hasExternalTextSource, int externalTextSourceCount, int wordCount = 0, bool hasVisibilityOverrides = false, bool revealEffectsEnabled = true, bool activeEffectsEnabled = true, bool hideEffectsEnabled = true)Creates a diagnostic snapshot from the current compiled plan, playback, renderer, and integration state. String arguments are normalized to empty strings so consumers do not need null checks.
Parameters
| Name | Type |
|---|---|
hasPlan |
System.Boolean |
markup |
System.String |
resolvedText |
System.String |
revealMode |
TextStudio.RevealMode |
placementMode |
TextStudio.PlacementMode |
revealedGlyphCount |
System.Int32 |
totalGlyphCount |
System.Int32 |
revealProgress |
System.Single |
speedMultiplier |
System.Single |
approximateDuration |
System.Single |
isRevealing |
System.Boolean |
isComplete |
System.Boolean |
isPaused |
System.Boolean |
isLoopWaiting |
System.Boolean |
activeActionCount |
System.Int32 |
actionMarkerCount |
System.Int32 |
effectBindingCount |
System.Int32 |
rendererCount |
System.Int32 |
hasExternalTextSource |
System.Boolean |
externalTextSourceCount |
System.Int32 |
wordCount |
System.Int32 |
hasVisibilityOverrides |
System.Boolean |
revealEffectsEnabled |
System.Boolean |
activeEffectsEnabled |
System.Boolean |
hideEffectsEnabled |
System.Boolean |