Class AchievementSyncApplyRequest

Everything Apply(AchievementSyncApplyRequest) needs to turn a plan's accepted Pull-direction changes into project assets: the plan and selection an AchievementSyncPlanner run and a review window produced, the authored definitions the plan's MatchedBoth items resolve against, and the platform context a fresh PlatformOnly creation needs.

Inheritance

object

AchievementSyncApplyRequest

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.Achievements.Infrastructure.Editor.Sync

Assembly: Serenity.UnityAchievements.Infrastructure.Editor.dll

Syntax

public sealed class AchievementSyncApplyRequest

Constructors

AchievementSyncApplyRequest()

Declaration

public AchievementSyncApplyRequest()

Fields

AuthoringLocaleCode

The locale a non-translating achievement's literal Name/Description text is filed under, and the locale every new set of string table entries starts with. An accepted change for any other locale on a non-translating achievement waits for its key-adoption row — see LocalizationKeyAdoption.

Declaration

public string AuthoringLocaleCode

Field Value

Type	Description
string

CreatedLocaleDescriptions

One line for each language the author added to the project for this pull, so the report that lists the entries filed in it also lists that the language was created.

Declaration

public IReadOnlyList<string> CreatedLocaleDescriptions

Field Value

Type	Description
IReadOnlyList<string>

DefinitionsByLocalId

The authored achievements the plan's MatchedBoth items resolve against, keyed by LocalId.

Declaration

public IReadOnlyDictionary<string, UnityAchievementDefinition> DefinitionsByLocalId

Field Value

Type	Description
IReadOnlyDictionary<string, UnityAchievementDefinition>

IconSource

Where an accepted icon is downloaded from. A preview never asks it; an apply that accepted an icon and has none reports that icon as failed.

Declaration

public IAchievementSyncIconSource IconSource

Field Value

Type	Description
IAchievementSyncIconSource

LocalesCreatedWithoutTable

One line for each language the author added whose table could not then be added, so the project has the language but the collection has no table for it. The report warns about each.

Declaration

public IReadOnlyList<string> LocalesCreatedWithoutTable

Field Value

Type	Description
IReadOnlyList<string>

OverwriteExistingEntries

Whether the author confirmed replacing text a string table entry already holds when a pull files different text under the same key. False keeps the held text and reports the key as a conflict.

Declaration

public bool OverwriteExistingEntries

Field Value

Type	Description
bool

Plan

The plan whose accepted changes are applied. Must be a Pull-direction plan.

Declaration

public AchievementSyncPlan Plan

Field Value

Type	Description
AchievementSyncPlan

Platform

The storefront this plan was built for, used to stamp a fresh PlatformOnly creation's platform mapping.

Declaration

public AchievementPlatformKind Platform

Field Value

Type	Description
AchievementPlatformKind

ProposedLocalIdsByApiName

Author-editable local id proposals for a PlatformOnly row, keyed by api name. A missing or blank entry falls back to ProposeLocalId(string).

Declaration

public IReadOnlyDictionary<string, string> ProposedLocalIdsByApiName

Field Value

Type	Description
IReadOnlyDictionary<string, string>

RegisterAsAddressables

Whether a freshly created achievement, and an icon file a pull creates, are registered as Addressables under the achievements label. Tests pass false.

Declaration

public bool RegisterAsAddressables

Field Value

Type	Description
bool

Selection

Which of the plan's field changes an author accepted.

Declaration

public AchievementSyncReviewSelection Selection

Field Value

Type	Description
AchievementSyncReviewSelection

StringTableCollectionName

The Unity Localization string table collection a pull files translated text in: the changes of a translating achievement, the entries of a new or key-adopting one. Blank, or a collection that cannot take the text, leaves a pull writing literal text.

Declaration

public string StringTableCollectionName

Field Value

Type	Description
string

TargetFolder

The folder a freshly created PlatformOnly achievement lands in, and the one whose Icons subfolder receives the icons a pull downloads.

Declaration

public string TargetFolder

Field Value

Type	Description
string