Difference between revisions of "GetSteamStat"

Revision as of 18:26, 11 March 2013

Command History

Available since v3.7

Returns the requested steam stat!

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:

getSteamStat(apiName)

Example:

n/a

Arguments

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

Flags: none

Return: stat
The integer value of the stat or -1 if the stat could not be retrieved

日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский

@@ Line 6: / Line 6: @@
-Returns the number of milliseconds since the command was first called - or since the timer was reset! <br/>
+Returns the requested steam stat!
-Use this command for relative time measurements; for example: call getTime() at the beginning of an action & then again when the action has finished to get the time taken to perform said action!
 <div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
 <b>Additional Info</b>
@@ Line 17: / Line 16: @@
 Syntax:
 <syntaxhighlight>
-getTime({flags=1, reset})
+getSteamStat(apiName)
 </syntaxhighlight>
@@ Line 23: / Line 22: @@
 Example:
 <syntaxhighlight>
--- let's store the current time in a variable & then check it against current time!
+n/a
-local initialTime = getTime()
--- we'll use this function to check current time elapsed & decided what action to perform!
-function checkTime()
- if getTime() >= initialTime + 3000 then -- if current time more than equals initial time + 3 seconds then ...
-  -- do some action!
-  getTime({flags=1, reset=true}) -- let's reset timer back to zero!
- end
-end
--- the checkTime() function would be most effective, if included in a mainLoop event handler!
 </syntaxhighlight>
@@ Line 41: / Line 29: @@
 <b><u>Arguments</u></b>
-none
+apiName: "string" <br/>
+The name of the requested stat (this is the API name specified in the steam account for your game)
-<b><u>Flags</u></b>
-<b>r/reset</b> <br/>
-True resets timer back to zero; false does nothing (if no flags are set then reset will be false by default)
-<b><u>Return</u></b>
+Flags: none
-<b>time</b> <br/>
+Return: stat <br/>
-The integer value of the current time (in ms)
+The integer value of the stat or -1 if the stat could not be retrieved
-{{i18n|GetTime}}
+{{i18n|GetSteamStat}}