Difference between revisions of "SetSteamAchievement"

Latest revision as of 22:28, 30 September 2014

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.

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+==setSteamAchievement==
-<b>History Changelog</b>:
-<div class="mw-collapsible-content">
-Available since <span style="color:green">v3.7</span>
-</div></div>
-Gets current state of a steam achievement!
+<div class="command-min-version-info">Available since: <span class="command-min-version">v3.6</span></div>
-{| class="mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
-! 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:
+<div class="command-doc">Sets an achievement to done.
-<syntaxhighlight>
-getSteamAchievement(apiName)
-</syntaxhighlight>
-Example:
+Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.</div>
-<syntaxhighlight>
-n/a
-</syntaxhighlight>
+Lua Syntax:
+<pre class="command-syntax">setSteamAchievement(apiName, {flags=1,
+    clear = true|false})</pre>
+===Arguments===
+====apiName====
+:'''"string"''' - The name of the achievement to set. This is the API name specified in the steam account.
+===Flags===
+====clr/clear====
-<b><u>Arguments</u></b>
+:If true the achievement will be cleared. Default value is false.
+===Return Values===
-apiName: "string" <br/>
+;success
-The name of the requested achievement (this is the API name specified in the steam account for your game)
+:True if the achievement was set successfully, false if the operation failed.
+===Examples===
-Flags: none
+None.
-Return: achievement <br/>
-True/false depending if the achievement is set or not, false if the operation failed
-{{i18n|SetSteamAchievement}}