godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: Sync with current 3.5 branch (8ee69a88c)

Browse Source
This commit is contained in:
Rémi Verschelde
2022-04-29 14:16:57 +02:00
parent 94366cdd8f
commit 12786907c6
398 changed files with 9782 additions and 3681 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
classes/class_websocketserver.rst
View File

@@ -20,7 +20,7 @@ This class implements a WebSocket server that can also support the high-level mu
After starting the server (:ref:`listen<class_WebSocketServer_method_listen>`), you will need to :ref:`NetworkedMultiplayerPeer.poll<class_NetworkedMultiplayerPeer_method_poll>` it at regular intervals (e.g. inside :ref:`Node._process<class_Node_method__process>`). When clients connect, disconnect, or send data, you will receive the appropriate signal.
**Note:** Not available in HTML5 exports.
\ **Note:** Not available in HTML5 exports.
Properties
----------
@@ -53,6 +53,8 @@ Methods
+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`listen<class_WebSocketServer_method_listen>` **(** :ref:`int<class_int>` port, :ref:`PoolStringArray<class_PoolStringArray>` protocols=PoolStringArray( ), :ref:`bool<class_bool>` gd_mp_api=false **)** |
+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_extra_headers<class_WebSocketServer_method_set_extra_headers>` **(** :ref:`PoolStringArray<class_PoolStringArray>` headers=PoolStringArray( ) **)** |
+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_WebSocketServer_method_stop>` **(** **)** |
+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -89,7 +91,7 @@ Emitted when a client disconnects. ``was_clean_close`` will be ``true`` if the c
Emitted when a new message is received.
**Note:** This signal is *not* emitted when used as high-level multiplayer peer.
\ **Note:** This signal is *not* emitted when used as high-level multiplayer peer.
Property Descriptions
---------------------
@@ -223,6 +225,14 @@ If ``false`` is passed instead (default), you must call :ref:`PacketPeer<class_P
----
.. _class_WebSocketServer_method_set_extra_headers:
- void **set_extra_headers** **(** :ref:`PoolStringArray<class_PoolStringArray>` headers=PoolStringArray( ) **)**
Sets additional headers to be sent to clients during the HTTP handshake.
----
.. _class_WebSocketServer_method_stop:
- void **stop** **(** **)**