mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
51 lines
1.9 KiB
ReStructuredText
51 lines
1.9 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the WebSocketMultiplayerPeer.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_WebSocketMultiplayerPeer:
|
|
|
|
WebSocketMultiplayerPeer
|
|
========================
|
|
|
|
**Inherits:** :ref:`NetworkedMultiplayerPeer<class_NetworkedMultiplayerPeer>` **<** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Inherited By:** :ref:`WebSocketClient<class_WebSocketClient>`, :ref:`WebSocketServer<class_WebSocketServer>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Base class for WebSocket server and client.
|
|
|
|
Methods
|
|
-------
|
|
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
|
|
| :ref:`WebSocketPeer<class_WebSocketPeer>` | :ref:`get_peer<class_WebSocketMultiplayerPeer_get_peer>` **(** :ref:`int<class_int>` peer_id **)** const |
|
|
+--------------------------------------------+----------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_WebSocketMultiplayerPeer_peer_packet:
|
|
|
|
- **peer_packet** **(** :ref:`int<class_int>` peer_source **)**
|
|
|
|
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
|
|
-----------
|
|
|
|
Base class for WebSocket server and client, allowing them to be used as network peer for the :ref:`MultiplayerAPI<class_MultiplayerAPI>`.
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_WebSocketMultiplayerPeer_get_peer:
|
|
|
|
- :ref:`WebSocketPeer<class_WebSocketPeer>` **get_peer** **(** :ref:`int<class_int>` peer_id **)** const
|
|
|
|
Returns the :ref:`WebSocketPeer<class_WebSocketPeer>` associated to the given ``peer_id``.
|
|
|