From dd546dc5b86e0bb9c397919fd8bfcf8e8460bc38 Mon Sep 17 00:00:00 2001
From: Fabio Alessandrelli
Date: Tue, 8 May 2018 14:40:08 +0200
Subject: Document websocket module, further document enet

---
 .../doc_classes/WebSocketMultiplayerPeer.xml       | 35 ++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml

(limited to 'modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml')

diff --git a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
new file mode 100644
index 000000000..1a841f85e
--- /dev/null
+++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
@@ -0,0 +1,35 @@
+<?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>
+	<demos>
+	</demos>
+	<methods>
+		<method name="get_peer" qualifiers="const">
+			<return type="WebSocketPeer">
+			</return>
+			<argument index="0" name="peer_id" type="int">
+			</argument>
+			<description>
+				Returns the [WebSocketPeer] associated to the given [code]peer_id[/code].
+			</description>
+		</method>
+	</methods>
+	<signals>
+		<signal name="peer_packet">
+			<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>
+	<constants>
+	</constants>
+</class>
-- 
cgit v1.2.3-70-g09d2