hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document websocket module, further document enet

Browse source
This commit is contained in:
Fabio Alessandrelli 2018-05-08 14:40:08 +02:00
parent cbb744c4e0
commit dd546dc5b8
11 changed files with 309 additions and 184 deletions
Download patch file Download diff file Expand all files Collapse all files

35
modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml Normal file
View file

@ -0,0 +1,35 @@
<?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>