SetSteamAchievement

From The Official Visionaire Studio: Adventure Game Engine Wiki
Revision as of 22:28, 30 September 2014 by Vis apiuser (talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

setSteamAchievement

Available since: v3.6
Sets an achievement to done. Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.

Lua Syntax:

setSteamAchievement(apiName, {flags=1, 
    clear = true|false})

Arguments

apiName

"string" - The name of the achievement to set. This is the API name specified in the steam account.

Flags

clr/clear

If true the achievement will be cleared. Default value is false.

Return Values

success
True if the achievement was set successfully, false if the operation failed.

Examples

None.