Difference between revisions of "GetSteamAchievement"
From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 1: | Line 1: | ||
− | + | ==getSteamAchievement== | |
− | |||
− | |||
− | |||
− | |||
+ | <div class="command-min-version-info">Available since: <span class="command-min-version">v3.6</span></div> | ||
− | + | <div class="command-doc">Gets current state of an achievement. | |
− | <div class=" | ||
− | |||
− | |||
− | |||
− | |||
+ | Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.</div> | ||
− | Syntax: | + | Lua Syntax: |
− | < | + | <pre class="command-syntax">getSteamAchievement(apiName)</pre> |
− | getSteamAchievement(apiName) | + | ===Arguments=== |
− | </ | + | ====apiName==== |
− | + | :'''"string"''' - The name of the requested achievement. This is the API name specified in the steam account. | |
− | + | ===Flags=== | |
− | + | ===Return Values=== | |
− | + | ;achievement | |
− | + | :True/false depending if the achievement is set or not, false if the operation failed. | |
− | + | ===Examples=== | |
− | + | None. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | The name of the requested achievement | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | True/false depending if the achievement is set or not, false if the operation failed | ||
− | |||
− | |||
− | |||
− | |||
− |
Revision as of 17:11, 22 November 2013
getSteamAchievement
Available since: v3.6
Gets current state of an achievement.
Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.
Lua Syntax:
getSteamAchievement(apiName)
Arguments
apiName
- "string" - The name of the requested achievement. This is the API name specified in the steam account.
Flags
Return Values
- achievement
- True/false depending if the achievement is set or not, false if the operation failed.
Examples
None.