Signals For Server

Here is a list of all the currently available signals, both callbacks and call results, in the GodotSteam Server module.


Apps

_dlc_installed

  • Triggered after the current user gains ownership of DLC and that DLC is installed.
  • Emits signal dlc_installed in response to function installDLC.
  • Sends back the following data:
    • appID (int)

_file_details_result

  • Called after requesting the details of a specific file.
  • Emits signal file_details_result in response to function getFileDetails.
  • Sends back the following data:
    • result (int)
    • fileSize (int)
    • fileHash (PoolByteArray)
    • flags (int)

_new_launch_url_parameters

  • Posted after the user executes a steam url with command line or query parameters such as steam://run/(appid)//?param1=value1;param2=value2;param3=value3; while the game is already running. The new params can be queried with getLaunchCommandLine and getLaunchQueryParam.
  • Emits signal new_launch_url_parameters in response to function getLaunchCommandLine.
  • Sends back no data.

_new_launch_query_parameters

  • Posted after the user executes a steam url with query parameters such as steam://run/(appid)//?param1=value1;param2=value2;param3=value3; while the game is already running. The new params can be queried with getLaunchQueryParam.
  • ISSUE: when compiling says it is an undeclared identifier
  • Emits signal new_launch_query_parameters in response to function getLaunchQueryParam.
  • Sends back no data.

HTTP

_http_request_completed

  • Result when an HTTP request completes. If you're using GetHTTPStreamingResponseBodyData then you should be using the HTTPRequestHeadersReceived_t or HTTPRequestDataReceived_t.
  • Emits signal http_request_completed in response to function SendHTTPRequest or SendHTTPRequestAndStreamResponse.
  • Sends back the following data:
    • cookieHandle (int)
    • contextValue (int)
    • requestSuccess (bool)
    • statusCode (int)
    • bodySize (int)

_http_request_data_received

  • Triggered when a chunk of data is received from a streaming HTTP request.
  • Emits signal http_request_data_received in response to function SendHTTPRequestAndStreamResponse.
  • Sends back the following data:
    • cookieHandle (int)
    • contextValue (int)
    • offset (int)
    • bytesReceived (int)

_http_request_headers_received

  • Triggered when HTTP headers are received from a streaming HTTP request.
  • Emits signal http_request_headers_received in response to function SendHTTPRequestAndStreamResponse.
  • Sends back the following data:
    • cookieHandle (int)
    • contextValue (int)

Inventory

_inventory_definition_update

  • This callback is triggered whenever item definitions have been updated, which could be in response to LoadItemDefinitions or any time new item definitions are available (eg, from the dynamic addition of new item types while players are still in-game).
  • Emits signal inventory_definition_update.
  • Sends back the following data:
    • definitions (array)

_inventory_eligible_promo_item

  • Returned when you have requested the list of "eligible" promo items that can be manually granted to the given user. These are promo items of type "manual" that won't be granted automatically.
  • Emits signal inventory_eligible_promo_item in response to function RequestEligiblePromoItemDefinitionsIDs.
  • Sends back the following data:
    • result (int)
    • eligible (int)
    • cached (bool)
    • definitions (array)

_inventory_full_update

  • Triggered when GetAllItems successfully returns a result which is newer / fresher than the last known result. (It will not trigger if the inventory hasn't changed, or if results from two overlapping calls are reversed in flight and the earlier result is already known to be stale/out-of-date.) The regular SteamInventoryResultReady_t callback will still be triggered immediately afterwards; this is an additional notification for your convenience.
  • Emits signal inventory_full_update.
  • Sends back the following data:
    • inventoryHandle (int)

_inventory_result_ready

  • This is fired whenever an inventory result transitions from k_EResultPending to any other completed state, see GetResultStatus for the complete list of states. There will always be exactly one callback per handle.
  • Emits signal inventory_result_ready in response to function GetAllItems.
  • Sends back the following data:
    • handle (int)
    • result (int)

_inventory_start_purchase_result

  • Returned after StartPurchase is called.
  • Emits signal inventory_start_purchase_result.
  • Sends back the following data:
    • success or failure (string)
    • orderID (int)
    • transactionID (int)

_inventory_request_prices_result

  • Returned after RequestPrices is called.
  • Emits signal inventory_request_prices_result.
  • Sends back the following data:
    • result (int)
    • currency (int)

Networking

_p2p_session_connect_fail

  • Called when packets can't get through to the specified user. All queued packets unsent at this point will be dropped, further attempts to send will retry making the connection (but will be dropped if we fail again).
  • Emits signal p2p_session_connect_fail in response to function SendP2PPacket.
  • Sends back the following data:
    • steamIDRemote (int)
    • sessionError (int)

_p2p_session_request

  • A user wants to communicate with us over the P2P channel via the sendP2PPacket. In response, a call to acceptP2PSessionWithUser needs to be made, if you want to open the network channel with them.
  • Emits signal p2p_session_request in response to function SendP2PPacket.
  • Sends back the following data:
    • steamIDRemote (int)

Remote Storage

_unsubscribe_item

  • Called when the user has unsubscribed from a piece of UGC.
  • Emits signal unsubscribe_item in response to function UnsubscribeItem.
  • Sends back the following data:
    • result (int)
    • fileID (int)

_subscribe_item

  • Called when the user has subscribed to a piece of UGC.
  • Emits signal subscribe_item in response to function SubscribeItem.
  • Sends back the following data:
    • result (int)
    • fileID (int)

Server

_server_Connect_Failure

  • Logging the game server onto Steam.
  • Emits signal server_Connect_Failure in response to functions LogOff, LogOn, or LogOnAnonymous.
  • Sends back the following data:
    • result (int)
    • retrying (bool)

_server_Connected

  • Server has connected to the Steam back-end.
  • Emits signal server_Connected in response to functions LogOff, LogOn, or LogOnAnonymous.
  • Sends back no data.

_server_Disconnected

  • Called if the client has lost connection to the Steam servers. Real-time services will be disabled until a matching SteamServersConnected_t has been posted.
  • Emits signal server_Disconnected in response to functions LogOff, LogOn, or LogOnAnonymous.
  • Sends back the following data:
    • result (int)

_client_Approved

  • Client has been approved to connect to this game server.
  • Emits signal client_Approved in response to function SendUserConnectAndAuthenticate.
  • Sends back the following data:
    • steamID (int)
    • ownerID (int)

_client_Denied

  • Client has been denied to connection to this game server.
  • Emits signal client_Denied in response to function SendUserConnectAndAuthenticate.
  • Sends back the following data:
    • steamID (int)
    • reason (int)

_client_Kick

  • Request the game server should kick the user.
  • Emits signal client_Kick.
  • Sends back the following data:
    • steamID (int)
    • reason (int)

_policy_Response

  • Received when the game server requests to be displayed as secure (VAC protected). m_bSecure is true if the game server should display itself as secure to users, false otherwise.
  • Emits signal policy_Response in response to function Secure.
  • Sends back the following data:
    • secure (int)

_client_Group_Status

  • Sent as a reply to RequestUserGroupStatus.
  • Emits signal client_Group_Status.
  • Sends back the following data:
    • steamID (int)
    • groupID (int)
    • member (bool)
    • officer (bool)

_associate_Clan

  • Sent as a reply to AssociateWithClan.
  • Emits signal associate_Clan.
  • Sends back the following data:
    • result (int)

_player_Compat

  • Sent as a reply to ComputeNewPlayerCompatibility.
  • Emits signal player_Compat.
  • Sends back the following data:
    • result (int)
    • playersDontLikeCandidate (int)
    • playersCandidateDoesntLike (int)
    • clanPlayersDontLikeCandidate (int)
    • steamID (int)

Server Stats

_stat_received

  • Result when getting the latests stats and achievements for a user from the server.
  • Emits signal stat_received in response to function RequestUserStats.
  • Sends back the following data:
    • result (int)
    • steamID (int)

_stats_stored

  • Result of a request to store the user stats.
  • Emits signal stats_stored in response to function StoreUserStats.
  • Sends back the following data:
    • result (int)
    • steamID (int)

_stats_unloaded

  • Callback indicating that a user's stats have been unloaded.
  • Emits signal stats_unloaded.
  • Sends back the following data:
    • steamID (int)

UGC

_add_app_dependency_result

  • The result of a call to AddAppDependency.
  • Emits signal add_app_dependency_result.
  • Sends back the following data:
    • result (int)
    • fileID (int)
    • appID (int)

_add_ugc_dependency_result

  • The result of a call to AddDependency.
  • Emits signal add_ugc_dependency_result.
  • Sends back the following data:
    • result (int)
    • fileID (int)
    • childID (int)

_item_created

  • Result of a workshop item being created.
  • Emits signal item_created.
  • Sends back the following data:
    • result (int)
    • fileID (int)
    • acceptTOS (bool)

_item_downloaded

  • Called when a workshop item has been downloaded.
  • Emits signal item_downloaded.
  • Sends back the following data:
    • result (int)
    • fileID (int)
    • appID (int)

_get_app_dependencies_result

  • Called when getting the app dependencies for an item.
  • Emits signal get_app_dependencies_result.
  • Sends back the following data:
    • result (int)
    • fileID (int)
    • appID (array) - Currently omitted
    • appDependencies (int)
    • totalAppDependencies (int)

_item_deleted

  • Called when an attempt at deleting an item completes.
  • Emits signal item_deleted.
  • Sends back the following data:
    • result (int)
    • fileID (int)

_get_item_vote_result

  • Called when getting the users vote status on an item.
  • Emits signal get_item_vote_result.
  • Sends back the following data:
    • result (int)
    • fileID (int)
    • voteUp (bool)
    • voteDown (bool)
    • voteSkipped (bool)

_item_installed

  • Called when a workshop item has been installed or updated.
  • Emits signal item_installed.
  • Sends back the following data:
    • appID (int)
    • fileID (int)

_remove_app_dependency_result

  • Purpose: The result of a call to RemoveAppDependency.
  • Emits signal remove_app_dependency_result.
  • Sends back the following data:
    • result (int)
    • fileID (int)
    • appID (int)

_remove_ugc_dependency_result

  • Purpose: The result of a call to RemoveDependency.
  • Emits signal remove_ugc_dependency_result.
  • Sends back the following data:
    • result (int)
    • fileID (int)
    • childID (int)

_set_user_item_vote

  • Called when the user has voted on an item.
  • Emits signal set_user_item_vote.
  • Sends back the following data:
    • result (int)
    • fileID (int)
    • voteUp (bool)

_start_playtime_tracking

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

_ugc_query_completed

  • Called when a UGC query request completes.
  • Emits signal ugc_query_completed.
  • Sends back the following data:
    • handle (int)
    • result (int)
    • resultsReturned (int)
    • totalMatching (int)
    • cached (bool)

_stop_playtime_tracking

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

_item_updated

  • Result of a workshop item being updated.
  • Emits signal item_updated.
  • Sends back the following data:
    • result (int)
    • acceptTOS (bool)

_user_favorite_items_list_changed

  • Called when the user has added or removed an item to/from their favorites.
  • Emits signal user_favorite_items_list_changed.
  • Sends back the following data:
    • result (int)
    • fileID (int)
    • wasAddRequest (bool)

Utility

_check_file_signature

  • CallResult for checkFileSignature.
  • Emits signal check_file_signature.
  • Sends back the following data:
    • signature (string)

_gamepad_text_input_dismissed

  • Called when the Big Picture gamepad text input has been closed.
  • Emits signal gamepad_text_input_dismissed.
  • Sends back the following data:
    • text (string)
    • length (int)

_ip_country

  • Called when the country of the user changed. The country should be updated with getIPCountry.
  • Emits signal ip_country.
  • Sends back no data.

_low_power

  • Called when running on a laptop and less than 10 minutes of battery is left, and then fires then every minute afterwards.
  • Emits signal low_power.
  • Sends back the following data:
    • power (int)

_steam_api_call_completed

  • Called when a SteamAPICall_t has completed (or failed).
  • Emits signal steam_api_call_completed.
  • Sends back the following data:
    • asyncCall (int)
    • callback (int)
    • parameter (int)

_steam_shutdown

  • Called when Steam wants to shutdown.
  • Emits signal steam_showdown.
  • Sends back no data.