Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_websocketmultiplayerpeer.rst

class_websocketmultiplayerpeer.rst 4.6 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the WebSocketMultiplayerPeer.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_WebSocketMultiplayerPeer:
    8. 

  8. 

  9. WebSocketMultiplayerPeer
    10. 

  10. ========================
    11. 

  11. 

  12. **Inherits:** :ref:`MultiplayerPeer<class_MultiplayerPeer>` **<** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. **Inherited By:** :ref:`WebSocketClient<class_WebSocketClient>`, :ref:`WebSocketServer<class_WebSocketServer>`
    15. 

  15. 

  16. Base class for WebSocket server and client.
    17. 

  17. 

  18. Description
    19. 

  19. -----------
    20. 

  20. 

  21. Base class for WebSocket server and client, allowing them to be used as multiplayer peer for the :ref:`MultiplayerAPI<class_MultiplayerAPI>`.
    22. 

  22. 

  23. \ **Note:** When exporting to Android, make sure to enable the ``INTERNET`` permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.
    24. 

  24. 

  25. Methods
    26. 

  26. -------
    27. 

  27. 

  28. +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`WebSocketPeer<class_WebSocketPeer>` | :ref:`get_peer<class_WebSocketMultiplayerPeer_method_get_peer>` **(** :ref:`int<class_int>` peer_id **)** |const|                                                                                                                                            |
    30. 

  30. +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`Error<enum_@GlobalScope_Error>`     | :ref:`set_buffers<class_WebSocketMultiplayerPeer_method_set_buffers>` **(** :ref:`int<class_int>` input_buffer_size_kb, :ref:`int<class_int>` input_max_packets, :ref:`int<class_int>` output_buffer_size_kb, :ref:`int<class_int>` output_max_packets **)** |
    32. 

  32. +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. 

  34. Signals
    35. 

  35. -------
    36. 

  36. 

  37. .. _class_WebSocketMultiplayerPeer_signal_peer_packet:
    38. 

  38. 

  39. - **peer_packet** **(** :ref:`int<class_int>` peer_source **)**
    40. 

  40. 

  41. Emitted when a packet is received from a peer.
    42. 

  42. 

  43. \ **Note:** This signal is only emitted when the client or server is configured to use Godot multiplayer API.
    44. 

  44. 

  45. Method Descriptions
    46. 

  46. -------------------
    47. 

  47. 

  48. .. _class_WebSocketMultiplayerPeer_method_get_peer:
    49. 

  49. 

  50. - :ref:`WebSocketPeer<class_WebSocketPeer>` **get_peer** **(** :ref:`int<class_int>` peer_id **)** |const|
    51. 

  51. 

  52. Returns the :ref:`WebSocketPeer<class_WebSocketPeer>` associated to the given ``peer_id``.
    53. 

  53. 

  54. ----
    55. 

  55. 

  56. .. _class_WebSocketMultiplayerPeer_method_set_buffers:
    57. 

  57. 

  58. - :ref:`Error<enum_@GlobalScope_Error>` **set_buffers** **(** :ref:`int<class_int>` input_buffer_size_kb, :ref:`int<class_int>` input_max_packets, :ref:`int<class_int>` output_buffer_size_kb, :ref:`int<class_int>` output_max_packets **)**
    59. 

  59. 

  60. Configures the buffer sizes for this WebSocket peer. Default values can be specified in the Project Settings under ``network/limits``. For server, values are meant per connected peer.
    61. 

  61. 

  62. The first two parameters define the size and queued packets limits of the input buffer, the last two of the output buffer.
    63. 

  63. 

  64. Buffer sizes are expressed in KiB, so ``4 = 2^12 = 4096 bytes``. All parameters will be rounded up to the nearest power of two.
    65. 

  65. 

  66. \ **Note:** HTML5 exports only use the input buffer since the output one is managed by browsers.
    67. 

  67. 

  68. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    69. 

  69. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    70. 

  70. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    71. 

  71. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    72. 

  72. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    73. 

  73. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    74.