Achievements Interface Reference

Scripted API to access platform's achievements. More...

Static Public Member Functions
static proto bool	UnlockAchievement (AchievementId achievement)
	Unlocks the given achievement.
static proto bool	IncrementAchievementProgress (AchievementStatId stat, int value)
	Increments the given stat .

Detailed Description

Scripted API to access platform's achievements.

Calls to this API may fail if achievements are not properly configured on used platform or if the platfrom encounters an error (see runtime logs)

Member Function Documentation

IncrementAchievementProgress()

static proto bool Achievements.IncrementAchievementProgress ( AchievementStatId  stat, int  value  )

static

Increments the given stat .

Cannot decrement Achievements are automatically unlocked if the maximum value is reached. Fails if game is not running vanilla addons only.

Parameters

value

Value greater then 0 to be added to tracked stat.

Returns

True on success

UnlockAchievement()

static proto bool Achievements.UnlockAchievement ( AchievementId  achievement )

static

Unlocks the given achievement.

Fails if game is not running vanilla addons only.

Returns

True on success

---

The documentation for this interface was generated from the following file:

• Game/generated/Core/Achievements.c