Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ughuuu committed Dec 7, 2024
1 parent 0540984 commit a9d3591
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 22 deletions.
44 changes: 25 additions & 19 deletions modules/blazium_sdk/doc_classes/LobbyClient.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@
Returns the lobby data. Only works if you are host.
</description>
</method>
<method name="get_peer_data">
<return type="Variant" />
<description>
Returns the self peer data. Only works if you are in a lobby.
</description>
</method>
<method name="is_host">
<return type="bool" />
<description>
Expand Down Expand Up @@ -98,19 +104,19 @@
Generates [signal peer_messaged].
</description>
</method>
<method name="set_lobby_data">
<method name="send_peer_data">
<return type="LobbyResponse" />
<param index="0" name="data" type="Variant" />
<param index="1" name="target_peer" type="String" />
<description>
Set data on the lobby. Only works if you are host.
Send data to a peer.
</description>
</method>
<method name="send_peer_data">
<method name="set_lobby_data">
<return type="LobbyResponse" />
<param index="0" name="data" type="Variant" />
<param index="1" name="target_peer" type="String" />
<description>
Send data to a peer.
Set data on the lobby. Only works if you are host.
</description>
</method>
<method name="set_lobby_ready">
Expand Down Expand Up @@ -182,13 +188,6 @@
Signal generated after you connect to the lobby.
</description>
</signal>
<signal name="received_data">
<param index="0" name="data" type="Object" />
<param index="1" name="from_peer" type="LobbyPeer" />
<description>
Signal generated after data is received.
</description>
</signal>
<signal name="disconnected_from_lobby">
<param index="0" name="reason" type="String" />
<description>
Expand All @@ -215,6 +214,13 @@
Signal generated after you leave a lobby.
</description>
</signal>
<signal name="lobby_notified">
<param index="0" name="data" type="Object" />
<param index="1" name="from_peer" type="LobbyPeer" />
<description>
Signal generated after a notification is received.
</description>
</signal>
<signal name="lobby_sealed">
<param index="0" name="sealed" type="bool" />
<description>
Expand All @@ -234,13 +240,6 @@
Signals a log from a command.
</description>
</signal>
<signal name="lobby_notified">
<param index="0" name="data" type="Object" />
<param index="1" name="from_peer" type="LobbyPeer" />
<description>
Signal generated after a notification is received.
</description>
</signal>
<signal name="peer_disconnected">
<param index="0" name="peer" type="LobbyPeer" />
<description>
Expand Down Expand Up @@ -286,5 +285,12 @@
Signal generated after a peer reconnects.
</description>
</signal>
<signal name="received_data">
<param index="0" name="data" type="Object" />
<param index="1" name="from_peer" type="LobbyPeer" />
<description>
Signal generated after data is received.
</description>
</signal>
</signals>
</class>
3 changes: 0 additions & 3 deletions modules/blazium_sdk/doc_classes/LobbyPeer.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@
<tutorials>
</tutorials>
<members>
<member name="data" type="Variant" setter="" getter="get_data" default="null">
Data of the peer.
</member>
<member name="id" type="String" setter="" getter="get_id" default="&quot;&quot;">
Identifier of the peer.
</member>
Expand Down

0 comments on commit a9d3591

Please sign in to comment.