Files
godot-docs/classes/class_websocketclient.rst
2018-02-19 10:48:33 +01:00

60 lines
2.6 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the WebSocketClient.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_WebSocketClient:
WebSocketClient
===============
**Inherits:** :ref:`WebSocketMultiplayerPeer<class_websocketmultiplayerpeer>` **<** :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` **<** :ref:`PacketPeer<class_packetpeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Member Functions
----------------
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`connect_to_url<class_WebSocketClient_connect_to_url>` **(** :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` protocols=PoolStringArray( ), :ref:`bool<class_bool>` gd_mp_api=false **)** |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_from_host<class_WebSocketClient_disconnect_from_host>` **(** **)** |
+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_WebSocketClient_connection_closed:
- **connection_closed** **(** **)**
.. _class_WebSocketClient_connection_error:
- **connection_error** **(** **)**
.. _class_WebSocketClient_connection_established:
- **connection_established** **(** :ref:`String<class_string>` protocol **)**
.. _class_WebSocketClient_data_received:
- **data_received** **(** **)**
Member Function Description
---------------------------
.. _class_WebSocketClient_connect_to_url:
- :ref:`int<class_int>` **connect_to_url** **(** :ref:`String<class_string>` url, :ref:`PoolStringArray<class_poolstringarray>` protocols=PoolStringArray( ), :ref:`bool<class_bool>` gd_mp_api=false **)**
.. _class_WebSocketClient_disconnect_from_host:
- void **disconnect_from_host** **(** **)**