Signals - User Stats

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

current_stats_received

Called when the latest stats and achievements for the local user have been received from the server; in response to function requestCurrentStats.

Returns:

game (uint64_t)
result (uint32_t)
user (uint64_t) as Steam ID

global_achievement_percentages_ready

Called when the global achievement percentages have been received from the server.

Returns:

game (uint64_t)
result (uint32_t)

global_stats_received

Called when the global stats have been received from the server.

Returns:

game_id (uint64_t)
result (string)

leaderboard_find_result

Result when finding a leaderboard.

Returns:

leaderboard_handle (uint64_t)
found (uint8_t)

leaderboard_scores_downloaded

Called when scores for a leaderboard have been downloaded and are ready to be retrieved.

Returns:

message (string)
- this_handle (uint64_t)
- leaderboard_entries_array (array)
  - entry_dict (dictionary)
    - score (int)
    - steam_id (uint64_t)
    - global_rank (int)
    - ugc_handle (uint64_t)
    - details (array)

leaderboard_score_uploaded

Result indicating that a leaderboard score has been uploaded.

Returns:

success (uint8)
this_handle (uint64_t)
this_score (dictionary)
- score (int32)
- score_changed (uint8)
- global_rank_new (int)
- global_rank_prev (int)

leaderboard_ugc_set

Result indicating that user generated content has been attached to one of the current user's leaderboard entries.

Returns:

leaderboard_handle (uint64_t)

number_of_current_players

Gets the current number of players for the current app ID.

Returns:

success (uint8)
players (int32)

user_achievement_stored

Result of a request to store the achievements on the server, or an "indicate progress" call. If both current progress and max progress are zero, that means the achievement has been fully unlocked.

Returns:

game (uint64_t)
group_achieve (bool)
name (string)
current_progress (uint32_t)
max_progress (uint32_t)

user_stats_received

Called when the latest stats and achievements for a specific user (including the local user) have been received from the server.

Returns:

game (uint64_t)
result (uint32_t)
user (uint64_t) as Steam ID

user_stats_stored

Result of a request to store the user stats.

Returns:

game (uint64_t)
result (uint32_t)

user_stats_unloaded

Callback indicating that a user's stats have been unloaded. Call requestUserStats again before accessing stats for this user.

Returns:

user (uint64_t) as Steam ID