Class AchievementSettingsDefaults

The one place the achievements module's default configuration is written down.

Inheritance

object

AchievementSettingsDefaults

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.Achievements.Application.Services

Assembly: Serenity.Achievements.Application.dll

Syntax

public static class AchievementSettingsDefaults

Remarks

Both readers of a project's configuration start here: the Unity settings asset seeds its serialized fields with these values, and DefaultAchievementSettings answers with them when no asset was authored at all. Stating them twice is how the two drifted apart in the first place — a project that authored an asset captured a frame on unlock, and a project that did not, silently did not.

Fields

CaptureScreenshotOnUnlock

An unlock captures the frame the player earned it on.

Declaration

public const bool CaptureScreenshotOnUnlock = true

Field Value

Type	Description
bool

ClearPlatformOnReset

A reset leaves the platform account alone: on most storefronts the call is irreversible, and a local debug reset must not revoke trophies the player earned.

Declaration

public const bool ClearPlatformOnReset = false

Field Value

Type	Description
bool

IdentitySource

Achievements are keyed to the device unless a project signs a player in.

Declaration

public const PlayerIdentitySource IdentitySource = 0

Field Value

Type	Description
PlayerIdentitySource

PlatformCallTimeoutSeconds

A platform gateway call is abandoned after ten seconds, so a hung SDK cannot hold up boot.

Declaration

public const double PlatformCallTimeoutSeconds = 10

Field Value

Type	Description
double

PlatformProgressPushStepPercent

Platform progress is pushed at most once every ten percent.

Declaration

public const int PlatformProgressPushStepPercent = 10

Field Value

Type	Description
int

PlatformSyncRetrySeconds

Seconds between platform-sync retries while the storefront is unreachable.

Declaration

public const double PlatformSyncRetrySeconds = 30

Field Value

Type	Description
double

PointsScoreKey

No Score metric mirrors the points until a project names one.

Declaration

public const string PointsScoreKey = ""

Field Value

Type	Description
string

ScreenshotMaxWidth

The width a captured screenshot is downscaled to before it is encoded, in pixels.

Declaration

public const int ScreenshotMaxWidth = 960

Field Value

Type	Description
int

ShowToastOnUnlock

An unlock raises a toast notification.

Declaration

public const bool ShowToastOnUnlock = true

Field Value

Type	Description
bool

SignalOnReconciledUnlock

An unlock mirrored in from a platform account stays silent, so reinstalling a game does not replay every notification the player already saw.

Declaration

public const bool SignalOnReconciledUnlock = false

Field Value

Type	Description
bool