Class AchievementSettingsCreator.Input

Everything needed to author a project's achievements configuration.

Inheritance

object

AchievementSettingsCreator.Input

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.Achievements.Infrastructure.Editor.Builder

Assembly: Serenity.UnityAchievements.Infrastructure.Editor.dll

Syntax

public sealed class AchievementSettingsCreator.Input

Constructors

Input()

Declaration

public Input()

Fields

BackendAssetName

File name (without extension) of a created backend asset.

Declaration

public string BackendAssetName

Field Value

Type	Description
string

BackendFields

Connection fields for BackendKind.

Declaration

public StructuredBackendAuthoringFields BackendFields

Field Value

Type	Description
StructuredBackendAuthoringFields

BackendKind

Which shared backend subtype is created when ExistingBackend is null.

Declaration

public StructuredBackendAuthoringKind BackendKind

Field Value

Type	Description
StructuredBackendAuthoringKind

DisplayName

Human-readable name for the configuration. Used only to name a brand-new settings asset; blank falls back to DefaultSettingsAssetName.

Declaration

public string DisplayName

Field Value

Type	Description
string

EnabledPlatforms

The storefronts this project mirrors unlocks to. Empty is a complete, local-only configuration.

Declaration

public IReadOnlyCollection<AchievementPlatformKind> EnabledPlatforms

Field Value

Type	Description
IReadOnlyCollection<AchievementPlatformKind>

ExistingBackend

An already-authored backend to assign instead of creating one. Null creates one from BackendKind and BackendFields.

Declaration

public UnityStructuredBackendDefinition ExistingBackend

Field Value

Type	Description
UnityStructuredBackendDefinition

Id

Id carried by the settings asset. Also the stem of every platform definition's Id.

Declaration

public string Id

Field Value

Type	Description
string

Options

How the module behaves once installed. Defaults match a hand-created settings asset.

Declaration

public AchievementOptionsAuthoring Options

Field Value

Type	Description
AchievementOptionsAuthoring

PlatformFields

The per-storefront values the enabled platforms' assets are filled from.

Declaration

public AchievementPlatformFields PlatformFields

Field Value

Type	Description
AchievementPlatformFields

RegisterAsAddressables

Whether every created asset is registered in the Serenity Addressables group. Tests pass false.

Declaration

public bool RegisterAsAddressables

Field Value

Type	Description
bool

ReplaceExistingBackend

Whether a backend already assigned to a pre-existing settings asset is overwritten. Off, the assigned backend is kept and a warning is reported.

Declaration

public bool ReplaceExistingBackend

Field Value

Type	Description
bool

RetrofitThemes

Whether every theme missing an achievements panel is retrofitted after the assets are written.

Declaration

public bool RetrofitThemes

Field Value

Type	Description
bool

SettingsAssetPath

Explicit settings asset path (a test seam and an already-known-asset fast path). An asset already present here is edited in place; otherwise a fresh one is created at exactly this path. Blank resolves to {TargetFolder}/{DisplayName or AchievementSettings}.asset.

Declaration

public string SettingsAssetPath

Field Value

Type	Description
string

TargetFolder

Folder every asset this run creates lands in. Created when it does not exist yet.

Declaration

public string TargetFolder

Field Value

Type	Description
string

TargetProfiles

The boot profiles the install task is inserted into. Null or empty ensures the task asset exists without inserting it anywhere.

Declaration

public IReadOnlyCollection<UnityInitializationPipelineProfile> TargetProfiles

Field Value

Type	Description
IReadOnlyCollection<UnityInitializationPipelineProfile>

View

The optional on-screen achievements listing.

Declaration

public AchievementViewAuthoring View

Field Value

Type	Description
AchievementViewAuthoring

WireInstallTask

Whether the InstallAchievements boot task is ensured and inserted into TargetProfiles.

Declaration

public bool WireInstallTask

Field Value

Type	Description
bool