Interface IAchievementDescription

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

Namespace: VoxelBusters.EssentialKit

Assembly: cs.temp.dll.dll

Syntax

public interface IAchievementDescription

Remarks

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

Properties

AchievedDescription

A localized description to be used after the local player has completed the achievement. (read-only)

Declaration

string AchievedDescription { get; }

Property Value

Type	Description
System.String

Id

An unique string used to identify the achievement across all the supported platforms. (read-only)

Declaration

string Id { get; }

Property Value

Type	Description
System.String

IsHidden

A boolean that states whether this achievement is initially visible to users. (read-only)

Declaration

bool IsHidden { get; }

Property Value

Type	Description
System.Boolean

IsReplayable

A Boolean value that states whether this achievement can be earned multiple times. (read-only)

Declaration

bool IsReplayable { get; }

Property Value

Type	Description
System.Boolean

MaximumPoints

The number of points the player earns by completing this achievement. (read-only)

Declaration

long MaximumPoints { get; }

Property Value

Type	Description
System.Int64

NumberOfStepsRequiredToUnlockAchievement

The number of steps required for completing this achievement.

Declaration

int NumberOfStepsRequiredToUnlockAchievement { get; }

Property Value

Type	Description
System.Int32

PlatformId

A string used to identify the achievement in the current platform. (read-only)

Declaration

string PlatformId { get; }

Property Value

Type	Description
System.String

Title

A localized title for the achievement. (read-only)

Declaration

string Title { get; }

Property Value

Type	Description
System.String

UnachievedDescription

A localized description of the achievement to be used when the local player has not completed the achievement. (read-only)

Declaration

string UnachievedDescription { get; }

Property Value

Type	Description
System.String

Methods

LoadImage(EventCallback<TextureData>)

Loads the image property for a completed achievement.

Declaration

void LoadImage(EventCallback<TextureData> callback)

Parameters

Type	Name	Description
EventCallback<TextureData>	callback	Callback method that will be invoked after operation is completed.

LoadIncompleteAchievementImage(EventCallback<TextureData>)

Loads the image property for an incomplete achievement.

Declaration

void LoadIncompleteAchievementImage(EventCallback<TextureData> callback)

Parameters

Type	Name	Description
EventCallback<TextureData>	callback	Callback method that will be invoked after operation is completed.