diff options
Diffstat (limited to 'doc/classes/PacketPeer.xml')
| -rw-r--r-- | doc/classes/PacketPeer.xml | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index 8d0aa89287..ab2bc34672 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PacketPeer" inherits="RefCounted" version="4.0"> +<class name="PacketPeer" inherits="RefCounted" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Abstraction and base class for packet-based protocols. </brief_description> <description> PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low-level bytes or having to worry about network ordering. + [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> </tutorials> @@ -29,25 +30,25 @@ </method> <method name="get_var"> <return type="Variant" /> - <argument index="0" name="allow_objects" type="bool" default="false" /> + <param index="0" name="allow_objects" type="bool" default="false" /> <description> - Gets a Variant. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. + Gets a Variant. If [param allow_objects] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. </description> </method> <method name="put_packet"> <return type="int" enum="Error" /> - <argument index="0" name="buffer" type="PackedByteArray" /> + <param index="0" name="buffer" type="PackedByteArray" /> <description> Sends a raw packet. </description> </method> <method name="put_var"> <return type="int" enum="Error" /> - <argument index="0" name="var" type="Variant" /> - <argument index="1" name="full_objects" type="bool" default="false" /> + <param index="0" name="var" type="Variant" /> + <param index="1" name="full_objects" type="bool" default="false" /> <description> - Sends a [Variant] as a packet. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). + Sends a [Variant] as a packet. If [param full_objects] is [code]true[/code], encoding objects is allowed (and can potentially include code). </description> </method> </methods> @@ -57,6 +58,4 @@ The [method put_var] method allocates memory on the stack, and the buffer used will grow automatically to the closest power of two to match the size of the [Variant]. If the [Variant] is bigger than [code]encode_buffer_max_size[/code], the method will error out with [constant ERR_OUT_OF_MEMORY]. </member> </members> - <constants> - </constants> </class> |