Skip to content

Stats

The Stats feature provides access to numerical Steam user statistics configured for the current application.

It supports integer and floating-point stats, local modifications, explicit synchronization to Steam, and complete stat resets for development or game-specific workflows.

Main Capabilities

  • Read integer stats
  • Read floating-point stats
  • Set integer and float values
  • Increment stats by a delta
  • Store modified stats to Steam
  • Reset all stats
  • Optionally reset achievements together with stats

Basic Workflow

A typical stat workflow is:

  1. Create the stat in Steamworks with the correct name and type.
  2. Read the current value when needed.
  3. Set or increment the local value during gameplay.
  4. Call Store Steam Stats to synchronize modified values with Steam.
  5. Handle the success or failure callback.

For Steamworks configuration, see Steamworks Setup.

For practical Blueprint workflows, see Examples.

Local Changes and Steam Storage

Set and Increment functions modify the Steam stat state locally first.

Call Store Steam Stats when you want those modified values sent to the Steam backend.

The integer and float getter functions expose a separate Success output so a valid value of 0 can be distinguished from a failed read.

Resetting Stats

Reset All Steam Stats resets the current user's stats and then stores the changes.

It can optionally reset achievements at the same time. This is especially useful during development and testing, but should be exposed to players only when that behavior is intentional for your game.

Important Notes

  • Stat names and types must match their Steamworks definitions.
  • Modified stats are not fully synchronized until Store Steam Stats succeeds.
  • Write operations are serialized by the plugin when required so overlapping store/reset requests are processed in order.
  • Resetting stats or achievements is destructive for the current user's application data.