class_websocketpeer.rst 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the WebSocketPeer.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_WebSocketPeer:
  5. WebSocketPeer
  6. =============
  7. **Inherits:** :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. | void | :ref:`close<class_WebSocketPeer_close>` **(** **)** |
  15. +--------------------------+--------------------------------------------------------------------------------------------------+
  16. | :ref:`int<class_int>` | :ref:`get_write_mode<class_WebSocketPeer_get_write_mode>` **(** **)** const |
  17. +--------------------------+--------------------------------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`is_connected_to_host<class_WebSocketPeer_is_connected_to_host>` **(** **)** const |
  19. +--------------------------+--------------------------------------------------------------------------------------------------+
  20. | void | :ref:`set_write_mode<class_WebSocketPeer_set_write_mode>` **(** :ref:`int<class_int>` mode **)** |
  21. +--------------------------+--------------------------------------------------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | :ref:`was_string_packet<class_WebSocketPeer_was_string_packet>` **(** **)** const |
  23. +--------------------------+--------------------------------------------------------------------------------------------------+
  24. Enums
  25. -----
  26. .. _enum_WebSocketPeer_WriteMode:
  27. enum **WriteMode**
  28. - **WRITE_MODE_TEXT** = **0**
  29. - **WRITE_MODE_BINARY** = **1**
  30. Member Function Description
  31. ---------------------------
  32. .. _class_WebSocketPeer_close:
  33. - void **close** **(** **)**
  34. .. _class_WebSocketPeer_get_write_mode:
  35. - :ref:`int<class_int>` **get_write_mode** **(** **)** const
  36. .. _class_WebSocketPeer_is_connected_to_host:
  37. - :ref:`bool<class_bool>` **is_connected_to_host** **(** **)** const
  38. .. _class_WebSocketPeer_set_write_mode:
  39. - void **set_write_mode** **(** :ref:`int<class_int>` mode **)**
  40. .. _class_WebSocketPeer_was_string_packet:
  41. - :ref:`bool<class_bool>` **was_string_packet** **(** **)** const