Skip to content

TextStudio3DTheme

ClassTextStudio.ThreeDTextStudio.3D
[CreateAssetMenu(fileName = "Text Studio 3D Theme", menuName = "Text Studio/3D/Setup/Theme", order = 100)]
public sealed class TextStudio3DTheme : ScriptableObject

Reusable project theme that supplies a shared font, prepared 3D font data, default and named extrusion styles, and interaction visuals for themed text and controls.

public string AddStyleVariation(string displayName, Extrude3DStyle style)

Adds a named style with a generated stable ID and notifies all theme consumers.

Parameters

Name Type
displayName System.String
style TextStudio.ThreeD.Extrude3DStyle

Returns

System.String: The generated variation ID.

SetStyleVariation(string, string, Extrude3DStyle)

Section titled “SetStyleVariation(string, string, Extrude3DStyle)”
public string SetStyleVariation(string variationId, string displayName, Extrude3DStyle style)

Adds or replaces a named style variation while preserving or normalizing its stable ID.

Parameters

Name Type
variationId System.String
displayName System.String
style TextStudio.ThreeD.Extrude3DStyle

Returns

System.String: The normalized variation ID.

public bool RemoveStyleVariation(string variationId)

Removes the exact named variation and clears automatic bindings that referenced it.

Parameters

Name Type
variationId System.String

Returns

System.Boolean: True when a variation was removed.

TryGetStyleVariation(string, out TextStudio3DThemeStyleVariation)

Section titled “TryGetStyleVariation(string, out TextStudio3DThemeStyleVariation)”
public bool TryGetStyleVariation(string variationId, out TextStudio3DThemeStyleVariation variation)

Tries to resolve an exact ordinal variation ID to its read-only theme entry.

Parameters

Name Type
variationId System.String
variation TextStudio.ThreeD.TextStudio3DThemeStyleVariation

Returns

System.Boolean

GetStyle(TextStudio3DThemeStyleBinding, string)

Section titled “GetStyle(TextStudio3DThemeStyleBinding, string)”
public Extrude3DStyle GetStyle(TextStudio3DThemeStyleBinding binding, string variationId = null)

Resolves a default, named, control-label, or gameplay-feedback style with fallback to the theme default.

Parameters

Name Type
binding TextStudio.ThreeD.TextStudio3DThemeStyleBinding
variationId System.String

Returns

TextStudio.ThreeD.Extrude3DStyle

public TextStudio3DTheme()

public TMP_FontAsset GlobalFont { get; set; }

Returns

TMPro.TMP_FontAsset

public Font3D GlobalFontData { get; set; }

Returns

TextStudio.ThreeD.Font3D

public TextStudio3DControlTheme ControlTheme { get; set; }

Returns

TextStudio.ThreeD.TextStudio3DControlTheme

public Extrude3DStyle DefaultStyle { get; set; }

Returns

TextStudio.ThreeD.Extrude3DStyle

public IReadOnlyList<TextStudio3DThemeStyleVariation> StyleVariations { get; }

Returns

System.Collections.Generic.IReadOnlyList{TextStudio.ThreeD.TextStudio3DThemeStyleVariation}

public string ControlTextStyleVariationId { get; set; }

Returns

System.String

public string GameplayFeedbackStyleVariationId { get; set; }

Returns

System.String