Essential Kit
Loading...
Searching...
No Matches
IAchievementDescription

Provides an interface to access an achievement's properties such as achievement's title, max points, image etc. More...

Public Member Functions

void LoadIncompleteAchievementImage (EventCallback< TextureData > callback)
 Loads the image property for an incomplete achievement.
 
void LoadImage (EventCallback< TextureData > callback)
 Loads the image property for a completed achievement.
 

Properties

string Id [get]
 An unique string used to identify the achievement across all the supported platforms. (read-only)
 
string PlatformId [get]
 A string used to identify the achievement in the current platform. (read-only)
 
string Title [get]
 A localized title for the achievement. (read-only)
 
string UnachievedDescription [get]
 A localized description of the achievement to be used when the local player has not completed the achievement. (read-only)
 
string AchievedDescription [get]
 A localized description to be used after the local player has completed the achievement. (read-only)
 
long MaximumPoints [get]
 The number of points the player earns by completing this achievement. (read-only)
 
int NumberOfStepsRequiredToUnlockAchievement [get]
 The number of steps required for completing this achievement.
 
bool IsHidden [get]
 A boolean that states whether this achievement is initially visible to users. (read-only)
 
bool IsReplayable [get]
 A Boolean value that states whether this achievement can be earned multiple times. (read-only)
 

Detailed Description

Note
Your game must authenticate the local user before using any features.

Member Function Documentation

◆ LoadIncompleteAchievementImage()

void LoadIncompleteAchievementImage ( EventCallback< TextureData > callback)
Parameters
callbackCallback method that will be invoked after operation is completed.

◆ LoadImage()

void LoadImage ( EventCallback< TextureData > callback)
Parameters
callbackCallback method that will be invoked after operation is completed.