Difference between revisions of "SetSteamStat"

Revision as of 17:12, 22 November 2013

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 tbl-ds">
+==setSteamStat==
-<span class="bold">Command History</span>
-<div class="mw-collapsible-content">
-<div class="alt-bg">Available since v3.7</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 tbl-ds">
-<span class="bold">Additional Info</span>
-<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===
--- to do!
+===Return Values===
-</syntaxhighlight>
+;success
+:True if the value was set successfully, false if the operation failed.
+===Examples===
+None.
-<span class="bold underline">Arguments</span>
-<span class="bold">apiName</span>: "string" <br/>
-The name of the stat to set (this is the API name specified in the steam account for your game)
-<span class="bold">value</span>: integer (number) <br/>
-The included stat will be set to the listed value!
-<span class="bold underline">Flags</span>
-none
-<span class="bold underline">Return</span>
-<span class="bold">success</span> <br/>
-True if the value was set successfully, false if the operation failed!
-{{i18n|SetSteamStat}} <br/>
-{| class="tbl-ds"
-|-
-|<span class="bold">Relevant Pages</span>: [[GetSteamAchievement|getSteamAchievement]] - [[GetSteamStat|getSteamStat]] - [[ResetSteamStats|resetSteamStats]] - [[SetSteamAchievement|setSteamAchievement]]
-|}