浏览代码

Merge pull request #99015 from CabalCrow/PacketPeerUDP-docs-example

Add examples to PacketPeerUDP class documentation
Thaddeus Crews 10 月之前
父节点
当前提交
0439686bea
共有 1 个文件被更改,包括 26 次插入1 次删除
  1. 26 1
      doc/classes/PacketPeerUDP.xml

+ 26 - 1
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() &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>