Class SingletonSettingsInput

The request shape every project-wide-singleton settings wizard shares: which existing asset to edit (if any), where a brand-new one goes, what it is called, the identifier written onto it, and the Addressables policy. Base for each module's own Input type, which adds only its own fields — the counterpart to SingletonSettingsResult and the input half of SingletonSettingsCreationEngine<TSettings, TInput, TResult>.

Inheritance

object

SingletonSettingsInput

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.StructuredPersistence.Infrastructure.Editor.Authoring

Assembly: Serenity.UnityStructuredPersistence.Infrastructure.Editor.dll

Syntax

public abstract class SingletonSettingsInput

Constructors

SingletonSettingsInput()

Declaration

protected SingletonSettingsInput()

Fields

AssetName

File name (without extension) for a brand-new settings asset. Ignored while updating an existing asset, and falls back to the engine's own default when it sanitizes to nothing.

Declaration

public string AssetName

Field Value

Type	Description
string

ExistingSettingsAssetPath

Path of an already-existing settings asset to edit in place — set this (a window's "Edit existing" pick, or a test's fixture path) to update rather than create. Leave empty to create a brand-new asset under OutputFolderPath.

Declaration

public string ExistingSettingsAssetPath

Field Value

Type	Description
string

Id

Identifier written onto the settings asset, both on creation and on every update.

Declaration

public string Id

Field Value

Type	Description
string

OutputFolderPath

Folder a brand-new settings asset is created under. Ignored while updating an existing asset.

Declaration

public string OutputFolderPath

Field Value

Type	Description
string

RegisterAsAddressables

When true, the created asset is registered in the Serenity Addressables group with the engine's module label. Tests disable this to keep the Addressables settings asset untouched.

Declaration

public bool RegisterAsAddressables

Field Value

Type	Description
bool