WebSocketMultiplayerPeer.xml 1.1 KB

123456789101112131415161718192021222324252627282930313233343536
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="WebSocketMultiplayerPeer" inherits="NetworkedMultiplayerPeer" category="Core" version="3.1">
  3. <brief_description>
  4. Base class for WebSocket server and client.
  5. </brief_description>
  6. <description>
  7. Base class for WebSocket server and client, allowing them to be used as network peer for the [MultiplayerAPI].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. <method name="get_peer" qualifiers="const">
  15. <return type="WebSocketPeer">
  16. </return>
  17. <argument index="0" name="peer_id" type="int">
  18. </argument>
  19. <description>
  20. Returns the [WebSocketPeer] associated to the given [code]peer_id[/code].
  21. </description>
  22. </method>
  23. </methods>
  24. <signals>
  25. <signal name="peer_packet">
  26. <argument index="0" name="peer_source" type="int">
  27. </argument>
  28. <description>
  29. Emitted when a packet is received from a peer. Note: this signal is only emitted when the client or server is configured to use Godot multiplayer API.
  30. </description>
  31. </signal>
  32. </signals>
  33. <constants>
  34. </constants>
  35. </class>