Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-21 19:42:43 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Add examples to PacketPeerUDP class documentation.

Browse Source 
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 >
This commit is contained in:
Emanuil Chizhov 2024-11-10 13:18:39 +02:00
parent e65a23762b
commit 5516088c51
No known key found for this signature in database
GPG Key ID: A7340EC8DC47F5D3
1 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/classes/PacketPeerUDP.xml
View File

@ -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() &gt; 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>