Struct AchievementPlatformMapping

The per-platform identifiers an achievement is mirrored under. Each platform names its achievements independently of Serenity's own AchievementId, so a definition carries one identifier per platform it ships on. A blank identifier means "not mirrored to that platform".

Implements

IEquatable<AchievementPlatformMapping>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Serenity.Achievements.Domain.ValueObjects

Assembly: Serenity.Achievements.Domain.dll

Syntax

public readonly struct AchievementPlatformMapping : IEquatable<AchievementPlatformMapping>

Constructors

AchievementPlatformMapping(string, string, string, string, TrophyGrade)

Creates a new AchievementPlatformMapping with the specified identifiers.

Declaration

public AchievementPlatformMapping(string steamApiName, string xboxAchievementId, string epicAchievementId, string psnTrophyId, TrophyGrade trophyGrade)

Parameters

Type	Name	Description
string	steamApiName	The Steam API name. May be null or empty.
string	xboxAchievementId	The Xbox achievement identifier. May be null or empty.
string	epicAchievementId	The Epic achievement identifier. May be null or empty.
string	psnTrophyId	The PlayStation Network trophy identifier. May be null or empty.
TrophyGrade	trophyGrade	The trophy tier used by tiered platforms.

Fields

EpicAchievementId

The Epic Online Services achievement identifier. May be null or empty.

Declaration

public readonly string EpicAchievementId

Field Value

Type	Description
string

PsnTrophyId

The PlayStation Network trophy identifier. May be null or empty.

Declaration

public readonly string PsnTrophyId

Field Value

Type	Description
string

SteamApiName

The Steam API name (Steamworks "API Name" field). May be null or empty.

Declaration

public readonly string SteamApiName

Field Value

Type	Description
string

TrophyGrade

The trophy tier used by tiered platforms.

Declaration

public readonly TrophyGrade TrophyGrade

Field Value

Type	Description
TrophyGrade

XboxAchievementId

The Xbox achievement identifier. May be null or empty.

Declaration

public readonly string XboxAchievementId

Field Value

Type	Description
string

Properties

Empty

A mapping that names no platform at all — the local-only default.

Declaration

public static AchievementPlatformMapping Empty { get; }

Property Value

Type	Description
AchievementPlatformMapping

HasAnyPlatformIdentifier

Whether this mapping names at least one platform identifier.

Declaration

public bool HasAnyPlatformIdentifier { get; }

Property Value

Type	Description
bool

Methods

Equals(AchievementPlatformMapping)

Declaration

public bool Equals(AchievementPlatformMapping other)

Parameters

Type	Name	Description
AchievementPlatformMapping	other

Returns

Type	Description
bool

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

ValueType.Equals(object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

ValueType.GetHashCode()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

ValueType.ToString()

Operators

operator ==(AchievementPlatformMapping, AchievementPlatformMapping)

Declaration

public static bool operator ==(AchievementPlatformMapping left, AchievementPlatformMapping right)

Parameters

Type	Name	Description
AchievementPlatformMapping	left
AchievementPlatformMapping	right

Returns

Type	Description
bool

operator !=(AchievementPlatformMapping, AchievementPlatformMapping)

Declaration

public static bool operator !=(AchievementPlatformMapping left, AchievementPlatformMapping right)

Parameters

Type	Name	Description
AchievementPlatformMapping	left
AchievementPlatformMapping	right

Returns

Type	Description
bool

Implements

IEquatable<T>