Docsv3.20.2
Back to API Reference
Class

UniTextSettings

sealed
Inherits:LightSideSettingsAsset<UniTextSettings>

Global settings ScriptableObject for UniText configuration.

Remarks

Access via Edit → Project Settings → LightSide → UniText. Contains editor-only default configurations for new UniText components.
public static int VirtualizationThreshold{ get; set }

Gets or sets the maximum UTF-16 character count processed without virtualization; must be positive.

public static UniTextPaints Paints{ get; set }

Gets or sets the project-wide named paint swatch catalog.

public static StylePreset GlobalStylePreset{ get; set }

Project-wide StylePreset applied to every UniTextBase component without per-component opt-in. Behaves as one extra entry appended after each component's local StylePresets list, so local Styles and per-component StylePresets register first and win parse-rule conflicts.

public static UniTextSystemFont SystemFont{ get; set }

Project-wide system font. Serves two roles, both via Default: the always-on final fallback that fills coverage gaps after the assigned fonts, and the primary for components with no Font and no Font Stack. When null, the OS default sans-serif fills both.

public static bool SystemFontDisabled{ get; set }

Persisted mirror of Disabled. The setter pushes the value to the runtime flag; the saved value is pushed back on editor load (static constructor).

public static bool EmojiDisabled{ get; set }

Persisted mirror of Disabled. The setter pushes the value to the runtime flag; the saved value is pushed back on editor load (static constructor).

public static bool CursorDisabled{ get; set }

Persisted mirror of Disabled. The setter pushes the value to the runtime flag; the saved value is pushed back on editor load (static constructor).

public static StateList<WordSegmentationDictionary> Dictionaries{ get }

Gets the configured word segmentation dictionaries.

public static float CaretBlinkTimeout{ get }

Gets the inactivity limit for caret blinking in seconds; zero disables the limit.

public static float CaretBlinkInterval{ get }

Gets the caret blink half-period in seconds, defaulting to 0.5 when no settings asset is available.

public static float CaretWidthPercent{ get }

Gets the caret thickness, in percent of the line height, for carets UniText creates itself.

public static Vector4 CaretPadding{ get }

Gets the per-side caret adjustment, in percent of the line height, for carets UniText creates itself.

public static string Language{ get; set }

Gets or sets the project-wide BCP 47 language tag. Applied to any codepoint that has no component-level UniText.Language and no per-range <lang> override.

public static LineHeightMode DefaultLineHeightMode{ get; set }

Project-wide default line-height mode applied to every component without a per-range override. Mirrored to DefaultLineHeightMode.

public static float LineHeightScale{ get; set }

Line height as a multiple of font size when DefaultLineHeightMode is Scaled. Mirrored to DefaultLineHeightScale.

public static FontNormalizeMetric FontNormalizeMetric{ get; set }

Project-wide default font normalization metric (CSS font-size-adjust), applied to each component's font provider on init. None matches platform defaults.

public static float FontNormalizeTarget{ get; set }

Target aspect for FontNormalizeMetric (metric ÷ font size); 0 matches the primary font.

public static TextMenuPresentation AndroidMenu{ get; set }

Context menu every field presents on Android while its own choice is ProjectDefault (AndroidMenu). A device without the system menu, before Android 6.0, presents the Unity-UI menu.

public static TextMenuPresentation IOSMenu{ get; set }

Context menu every field presents on iOS while its own choice is ProjectDefault (IOSMenu). A device without the system menu, before iOS 13, presents the Unity-UI menu.

public static TextContextMenu ContextMenuPrefab{ get; set }

Unity-UI context menu prefab a field presents while its own (ContextMenuPrefab) is empty, or.

public static UniTextSelectionHandles SelectionHandlesPrefab{ get; set }

Selection handles prefab a field presents while its own handles prefab is empty, or.

public static StateList<TextCommandSource> Commands{ get }

Commands a field's ProjectCommands entry stands for, in menu order. Never holds a ProjectCommands itself.

public static GlyphAtlasSize SdfAtlasSize{ get; set }

Gets or sets SDF page dimensions; changing the value discards the SDF cache and refreshes text.

public static GlyphAtlasPrecision SdfAtlasPrecision{ get; set }

Gets or sets SDF channel precision; changing the value discards the SDF cache and refreshes text.

public static GlyphAtlasSize MsdfAtlasSize{ get; set }

Gets or sets MSDF page dimensions; changing the value discards the MSDF cache and refreshes text.

public static GlyphAtlasPrecision MsdfAtlasPrecision{ get; set }

Gets or sets MSDF channel precision; changing the value discards the MSDF cache and refreshes text.

public static GlyphAtlasSize ColorAtlasSize{ get; set }

Gets or sets preferred color and emoji page dimensions; pages accommodate larger tiles, and changing the value refreshes cached color glyphs.

protected override void OnBecameInstance()
protected override void OnResignedInstance()
Back to API Reference