Skip to content

Commit

Permalink
Update LobbyClient.xml
Browse files Browse the repository at this point in the history
  • Loading branch information
Ughuuu committed Nov 29, 2024
1 parent 38ee30f commit 02063c3
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions modules/blazium_sdk/doc_classes/LobbyClient.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<return type="bool" />
<param index="0" name="game_id" type="String" />
<description>
Connect to a Blazium Lobby Server using the [game_id] and [server_url].
Connect to a Blazium Lobby Server using the game_id and [member server_url].
</description>
</method>
<method name="create_lobby">
Expand All @@ -23,7 +23,7 @@
<param index="2" name="password" type="String" default="&quot;&quot;" />
<description>
Create a lobby and become host. If you are already in a lobby, you cannot create one. You need to leave first.
Generates [lobby_created] signal.
Generates [member lobby_created] signal.
</description>
</method>
<method name="join_lobby">
Expand All @@ -32,22 +32,22 @@
<param index="1" name="password" type="String" default="&quot;&quot;" />
<description>
Joint a lobby. If you are already in a lobby, you cannot join another one. You need to leave first.
Generates [lobby_joined].
Generates [member lobby_joined].
</description>
</method>
<method name="kick_peer">
<return type="LobbyResponse" />
<param index="0" name="peer_id" type="String" />
<description>
Kick a peer. You need to be host to do so.
Generates [peer_left] signal with kicked set to true.
Generates [member peer_left] signal with kicked set to true.
</description>
</method>
<method name="leave_lobby">
<return type="LobbyResponse" />
<description>
Leave a lobby. You need to be in a lobby to leave one.
Generates [lobby_left].
Generates [member lobby_left].
</description>
</method>
<method name="list_lobby">
Expand All @@ -63,7 +63,7 @@
<param index="0" name="data" type="String" />
<description>
Send data either to the host, or if you are host send data to all peers.
Generates [received_data] signal.
Generates [member received_data] signal.
</description>
</method>
<method name="lobby_data_to">
Expand All @@ -72,43 +72,43 @@
<param index="1" name="target_peer" type="String" />
<description>
Send data either to a peer, works only if you are host.
Generates [received_data_to] signal.
Generates [member received_data_to] signal.
</description>
</method>
<method name="lobby_ready">
<return type="LobbyResponse" />
<description>
Ready up in the lobby. You need to be in a lobby and unready to run this.
Generates [peer_ready].
Generates [member peer_ready].
</description>
</method>
<method name="lobby_unready">
<return type="LobbyResponse" />
<description>
Ready up in the lobby. You need to be in a lobby and ready to run this.
Generates [peer_unready].
Generates [member peer_unready].
</description>
</method>
<method name="seal_lobby">
<return type="LobbyResponse" />
<description>
Seals the lobby. You need to be the host to do this and the lobby needs to be unsealed.
Generates [lobby_sealed].
Generates [member lobby_sealed].
</description>
</method>
<method name="set_peer_name">
<return type="LobbyResponse" />
<param index="0" name="peer_name" type="String" />
<description>
Set your peer name.
Generates [peer_named] signal if you are in lobby.
Generates [member peer_named] signal if you are in lobby.
</description>
</method>
<method name="unseal_lobby">
<return type="LobbyResponse" />
<description>
Unseals the lobby. You need to be the host to do this and the lobby needs to be sealed.
Generates [lobby_unsealed].
Generates [member lobby_unsealed].
</description>
</method>
<method name="view_lobby">
Expand Down

0 comments on commit 02063c3

Please sign in to comment.