res://addons/w4gd/matchmaker/matchmaker.gd:Lobby
Inherits: RefCounted
A collection of players who are in (about to be in) a match together.
Properties
String |
||
int |
||
String |
||
bool |
||
String |
||
int |
||
Dictionary |
||
|
||
int |
Methods
delete ( ) |
|
Array |
get_players ( ) |
WebRTCMultiplayerPeer |
|
bool |
is_creator ( ) |
bool |
is_deleted ( ) |
bool |
is_subscribed ( ) |
leave ( ) |
|
save ( ) |
|
void |
subscribe ( ) |
void |
unsubscribe ( ) |
Signals
deleted ( )
Emitted when the lobby is deleted.
player_joined ( Variant player_id )
Emitted when a player joins the lobby.
player_left ( Variant player_id )
Emitted when a player leaves the lobby.
received_server_ticket ( Variant ticket )
Emitted when a server ticket is received for this lobby.
updated ( )
Emitted when the lobby is updated.
webrtc_mesh_created ( Variant multiplayer_peer )
Emitted when a WebRTC mesh is created.
webrtc_peers_not_ready ( )
Emitted when one or more of the WebRTC peers is no longer connected, or a new peer has joined that we haven't connected to yet.
webrtc_peers_ready ( )
Emitted when connections to all WebRTC peers have been established.
Property Descriptions
String cluster
The name of the cluster when using a dedicated server lobby.
int created_at
When the lobby was created (in UNIX time).
String creator_id
The ID of the player who created the lobby (if any).
Whether or not this lobby is hidden.
String id
The lobby ID.
int max_players
The maximum number of players allowed in this lobby.
Dictionary props
Properties or settings for this lobby.
LobbyState state = 1
The current lobby state.
LobbyType type
The lobby type.
int updated_at
When the lobby was last updated (in UNIX time).
Method Descriptions
res://addons/w4gd/rest-client/client_request.gd delete ( )
Creates a request to delete the lobby.
Array get_players ( )
Gets the current player list.
res://addons/w4gd/matchmaker/matchmaker.gd:ServerTicket get_server_ticket ( )
Gets the server ticket for this lobby (if any).
res://addons/w4gd/matchmaker/webrtc_manager.gd get_webrtc_manager ( )
Gets the WebRTC manager.
WebRTCMultiplayerPeer get_webrtc_multiplayer_peer ( )
Gets the WebRTC multiplayer peer for this lobby (if any).
bool is_creator ( )
Returns true if the currently logged in user is the creator of this lobby.
bool is_deleted ( )
Returns true if this is a deleted lobby.
bool is_subscribed ( )
There is currently no description for this method.
res://addons/w4gd/rest-client/client_request.gd leave ( )
Creates a request to leave the lobby.
res://addons/w4gd/rest-client/client_request.gd refresh_player_list ( )
Creates a request to refresh the player list.
res://addons/w4gd/rest-client/client_request.gd refresh_server_ticket ( )
Creates a request to refresh the server ticket for this lobby.
res://addons/w4gd/rest-client/client_request.gd refresh_webrtc_sessions ( )
Creates a request to refresh the WebRTC sessions for this lobby.
res://addons/w4gd/rest-client/client_request.gd save ( )
Creates a request to save any changed properties on the lobby.
void subscribe ( )
There is currently no description for this method.
void unsubscribe ( )
There is currently no description for this method.