Class AchievementUnlockedSignal

Broadcast whenever an achievement is unlocked for a player.

Inheritance

object

AchievementUnlockedSignal

Namespace: Serenity.Achievements.Application.Events

Assembly: Serenity.Achievements.Application.dll

Syntax

public class AchievementUnlockedSignal : EventDispatcherSignal

Remarks

An unlock mirrored in from a platform account only raises this signal when SignalOnReconciledUnlock is on, so reinstalling a game does not replay every notification.

Constructors

AchievementUnlockedSignal()

Initializes a new instance of the AchievementUnlockedSignal class.

Declaration

public AchievementUnlockedSignal()

AchievementUnlockedSignal(AchievementId, PlayerId, int, long)

Initializes a new instance of the AchievementUnlockedSignal class.

Declaration

public AchievementUnlockedSignal(AchievementId achievement, PlayerId player, int points, long unlockedAtUtcTicks)

Parameters

Type	Name	Description
AchievementId	achievement	The achievement that was unlocked.
PlayerId	player	The player who unlocked it.
int	points	The points the unlock awarded.
long	unlockedAtUtcTicks	The UTC timestamp (in ticks) at which the unlock happened.

Fields

Achievement

Declaration

public readonly AchievementId Achievement

Field Value

Type	Description
AchievementId	The achievement that was unlocked.

Player

Declaration

public readonly PlayerId Player

Field Value

Type	Description
PlayerId	The player who unlocked it.

Points

Declaration

public readonly int Points

Field Value

Type	Description
int	The points the unlock awarded.

UnlockedAtUtcTicks

Declaration

public readonly long UnlockedAtUtcTicks

Field Value

Type	Description
long	The UTC timestamp (in ticks) at which the unlock happened.

Methods

ToString()

Returns a string representation of the event.

Declaration

public override string ToString()

Returns

Type	Description
string