Class AchievementInstance

An individual achievement earned or in progress of being earned by a user.

Inheritance
System.Object
AchievementInstance
Namespace: Eco.Gameplay.Achievements
Assembly: Eco.Gameplay.dll
Syntax
public class AchievementInstance : Object, IController, IViewController, IHasUniversalID, INotifyPropertyChanged, ILinkableParameterized<bool>, ILinkable, IHasReferenceableSerializableID, IHasSerializableID
Remarks

Contains details about where it was earned and the specifics of it.

Constructors

AchievementInstance()

Declaration
public AchievementInstance()

Fields

AchievementName

Declaration
public string AchievementName
Field Value
Type Description
System.String

TimeStamp

Declaration
public double TimeStamp
Field Value
Type Description
System.Double

TimeWhenProgressChanged

Declaration
public double TimeWhenProgressChanged
Field Value
Type Description
System.Double

Properties

Achieved

Declaration
public bool Achieved { get; set; }
Property Value
Type Description
System.Boolean

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

CurrentProgress

Declaration
public float CurrentProgress { get; set; }
Property Value
Type Description
System.Single

CustomDescription

Declaration
public string CustomDescription { get; set; }
Property Value
Type Description
System.String

Definition

Declaration
public AchievementDefinition Definition { get; }
Property Value
Type Description
AchievementDefinition

DisplayName

Declaration
public LocString DisplayName { get; }
Property Value
Type Description
LocString

IconName

Declaration
public string IconName { get; }
Property Value
Type Description
System.String

RequiredProgress

Declaration
public float RequiredProgress { get; set; }
Property Value
Type Description
System.Single

WorldSourceID

Declaration
public string WorldSourceID { get; set; }
Property Value
Type Description
System.String

WorldSourceName

Declaration
public string WorldSourceName { get; set; }
Property Value
Type Description
System.String

Methods

OnLinkClicked(TooltipOrigin, TooltipClickContext, User)

Declaration
public void OnLinkClicked(TooltipOrigin origin, TooltipClickContext clickContext, User user)
Parameters
Type Name Description
TooltipOrigin origin
TooltipClickContext clickContext
User user

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

UILinkContent()

Declaration
public LocString UILinkContent()
Returns
Type Description
LocString

UILinkContent(Boolean)

Declaration
public LocString UILinkContent(bool param)
Parameters
Type Name Description
System.Boolean param
Returns
Type Description
LocString

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods