Text Studio API Reference

This reference is generated from the shipped Text Studio assemblies and their XML documentation.

TextStudio

ActionContext: Context passed to action execution.
ActionMarker: Parsed action data from text markup. Immutable once created.
AnimationPhase: API type
ArcPlacement: Arc placement: distributes glyphs along a circular arc. Only controls position + path frame. Glyph rotation is handled globally by the hub’s…
CharacterSubstitutionBinding: Binding of a presentation-layer character substitution to a glyph range.
CharacterTimings: Punctuation-aware character timings for natural typewriter pacing.
CirclePlacement: Circle placement: distributes glyphs evenly around a full circle. Rotation is handled by the hub-level TextStudio.PlacementOrientation module.
CurveType: API type
DecorationBits: Which decoration tiles this glyph participates in. Combinable as flags so a single character can sit under an underline and a strikethrough at the…
DirtyFlags: API type
EffectBinding: Binding of an effect to a glyph range within the text.
EffectBlendMode: API type
EffectCurveAsset: Reusable normalized curve asset sampled by effect playback and composed layers.
EffectEvaluationContext: Context passed to effect evaluation. Contains all timing and effect area information needed for effect computation without accessing global state.
EffectInfoAttribute: Attaches display metadata to a code-defined effect so discovery tooling can render category grouping, tooltips, and markup examples.
EffectPlaybackAsset: Reusable playback asset that maps elapsed time to normalized effect intensity with delay, looping, hold, and completion policy.
EffectPlaybackCompletion: API type
EvaluatedGlyphState: Per-glyph evaluated animation state. Output of the animation evaluation pipeline. 8 channels with per-channel blend mode support.
GlyphInstanceFlags: API type
GlyphLayoutInfo: Per-glyph layout data produced by the layout engine. Backend-neutral: TMP and UITK adapters translate their layout to this model.
GlyphPlacement: Per-glyph placement result. 3D-capable with tangent and up vectors for path-following placement modes.
GlyphRun: A run of visible glyphs with shared style properties.
GridCellSizing: Controls whether grid cells follow rendered glyph bounds or authored dimensions.
GridFlow: Controls which grid axis fills first.
GridPlacement: Grid placement: arranges glyphs in a grid pattern.
IEffectCurve: Curve evaluation interface. Provides normalized (0–1 or -1 to 1) curve sampling. Curves are separate ScriptableObjects composable with any effect.
IEffectPlayback: Playback mode interface for effect timing/intensity.
IGlyphMetricsProvider: Backend-neutral source of per-character advance widths and kerning adjustments. Implemented by renderers that have font metrics available (e.g. the…
IPlacementContextStrategy: Extended placement contract for strategies that need rendered line ranges and sizing metadata in addition to the flat glyph positions.
IPlacementStrategy: Interface for placement strategies. Placement modes transform linear layout positions into final 3D positions.
IPresentationGlyphProvider: Addon extension point for presentation glyph substitution. Terminal FX, Mechanical Displays, and custom addons implement this to substitute visual…
ISettingsProvider: Settings cascade interface: Global SO → Shared SO → Local inline. Never cached - always read through provider for runtime swappability. Adopted from…
ITextStudioAction: Action factory interface. Actions are invoked during text reveal (wait, speed change, events, etc.). Priority chain: Local component → Global…
ITextStudioActionDefinitionProvider: Exposes discoverable tag metadata for an action implementation.
ITextStudioAddonDirtyNotifier: Addon dirty notification interface. Addons signal the base controller when they need a presentation update.
ITextStudioBackendHost: Advanced text-backend host view. Everyday playback code should not depend on this contract.
ITextStudioCharacterSubstitution: Defines a registered markup-driven transformation of presentation glyphs.
ITextStudioCharacterSubstitutionRuntime: Per-host runtime instance that updates one character-substitution binding.
ITextStudioContent: Focused content contract shared by component and UI Toolkit hosts. Use this view when a caller owns text content but not playback policy.
ITextStudioController: Restricted playback controller exposed to custom actions while they execute.
ITextStudioCue: User-facing marker for timeline instructions such as wait, speed, event, and input markers. Cues keep the existing action execution contract.
ITextStudioEditModePreviewAction: Optional metadata marker for actions that are designed to behave predictably during edit-mode preview. Runtime-only actions still require the…
ITextStudioEffect: Runtime leaf evaluator. Expansion-only definitions such as Composed Effects deliberately do not implement this interface and are flattened into leaf…
ITextStudioEffectCapabilitiesProvider: Publishes renderer compatibility, performance, phase, and accessibility metadata for an effect.
ITextStudioEffectControl: Focused renderer-neutral effect control shared by component and UI Toolkit hosts. External effects contribute after authored Reveal, Active, and…
ITextStudioEffectDefinition: Base interface for all text effects. Effects modify glyph states through a channel-based evaluation model with explicit blend modes (not…
ITextStudioEffectFactory: Creates an isolated leaf evaluator for one effect invocation. Factories are definitions, never invocation state, and are called only while a plan or…
ITextStudioEffectMetadataProvider: Publishes effect identity, documentation, phase suggestions, and typed parameters.
ITextStudioExtensionTagProcessor: Receives compiled extension tags and reveal-time tag events for one host.
ITextStudioExternalEffectSource: Opt-in source for renderer-neutral effect contributions. Active sources are polled after the semantic plan is current and before layout, in host…
ITextStudioExternalTextSource: Marker interface for any component that programmatically drives the text on a TextStudio.TextStudioText hub (localization bridges, data bindings…
ITextStudioFrameComposer: Target-scoped stateful pose and response contributor.
ITextStudioGlyphGeometryProvider: Optional exact-outline or compound-convex geometry provider.
ITextStudioGlyphSignalProvider: Provides target-scoped physical signal values for individual glyphs.
ITextStudioHostMeshRendererOwner: Optional renderer contract for an external backend that intentionally reuses the host world-space TMP MeshFilter and MeshRenderer. The hub still…
ITextStudioInputProvider: Supplies frame-based advance input to reveal actions without binding Text Studio to an input system.
ITextStudioKeyedInputProvider: Extends advance input with named action keys used by keyed wait tags.
ITextStudioLayoutBackend: Optional backend capability for publishing semantic glyph layout to Text Studio.
ITextStudioMarkupPreprocessor: Transforms authored markup before Text Studio parses tags and builds its semantic plan.
ITextStudioMeshBackend: Optional backend capability that renders evaluated glyph state into its target.
ITextStudioPlacementExtension: Optional metadata contract for component-based placement extensions. The Text Studio hub owns selection and composition while add-ons provide…
ITextStudioPlayback: Focused reveal and hide playback contract shared by every Text Studio host.
ITextStudioPreviewStageProvider: Optional renderer extension for the shared Text Studio preview lifecycle. The base owns mode/view/quality selection and playback; renderers…
ITextStudioRenderDomainProvider: Optional renderer contract used by authoring catalogs and diagnostics to distinguish flat text from extrusion-specific output without depending on…
ITextStudioRenderer: Renderer add-on contract. Components that visualize TextStudio output (extruded 3D text, mechanical flip tiles, custom backends) implement this…
ITextStudioRendererChannelSupport: Optional renderer extension contract for precise effect-channel compatibility. Text Studio keeps effect evaluation renderer-agnostic; renderers use…
ITextStudioRevealState: Read-only reveal information exposed to character-substitution extensions.
ITextStudioShapedGlyphBackend: Optional topology contract for renderers that need the exact shaped glyph IDs and font outlines selected by a text backend. This keeps complex…
ITextStudioShapedGlyphPreparationBackend: Optional authoring capability for shaping representative text independently from the live backend target. Implementations must not replace target…
ITextStudioStatefulPreviewProvider: Stateful preview lifecycle for simulations and other history-dependent extensions.
ITextStudioTextBackend: Stable identity and lifecycle contract for an optional text backend. Source, layout, and mesh responsibilities are split into additive interfaces so…
ITextStudioTextChangeHandoffProvider: Optional renderer capability for retaining outgoing visuals across a text replacement. The base package owns replacement timing while renderer…
ITextStudioTextSource: Text source interface for canonical text input. Sources provide text with version tracking for dirty detection.
ITextStudioTextSourceBackend: Optional backend capability for synchronizing authored markup with an external text target.
ITextStudioVisibility: Focused runtime visibility contract. Visibility overrides never change authored markup.
ITextStudioWaitLifecycleSink: Receives lifecycle notifications for waits that suspend reveal or hide playback. Implementations must not retain the supplied marker beyond the…
ITypewriterProvider: Compatibility contract for components that drive reveal and hide sequences through a typewriter-style API.
LayoutSettings: Backend-neutral layout configuration.
LinearPlacement: Linear placement: glyphs stay at their layout positions (identity transform).
LineRange: Line segmentation range.
OverflowPolicy: Overflow handling policy.
ParagraphRange: Paragraph segmentation range.
PathPosition: Controls which vertical part of a glyph is positioned on a curve path.
PathSpacing: Controls how glyphs are distributed along path-following placements (Arc, Spline).
PhaseParams: Per-glyph stagger parameters for animation phasing. Controls how effects stagger across characters, words, and lines.
PlacementContext: Shared input for placement strategies. Keeps per-glyph positions contiguous while allowing path strategies to preserve rendered line boundaries.
PlacementMode: API type
PlacementOrientation: Placement-agnostic orientation override. Placement Default preserves the strategy-authored rotation while the other policies reinterpret its frame.
PlaybackMode: API type
PresentationFlags: API type
PresentationGlyph: A single glyph in the presentation layer. Separates canonical text (what was authored) from visual text (what is displayed). Addons like Terminal FX…
RegionToGlyphMap: Maps a named region to its glyph range.
RendererCapabilities: Capability flags that describe what a renderer can express for a given frame. Used to warn users about mismatches (e.g. color effects on a…
RevealMode: API type
RevealTimingsPreset: Built-in reveal timing presets, used when the hub has no custom TypingTimingsBase asset assigned. See BuiltInTimings for the actual delay curves.
StringTextSource: Mutable in-memory text source that tracks replacements and append operations for incremental compilation.
SubstitutionState: API type
TextAlignment: Alignment modes for text layout.
TextStudioActionAsset: ScriptableObject base for actions that can be registered in the database.
TextStudioActionComponent: Scene-local action base. Attach next to a TextStudioText hub to make the tag available only for that hub, without touching global project settings.
TextStudioActionDefinition: Immutable discovery metadata and parameter schema for a registered action tag.
TextStudioActionDefinitionUtility: Matches action implementations against their canonical identifiers and aliases.
TextStudioActions: Registers and resolves actions invoked by Text Studio markup.
TextStudioApi: Public convenience API for common TextStudio operations. Wraps the hub with simple methods so callers can drive reveal without poking at the full…
TextStudioAudioPlayer: Plays pooled per-glyph and marker-driven audio cues from Text Studio playback events.
TextStudioAudioPlayerClipSequenceMode: API type
TextStudioAudioPlayerMarkerCue: Serializable marker route and clip set used by a Text Studio audio player.
TextStudioAudioPlayerPlaybackMode: API type
TextStudioAudioPlayerRules: Pure routing and eligibility rules shared by runtime audio playback and validation.
TextStudioAudioPlayerSettingsSource: API type
TextStudioAudioSet: Reusable glyph clip pool and marker-cue routing asset for Text Studio audio players.
TextStudioAuthoringMode: API type
TextStudioAuthoringProfile: Selects the source markup dialect accepted before Text Studio compiles canonical tags.
TextStudioAutoScrollFollower: Keeps a ScrollRect positioned near the most recently revealed TextMeshPro glyph.
TextStudioBackendLayoutBuilder: Controlled writer that lets an optional backend publish layout without exposing Text Studio’s mutable layout storage.
TextStudioBackendLayoutData: Structured zero-allocation layout publication request. Array inputs remain caller-owned and are copied into Text Studio storage only when committed…
TextStudioBackendLayoutRequest: Transient layout request passed to a backend before it publishes glyph positions.
TextStudioBackendShapedFontFace: Transient description of a shaped font face, including metrics and a bounded view of backend-owned font bytes.
TextStudioBackendShapedGlyph: Immutable shaped-glyph topology and metrics published by a shaping-capable backend.
TextStudioBackendTextRequest: Transient compiled-text request passed to an external text backend.
TextStudioBackendWriteHandling: API type
TextStudioBehaviorDomain: API type
TextStudioBehaviorProfile: Reusable renderer-neutral behavior asset. Each enabled domain replaces the matching component-local fallback while all other host and renderer…
TextStudioBehaviorResolver: Resolves behavior domains from an optional profile and component-local fallbacks.
TextStudioBehaviorSettings: Complete renderer-neutral behavior snapshot used by behavior profiles and local hosts.
TextStudioBehaviorValueSource: API type
TextStudioBinding: Binds Text Studio markup, reveal playback, effects, placement, and visibility control to an existing UI Toolkit UnityEngine.UIElements.TextElement…
TextStudioBindingDiagnostic: Non-spamming runtime state surfaced by the binding authoring UI.
TextStudioBindingDiagnosticCode: Stable diagnostic categories reported by a Text Studio UI Toolkit binding.
TextStudioBindingSourceMode: Determines where a Text Studio UI Toolkit binding reads its authored markup.
TextStudioBuiltInActionIds: Stable identifiers for actions included with Text Studio.
TextStudioBuiltInEffectIds: Stable identifiers for effects included with Text Studio.
TextStudioChannelBlendModes: API type
TextStudioChannelDescriptor: Immutable registration contract for one namespaced renderer-extension channel.
TextStudioChannelPerformanceClass: API type
TextStudioChannelRegistry: Domain-local registry that validates channel layouts and applies extension values to evaluated glyph state.
TextStudioChannelStage: API type
TextStudioChannelValueType: API type
TextStudioCharacterSubstitutionContext: Transient update context provided to a character-substitution runtime.
TextStudioCharacterSubstitutionDefinition: Metadata, aliases, examples, and parameter schema for one substitution tag.
TextStudioCharacterSubstitutionResult: Reports the output and scheduling consequences of one substitution update.
TextStudioCharacterVisibleEvent: Serialized callback carrying a visible-glyph index and displayed text.
TextStudioCodeEffectAsset: Lean asset-backed definition for programmable leaf effects. Lifecycle, playback, curves, sequencing, and scope are authored by Composed Effect…
TextStudioCodeEffectAsset<TState, TParameters>: Typed Code Effect asset with one default parameter struct and isolated per-glyph state.
TextStudioColorBlendMode: API type
TextStudioColorUtility: Parses Text Studio color syntax and formats normalized hexadecimal color values.
TextStudioComposedEffectAsset: Reusable effect definition composed from ordered semantic effect and channel layers.
TextStudioCompositionAuthoringSpace: API type
TextStudioCompositionChannel: API type
TextStudioCompositionColorMode: API type
TextStudioCompositionLayer: One ordered effect or channel layer with phase, area, color, and influence-field configuration.
TextStudioCompositionLayerKind: API type
TextStudioCompositionTagSpec: Serializable tag selector used to scope a composed-effect layer to authored semantic tags.
TextStudioCornerOffsets: Independent 2D offsets for the four vertices of a glyph quad. Values use Text Studio effect units and are applied before the glyph transform.
TextStudioCustomChannelState: Bounded allocation-free payload carried with each evaluated glyph. Descriptor IDs resolve to stable component slots for the current domain…
TextStudioDefaultAttribute: Marks a field with a recommended default. The default property drawer renders a small reset button next to the field; clicking it writes the default…
TextStudioDefaultEffectMode: API type
TextStudioDefaultEffectSettings: Serializable all-phase or per-phase default effect expressions applied when markup omits explicit effects.
TextStudioDefaultEffectsSource: API type
TextStudioDefaultSettings: Global Text Studio defaults. Text Studio does not ship a default settings asset. Users can optionally create one at Text Studio’s canonical…
TextStudioDiagnostic: One markup diagnostic with severity, stable code, source range, message, and suggested action.
TextStudioDiagnosticCode: API type
TextStudioDiagnosticReport: Immutable analyzed markup plus general and tag-specific diagnostics.
TextStudioDiagnosticSeverity: API type
TextStudioDialogueSource: Generic bridge for narrative, dialogue, subtitle, and speech-bubble systems. Third-party tools can call this component without taking a package…
TextStudioDirtyGlyphView: Read-only view of the glyphs changed for the current frame.
TextStudioEffectAliasAttribute: Declares an additional case-insensitive lookup name for a code-defined effect.
TextStudioEffectAreaMode: API type
TextStudioEffectAreaSettings: Serializable semantic range selection used to limit an effect to glyphs, words, lines, or authored ranges.
TextStudioEffectCapabilities: Immutable phase, channel, performance, accessibility, determinism, and render-domain metadata for an effect.
TextStudioEffectCompatibility: Compatibility result for an effect definition against one or more requested render domains.
TextStudioEffectCompatibilityResolver: Resolves supported render domains and actionable compatibility status for effect definitions.
TextStudioEffectCompatibilityState: API type
TextStudioEffectCurvePreset: API type
TextStudioEffectDefinitionAsset: Serialized base for leaf and expansion-only effect definitions.
TextStudioEffectInvocation: One externally submitted renderer-neutral effect layer and its normalized progress, intensity, phase, and glyph range.
TextStudioEffectMetadata: Immutable discovery and parameter metadata for one effect definition.
TextStudioEffectPerformanceTier: API type
TextStudioEffectPlaybackPreset: API type
TextStudioEffectPlaybackRole: Defines whether authored playback controls an effect’s strength or its spatial progress.
TextStudioEffects: Registers and resolves effect definitions, curves, and playback strategies. Runtime registrations have priority over project and built-in entries.
TextStudioEffectUnitContext: Renderer-neutral per-unit source geometry, color, semantic indices, and world-space snapshots for effect evaluation.
TextStudioEmissionHandle: Generation-safe reference to one active temporary emission.
TextStudioEmissionMergeMode: API type
TextStudioEmissionOutputSpace: API type
TextStudioEmissionOverflowPolicy: API type
TextStudioEmissionPreset: Reusable presentation and lifecycle policy for temporary text. Gameplay meaning remains in the asset name and caller, not the runtime engine.
TextStudioEmissionRequest: One temporary text request. Use the emitter convenience methods for common calls.
TextStudioEmitter: Owns bounded, temporary Text Studio hosts. Presentation remains in profiles and prefabs.
TextStudioExtensionApi: Version information for renderer-neutral Text Studio extension contracts.
TextStudioExtensionProviderKind: API type
TextStudioExtensionProviderRegistration: Generation-safe token for a registered neutral extension provider.
TextStudioExtensionRegistrationFailure: API type
TextStudioExtensionRegistry: Target-scoped registry for pose composition, exclusive transform authority, exact geometry, physical signals, and stateful preview. Registration may…
TextStudioExtensions: Registers and resolves extension tags, character substitutions, and tag expansions.
TextStudioExtensionTag: Immutable occurrence of a registered extension tag mapped to source and visible-glyph ranges.
TextStudioExtensionTagBoundary: API type
TextStudioExtensionTagDefinition: Immutable schema and dispatch policy for a registered extension tag.
TextStudioExtensionTagDispatch: API type
TextStudioExtensionTagShape: API type
TextStudioExternalEffectDriver: Exposes one effect definition as externally driven progress and intensity. The component owns no clock or lifecycle, so Animator, Timeline, tweens…
TextStudioExternalEffectRangeMode: Range selection used by TextStudio.TextStudioExternalEffectDriver.
TextStudioExternalEffectSubmissionContext: Allocation-free submission view passed to an external effect source.
TextStudioFrame: Read-only frame view passed to every TextStudio.ITextStudioRenderer each pipeline tick. The view owns no buffers and does not allocate. Its data is…
TextStudioFrameComposerRegistration: Registration token for one frame composer and its authority lease.
TextStudioFrameCompositionContext: Canonical frame plus the independently composed target receiving it.
TextStudioFrameTarget: Reference-identity target for one independently composed Text Studio output.
TextStudioFrameTargetKind: API type
TextStudioGenerationHandle: Generation-safe identifier used by extension registrations and authority leases.
TextStudioGlyphAuthorityChannels: API type
TextStudioGlyphAuthorityLease: Generation-safe proof of exclusive target authority.
TextStudioGlyphAuthorityRequest: Exclusive channel and glyph range requested by a stateful extension.
TextStudioGlyphChangeSet: Semantic glyph correspondence for a text replacement. A changed glyph exits or enters; a retained glyph stays visually continuous across the…
TextStudioGlyphColorBounds: Renderer-neutral local coordinates used to sample a glyph’s source corner colors. TMP-backed bounds are relative to the character origin and…
TextStudioGlyphColorQuad: Renderer-neutral source colors for the four canonical corners of a glyph. The order matches TMP quads: bottom-left, top-left, top-right, bottom-right.
TextStudioGlyphGeometryBuffer: Reusable destination for provider-supplied convex glyph geometry.
TextStudioGlyphGeometryCapabilities: API type
TextStudioGlyphGeometryDetail: API type
TextStudioGlyphGeometryRequest: Allocation-free geometry request for a renderer-neutral glyph identity.
TextStudioGlyphIdentity: Stable semantic identity for one glyph within a compiled source generation.
TextStudioGlyphInstanceState: Complete renderer-neutral source, placement, animation, color, simulation, and channel state for one glyph.
TextStudioGlyphPose: Rest-relative or absolute pose contribution for one composed glyph.
TextStudioGlyphQuadTransform: Resolved transform for one glyph quad. Render backends use this to apply Text Studio placement, animation, pivot, color, and alpha consistently.
TextStudioGlyphQuadTransformer: Shared quad-space transform utility for TMP-style render backends.
TextStudioGlyphSignalState: Bounded per-glyph physical signal values for visual response mapping.
TextStudioGlyphStateWriter: Allocation-free writer scoped to one registered authority lease.
TextStudioGlyphVisualBounds: Renderer-neutral local glyph bounds plus source visibility metadata.
TextStudioGlyphVisualResponse: Bounded visual response contribution derived from simulation signals.
TextStudioGlyphVisualResponseChannels: API type
TextStudioInfluenceField: One spatial falloff shape that multiplies a composed layer’s semantic area influence.
TextStudioInfluenceFieldAxis: API type
TextStudioInfluenceFieldCombine: API type
TextStudioInfluenceFieldShape: API type
TextStudioInfluenceFieldSpace: API type
TextStudioInfluenceFieldStack: Ordered spatial influence fields combined into one allocation-free per-glyph weight.
TextStudioInstantRange: Inclusive visible-glyph range whose reveal timing is collapsed to one instant boundary.
TextStudioMarkerBinding: Serializable marker route, payload formatting policy, enabled state, and scene callback.
TextStudioMarkerEventRouter: Inspector-friendly marker router for gameplay hooks such as dialogue commands, audio cues, camera beats, and quest events.
TextStudioMarkerPayloadMode: API type
TextStudioMarkupDiagnostics: Analyzes authored markup for syntax, registration, compatibility, and parameter problems without rendering it.
TextStudioMarkupPreprocessContext: Immutable context describing the host and source of one markup preprocessing pass.
TextStudioMarkupSyntax: Configures project-wide or per-host authoring syntax without adding provider dependencies.
TextStudioMessageEvent: Serialized callback carrying a message channel and payload.
TextStudioMotionPolicy: API type
TextStudioMotionSettings: Global reduced-motion policy used to resolve effect and transition behavior.
TextStudioNamedTagParameter: One parsed named parameter, flag, or multiplicative modifier from a tag.
TextStudioNumberFormat: Shared numeric presentation used by persistent content and temporary emissions. Formatting occurs only when content changes.
TextStudioOwnershipMode: API type
TextStudioPageNavigator: Controls TextMeshPro page overflow manually or follows the page containing the latest revealed glyph.
TextStudioPageUtility: Shared TMP page-overflow helpers for renderers and decorations.
TextStudioParameterAliasAttribute: Adds an alternate inline markup parameter name for an effect field.
TextStudioPhaseMask: API type
TextStudioPlacementDimension: Describes whether a placement stays in the text plane or uses depth.
TextStudioPlacementOrientation: Shared orientation policies used by path and spatial placement extensions.
TextStudioPlanView: Read-only semantic plan consumed by renderers and integrations.
TextStudioPlaySoundAction: Reusable Text Studio action asset that plays one of its configured audio clips when a matching markup action is reached during text playback.
TextStudioPlaySoundActionComponent: Scene-bound sound action that can play through a supplied UnityEngine.AudioSource and optionally pause text reveal until the clip ends.
TextStudioPresentationGlyphWriter: Controlled writer for presentation-glyph substitutions.
TextStudioPreview: Preview controller attached to a TextStudio.TextStudioText hub. Exposes Play / Pause / Restart / Scrub / ShowEndState operations that work…
TextStudioPreviewCameraPose: Renderer-supplied camera framing for a preview stage.
TextStudioPreviewDiagnostic: Renderer-specific preview status with an optional suggested action.
TextStudioPreviewDiagnosticSeverity: API type
TextStudioPreviewQuality: API type
TextStudioPreviewSegment: API type
TextStudioPreviewStageCapabilities: API type
TextStudioPreviewStageMode: API type
TextStudioPreviewStageSettings: Immutable renderer-preview mode, viewpoint, quality, and comparison layout.
TextStudioPreviewView: API type
TextStudioProjectSettings: Optional user-created project-level settings. Ships zero assets by default; a user can create one via Assets → Create → Text Studio → Project…
TextStudioRangeAttribute: Compact ranged float attribute used by Text Studio effect authoring. Renders as a slider with optional snap increment and unit suffix.
TextStudioReadOnlyBuffer: Zero-allocation read-only view over a bounded portion of an engine-owned array. The view is valid only for the duration documented by the API that…
TextStudioReadOnlyBuffer.Enumerator: Value-type enumerator over the bounded engine-owned buffer.
TextStudioReducedMotionBehavior: API type
TextStudioRenderChannels: API type
TextStudioRenderDomain: API type
TextStudioResolvedBehaviorSettings: Resolves the two renderer-neutral behavior domains independently, so a profile can replace effects without taking ownership of a host’s typewriter…
TextStudioResolvedEffectBinding: Resolved effect definition plus its authored binding and optional solo-layer selection.
TextStudioRevealDebugSnapshot: Immutable reveal/timing snapshot for inspectors, diagnostics, and integration health checks. Reading this type does not mutate the text pipeline.
TextStudioRevealState: API type
TextStudioRuntimeServices: Process-wide service overrides used by Text Studio runtime components. Assign TextStudio.TextStudioRuntimeServices.InputProvider before playback to…
TextStudioSequenceOrder: API type
TextStudioSequenceSettings: Serializable ordering, grouping, direction, seed, and stagger spread for reveal or hide sequencing.
TextStudioShapedGlyphPreparationSnapshot: Caller-owned shaped glyph and font-face data for one representative preparation sample.
TextStudioSoundClipSelection: API type
TextStudioSourceColorMetric: API type
TextStudioSourceColorSelector: Optional source-color range selector that filters a composed layer by hue, saturation, luminance, or alpha.
TextStudioSourceModeAuthoringAttribute: Marks the source selector for Text Studio’s retained UI Builder authoring control.
TextStudioStatefulPreviewFidelity: API type
TextStudioStatefulPreviewSeekMode: API type
TextStudioSurfaceMask: API type
TextStudioTagAnalysisContext: Optional backend, catalog, and project-specific suggestion values used by markup diagnostics.
TextStudioTagBackend: API type
TextStudioTagCatalog: Searchable catalog of supported tags assembled from built-ins and installed extension contracts.
TextStudioTagCategories: Stable category identifiers used to group tags in discovery and authoring UI.
TextStudioTagCategory: API type
TextStudioTagDefinition: Immutable discovery and validation schema for one built-in, native, action, or extension tag.
TextStudioTagDiagnostic: Diagnostic annotation associated with one parsed tag occurrence.
TextStudioTagExpansionClosingMode: API type
TextStudioTagExpansionEntry: One stable shorthand tag expansion with opening and derived or custom closing markup.
TextStudioTagExpansionSheet: Reusable shorthand-tag sheet resolved before canonical markup parsing.
TextStudioTagKind: API type
TextStudioTagOwnership: API type
TextStudioTagParameterDefinition: Parameter name, aliases, type, requirement, defaults, examples, and suggestion metadata for a tag.
TextStudioTagParameterKind: API type
TextStudioTagParameterOperation: API type
TextStudioTagParameterRequirement: API type
TextStudioTagParameters: Allocation-free read view over positional and named parameters parsed from one tag. Lookup is case-insensitive and later named values take precedence.
TextStudioTagShape: API type
TextStudioTagSuggestionKeys: Stable lookup keys for injecting project-specific parameter suggestions.
TextStudioText: Central TextStudio hub. Owns the authored markup, runs the full pipeline (tokenize, resolve, layout, placement, reveal, effects) once per tick, and…
TextStudioTextBackendCapabilities: API type
TextStudioTextBackendChange: API type
TextStudioTextBackendIds: Stable identifiers used to select built-in text backends.
TextStudioTextChangeHandoffRequest: Immutable request passed to renderers before the base text plan is replaced. Renderers must copy any state that must survive beyond the callback.
TextStudioTextChangeMode: Controls how currently displayed content leaves when typewriter-driven text is replaced.
TextStudioTextChangeScope: Controls which semantic glyphs participate in an animated text replacement.
TextStudioTextShapingRisk: Detects Unicode patterns that may require a complex-shaping-capable text backend.
TextStudioTextUnit: Mapping between one semantic reveal unit and its resolved, display, source, and visible-glyph ranges.
TextStudioTimingContext: Allocation-free semantic context supplied to custom reveal timing assets.
TextStudioTimingDiagnostic: Snapshot of reveal timing, active wait state, and estimated completion for diagnostics UI.
TextStudioTimingDiagnostics: Converts runtime reveal snapshots into stable timing diagnostics.
TextStudioTimingEvaluator: Calculates the delay in seconds after one semantic text unit becomes visible.
TextStudioTimings: Registers and resolves reusable typing-timing assets.
TextStudioTypewriterEventRelay: Bridges Text Studio playback events to serialized UnityEvents for scene authoring.
TextStudioTypewriterMotionPreset: Reusable reveal and hide motion expressions with a default effect-composition policy.
TextStudioTypewriterPreset: Reusable authoring asset containing a complete typewriter settings recipe and gallery metadata.
TextStudioTypewriterRecipe: Chooses a built-in preset, custom preset asset, or inline settings as one resolvable typewriter recipe.
TextStudioTypewriterSettings: Complete serializable reveal, hide, timing, skip, looping, and motion configuration for a typewriter host.
TextStudioTypewriterSkipHideMode: API type
TextStudioTypewriterSkipRevealMode: API type
TextStudioTypewriterSource: API type
TextStudioTypewriterStartMode: API type
TextStudioTypewriterWaitEvent: Serialized callback carrying glyph index, character, wait kind, and duration in seconds.
TextStudioTypewriterWaitInfo: Immutable notification describing a timed, input, or custom wait in reveal or hide playback.
TextStudioTypewriterWaitKind: API type
TextStudioUITK: Attaches, retrieves, and detaches Text Studio through Unity’s native text binding slot.
TextStudioUITKCapabilities: Reports UI Toolkit animation and text-generator capabilities for the active Unity version.
TextStudioUITKFeatureSet: API type
TextStudioUITKTextGeneratorPreference: API type
TextStudioUITKUpdateMode: Selects whether a UI Toolkit binding owns its playback clock or is stepped by its host.
TextStudioVisibilityDiagnostics: Evaluates whether a Text Studio host has content, a valid target, layout, glyphs, and visible output.
TextStudioVisibilityIssue: API type
TextStudioVisibilityReport: Immutable visibility-readiness report with issue flags, diagnostic state, and user guidance.
TextToken: Flat token struct output by the tokenizer. References ranges into the source text via indices.
TokenKind: Token types produced by the single-pass tokenizer.
TypingTimingsBase: Base class for semantic reveal pacing. Returned values are waits applied after the current text unit has become visible.
UnityInputManagerTextStudioInputProvider: Advance-input provider backed by Unity’s built-in UnityEngine.Input.anyKeyDown state.
WavePlacement: Wave placement: applies a sine wave offset to layout Y positions. The local tangent of the sine curve is stored in tangent so the hub’s rotation…
WordRange: Word segmentation range.
WordTimings: Word-paced reveal timing settings.

TextStudio.BuiltIns

CodeEffectBase: Base class for stateless code-defined effects. All parameters are fields with sensible defaults. These never reference UnityEngine.Object subclasses…
ITextStudioBuiltIn: Implemented by code-defined built-ins so editor and runtime tooling can read common metadata.
TextStudioBuiltInTypewriterMotionPreset: Immutable catalog entry that pairs reveal and hide markup with presentation metadata for a built-in typewriter motion preset.

TextStudio.Editor

ITextStudioAuthoringCapabilityProvider: Implemented by optional editor packages that add authoring support for another text render domain. Providers must have a parameterless constructor.
ITextStudioGalleryProvider: Editor extension point that contributes discoverable creation or setup cards to the Text Gallery. Implementations must have a parameterless…
ITextStudioTMPSetupProvider: Editor extension point that adds Text Studio setup actions for selected TextMeshPro targets. Implementations must have a parameterless constructor.
TextGalleryCard: Immutable gallery contribution describing discovery text, preview content, and user actions.
TextGalleryCardActionState: Current primary and optional secondary actions displayed by a gallery card.
TextGalleryCategory: API type
TextGalleryPreviewContext: Describes the gallery surface requesting a card preview.
TextGalleryPreviewFactory: Creates an editor-owned preview element for a Text Gallery card.
TextGalleryPreviewQuality: API type