Difference between revisions of "GetSteamAchievement"

Latest revision as of 23:01, 30 April 2015

getSteamAchievement

WARNING: has been removed with 4.2 use

REDIRECT GetGameClientAchievement

instead

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.

@@ Line 1: / Line 1: @@
-<b>History</b>: Available since <span style="color:green">v3.7</span>
+==getSteamAchievement==
-Gets current state of a steam achievement!
+WARNING: has been removed with 4.2 use
-{| class="mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+#REDIRECT [[GetGameClientAchievement]]
-! Additional Info
+instead
-|-
-|
-This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!
-|}
-Syntax:
-<syntaxhighlight>
-getSteamAchievement(apiName)
-</syntaxhighlight>
-Example:
+<div class="command-min-version-info">Available since: <span class="command-min-version">v3.6</span></div>
-<syntaxhighlight>
-n/a
-</syntaxhighlight>
+<div class="command-doc">Gets current state of an achievement.
-<b><u>Arguments</u></b>
+Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.</div>
-apiName: "string" <br/>
+Lua Syntax:
-The name of the requested achievement (this is the API name specified in the steam account for your game)
+<pre class="command-syntax">getSteamAchievement(apiName)</pre>
+===Arguments===
-Flags: none
+====apiName====
+:'''"string"''' - The name of the requested achievement. This is the API name specified in the steam account.
-Return: achievement <br/>
+===Flags===
-True/false depending if the achievement is set or not, false if the operation failed
+===Return Values===
-{{i18n|GetSteamAchievement}}
+;achievement
+:True/false depending if the achievement is set or not, false if the operation failed.
+===Examples===
+None.