.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml. .. _class_WebSocketMultiplayerPeer: WebSocketMultiplayerPeer ======================== **Inherits:** :ref:`MultiplayerPeer` **<** :ref:`PacketPeer` **<** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. 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` **(** :ref:`String` url, :ref:`TLSOptions` tls_client_options=null **)** | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`create_server` **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`TLSOptions` tls_server_options=null **)** | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`WebSocketPeer` | :ref:`get_peer` **(** :ref:`int` peer_id **)** |const| | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_peer_address` **(** :ref:`int` id **)** |const| | +-------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_peer_port` **(** :ref:`int` id **)** |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()`` .. rst-class:: classref-property-setget - void **set_handshake_headers** **(** :ref:`PackedStringArray` value **)** - :ref:`PackedStringArray` **get_handshake_headers** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_property_handshake_timeout: .. rst-class:: classref-property :ref:`float` **handshake_timeout** = ``3.0`` .. rst-class:: classref-property-setget - void **set_handshake_timeout** **(** :ref:`float` value **)** - :ref:`float` **get_handshake_timeout** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_property_inbound_buffer_size: .. rst-class:: classref-property :ref:`int` **inbound_buffer_size** = ``65535`` .. rst-class:: classref-property-setget - void **set_inbound_buffer_size** **(** :ref:`int` value **)** - :ref:`int` **get_inbound_buffer_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_property_max_queued_packets: .. rst-class:: classref-property :ref:`int` **max_queued_packets** = ``2048`` .. rst-class:: classref-property-setget - void **set_max_queued_packets** **(** :ref:`int` value **)** - :ref:`int` **get_max_queued_packets** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_property_outbound_buffer_size: .. rst-class:: classref-property :ref:`int` **outbound_buffer_size** = ``65535`` .. rst-class:: classref-property-setget - void **set_outbound_buffer_size** **(** :ref:`int` value **)** - :ref:`int` **get_outbound_buffer_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_property_supported_protocols: .. rst-class:: classref-property :ref:`PackedStringArray` **supported_protocols** = ``PackedStringArray()`` .. rst-class:: classref-property-setget - void **set_supported_protocols** **(** :ref:`PackedStringArray` value **)** - :ref:`PackedStringArray` **get_supported_protocols** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. 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** **(** :ref:`String` url, :ref:`TLSOptions` tls_client_options=null **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_method_create_server: .. rst-class:: classref-method :ref:`Error` **create_server** **(** :ref:`int` port, :ref:`String` bind_address="*", :ref:`TLSOptions` tls_server_options=null **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_method_get_peer: .. rst-class:: classref-method :ref:`WebSocketPeer` **get_peer** **(** :ref:`int` peer_id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_method_get_peer_address: .. rst-class:: classref-method :ref:`String` **get_peer_address** **(** :ref:`int` id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebSocketMultiplayerPeer_method_get_peer_port: .. rst-class:: classref-method :ref:`int` **get_peer_port** **(** :ref:`int` id **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)`