Signals - Friends

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

avatar_loaded

Called when a large avatar is loaded if you have tried requesting it when it was unavailable.

Emits signal in response to function getLargeFriendAvatar, getMediumFriendAvatar, or getSmallFriendAvatar.

Returns:

avatar_id (uint64_t)
width (int)
data (PoolByteArray)

avatar_image_loaded

Called when an avatar is requested; sends back the raw Steamworks callback data compared to avatar_loaded.

Emits signal in response to function getLargeFriendAvatar, getMediumFriendAvatar, or getSmallFriendAvatar.

Returns:

avatar_id (uint64_t)
avatar_handle (uint32_t)
width (uint32_t)
height (uint32_t)

change_server_requested

This callback is made when joining a game. If the user is attempting to join a lobby, then the callback [join_requested] will be made.

Returns:

server (string)
password (string)

clan_activity_downloaded

Called when a Steam group activity has received.

Emits signal in response to function downloadClanActivityCounts.

Returns:

online (int)
in_game (int)
chatting (int)

connected_chat_join

Called when a user has joined a Steam group chat that the we are in.

Returns:

chat_id (uint64_t)
steam_id (uint64_t)

connected_chat_leave

Called when a user has left a Steam group chat that the we are in.

Returns:

chat_id (uint64_t)
steam_id (uint64_t)
kicked (bool)
dropped (bool)

connected_clan_chat_message

Called when a chat message has been received in a Steam group chat that we are in.

Returns:

chat (dictionary):
- ret (int)
- text (string)
- type (string)
- chatter (uint64_t)

connected_friend_chat_message

Called when chat message has been received from a friend.

Returns:

chat (dictionary):
- ret (int)
- text (string)

enumerate_following_list

Returns the result of enumerateFollowingList.

Returns:

message (string)
following (array)
- follow (dictionary)
  - num (int)
  - id (uint64_t)

equipped_profile_items

Call result from requestEquippedProfileItems. Also sent as a callback.

Returns:

result (int)
steam_id (uint64_t)
- profile_data (dictionary)
  - has_avatar_animated (bool)
  - has_avatar_frame (bool)
  - has_profile_modifier (bool)
  - has_profile_background (bool)
  - has_profile_mini_background (bool)

Note: GodotSteam is using the callback version.

equipped_profile_items_changed

Callback for when a user's equipped Steam Commuity profile items have changed. This can be for the current user or their friends.

Returns:

steam_id (uint64_t)

Note: GodotSteam is using the callback version.

friend_rich_presence_update

Called when rich presence data has been updated for a user, this can happen automatically when friends in the same game update their rich presence, or after a call to requestFriendRichPresence.

Returns:

steam_id (uint64_t)
app_id (uint32)

get_follower_count

Returns the result of getFollowerCount.

Returns:

result (int)
steam_id (uint64_t)
count (int)

is_following

Returns the result of isFollowing.

Returns:

result (int)
steam_id (uint64_t)
following (bool)

join_clan_chat_complete

Posted when the user has attempted to join a Steam group chat via joinClanChatRoom.

Returns:

chat_id (uint64_t)
response (int)

join_game_requested

Called when the user tries to join a game from their friends list or after a user accepts an invite by a friend with inviteUserToGame.

Emits signal in response to receiving a Steam invite.

Returns:

user (uint64_t)
connect (string)

join_requested

Called when the user tries to join a lobby from their friends list or after a user accepts an invite by a friend with inviteUserToGame.

Emits signal in response to receiving a Steam invite.

Returns:

lobby (uint64_t)
steam_id (uint64_t)

name_changed

Reports the result of an attempt to change the current user's persona name.

Emits signal in response to function setPersonaName.

Returns:

success (bool)
local_success (bool)
result (int)

overlay_browser_protocol

Dispatched when an overlay browser instance is navigated to a protocol/scheme registered by registerProtocolInOverlayBrowser.

Returns:

uri (string)

overlay_toggled

Posted when the Steam Overlay activates or deactivates. The game can use this to be pause or resume single player games.

Returns:

toggled (bool)

persona_state_change

This is called when a user has some kind of change.

Returns:

steam_id (uint64_t)
flags (int)

request_clan_officer_list

Marks the return of a request officer list call.

Emits signal in response to function requestClanOfficerList.

Returns:

message (string)
officers_list (array)
- officer (dictionary)
  - id (uint64_t)
  - name (string)

unread_chat_messages_changed

Invoked when the status of unread messages changes

Returns: nothing