Class UnityUiSettings
Unity UI settings configuration that defines UI system parameters and theme definitions.
Configures UI root objects, theme definitions, and asset prewarming for the Unity UI system.
Namespace: Serenity.Ui.Installation.Settings
Assembly: Serenity.UnityUi.Installation.dll
Syntax
public class UnityUiSettings : ScriptableObject, IUiSettings, IFoundationSettings
Constructors
UnityUiSettings()
Declaration
public UnityUiSettings()
Fields
FloatIncrement
Declaration
public float FloatIncrement
Field Value
| Type | Description |
|---|---|
| float | Increment step used when modifying float-type values in UI interactions. |
FontSizeKey
Declaration
public string FontSizeKey
Field Value
| Type | Description |
|---|---|
| string |
Guid
Declaration
public string Guid
Field Value
| Type | Description |
|---|---|
| string | Globally unique identifier for this settings instance. |
Id
Declaration
public string Id
Field Value
| Type | Description |
|---|---|
| string | Unique identifier for this settings instance. |
PrewarmAddresses
Declaration
public string[] PrewarmAddresses
Field Value
| Type | Description |
|---|---|
| string[] | Specific Addressable addresses/keys for assets to preload at runtime. |
PrewarmLabels
Declaration
public string[] PrewarmLabels
Field Value
| Type | Description |
|---|---|
| string[] | Addressable labels for assets to preload at runtime. |
ScaleKey
Declaration
public string ScaleKey
Field Value
| Type | Description |
|---|---|
| string |
Ui
Declaration
public GameObject Ui
Field Value
| Type | Description |
|---|---|
| GameObject | Root GameObject for the UI system. |
Properties
UiThemeDefinition
Declaration
public IUiThemeDefinition UiThemeDefinition { get; }
Property Value
| Type | Description |
|---|---|
| IUiThemeDefinition | Interface implementation for accessing the UI theme definition. |
UnityUiThemeDefinition
Gets the Unity UI theme definition for this settings instance.
Declaration
public UnityUiThemeDefinition UnityUiThemeDefinition { get; }
Property Value
| Type | Description |
|---|---|
| UnityUiThemeDefinition | The Unity UI theme definition |
Methods
SetUnityUiThemeDefinition(UnityUiThemeDefinition)
Sets the Unity UI theme definition for this settings instance.
Updates the theme configuration that controls UI appearance and styling.
Declaration
public void SetUnityUiThemeDefinition(UnityUiThemeDefinition theme)
Parameters
| Type | Name | Description |
|---|---|---|
| UnityUiThemeDefinition | theme | The theme definition to apply |