Signals | UGC

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


add_app_dependency_result

  • The result of a call to addAppDependency.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • app_id (int)
    • result (int)
    • file_id (uint64_t)
    • app_id (uint32_t)

add_ugc_dependency_result

  • The result of a call to AddDependency.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • child_id (int)
    • result (int)
    • file_id (uint64_t)
    • child_id (uint32_t)

item_created

  • Called when a new workshop item has been created.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • accept_tos (bool)
    • result (int)
    • file_id (uint64_t)
    • accept_tos (bool)

item_downloaded

  • Called when a workshop item has been downloaded.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • app_id (int)
    • result (int)
    • file_id (uint64_t)
    • app_id (uint32_t)

get_app_dependencies_result

  • Called when getting the app dependencies for an item.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • app_dependencies (int)
    • total_app_dependencies (int)
    • result (int)
    • file_id (uint64_t)
    • app_dependencies (uint32)
    • total_app_dependencies (uint32)

item_deleted

  • Called when an attempt at deleting an item completes.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • result (int)
    • file_id (uint64_t)

get_item_vote_result

  • Called when getting the users vote status on an item.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • vote_up (bool)
    • vote_down (bool)
    • vote_skipped (bool)
    • result (int)
    • file_id (uint64_t)
    • vote_up (bool)
    • vote_down (bool)
    • vote_skipped (bool)

item_installed

  • Called when a workshop item has been installed or updated.
  • Sends back the following data:
    • app_id (int)
    • file_id (int)
    • app_id (uint32_t)
    • file_id (uint64_t)

remove_app_dependency_result

  • Purpose: The result of a call to removeAppDependency.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • app_id (int)
    • result (int)
    • file_id (uint64_t)
    • app_id (uint32_t)

remove_ugc_dependency_result

  • Purpose: The result of a call to removeDependency.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • child_id (int)
    • result (int)
    • file_id (uint64_t)
    • child_id (uint64_t)

set_user_item_vote

  • Called when the user has voted on an item.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • vote_up (bool)
    • result (int)
    • file_id (uint64_t)
    • vote_up (bool)

start_playtime_tracking

  • Called when workshop item playtime tracking has started.
  • Sends back the following data:
    • result (int)

ugc_query_completed

  • Called when a UGC query request completes.
  • Sends back the following data:
    • handle (int)
    • result (int)
    • results_returned (int)
    • total_matching (int)
    • cached (bool)
    • handle (uint64_t)
    • result (int)
    • results_returned (uint32)
    • total_matching (uint32)
    • cached (bool)

stop_playtime_tracking

  • Called when workshop item playtime tracking has stopped.
  • Sends back the following data:
    • result (int)

item_updated

  • Called when an item update has completed.
  • Emits signal in response to function submitItemUpdate.
  • Sends back the following data:
    • result (int)
    • accept_tos (bool)

user_favorite_items_list_changed

  • Called when the user has added or removed an item to/from their favorites.
  • Sends back the following data:
    • result (int)
    • file_id (int)
    • was_add_request (bool)
    • result (int)
    • file_id (uint64_t)
    • was_add_request (bool)

user_subscribed_items_list_changed

  • Signal that the list of subscribed items changed.
  • Sends back the following data:
    • app_id (int)
    • app_id (uint32)

workshop_eula_status

  • Status of the user's acceptable/rejection of the app's specific Workshop EULA.
  • Sends back the following data:
    • result (int)
    • app_id (int)
    • eula_data (dictionary)
      • version (int)
      • action (int)
      • accepted (bool)
      • needs_action (bool)
    • result (int)
    • app_id (uint32)
    • eula_data (dictionary)
      • version (uint32)
      • action (uint32)
      • accepted (bool)
      • needs_action (bool)