diff options
| author | Max Hilbrunner | 2018-05-09 01:41:01 +0200 |
|---|---|---|
| committer | GitHub | 2018-05-09 01:41:01 +0200 |
| commit | e744d12e568c22d2f260eee15fc9b2cade3dcdd8 (patch) | |
| tree | 06c480ec011f817af8733a1208f20b7aa1fd391b /modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml | |
| parent | 9a22a835f6527af3f2165ee048c875cd2ce6b2cf (diff) | |
| parent | dd546dc5b86e0bb9c397919fd8bfcf8e8460bc38 (diff) | |
| download | godot-e744d12e568c22d2f260eee15fc9b2cade3dcdd8.tar.gz godot-e744d12e568c22d2f260eee15fc9b2cade3dcdd8.tar.zst godot-e744d12e568c22d2f260eee15fc9b2cade3dcdd8.zip | |
Merge pull request #18709 from Faless/multiplayer_docs
Rename multiplayer_api to multiplayer, add docs
Diffstat (limited to '')
| -rw-r--r-- | modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml (renamed from doc/classes/WebSocketMultiplayerPeer.xml) | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml index a1014350f..1a841f85e 100644 --- a/doc/classes/WebSocketMultiplayerPeer.xml +++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml @@ -1,8 +1,10 @@ <?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> @@ -15,6 +17,7 @@ <argument index="0" name="peer_id" type="int"> </argument> <description> + Returns the [WebSocketPeer] associated to the given [code]peer_id[/code]. </description> </method> </methods> @@ -23,6 +26,7 @@ <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> |