Difference between revisions of "SetSteamAchievement"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 1: | Line 1: | ||
| − | <div class="toccolours mw-collapsible mw-collapsed" | + | <div class="toccolours mw-collapsible mw-collapsed tbl-ds"> |
| − | + | <span class="bold">Command History</span> | |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
| − | <div | + | <div class="alt-bg">Available since v3.7</div> |
</div></div> | </div></div> | ||
Gets current state of a steam achievement! | Gets current state of a steam achievement! | ||
| − | <div class="toccolours mw-collapsible mw-collapsed" | + | <div class="toccolours mw-collapsible mw-collapsed tbl-ds"> |
| − | + | <span class="bold">Additional Info</span> | |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
<div>This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!</div> | <div>This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!</div> | ||
| Line 22: | Line 22: | ||
Example: | Example: | ||
<syntaxhighlight> | <syntaxhighlight> | ||
| − | + | -- to do! | |
</syntaxhighlight> | </syntaxhighlight> | ||
| − | < | + | <span class="bold underline">Arguments</span> |
| − | apiName: "string" <br/> | + | <span class="bold">apiName</span>: "string" <br/> |
The name of the requested achievement (this is the API name specified in the steam account for your game) | The name of the requested achievement (this is the API name specified in the steam account for your game) | ||
| − | Flags | + | |
| + | <span class="bold underline">Flags</span> | ||
| + | |||
| + | <span class="bold">clr/clear</span>: boolean (true/false) <br/> | ||
If true the achievement will be cleared. Default value is false! | If true the achievement will be cleared. Default value is false! | ||
| − | Return | + | |
| + | <span class="bold underline">Return</span> | ||
| + | |||
| + | <span class="bold">success</span> <br/> | ||
True if the achievement was set successfully, false if the operation failed! | True if the achievement was set successfully, false if the operation failed! | ||
| − | {{i18n|SetSteamAchievement}} | + | {{i18n|SetSteamAchievement}} <br/> |
| + | {| class="tbl-ds" | ||
| + | |- | ||
| + | |<span class="bold">Relevant Pages</span>: [[GetSteamAchievement|getSteamAchievement]] - [[GetSteamStat|getSteamStat]] - [[ResetSteamStats|resetSteamStats]] - [[SetSteamStat|setSteamStat]] | ||
| + | |} | ||
Revision as of 18:39, 3 April 2013
Command History
Available since v3.7
Gets current state of a steam achievement!
Additional Info
This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!
Syntax:
setSteamAchievement(apiName, {flags=1, clear = true|false})
Example:
-- to do!
Arguments
apiName: "string"
The name of the requested achievement (this is the API name specified in the steam account for your game)
Flags
clr/clear: boolean (true/false)
If true the achievement will be cleared. Default value is false!
Return
success
True if the achievement was set successfully, false if the operation failed!
|
日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский |
| Relevant Pages: getSteamAchievement - getSteamStat - resetSteamStats - setSteamStat |
