From c5d7115038de5f83cb83e08748615a84fc26bee2 Mon Sep 17 00:00:00 2001 From: Yuri Sizov Date: Sat, 6 Aug 2022 21:11:48 +0300 Subject: Rename the argument tag to param in XML documentation --- modules/websocket/doc_classes/WebSocketServer.xml | 38 +++++++++++------------ 1 file changed, 19 insertions(+), 19 deletions(-) (limited to 'modules/websocket/doc_classes/WebSocketServer.xml') diff --git a/modules/websocket/doc_classes/WebSocketServer.xml b/modules/websocket/doc_classes/WebSocketServer.xml index 46b0274de3..6a7bf8075c 100644 --- a/modules/websocket/doc_classes/WebSocketServer.xml +++ b/modules/websocket/doc_classes/WebSocketServer.xml @@ -14,30 +14,30 @@ - - - + + + Disconnects the peer identified by [code]id[/code] from the server. See [method WebSocketPeer.close] for more information. - + Returns the IP address of the given peer. - + Returns the remote port of the given peer. - + Returns [code]true[/code] if a peer with the given ID is connected. @@ -50,9 +50,9 @@ - - - + + + Starts listening on the given port. You can specify the desired subprotocols via the "protocols" array. If the list empty (default), no sub-protocol will be requested. @@ -62,7 +62,7 @@ - + Sets additional headers to be sent to clients during the HTTP handshake. @@ -93,31 +93,31 @@ - - - + + + Emitted when a client requests a clean close. You should keep polling until you get a [signal client_disconnected] signal with the same [code]id[/code] to achieve the clean close. See [method WebSocketPeer.close] for more details. - - - + + + Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client, and "resource_name" will be the resource name of the URI the peer used. "resource_name" is a path (at the very least a single forward slash) and potentially a query string. - - + + Emitted when a client disconnects. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly. - + Emitted when a new message is received. [b]Note:[/b] This signal is [i]not[/i] emitted when used as high-level multiplayer peer. -- cgit v1.2.3