diff options
| author | Thaddeus Crews <repiteo@outlook.com> | 2024-11-12 09:27:59 -0600 |
|---|---|---|
| committer | Thaddeus Crews <repiteo@outlook.com> | 2024-11-12 09:27:59 -0600 |
| commit | 0439686beaf64fd3a83d8ae257fe67795b268d55 (patch) | |
| tree | 9fd9847595832847b4cedf64b6ba658637c33537 | |
| parent | d58ac7fc1214c45abe0fe75ad9875514e727177c (diff) | |
| parent | 5516088c51bd58547de2600e3cfe67021cbce1dc (diff) | |
| download | redot-engine-0439686beaf64fd3a83d8ae257fe67795b268d55.tar.gz | |
Merge pull request #99015 from CabalCrow/PacketPeerUDP-docs-example
Add examples to PacketPeerUDP class documentation
| -rw-r--r-- | doc/classes/PacketPeerUDP.xml | 27 |
1 files changed, 26 insertions, 1 deletions
diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 12d3178797..05b6e646c0 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -4,7 +4,32 @@ UDP packet peer. </brief_description> <description> - UDP packet peer. Can be used to send raw UDP packets as well as [Variant]s. + UDP packet peer. Can be used to send and receive raw UDP packets as well as [Variant]s. + [b]Example:[/b] Send a packet: + [codeblock] + var peer = PacketPeerUDP.new() + + # Optionally, you can select the local port used to send the packet. + peer.bind(4444) + + peer.set_dest_address("1.1.1.1", 4433) + peer.put_packet("hello".to_utf8_buffer()) + [/codeblock] + [b]Example:[/b] Listen for packets: + [codeblock] + var peer + + func _ready(): + peer = PacketPeerUDP.new() + peer.bind(4433) + + + func _process(_delta): + if peer.get_available_packet_count() > 0: + var array_bytes = peer.get_packet() + var packet_string = array_bytes.get_string_from_ascii() + print("Received message: ", packet_string) + [/codeblock] [b]Note:[/b] When exporting to Android, make sure to enable the [code]INTERNET[/code] 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. </description> <tutorials> |