Signals | User Stats

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


global_achievement_percentages_ready

  • Called when the global achievement percentages have been received from the server.
  • Sends back the following data:
    • game (int)
    • result (int)
    • game (uint64_t)
    • result (uint32_t)

global_stats_received

  • Called when the global stats have been received from the server.
  • Sends back the following data:
    • game_id (int)
    • result (string)
    • game_id (uint64_t)
    • result (string)

leaderboard_find_result

  • Result when finding a leaderboard.
  • Sends back the following data:
    • leaderboard_handle (int)
    • found (int)
    • 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.
  • Sends back the following data:
    • message (string)
    • this_handle (int)
    • leaderboard_entries_array (array)
      • entryDict (dictionary)
        • score (int)
        • steam_id (int)
        • global_rank (int)
        • ugc_handle (int)
        • details (array)
    • message (string)
    • this_handle (uint64_t)
    • leaderboard_entries_array (array)
      • entryDict (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.
  • Sends back the following data:
    • success (int)
    • this_handle (int)
    • score (int)
    • score_changed (int)
    • global_rank_new (int)
    • global_rank_prev (int)
    • success (uint8)
    • this_handle (uint64_t)
    • 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.
  • Sends back the following data:
    • leaderboard_handle (int)
    • result (int)
    • leaderboard_handle (uint64_t)
    • result (int)

number_of_current_players

  • Gets the current number of players for the current app ID.
  • Sends back the following data:
    • success (int)
    • players (int)
    • 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.
  • Sends back the following data:
    • game (int)
    • group_achieve (bool)
    • name (string)
    • current_progress (int)
    • max_progress (int)
    • game (uint64_t)
    • group_achieve (bool)
    • name (string)
    • current_progress (uint32_t)
    • max_progress (uint32_t)

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.
  • Sends back the following data:
    • game (int)
    • result (int)
    • user (int) as Steam ID
    • game (uint64_t)
    • result (uint32_t)
    • user (uint64_t) as Steam ID

user_stats_received

  • Called when the latest stats and achievements for a specific user (including the local user) have been received from the server.
  • Sends back the following data:
    • game (int)
    • result (int)
    • user (int) as Steam ID
    • game (uint64_t)
    • result (uint32_t)
    • user (uint64_t) as Steam ID

user_stats_stored

  • Result of a request to store the user stats.
  • Sends back the following data:
    • game (int)
    • result int)
    • 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.
  • Sends back the following data:
    • user (int)
    • user (uint64_t) as Steam ID