class_packetpeerudp.rst 4.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_PacketPeerUDP:
  4. PacketPeerUDP
  5. =============
  6. **Inherits:** :ref:`PacketPeer<class_packetpeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  13. | Error | :ref:`listen<class_PacketPeerUDP_listen>` **(** :ref:`int<class_int>` port, :ref:`int<class_int>` recv_buf_size=65536 **)** |
  14. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`close<class_PacketPeerUDP_close>` **(** **)** |
  16. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  17. | Error | :ref:`wait<class_PacketPeerUDP_wait>` **(** **)** |
  18. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`is_listening<class_PacketPeerUDP_is_listening>` **(** **)** const |
  20. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`String<class_string>` | :ref:`get_packet_ip<class_PacketPeerUDP_get_packet_ip>` **(** **)** const |
  22. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`int<class_int>` | :ref:`get_packet_address<class_PacketPeerUDP_get_packet_address>` **(** **)** const |
  24. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`get_packet_port<class_PacketPeerUDP_get_packet_port>` **(** **)** const |
  26. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`int<class_int>` | :ref:`set_send_address<class_PacketPeerUDP_set_send_address>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)** |
  28. +------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
  29. Member Function Description
  30. ---------------------------
  31. .. _class_PacketPeerUDP_listen:
  32. - Error **listen** **(** :ref:`int<class_int>` port, :ref:`int<class_int>` recv_buf_size=65536 **)**
  33. .. _class_PacketPeerUDP_close:
  34. - void **close** **(** **)**
  35. .. _class_PacketPeerUDP_wait:
  36. - Error **wait** **(** **)**
  37. .. _class_PacketPeerUDP_is_listening:
  38. - :ref:`bool<class_bool>` **is_listening** **(** **)** const
  39. .. _class_PacketPeerUDP_get_packet_ip:
  40. - :ref:`String<class_string>` **get_packet_ip** **(** **)** const
  41. .. _class_PacketPeerUDP_get_packet_address:
  42. - :ref:`int<class_int>` **get_packet_address** **(** **)** const
  43. .. _class_PacketPeerUDP_get_packet_port:
  44. - :ref:`int<class_int>` **get_packet_port** **(** **)** const
  45. .. _class_PacketPeerUDP_set_send_address:
  46. - :ref:`int<class_int>` **set_send_address** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)**