Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Rename the argument tag to param in XML documentation

Browse source
This commit is contained in:
Yuri Sizov 2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download patch file Download diff file Expand all files Collapse all files

20
modules/websocket/doc_classes/WebSocketClient.xml
View file

@ -15,10 +15,10 @@
<methods>
<method name="connect_to_url">
<return type="int" enum="Error" />
<argument index="0" name="url" type="String" />
<argument index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" />
<argument index="2" name="gd_mp_api" type="bool" default="false" />
<argument index="3" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" />
<param index="0" name="url" type="String" />
<param index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" />
<param index="2" name="gd_mp_api" type="bool" default="false" />
<param index="3" name="custom_headers" type="PackedStringArray" default="PackedStringArray()" />
<description>
Connects to the given URL requesting one of the given [code]protocols[/code] as sub-protocol. If the list empty (default), no sub-protocol will be requested.
If [code]true[/code] is passed as [code]gd_mp_api[/code], the client will behave like a multiplayer peer for the [MultiplayerAPI], connections to non-Godot servers will not work, and [signal data_received] will not be emitted.
@ -30,8 +30,8 @@
</method>
<method name="disconnect_from_host">
<return type="void" />
<argument index="0" name="code" type="int" default="1000" />
<argument index="1" name="reason" type="String" default="&quot;&quot;" />
<param index="0" name="code" type="int" default="1000" />
<param index="1" name="reason" type="String" default="&quot;&quot;" />
<description>
Disconnects this client from the connected host. See [method WebSocketPeer.close] for more information.
</description>
@ -61,7 +61,7 @@
</members>
<signals>
<signal name="connection_closed">
<argument index="0" name="was_clean_close" type="bool" />
<param index="0" name="was_clean_close" type="bool" />
<description>
Emitted when the connection to the server is closed. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly.
</description>
@ -72,7 +72,7 @@
</description>
</signal>
<signal name="connection_established">
<argument index="0" name="protocol" type="String" />
<param index="0" name="protocol" type="String" />
<description>
Emitted when a connection with the server is established, [code]protocol[/code] will contain the sub-protocol agreed with the server.
</description>
@ -84,8 +84,8 @@
</description>
</signal>
<signal name="server_close_request">
<argument index="0" name="code" type="int" />
<argument index="1" name="reason" type="String" />
<param index="0" name="code" type="int" />
<param index="1" name="reason" type="String" />
<description>
Emitted when the server requests a clean close. You should keep polling until you get a [signal connection_closed] signal to achieve the clean close. See [method WebSocketPeer.close] for more details.
</description>

12
modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
View file

@ -12,17 +12,17 @@
<methods>
<method name="get_peer" qualifiers="const">
<return type="WebSocketPeer" />
<argument index="0" name="peer_id" type="int" />
<param index="0" name="peer_id" type="int" />
<description>
Returns the [WebSocketPeer] associated to the given [code]peer_id[/code].
</description>
</method>
<method name="set_buffers">
<return type="int" enum="Error" />
<argument index="0" name="input_buffer_size_kb" type="int" />
<argument index="1" name="input_max_packets" type="int" />
<argument index="2" name="output_buffer_size_kb" type="int" />
<argument index="3" name="output_max_packets" type="int" />
<param index="0" name="input_buffer_size_kb" type="int" />
<param index="1" name="input_max_packets" type="int" />
<param index="2" name="output_buffer_size_kb" type="int" />
<param index="3" name="output_max_packets" type="int" />
<description>
Configures the buffer sizes for this WebSocket peer. Default values can be specified in the Project Settings under [code]network/limits[/code]. For server, values are meant per connected peer.
The first two parameters define the size and queued packets limits of the input buffer, the last two of the output buffer.
@ -33,7 +33,7 @@
</methods>
<signals>
<signal name="peer_packet">
<argument index="0" name="peer_source" type="int" />
<param index="0" name="peer_source" type="int" />
<description>
Emitted when a packet is received from a peer.
[b]Note:[/b] This signal is only emitted when the client or server is configured to use Godot multiplayer API.

8
modules/websocket/doc_classes/WebSocketPeer.xml
View file

@ -12,8 +12,8 @@
<methods>
<method name="close">
<return type="void" />
<argument index="0" name="code" type="int" default="1000" />
<argument index="1" name="reason" type="String" default="&quot;&quot;" />
<param index="0" name="code" type="int" default="1000" />
<param index="1" name="reason" type="String" default="&quot;&quot;" />
<description>
Closes this WebSocket connection. [code]code[/code] is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). [code]reason[/code] is the human readable reason for closing the connection (can be any UTF-8 string that's smaller than 123 bytes).
[b]Note:[/b] To achieve a clean close, you will need to keep polling until either [signal WebSocketClient.connection_closed] or [signal WebSocketServer.client_disconnected] is received.
@ -54,7 +54,7 @@
</method>
<method name="set_no_delay">
<return type="void" />
<argument index="0" name="enabled" type="bool" />
<param index="0" name="enabled" type="bool" />
<description>
Disable Nagle's algorithm on the underling TCP socket (default). See [method StreamPeerTCP.set_no_delay] for more information.
[b]Note:[/b] Not available in the HTML5 export.
@ -62,7 +62,7 @@
</method>
<method name="set_write_mode">
<return type="void" />
<argument index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode" />
<param index="0" name="mode" type="int" enum="WebSocketPeer.WriteMode" />
<description>
Sets the socket to use the given [enum WriteMode].
</description>

38
modules/websocket/doc_classes/WebSocketServer.xml
View file

@ -14,30 +14,30 @@
<methods>
<method name="disconnect_peer">
<return type="void" />
<argument index="0" name="id" type="int" />
<argument index="1" name="code" type="int" default="1000" />
<argument index="2" name="reason" type="String" default="&quot;&quot;" />
<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_address" qualifiers="const">
<return type="String" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Returns the IP address of the given peer.
</description>
</method>
<method name="get_peer_port" qualifiers="const">
<return type="int" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Returns the remote port of the given peer.
</description>
</method>
<method name="has_peer" qualifiers="const">
<return type="bool" />
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Returns [code]true[/code] if a peer with the given ID is connected.
</description>
@ -50,9 +50,9 @@
</method>
<method name="listen">
<return type="int" enum="Error" />
<argument index="0" name="port" type="int" />
<argument index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" />
<argument index="2" name="gd_mp_api" type="bool" default="false" />
<param index="0" name="port" type="int" />
<param index="1" name="protocols" type="PackedStringArray" default="PackedStringArray()" />
<param index="2" name="gd_mp_api" type="bool" default="false" />
<description>
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 @@
</method>
<method name="set_extra_headers">
<return type="void" />
<argument index="0" name="headers" type="PackedStringArray" default="PackedStringArray()" />
<param index="0" name="headers" type="PackedStringArray" default="PackedStringArray()" />
<description>
Sets additional headers to be sent to clients during the HTTP handshake.
</description>
@ -93,31 +93,31 @@
</members>
<signals>
<signal name="client_close_request">
<argument index="0" name="id" type="int" />
<argument index="1" name="code" type="int" />
<argument index="2" name="reason" type="String" />
<param index="0" name="id" type="int" />
<param index="1" name="code" type="int" />
<param index="2" name="reason" type="String" />
<description>
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.
</description>
</signal>
<signal name="client_connected">
<argument index="0" name="id" type="int" />
<argument index="1" name="protocol" type="String" />
<argument index="2" name="resource_name" type="String" />
<param index="0" name="id" type="int" />
<param index="1" name="protocol" type="String" />
<param index="2" name="resource_name" type="String" />
<description>
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.
</description>
</signal>
<signal name="client_disconnected">
<argument index="0" name="id" type="int" />
<argument index="1" name="was_clean_close" type="bool" />
<param index="0" name="id" type="int" />
<param index="1" name="was_clean_close" type="bool" />
<description>
Emitted when a client disconnects. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly.
</description>
</signal>
<signal name="data_received">
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Emitted when a new message is received.
[b]Note:[/b] This signal is [i]not[/i] emitted when used as high-level multiplayer peer.