:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.3/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml. .. _class_WebSocketMultiplayerPeer: WebSocketMultiplayerPeer ======================== **Inherits:** :ref:`MultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`RefCounted` **<** :ref:`Object` Base class for WebSocket server and client. .. rst-class:: classref-introduction-group Description ----------- Base class for WebSocket server and client, allowing them to be used as multiplayer peer for the :ref:`MultiplayerAPI`. \ **Note:** When exporting to Android, make sure to enable the ``INTERNET`` permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------------+-------------------------------------------------------------------------------------------+-------------------------+ | :ref:`PackedStringArray` | :ref:`handshake_headers` | ``PackedStringArray()`` | +---------------------------------------------------+-------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`handshake_timeout` | ``3.0`` | +---------------------------------------------------+-------------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`inbound_buffer_size` | ``65535`` | +---------------------------------------------------+-------------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`max_queued_packets` | ``2048`` | +---------------------------------------------------+-------------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`outbound_buffer_size` | ``65535`` | +---------------------------------------------------+-------------------------------------------------------------------------------------------+-------------------------+ | :ref:`PackedStringArray` | :ref:`supported_protocols` | ``PackedStringArray()`` | +---------------------------------------------------+-------------------------------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`create_client`\ (\ url\: :ref:`String`, tls_client_options\: :ref:`TLSOptions` = null\ ) | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`create_server`\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*", tls_server_options\: :ref:`TLSOptions` = null\ ) | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`WebSocketPeer` | :ref:`get_peer`\ (\ peer_id\: :ref:`int`\ ) |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_peer_address`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_peer_port`\ (\ id\: :ref:`int`\ ) |const| | +-------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_WebSocketMultiplayerPeer_property_handshake_headers: .. rst-class:: classref-property :ref:`PackedStringArray` **handshake_headers** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_handshake_headers**\ (\ value\: :ref:`PackedStringArray`\ ) - :ref:`PackedStringArray` **get_handshake_headers**\ (\ ) The extra headers to use during handshake. See :ref:`WebSocketPeer.handshake_headers` for more details. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_property_handshake_timeout: .. rst-class:: classref-property :ref:`float` **handshake_timeout** = ``3.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_handshake_timeout**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_handshake_timeout**\ (\ ) The maximum time each peer can stay in a connecting state before being dropped. .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_property_inbound_buffer_size: .. rst-class:: classref-property :ref:`int` **inbound_buffer_size** = ``65535`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_inbound_buffer_size**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_inbound_buffer_size**\ (\ ) The inbound buffer size for connected peers. See :ref:`WebSocketPeer.inbound_buffer_size` for more details. .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_property_max_queued_packets: .. rst-class:: classref-property :ref:`int` **max_queued_packets** = ``2048`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_max_queued_packets**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_max_queued_packets**\ (\ ) The maximum number of queued packets for connected peers. See :ref:`WebSocketPeer.max_queued_packets` for more details. .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_property_outbound_buffer_size: .. rst-class:: classref-property :ref:`int` **outbound_buffer_size** = ``65535`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_outbound_buffer_size**\ (\ value\: :ref:`int`\ ) - :ref:`int` **get_outbound_buffer_size**\ (\ ) The outbound buffer size for connected peers. See :ref:`WebSocketPeer.outbound_buffer_size` for more details. .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_property_supported_protocols: .. rst-class:: classref-property :ref:`PackedStringArray` **supported_protocols** = ``PackedStringArray()`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_supported_protocols**\ (\ value\: :ref:`PackedStringArray`\ ) - :ref:`PackedStringArray` **get_supported_protocols**\ (\ ) The supported WebSocket sub-protocols. See :ref:`WebSocketPeer.supported_protocols` for more details. **Note:** The returned array is *copied* and any changes to it will not update the original property value. See :ref:`PackedStringArray` for more details. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_WebSocketMultiplayerPeer_method_create_client: .. rst-class:: classref-method :ref:`Error` **create_client**\ (\ url\: :ref:`String`, tls_client_options\: :ref:`TLSOptions` = null\ ) :ref:`🔗` Starts a new multiplayer client connecting to the given ``url``. TLS certificates will be verified against the hostname when connecting using the ``wss://`` protocol. You can pass the optional ``tls_client_options`` parameter to customize the trusted certification authorities, or disable the common name verification. See :ref:`TLSOptions.client` and :ref:`TLSOptions.client_unsafe`. \ **Note:** It is recommended to specify the scheme part of the URL, i.e. the ``url`` should start with either ``ws://`` or ``wss://``. .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_method_create_server: .. rst-class:: classref-method :ref:`Error` **create_server**\ (\ port\: :ref:`int`, bind_address\: :ref:`String` = "*", tls_server_options\: :ref:`TLSOptions` = null\ ) :ref:`🔗` Starts a new multiplayer server listening on the given ``port``. You can optionally specify a ``bind_address``, and provide valid ``tls_server_options`` to use TLS. See :ref:`TLSOptions.server`. .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_method_get_peer: .. rst-class:: classref-method :ref:`WebSocketPeer` **get_peer**\ (\ peer_id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the :ref:`WebSocketPeer` associated to the given ``peer_id``. .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_method_get_peer_address: .. rst-class:: classref-method :ref:`String` **get_peer_address**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the IP address of the given peer. .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_method_get_peer_port: .. rst-class:: classref-method :ref:`int` **get_peer_port**\ (\ id\: :ref:`int`\ ) |const| :ref:`🔗` Returns the remote port of the given peer. .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`