Class AchievementSyncRecord.Fields

The values one record is built from, named rather than positional.

Inheritance

object

AchievementSyncRecord.Fields

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.Achievements.Application.Sync

Assembly: Serenity.Achievements.Application.dll

Syntax

public sealed class AchievementSyncRecord.Fields

Constructors

Fields()

Declaration

public Fields()

Fields

ApiName

The platform-side identity/match key (Steam API name, Xbox id, and so on).

Declaration

public string ApiName

Field Value

Type	Description
string

Description

The localized description.

Declaration

public LocalizedTextSet Description

Field Value

Type	Description
LocalizedTextSet

DisplayName

The localized display name.

Declaration

public LocalizedTextSet DisplayName

Field Value

Type	Description
LocalizedTextSet

DisplayOrder

Where the achievement is listed relative to its siblings.

Declaration

public int DisplayOrder

Field Value

Type	Description
int

HeldUnlockedIconStorefrontReference

The storefront reference the authored achievement's unlocked icon was saved from by an earlier pull, when the project's file is still that unchanged copy; empty otherwise. Only a record built from an authored achievement says so.

Declaration

public string HeldUnlockedIconStorefrontReference

Field Value

Type	Description
string

HoldsLockedIcon

Whether the authored achievement already holds a locked icon. Only a record built from an authored achievement says so.

Declaration

public bool HoldsLockedIcon

Field Value

Type	Description
bool

HoldsUnlockedIcon

Whether the authored achievement already holds an unlocked icon. Only a record built from an authored achievement says so.

Declaration

public bool HoldsUnlockedIcon

Field Value

Type	Description
bool

IsHidden

Whether the achievement stays concealed until unlocked.

Declaration

public bool IsHidden

Field Value

Type	Description
bool

LocalId

The Serenity achievement id, or empty for a row that only exists on the platform.

Declaration

public string LocalId

Field Value

Type	Description
string

LockedIcon

The icon shown while the achievement is still locked.

Declaration

public AchievementIconPayload LockedIcon

Field Value

Type	Description
AchievementIconPayload

PlatformExtras

Platform-specific ballast this record must round-trip untouched. See the class remarks.

Declaration

public IReadOnlyDictionary<string, string> PlatformExtras

Field Value

Type	Description
IReadOnlyDictionary<string, string>

ProgressTarget

The progress numerator that unlocks it. Zero is a single-step unlock.

Declaration

public long ProgressTarget

Field Value

Type	Description
long

StorefrontLockedIcon

The locked icon the storefront holds, for a pull to offer. Only a record a storefront returned carries one.

Declaration

public AchievementStorefrontIcon StorefrontLockedIcon

Field Value

Type	Description
AchievementStorefrontIcon

StorefrontUnlockedIcon

The unlocked icon the storefront holds, for a pull to offer. Only a record a storefront returned carries one.

Declaration

public AchievementStorefrontIcon StorefrontUnlockedIcon

Field Value

Type	Description
AchievementStorefrontIcon

TextIsLiteral

Whether the display name and description are literal text held in the definition itself rather than keys into a string table. Only a record built from an authored achievement can be literal; a record a storefront returned never is.

Declaration

public bool TextIsLiteral

Field Value

Type	Description
bool

UnlockedIcon

The icon shown once the achievement is unlocked.

Declaration

public AchievementIconPayload UnlockedIcon

Field Value

Type	Description
AchievementIconPayload