Difference between revisions of "Global Command: getGameClientStat"
From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "Returns the requested game client stat. ''Note: this command only works, if the Steam API/GOG Galaxy library was loaded and if a Steam/GOG Galaxy account for your game exists...") |
(No difference)
|
Latest revision as of 11:16, 19 May 2023
Returns the requested game client stat.
Note: this command only works, if the Steam API/GOG Galaxy library was loaded and if a Steam/GOG Galaxy account for your game exists.
| Related functions | getGameClientAchievement | getProperty | initGameClient | resetGameClientStats | setGameClientAchievement | setGameClientStat |
Syntax
getGameClientStat(apiName)
Parameters
| Parameter | Type | Description |
|---|---|---|
| apiName | string | The name of the requested stat. This is the API name specified in the Steam/GOG Galaxy account. |
Return values
| Type | Description |
|---|---|
| integer | The value of the stat or -1, if the stat could not be retrieved. |
Examples
Example 1: Get game client stat.
getGameClientStat("stat_progress")
