mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
94 lines
5.2 KiB
ReStructuredText
94 lines
5.2 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
.. _class_PacketPeerUDP:
|
|
|
|
PacketPeerUDP
|
|
=============
|
|
|
|
**Inherits:** :ref:`PacketPeer<class_packetpeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
UDP packet peer.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`close<class_PacketPeerUDP_close>` **(** **)** |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_string>` | :ref:`get_packet_ip<class_PacketPeerUDP_get_packet_ip>` **(** **)** const |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_packet_port<class_PacketPeerUDP_get_packet_port>` **(** **)** const |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_listening<class_PacketPeerUDP_is_listening>` **(** **)** const |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Error | :ref:`listen<class_PacketPeerUDP_listen>` **(** :ref:`int<class_int>` port, :ref:`int<class_int>` recv_buf_size=65536 **)** |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_ip_type<class_PacketPeerUDP_set_ip_type>` **(** :ref:`int<class_int>` ip_type **)** |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`set_send_address<class_PacketPeerUDP_set_send_address>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)** |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Error | :ref:`wait<class_PacketPeerUDP_wait>` **(** **)** |
|
|
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
UDP packet peer. Can be used to send raw UDP packets as well as :ref:`Variant<class_variant>`s.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_PacketPeerUDP_close:
|
|
|
|
- void **close** **(** **)**
|
|
|
|
Close the UDP socket the :ref:`PacketPeerUDP<class_packetpeerudp>` is currently listening on.
|
|
|
|
.. _class_PacketPeerUDP_get_packet_ip:
|
|
|
|
- :ref:`String<class_string>` **get_packet_ip** **(** **)** const
|
|
|
|
Return the IP of the remote peer that sent the last packet(that was received with :ref:`get_packet<class_PacketPeerUDP_get_packet>` or :ref:`get_var<class_PacketPeerUDP_get_var>`).
|
|
|
|
.. _class_PacketPeerUDP_get_packet_port:
|
|
|
|
- :ref:`int<class_int>` **get_packet_port** **(** **)** const
|
|
|
|
Return the port of the remote peer that sent the last packet(that was received with :ref:`get_packet<class_PacketPeerUDP_get_packet>` or :ref:`get_var<class_PacketPeerUDP_get_var>`).
|
|
|
|
.. _class_PacketPeerUDP_is_listening:
|
|
|
|
- :ref:`bool<class_bool>` **is_listening** **(** **)** const
|
|
|
|
Return whether this :ref:`PacketPeerUDP<class_packetpeerudp>` is listening.
|
|
|
|
.. _class_PacketPeerUDP_listen:
|
|
|
|
- Error **listen** **(** :ref:`int<class_int>` port, :ref:`int<class_int>` recv_buf_size=65536 **)**
|
|
|
|
Make this :ref:`PacketPeerUDP<class_packetpeerudp>` listen on the "port" with a buffer size "recv_buf_size". Listens on all available addresses.
|
|
|
|
.. _class_PacketPeerUDP_set_ip_type:
|
|
|
|
- void **set_ip_type** **(** :ref:`int<class_int>` ip_type **)**
|
|
|
|
.. _class_PacketPeerUDP_set_send_address:
|
|
|
|
- :ref:`int<class_int>` **set_send_address** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port **)**
|
|
|
|
Set the destination address and port for sending packets and variables, a hostname will be resolved using if valid.
|
|
|
|
.. _class_PacketPeerUDP_wait:
|
|
|
|
- Error **wait** **(** **)**
|
|
|
|
Wait for a packet to arrive on the listening port, see :ref:`listen<class_PacketPeerUDP_listen>`.
|
|
|
|
|