Difference between revisions of "SetSteamStat"

Latest revision as of 21:28, 30 September 2014

setSteamStat

Available since: v3.6

Sets the specified steam stat to the given value. Note: this command only works if the steam_api library was loaded and if a steam account for your game exists.

Lua Syntax:

setSteamStat(apiName, value)

Arguments

apiName

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

value

int - Stat will be set to this value.

Flags

Return Values

success: True if the value 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%">
+==setSteamStat==
-<b>Command History</b>
-<div class="mw-collapsible-content">
-<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
-</div></div>
+<div class="command-min-version-info">Available since: <span class="command-min-version">v3.6</span></div>
-Sets the specified steam stat to the given value!
+<div class="command-doc">Sets the specified steam stat to the given value.
-<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
-<b>Additional Info</b>
-<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></div>
+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:
-<syntaxhighlight>
+<pre class="command-syntax">setSteamStat(apiName, value)</pre>
-setSteamStat(apiName, value)
+===Arguments===
-</syntaxhighlight>
+====apiName====
+:'''"string"''' - The name of the stat to set. This is the API name specified in the steam account.
+====value====
-Example:
+:'''int''' - Stat will be set to this value.
-<syntaxhighlight>
+===Flags===
-n/a
+===Return Values===
-</syntaxhighlight>
+;success
+:True if the value was set successfully, false if the operation failed.
+===Examples===
+None.
-<b><u>Arguments</u></b>
-apiName: "string" <br/>
-The name of the stat to set (this is the API name specified in the steam account for your game)
-value: integer (number) <br/>
-The included stat will be set to the listed value!
-Flags: none
-Return: success <br/>
-True if the value was set successfully, false if the operation failed!
-{{i18n|SetSteamStat}}