Skip to content

Signals - User

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


duration_control

duration_control

Sent for games with enabled anti indulgence / duration control, for enabled users. Lets the game know whether persistent rewards or XP should be granted at normal rate, half rate, or zero rate.

Returns:

  • result (int)
  • duration (dictionary)
    • app_id (uint32)
    • applicable (bool)
    • seconds_last_5hrs (int32)
    • progress (int)
    • notification (int)
    • notification_verbal (string)

Read more in the official Steamworks SDK documentation

client_game_server_deny

client_game_server_deny

Sent by the Steam server to the client telling it to disconnect from the specified game server, which it may be in the process of or already connected to. The game client should immediately disconnect upon receiving this message. This can usually occur if the user doesn't have rights to play on the game server.

Returns:

  • app_id (uint32)
  • ip (string)
  • server_port (uint16)
  • secure (uint16)
  • reason (uint32)

Read more in the official Steamworks SDK documentation

encrypted_app_ticket_response

encrypted_app_ticket_response

Returns:

  • result (string)

Read more in the official Steamworks SDK documentation

game_web_callback

game_web_callback

Sent to your game in response to a steam://gamewebcallback/ command from a user clicking a link in the Steam overlay browser. You can use this to add support for external site signups where you want to pop back into the browser after some web page signup sequence, and optionally get back some detail about that.

Returns:

  • url (string)

Read more in the official Steamworks SDK documentation

get_auth_session_ticket_response

get_auth_session_ticket_response

Result when creating an auth session ticket.

Returns:

  • auth_ticket (uint32)
  • result (int)

Read more in the official Steamworks SDK documentation

ipc_failure

ipc_failure

Called when the callback system for this client is in an error state (and has flushed pending callbacks). When getting this message the client should disconnect from Steam, reset any stored Steam state and reconnect. This usually occurs in the rare event the Steam client has some kind of fatal error.

Returns:

  • type (uint8)

Read more in the official Steamworks SDK documentation

licenses_updated

licenses_updated

Called whenever the users licenses (owned packages) changes.

Returns: nothing


Read more in the official Steamworks SDK documentation

microtransaction_auth_response

microtransaction_auth_response

Called when a user has responded to a microtransaction authorization request.

Returns:

  • app_id (uint32)
  • order_id (uint64_t)
  • authorized (bool)

Read more in the official Steamworks SDK documentation

steam_server_connect_failed

steam_server_connect_failed

Called when a connection attempt has failed. This will occur periodically if the Steam client is not connected, and has failed when retrying to establish a connection.

Returns:

  • result (int)
  • retrying (bool)

Read more in the official Steamworks SDK documentation

steam_server_connected

steam_server_conn

Called when a connections to the Steam back-end has been established. This means the Steam client now has a working connection to the Steam servers. Usually this will have occurred before the game has launched, and should only be seen if the user has dropped connection due to a networking issue or a Steam server update.

Returns: nothing


Read more in the official Steamworks SDK documentation

steam_server_disconnected

steam_server_disconnected

Called if the client has lost connection to the Steam servers. Real-time services will be disabled until a matching steam_server_connected has been posted.

Returns: nothing


Read more in the official Steamworks SDK documentation

store_auth_url_response

store_auth_url_response

Response when we have recieved the authentication URL after a call to requestStoreAuthURL.

Returns:

  • url (string)

Read more in the official Steamworks SDK documentation

validate_auth_ticket_response

validate_auth_ticket_response

Called when an auth ticket has been validated.

Emits signal in response to function beginAuthSession.

Returns:

  • auth_id (uint64_t)
  • response (uint32_t)
  • owner_id (uint64_t)

Read more in the official Steamworks SDK documentation