Interface UM_iAchievementsClient

A client to interact with achievements functionality.

Namespace: SA.CrossPlatform.GameServices

Assembly: cs.temp.dll.dll

Syntax

public interface UM_iAchievementsClient

Methods

Increment(String, Int32, Action<SA_Result>)

Increments an achievement by the given number of steps. The achievement must be an incremental achievement. Once an achievement reaches at least the maximum number of steps, it will be unlocked automatically. Any further increments will be ignored.

Declaration

void Increment(string achievementId, int numSteps, Action<SA_Result> callback)

Parameters

Type	Name	Description
System.String	achievementId	The achievement ID to increment.
System.Int32	numSteps	The number of steps to increment by. Must be greater than 0.
Action<SA_Result>	callback

Load(Action<UM_AchievementsLoadResult>)

Retrive's the achievements info

Declaration

void Load(Action<UM_AchievementsLoadResult> callback)

Parameters

Type	Name	Description
Action<UM_AchievementsLoadResult>	callback

Reveal(String, Action<SA_Result>)

Asynchronously reveals a hidden achievement to the currently signed in player. If the achievement is already visible, this will have no effect.

Declaration

void Reveal(string achievementId, Action<SA_Result> callback)

Parameters

Type	Name	Description
System.String	achievementId	The achievement ID to reveal.
Action<SA_Result>	callback	Result callback

ShowUI(Action<SA_Result>)

Show the native UI with the list of achievements for a game.

Declaration

void ShowUI(Action<SA_Result> callback)

Parameters

Type	Name	Description
Action<SA_Result>	callback

Unlock(String, Action<SA_Result>)

Asynchronously unlocks an achievement for the currently signed in player. If the achievement is hidden this will reveal it to the player.

Declaration

void Unlock(string achievementId, Action<SA_Result> callback)

Parameters

Type	Name	Description
System.String	achievementId	The achievement ID to unlock.
Action<SA_Result>	callback	Result callback