Skip to content

TextStudioProjectSettings

ClassTextStudioTextStudio
public sealed class TextStudioProjectSettings : ScriptableObject

Optional user-created project-level settings. Ships zero assets by default; a user can create one via Assets → Create → Text Studio → Project Settings to customize the hard-coded Text Studio default settings and to register project assets by id.

public bool overrideDefaults

Returns

System.Boolean

public RevealMode defaultRevealMode

Returns

TextStudio.RevealMode

public PlacementMode defaultPlacementMode

Returns

TextStudio.PlacementMode

[Min(0)]
public float defaultCharDelay

Returns

System.Single

public bool warnOnMissingTags

Returns

System.Boolean

[Tooltip("Package-wide animation policy. Reduced limits motion while preserving color and material emphasis; None removes motion channels.")]
public TextStudioMotionPolicy motionPolicy

Returns

TextStudio.TextStudioMotionPolicy

[Tooltip("Optional authoring syntax override. Leave unassigned for angle tags plus supported Text Animator brace tags.")]
public TextStudioMarkupSyntax markupSyntax

Returns

TextStudio.TextStudioMarkupSyntax

public List<TextStudioEffectDefinitionAsset> effectCatalog

Returns

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

public List<TextStudioActionAsset> actionCatalog

Returns

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

public List<EffectCurveAsset> curveCatalog

Returns

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

public List<EffectPlaybackAsset> playbackCatalog

Returns

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

public List<TextStudioTagExpansionSheet> tagExpansionSheets

Returns

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

public static void SetActive(TextStudioProjectSettings settings)

Make a project settings asset active and atomically replace the project-owned catalog tier. Explicit runtime registrations remain in place and take precedence. Passing null clears the previous project catalog and restores built-in defaults.

Parameters

Name Type
settings TextStudio.TextStudioProjectSettings
public static void ApplyTo(TextStudioDefaultSettings defaultSettings)

Applies this settings asset’s values onto the given default settings instance (if enabled).

Parameters

Name Type
defaultSettings TextStudio.TextStudioDefaultSettings
public void RegisterCatalog()

Replaces the project-owned registry tier with this asset’s catalog. Prefer TextStudio.TextStudioProjectSettings.SetActive(TextStudio.TextStudioProjectSettings) when changing the active project settings.

public TextStudioProjectSettings()

public static TextStudioProjectSettings Active { get; }

Returns

TextStudio.TextStudioProjectSettings

public static TextStudioMarkupSyntax ActiveMarkupSyntax { get; }

Returns

TextStudio.TextStudioMarkupSyntax