:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/modules/webrtc/doc_classes/WebRTCMultiplayer.xml. .. _class_WebRTCMultiplayer: WebRTCMultiplayer ================= **Inherits:** :ref:`NetworkedMultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` A simple interface to create a peer-to-peer mesh network composed of :ref:`WebRTCPeerConnection` that is compatible with the :ref:`MultiplayerAPI`. .. rst-class:: classref-introduction-group Description ----------- This class constructs a full mesh of :ref:`WebRTCPeerConnection` (one connection for each peer) that can be used as a :ref:`MultiplayerAPI.network_peer`. You can add each :ref:`WebRTCPeerConnection` via :ref:`add_peer` or remove them via :ref:`remove_peer`. Peers must be added in :ref:`WebRTCPeerConnection.STATE_NEW` state to allow it to create the appropriate channels. This class will not create offers nor set descriptions, it will only poll them, and notify connections and disconnections. \ :ref:`NetworkedMultiplayerPeer.connection_succeeded` and :ref:`NetworkedMultiplayerPeer.server_disconnected` will not be emitted unless ``server_compatibility`` is ``true`` in :ref:`initialize`. Beside that data transfer works like in a :ref:`NetworkedMultiplayerPeer`. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`add_peer` **(** :ref:`WebRTCPeerConnection` peer, :ref:`int` peer_id, :ref:`int` unreliable_lifetime=1 **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_peer` **(** :ref:`int` peer_id **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_peers` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_peer` **(** :ref:`int` peer_id **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`initialize` **(** :ref:`int` peer_id, :ref:`bool` server_compatibility=false **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_peer` **(** :ref:`int` peer_id **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_WebRTCMultiplayer_method_add_peer: .. rst-class:: classref-method :ref:`Error` **add_peer** **(** :ref:`WebRTCPeerConnection` peer, :ref:`int` peer_id, :ref:`int` unreliable_lifetime=1 **)** Add a new peer to the mesh with the given ``peer_id``. The :ref:`WebRTCPeerConnection` must be in state :ref:`WebRTCPeerConnection.STATE_NEW`. Three channels will be created for reliable, unreliable, and ordered transport. The value of ``unreliable_lifetime`` will be passed to the ``maxPacketLifetime`` option when creating unreliable and ordered channels (see :ref:`WebRTCPeerConnection.create_data_channel`). .. rst-class:: classref-item-separator ---- .. _class_WebRTCMultiplayer_method_close: .. rst-class:: classref-method void **close** **(** **)** Close all the add peer connections and channels, freeing all resources. .. rst-class:: classref-item-separator ---- .. _class_WebRTCMultiplayer_method_get_peer: .. rst-class:: classref-method :ref:`Dictionary` **get_peer** **(** :ref:`int` peer_id **)** Return a dictionary representation of the peer with given ``peer_id`` with three keys. ``connection`` containing the :ref:`WebRTCPeerConnection` to this peer, ``channels`` an array of three :ref:`WebRTCDataChannel`, and ``connected`` a boolean representing if the peer connection is currently connected (all three channels are open). .. rst-class:: classref-item-separator ---- .. _class_WebRTCMultiplayer_method_get_peers: .. rst-class:: classref-method :ref:`Dictionary` **get_peers** **(** **)** Returns a dictionary which keys are the peer ids and values the peer representation as in :ref:`get_peer`. .. rst-class:: classref-item-separator ---- .. _class_WebRTCMultiplayer_method_has_peer: .. rst-class:: classref-method :ref:`bool` **has_peer** **(** :ref:`int` peer_id **)** Returns ``true`` if the given ``peer_id`` is in the peers map (it might not be connected though). .. rst-class:: classref-item-separator ---- .. _class_WebRTCMultiplayer_method_initialize: .. rst-class:: classref-method :ref:`Error` **initialize** **(** :ref:`int` peer_id, :ref:`bool` server_compatibility=false **)** Initialize the multiplayer peer with the given ``peer_id`` (must be between 1 and 2147483647). If ``server_compatibilty`` is ``false`` (default), the multiplayer peer will be immediately in state :ref:`NetworkedMultiplayerPeer.CONNECTION_CONNECTED` and :ref:`NetworkedMultiplayerPeer.connection_succeeded` will not be emitted. If ``server_compatibilty`` is ``true`` the peer will suppress all :ref:`NetworkedMultiplayerPeer.peer_connected` signals until a peer with id :ref:`NetworkedMultiplayerPeer.TARGET_PEER_SERVER` connects and then emit :ref:`NetworkedMultiplayerPeer.connection_succeeded`. After that the signal :ref:`NetworkedMultiplayerPeer.peer_connected` will be emitted for every already connected peer, and any new peer that might connect. If the server peer disconnects after that, signal :ref:`NetworkedMultiplayerPeer.server_disconnected` will be emitted and state will become :ref:`NetworkedMultiplayerPeer.CONNECTION_CONNECTED`. .. rst-class:: classref-item-separator ---- .. _class_WebRTCMultiplayer_method_remove_peer: .. rst-class:: classref-method void **remove_peer** **(** :ref:`int` peer_id **)** Remove the peer with given ``peer_id`` from the mesh. If the peer was connected, and :ref:`NetworkedMultiplayerPeer.peer_connected` was emitted for it, then :ref:`NetworkedMultiplayerPeer.peer_disconnected` will be emitted. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`