Skip to content
Impossible Robert — Unity Tools

TextStudioTypewriterSettings

StructTextStudioTextStudio
public struct TextStudioTypewriterSettings

Complete serializable reveal, hide, timing, skip, looping, and motion configuration for a typewriter host.

Fields

Section titled “Fields”

CustomMotionPresetId

Section titled “CustomMotionPresetId”
public const string CustomMotionPresetId = "typewriter.motion.custom"

Returns

System.String

RevealMode

Section titled “RevealMode”
public RevealMode RevealMode

Returns

TextStudio.RevealMode

Timings

Section titled “Timings”
public TypingTimingsBase Timings

Returns

TextStudio.TypingTimingsBase

BuiltInTimingsPreset

Section titled “BuiltInTimingsPreset”
public RevealTimingsPreset BuiltInTimingsPreset

Returns

TextStudio.RevealTimingsPreset

WaitAfterFinalReveal

Section titled “WaitAfterFinalReveal”
[Tooltip("When no custom timing asset is assigned, include the built-in cadence's final trailing delay before reveal completion.")]
public bool WaitAfterFinalReveal

Returns

System.Boolean

RevealSpeedMultiplier

Section titled “RevealSpeedMultiplier”
[Min(0.01)]
public float RevealSpeedMultiplier

Returns

System.Single

RevealAppearanceDuration

Section titled “RevealAppearanceDuration”
[Min(0.01)]
public float RevealAppearanceDuration

Returns

System.Single

RevealDisappearanceDuration

Section titled “RevealDisappearanceDuration”
[Min(0.01)]
public float RevealDisappearanceDuration

Returns

System.Single

RevealSequence

Section titled “RevealSequence”
public TextStudioSequenceSettings RevealSequence

Returns

TextStudio.TextStudioSequenceSettings

HideSequence

Section titled “HideSequence”
public TextStudioSequenceSettings HideSequence

Returns

TextStudio.TextStudioSequenceSettings

StartMode

Section titled “StartMode”
public TextStudioTypewriterStartMode StartMode

Returns

TextStudio.TextStudioTypewriterStartMode

ResetSpeedOnNewText

Section titled “ResetSpeedOnNewText”
public bool ResetSpeedOnNewText

Returns

System.Boolean

SkipRevealMode

Section titled “SkipRevealMode”
public TextStudioTypewriterSkipRevealMode SkipRevealMode

Returns

TextStudio.TextStudioTypewriterSkipRevealMode

TriggerRemainingMarkersOnSkip

Section titled “TriggerRemainingMarkersOnSkip”
public bool TriggerRemainingMarkersOnSkip

Returns

System.Boolean

SkipCurrentWaitOnSkip

Section titled “SkipCurrentWaitOnSkip”
public bool SkipCurrentWaitOnSkip

Returns

System.Boolean

SkipHideMode

Section titled “SkipHideMode”
public TextStudioTypewriterSkipHideMode SkipHideMode

Returns

TextStudio.TextStudioTypewriterSkipHideMode

LoopReveal

Section titled “LoopReveal”
public bool LoopReveal

Returns

System.Boolean

LoopRevealDelay

Section titled “LoopRevealDelay”
[Min(0)]
public float LoopRevealDelay

Returns

System.Single

MotionPresetId

Section titled “MotionPresetId”
public string MotionPresetId

Returns

System.String

CustomMotionPreset

Section titled “CustomMotionPreset”
public TextStudioTypewriterMotionPreset CustomMotionPreset

Returns

TextStudio.TextStudioTypewriterMotionPreset

RevealMotion

Section titled “RevealMotion”
public string RevealMotion

Returns

System.String

HideMotion

Section titled “HideMotion”
public string HideMotion

Returns

System.String

MotionEffectMode

Section titled “MotionEffectMode”
public TextStudioDefaultEffectMode MotionEffectMode

Returns

TextStudio.TextStudioDefaultEffectMode

Methods

Section titled “Methods”

NormalizeSerializedSettings(TextStudioTypewriterSettings)

Section titled “NormalizeSerializedSettings(TextStudioTypewriterSettings)”
public static TextStudioTypewriterSettings NormalizeSerializedSettings(TextStudioTypewriterSettings settings)

Clamps serialized ranges and restores safe defaults without resolving motion assets.

Parameters

Name Type
settings TextStudio.TextStudioTypewriterSettings

Returns

TextStudio.TextStudioTypewriterSettings

NormalizeAuthoringSettings(TextStudioTypewriterSettings)

Section titled “NormalizeAuthoringSettings(TextStudioTypewriterSettings)”
public static TextStudioTypewriterSettings NormalizeAuthoringSettings(TextStudioTypewriterSettings settings)

Normalizes serialized values and canonicalizes the selected built-in or custom motion source.

Parameters

Name Type
settings TextStudio.TextStudioTypewriterSettings

Returns

TextStudio.TextStudioTypewriterSettings

ResolveRuntimeSettings(TextStudioTypewriterSettings)

Section titled “ResolveRuntimeSettings(TextStudioTypewriterSettings)”
public static TextStudioTypewriterSettings ResolveRuntimeSettings(TextStudioTypewriterSettings settings)

Resolves motion IDs and assets into runtime reveal and hide effect expressions.

Parameters

Name Type
settings TextStudio.TextStudioTypewriterSettings

Returns

TextStudio.TextStudioTypewriterSettings

IsCustomMotionPreset(string)

Section titled “IsCustomMotionPreset(string)”
public static bool IsCustomMotionPreset(string motionPresetId)

Reports whether an identifier selects the custom motion asset slot.

Parameters

Name Type
motionPresetId System.String

Returns

System.Boolean

Properties

Section titled “Properties”

Default

Section titled “Default”
public static TextStudioTypewriterSettings Default { get; }

Returns

TextStudio.TextStudioTypewriterSettings

© Robert Wetzold Studios