Skip to content

Commit

Permalink
update docs 2
Browse files Browse the repository at this point in the history
  • Loading branch information
Ughuuu committed Nov 29, 2024
1 parent e9f53a6 commit b9feabc
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
23 changes: 12 additions & 11 deletions modules/blazium_sdk/doc_classes/LobbyClient.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
</method>
<method name="join_lobby">
<return type="ViewLobbyResponse" />
<param index="0" name="lobby_id" type="String" />
<param index="0" name="lobby_id" type="String" default="&quot;&quot;" >
<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.
Expand Down Expand Up @@ -124,10 +124,10 @@
<member name="connected" type="bool" setter="" getter="get_connected" default="false">
True if the client is connected, else false.
</member>
<member name="lobby" type="LobbyInfo" setter="" getter="get_lobby" default="">
<member name="lobby" type="LobbyInfo" setter="" getter="get_lobby">
The current lobby.
</member>
<member name="peer" type="LobbyPeer" setter="" getter="get_peer" default="">
<member name="peer" type="LobbyPeer" setter="" getter="get_peer">
The current peer.
</member>
<member name="peers" type="LobbyPeer[]" setter="" getter="get_peers" default="[]">
Expand All @@ -152,13 +152,15 @@
</description>
</signal>
<signal name="lobby_created">
<param index="0" name="lobby" type="String" />
+ <param index="0" name="lobby" type="LobbyInfo" />
+ <param index="1" name="peers" type="LobbyPeer[]" />
<description>
Signal generated after a lobby is created.
</description>
</signal>
<signal name="lobby_joined">
<param index="0" name="lobby" type="String" />
+ <param index="0" name="lobby" type="LobbyInfo" />
+ <param index="1" name="peers" type="LobbyPeer[]" />
<description>
Signal generated after you joint a lobby.
</description>
Expand All @@ -179,33 +181,32 @@
</description>
</signal>
<signal name="peer_joined">
<param index="0" name="peer_id" type="String" />
<param index="0" name="peer" type="LobbyPeer" />
<description>
Signal generated after a peer joins the lobby.
</description>
</signal>
<signal name="peer_left">
<param index="0" name="peer_id" type="String" />
<param index="0" name="peer" type="LobbyPeer" />
<param index="1" name="kicked" type="bool" />
<description>
Signal generated after a peer leaves the lobby.
</description>
</signal>
<signal name="peer_named">
<param index="0" name="peer_id" type="String" />
<param index="1" name="name" type="String" />
<param index="0" name="peer" type="LobbyPeer" />
<description>
Signal generated after a peer names himself.
</description>
</signal>
<signal name="peer_ready">
<param index="0" name="peer_id" type="String" />
<param index="0" name="peer" type="LobbyPeer" />
<description>
Signal generated after a peer is ready.
</description>
</signal>
<signal name="peer_unready">
<param index="0" name="peer_id" type="String" />
<param index="0" name="peer" type="LobbyPeer" />
<description>
Signal generated after a peer is unready.
</description>
Expand Down
2 changes: 1 addition & 1 deletion modules/blazium_sdk/doc_classes/LobbyInfo.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="LobbyInfo" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<class name="LobbyInfo" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Lobby information returned after a view lobby request.
</brief_description>
Expand Down
2 changes: 1 addition & 1 deletion modules/blazium_sdk/doc_classes/LobbyPeer.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="LobbyPeer" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<class name="LobbyPeer" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Lobby peers information returned after a view lobby request.
</brief_description>
Expand Down

0 comments on commit b9feabc

Please sign in to comment.