From 5516088c51bd58547de2600e3cfe67021cbce1dc Mon Sep 17 00:00:00 2001 From: Emanuil Chizhov Date: Sun, 10 Nov 2024 13:18:39 +0200 Subject: [PATCH] Add examples to PacketPeerUDP class documentation. Add examples for sending packets and listening for packets. Fix documentation indentation. Change tabs to spaced for codeblocks. Fix typos Remove typing in documentation code Add a blank line to comply with style guidelines Fix blank line to contain tabs Remove tabs from empty code lines Commit suggested changes by Mickeon Use correct syntax for > --- doc/classes/PacketPeerUDP.xml | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 12d3178797a..05b6e646c08 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -4,7 +4,32 @@ UDP packet peer. - 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.