Class AchievementManager

Handles management of achievements for users

Inheritance
System.Object
AchievementManager
Namespace: Eco.Gameplay.Achievements
Assembly: Eco.Gameplay.dll
Syntax
public class AchievementManager : Singleton<AchievementManager>, IController, IViewController, IHasUniversalID, IHasRequiredIcons

Constructors

AchievementManager()

Declaration
public AchievementManager()

Fields

AchievementsChangedEvent

Declaration
public ThreadSafeAction AchievementsChangedEvent
Field Value
Type Description
ThreadSafeAction

ModAchievements

Declaration
public IReadOnlyList<AchievementDefinition> ModAchievements
Field Value
Type Description
System.Collections.Generic.IReadOnlyList<AchievementDefinition>

NameToAchievement

Declaration
public ConcurrentDictionary<string, AchievementDefinition> NameToAchievement
Field Value
Type Description
System.Collections.Concurrent.ConcurrentDictionary<System.String, AchievementDefinition>

ServerAchievements

Declaration
public ServerAchievements ServerAchievements
Field Value
Type Description
ServerAchievements

Properties

CitizenCompletedAchievements

Declaration
public LocString CitizenCompletedAchievements { get; set; }
Property Value
Type Description
LocString

ControllerID

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

IconsCategoryName

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

WorldCompletedAchievementsCached

Declaration
public ControllerHashSet<AchievementInstance> WorldCompletedAchievementsCached { get; set; }
Property Value
Type Description
ControllerHashSet<AchievementInstance>

Methods

GetRequiredIcons()

Declaration
public static IEnumerable<(string, string)> GetRequiredIcons()
Returns
Type Description
System.Collections.Generic.IEnumerable<System.ValueTuple<System.String, System.String>>

GetServerAchievementNames()

Returns an array of localized achievement names and their description that the server has obtained. Returns empty array if none available

Declaration
public Dictionary<string, string> GetServerAchievementNames()
Returns
Type Description
System.Collections.Generic.Dictionary<System.String, System.String>

Initialize()

Declaration
public void Initialize()

OnAchievementProgress(AchievementProgressChange)

Process achievement Progress

Declaration
public void OnAchievementProgress(AchievementProgressChange achievementProgressData)
Parameters
Type Name Description
AchievementProgressChange achievementProgressData

Implements

Extension Methods