virtualx-engine/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
2018-05-08 21:15:50 +02:00

35 lines
1.1 KiB
XML

<?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>