summaryrefslogtreecommitdiff
path: root/modules/websocket/doc_classes
diff options
context:
space:
mode:
authorFabio Alessandrelli <fabio.alessandrelli@gmail.com>2022-10-22 17:49:40 +0200
committerFabio Alessandrelli <fabio.alessandrelli@gmail.com>2022-10-28 21:18:01 +0200
commit39f3d9d59e80d5a9f62925abca596d87ce1e4d0f (patch)
treee958ee207578ecf5912210377db44496faa5cc6f /modules/websocket/doc_classes
parent028db9f2b5b6d2ca9a00d3b08c17f82b5298e149 (diff)
[MP] Add MultiplayerPeer disconnect_peer, close.
Update ENet, WebRTC, and WebSocket to support peer disconnection and unify the close function.
Diffstat (limited to 'modules/websocket/doc_classes')
-rw-r--r--modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml16
1 files changed, 0 insertions, 16 deletions
diff --git a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
index c4481b046b..7e896a0ca3 100644
--- a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
+++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
@@ -10,13 +10,6 @@
<tutorials>
</tutorials>
<methods>
- <method name="close">
- <return type="void" />
- <description>
- Closes this [MultiplayerPeer], resetting the state to [constant MultiplayerPeer.CONNECTION_CONNECTED].
- [b]Note:[/b] To make sure remote peers receive a clean close prefer disconnecting clients via [method disconnect_peer].
- </description>
- </method>
<method name="create_client">
<return type="int" enum="Error" />
<param index="0" name="url" type="String" />
@@ -37,15 +30,6 @@
Starts a new multiplayer server listening on the given [param port]. You can optionally specify a [param bind_address], and provide a [param tls_key] and [param tls_certificate] to use TLS.
</description>
</method>
- <method name="disconnect_peer">
- <return type="void" />
- <param index="0" name="id" type="int" />
- <param index="1" name="code" type="int" default="1000" />
- <param index="2" name="reason" type="String" default="&quot;&quot;" />
- <description>
- Disconnects the peer identified by [code]id[/code] from the server. See [method WebSocketPeer.close] for more information.
- </description>
- </method>
<method name="get_peer" qualifiers="const">
<return type="WebSocketPeer" />
<param index="0" name="peer_id" type="int" />