Difference between revisions of "SetSteamStat"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 1: Line 1:
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<b>Command History</b>
+
<span class="bold">Command History</span>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
+
<div class="alt-bg">Available since v3.7</div>
 
</div></div>
 
</div></div>
  
  
 
Sets the specified steam stat to the given value!
 
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%">
+
<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<b>Additional Info</b>
+
<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 27: Line 27:
  
  
<b><u>Arguments</u></b>
+
<span class="bold underline">Arguments</span>
  
apiName: "string" <br/>
+
<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)
 
The name of the stat to set (this is the API name specified in the steam account for your game)
  
value: integer (number) <br/>
+
<span class="bold">value</span>: integer (number) <br/>
 
The included stat will be set to the listed value!
 
The included stat will be set to the listed value!
  
Flags: none
 
  
Return: success <br/>
+
<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!
 
True if the value was set successfully, false if the operation failed!
{{i18n|SetSteamStat}}
+
{{i18n|SetSteamStat}} <br/>
 +
{| class="tbl-ds"
 +
|-
 +
|<span class="bold">Relevant Pages</span>: [[GetSteamAchievement|getSteamAchievement]] - [[GetSteamStat|getSteamStat]] - [[ResetSteamStats|resetSteamStats]] - [[SetSteamAchievement|setSteamAchievement]]
 +
|}

Revision as of 18:49, 3 April 2013

Command History

Available since v3.7


Sets the specified steam stat to the given value!

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:

setSteamStat(apiName, value)


Example:

n/a


Arguments

apiName: "string"
The name of the stat to set (this is the API name specified in the steam account for your game)

value: integer (number)
The included stat will be set to the listed value!


Flags

none


Return

success
True if the value was set successfully, false if the operation failed!


Relevant Pages: getSteamAchievement - getSteamStat - resetSteamStats - setSteamAchievement