Signals - UGC

These callbacks 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.

Returns:

result (int)
file_id (uint64_t)
app_id (uint32_t)

add_ugc_dependency_result

The result of a call to addDependency.

Returns:

result (int)
file_id (uint64_t)
child_id (uint32_t)

get_app_dependencies_result

Called when getting the app dependencies for an item.

Returns:

result (int)
file_id (uint64_t)
app_dependencies (uint32)
total_app_dependencies (uint32)

get_item_vote_result

Called when getting the users vote status on an item.

Returns:

result (int)
file_id (uint64_t)
vote_up (bool)
vote_down (bool)
vote_skipped (bool)

item_created

Called when a new workshop item has been created.

Returns:

result (int)
file_id (uint64_t)
accept_tos (bool)

item_deleted

Called when an attempt at deleting an item completes.

Returns:

result (int)
file_id (uint64_t)

item_downloaded

Called when a workshop item has been downloaded.

Returns:

result (int)
file_id (uint64_t)
app_id (uint32_t)

item_installed

Called when a workshop item has been installed or updated.

Returns:

app_id (uint32_t)
file_id (uint64_t)

item_updated

Called when an item update has completed. Emits signal in response to function submitItemUpdate.

Returns:

result (int)
accept_tos (bool)

remove_app_dependency_result

Purpose: The result of a call to removeAppDependency.

Returns:

result (int)
file_id (uint64_t)
app_id (uint32_t)

remove_ugc_dependency_result

Purpose: The result of a call to removeDependency.

Returns:

result (int)
file_id (uint64_t)
child_id (uint64_t)

set_user_item_vote

Called when the user has voted on an item.

Returns:

result (int)
file_id (uint64_t)
vote_up (bool)

start_playtime_tracking

Called when workshop item playtime tracking has started.

Returns:

result (int)

stop_playtime_tracking

Called when workshop item playtime tracking has stopped.

Returns:

result (int)

ugc_query_completed

Called when a UGC query request completes.

Returns:

handle (uint64_t)
result (int)
results_returned (uint32)
total_matching (uint32)
cached (bool)

user_favorite_items_list_changed

Called when the user has added or removed an item to/from their favorites.

Returns:

result (int)
file_id (uint64_t)
was_add_request (bool)

user_subscribed_items_list_changed

Signal that the list of subscribed items changed.

Returns:

app_id (uint32)

workshop_eula_status

Status of the user's acceptable/rejection of the app's specific Workshop EULA.

Returns:

result (int)
app_id (uint32)
eula_data (dictionary)
- version (uint32)
- action (uint32)
- accepted (bool)
- needs_action (bool)