aboutsummaryrefslogtreecommitdiff
path: root/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml (renamed from doc/classes/WebSocketMultiplayerPeer.xml)4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
index a1014350f..1a841f85e 100644
--- a/doc/classes/WebSocketMultiplayerPeer.xml
+++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="WebSocketMultiplayerPeer" inherits="NetworkedMultiplayerPeer" category="Core" version="3.1">
<brief_description>
+ Base class for WebSocket server and client.
</brief_description>
<description>
+ Base class for WebSocket server and client, allowing them to be used as network peer for the [MultiplayerAPI].
</description>
<tutorials>
</tutorials>
@@ -15,6 +17,7 @@
<argument index="0" name="peer_id" type="int">
</argument>
<description>
+ Returns the [WebSocketPeer] associated to the given [code]peer_id[/code].
</description>
</method>
</methods>
@@ -23,6 +26,7 @@
<argument index="0" name="peer_source" type="int">
</argument>
<description>
+ Emitted when a packet is received from a peer. Note: this signal is only emitted when the client or server is configured to use Godot multiplayer API.
</description>
</signal>
</signals>