Game Server Stats

Functions to allow game servers to set stats and achievements on players.

Only available in the GodotSteam Server branches

Functions

clearUserAchievement

clearUserAchievement( uint64_t steam_id, string name )

Resets the unlock status of an achievement for the specified user. This is primarily only ever used for testing. You must have called requestUserStats and it needs to return successfully via its callback prior to calling this. This call only modifies Steam's in-memory state and is very cheap. To submit the stats to the server you must call storeUserStats.

Returns: bool

Note: This will work only on achievements that game servers are allowed to set. If the "Set By" field for this achievement is "Official GS" then only game servers that have been declared as officially controlled by you will be able to set it. To do this you must set the IP range of your official servers in the Dedicated Servers section of App Admin.

serverGetUserAchievement

serverGetUserAchievement( uint64_t steam_id, string name )

Gets the unlock status of the Achievement.

Returns: dictionary

Contains the following keys:

result (bool)
user (int) as Steam ID
name (string)
unlocked (bool

serverGetUserStatFloat

serverGetUserStatFloat( uint64_t steam_id, string name )

Gets the current value of the a stat for the specified user.

Returns: float

serverGetUserStatInt

serverGetUserStatInt( uint64_t steam_id, string name )

Gets the current value of the a stat for the specified user.

Returns: uint32

requestUserStats

requestUserStats( uint64_t steam_id )

Asynchronously downloads stats and achievements for the specified user from the server. These stats will only be auto-updated for clients currently playing on the server. For other users you'll need to call this function again to refresh any data.

Triggers a stats_received call result.

Returns: void

setUserAchievement

setUserAchievement( uint64_t steam_id, string name )

Unlocks an achievement for the specified user. You must have called requestUserStats and it needs to return successfully via its callback prior to calling this! This call only modifies Steam's in-memory state and is very cheap. To submit the stats to the server you must call storeUserStats.

Returns: bool

This function returns true upon success if all of the following conditions are met; otherwise, false.

The specified achievement "API Name" exists in App Admin on the Steamworks website, and the changes are published.
requestUserStats has completed and successfully returned its callback for the specified user.
The stat must be allowed to be set by game server.

Note: These updates will work only on stats that game servers are allowed to edit. If the "Set By" field for this stat is "Official GS" then only game servers that have been declared as officially controlled by you will be able to set it. To do this you must set the IP range of your official servers in the Dedicated Servers section of App Admin.

setUserStatFloat

setUserStatFloat( uint64_t steam_id, string name, float stat )

Sets / updates the value of a given stat for the specified user. You must have called requestUserStats and it needs to return successfully via its callback prior to calling this. This call only modifies Steam's in-memory state and is very cheap. To submit the stats to the server you must call storeUserStats.

Returns: bool

This function returns true upon success if all of the following conditions are met; otherwise, false.

The specified stat exists in App Admin on the Steamworks website, and the changes are published.
requestUserStats has completed and successfully returned its callback for the specified user.
The type passed to this function must match the type listed in the App Admin panel of the Steamworks website.
The stat must be allowed to be set by game server.

Note: These updates will work only on stats that game servers are allowed to edit. If the "Set By" field for this stat is "Official GS" then only game servers that have been declared as officially controlled by you will be able to set it. To do this you must set the IP range of your official servers in the Dedicated Servers section of App Admin.

setUserStatInt()

setUserStatInt( uint64_t steam_id, string name, int stat )

Sets / updates the value of a given stat for the specified user. You must have called requestUserStats and it needs to return successfully via its callback prior to calling this. This call only modifies Steam's in-memory state and is very cheap. To submit the stats to the server you must call storeUserStats.

Returns: bool

This function returns true upon success if all of the following conditions are met; otherwise, false.

The specified stat exists in App Admin on the Steamworks website, and the changes are published.
requestUserStats has completed and successfully returned its callback for the specified user.
The type passed to this function must match the type listed in the App Admin panel of the Steamworks website.
The stat must be allowed to be set by game server.

Note: These updates will work only on stats that game servers are allowed to edit. If the "Set By" field for this stat is "Official GS" then only game servers that have been declared as officially controlled by you will be able to set it. To do this you must set the IP range of your official servers in the Dedicated Servers section of App Admin.

storeUserStats

storeUserStats( uint64_t steam_id )

Send the changed stats and achievements data to the server for permanent storage for the specified user. If this fails then nothing is sent to the server. It's advisable to keep trying until the call is successful. This call can be rate limited. Call frequency should be on the order of minutes, rather than seconds. You should only be calling this during major state changes such as the end of a round, the map changing, or the user leaving a server. If you have stats or achievements that you have saved locally but haven't uploaded with this function when your application process ends then this function will automatically be called. You can find additional debug information written to the %steam_install%\logs\stats_log.txt file.

Triggers a stats_stored callback.

Returns: void

updateUserAvgRateStat

updateUserAvgRateStat( uint64_t steam_id, string name, float this_session, double session_length )

Updates an AVGRATE stat with new values for the specified user. You must have called requestUserStats and it needs to return successfully via its callback prior to calling this. This call only modifies Steam's in-memory state and is very cheap. To submit the stats to the server you must call storeUserStats.

Returns: bool

This function returns true upon success if all of the following conditions are met; otherwise, false.

The specified stat exists in App Admin on the Steamworks website, and the changes are published.
requestUserStats has completed and successfully returned its callback for the specified user.
The type must be AVGRATE in the Steamworks Partner backend.
The stat must be allowed to be set by game server.

Signals

These callbacks require you to run Steam.run_callbacks() in your _process() function to receive them.

stats_received

Result when getting the latests stats and achievements for a user from the server.

Emits signal in response to function requestUserStats.

Returns:

result (int)
steam_id (uint64_t)

stats_stored

Result of a request to store the user stats.

Emits signal in response to function storeUserStats.

Returns:

result (int)
steam_id (uint64_t)

stats_unloaded

Callback indicating that a user's stats have been unloaded.

Returns:

steam_id (uint64_t)