HBSteamLobby
Inherits: RefCounted < Object
Class representing a Steam lobby.
Properties
Methods
create_lobby ( LobbyType lobby_type, int max_members ) static |
|
get_member_data ( HBSteamFriend member, String key ) const |
|
void |
join_lobby ( ) |
set_lobby_owner ( HBSteamFriend owner ) |
Signals
chat_message_received ( HBSteamFriend sender, PackedByteArray data )
Emitted when a chat message is received.
lobby_created ( int result )
Emitted when lobby creation has completed.
lobby_data_updated ( )
Emitted when the per-lobby custom data has changed.
lobby_entered ( bool success )
Emitted when the user has entered the lobby.
lobby_member_data_updated ( HBSteamFriend member )
Emitted when the per-lobby member custom data has changed.
member_joined ( HBSteamFriend new_member )
Emitted when a new member enters the lobby.
member_left ( HBSteamFriend new_member )
Emitted when a new member leaves the lobby.
Property Descriptions
int max_members
Maximum number of members that can join this lobby.
Note: Can only be set by the owner of the lobby.
HBSteamFriend owner
HBSteamFriend get_owner ( )
Current owner of the lobby.
Method Descriptions
HBSteamLobby create_lobby ( LobbyType lobby_type, int max_members ) static
Creates a lobby of a given type with a maximum amount of members.
HBSteamLobby from_id ( int lobby_id ) static
Creates a steam lobby from a given ID.
String get_data ( String key ) const
Returns custom data that was set on this lobby.
String get_member_data ( HBSteamFriend member, String key ) const
Returns member-specific custom data.
void join_lobby ( )
Joins this lobby.
bool set_data ( String key, String value )
Sets custom data for this lobby, can only be done by the owner.
Note: Can only be set by the owner of the lobby.
bool set_lobby_owner ( HBSteamFriend owner )
Sets the owner of the lobby.