f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
48 lines
2.3 KiB
XML
48 lines
2.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="WebSocketMultiplayerPeer" inherits="NetworkedMultiplayerPeer" version="3.4">
|
|
<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>
|
|
<methods>
|
|
<method name="get_peer" qualifiers="const">
|
|
<return type="WebSocketPeer" />
|
|
<argument 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" />
|
|
<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.
|
|
Buffer sizes are expressed in KiB, so [code]4 = 2^12 = 4096 bytes[/code]. All parameters will be rounded up to the nearest power of two.
|
|
[b]Note:[/b] HTML5 exports only use the input buffer since the output one is managed by browsers.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections" override="true" default="false" />
|
|
<member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" override="true" enum="NetworkedMultiplayerPeer.TransferMode" default="2" />
|
|
</members>
|
|
<signals>
|
|
<signal name="peer_packet">
|
|
<argument 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.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
</constants>
|
|
</class>
|