Stats API Reference
This section documents all Stats Blueprint nodes provided by PloxTools: Steam Integration.
All functions require Steam to be initialized unless stated otherwise.
Getters
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Get Steam Stat Int | StatName (string) |
int32 Success: bool |
Returns the value of an integer Steam stat. Success is false when the stat cannot be read, allowing a real value of 0 to be distinguished from an error. |
| Get Steam Stat Float | StatName (string) |
float Success: bool |
Returns the value of a float Steam stat. Success is false when the stat cannot be read, allowing a real value of 0 to be distinguished from an error. |
Stats
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Set Steam Stat Int | StatName (string)Value (int32) |
bool | Sets the value of an integer Steam stat locally. Returns false if Steam rejects the operation. Call Store Steam Stats to sync with Steam. |
| Set Steam Stat Float | StatName (string)Value (float) |
bool | Sets the value of a float Steam stat locally. Returns false if Steam rejects the operation. Call Store Steam Stats to sync with Steam. |
| Increment Steam Stat Int | StatName (string)Delta (int32) |
bool | Increments an integer Steam stat locally. Returns false if the stat cannot be read or Steam rejects the new value. Call Store Steam Stats to sync with Steam. |
| Increment Steam Stat Float | StatName (string)Delta (float) |
bool | Increments a float Steam stat locally. Returns false if the stat cannot be read or Steam rejects the new value. Call Store Steam Stats to sync with Steam. |
| Store Steam Stats | – | On Success On Failure (Error Message: string) |
Uploads all modified Steam stats to the Steam backend. Concurrent Store Stats and Reset All Stats requests are processed in order. |
Reset
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Reset All Steam Stats | bAchievementsToo (bool) |
On Success On Failure (Error Message: string) |
Resets all Steam stats for the local user, optionally including achievements, then stores the changes. Concurrent write requests are processed in order. |