class_websocketclient.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the WebSocketClient.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_WebSocketClient:
  5. WebSocketClient
  6. ===============
  7. **Inherits:** :ref:`WebSocketMultiplayerPeer<class_websocketmultiplayerpeer>` **<** :ref:`NetworkedMultiplayerPeer<class_networkedmultiplayerpeer>` **<** :ref:`PacketPeer<class_packetpeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Member Functions
  12. ----------------
  13. +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | :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 **)** |
  15. +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`disconnect_from_host<class_WebSocketClient_disconnect_from_host>` **(** **)** |
  17. +------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. Signals
  19. -------
  20. .. _class_WebSocketClient_connection_closed:
  21. - **connection_closed** **(** **)**
  22. .. _class_WebSocketClient_connection_error:
  23. - **connection_error** **(** **)**
  24. .. _class_WebSocketClient_connection_established:
  25. - **connection_established** **(** :ref:`String<class_string>` protocol **)**
  26. .. _class_WebSocketClient_data_received:
  27. - **data_received** **(** **)**
  28. Member Variables
  29. ----------------
  30. .. _class_WebSocketClient_verify_ssl:
  31. - :ref:`bool<class_bool>` **verify_ssl**
  32. Member Function Description
  33. ---------------------------
  34. .. _class_WebSocketClient_connect_to_url:
  35. - :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 **)**
  36. .. _class_WebSocketClient_disconnect_from_host:
  37. - void **disconnect_from_host** **(** **)**