diff options
Diffstat (limited to 'doc/classes/PacketPeer.xml')
| -rw-r--r-- | doc/classes/PacketPeer.xml | 28 |
1 files changed, 17 insertions, 11 deletions
diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index a4cf0c8029..d52bf4e3bb 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -1,42 +1,43 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="PacketPeer" inherits="Reference" category="Core" version="3.1"> +<class name="PacketPeer" inherits="Reference" category="Core" version="3.2"> <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. + 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. </description> <tutorials> </tutorials> - <demos> - </demos> <methods> <method name="get_available_packet_count" qualifiers="const"> <return type="int"> </return> <description> - Return the number of packets currently available in the ring-buffer. + Returns the number of packets currently available in the ring-buffer. </description> </method> <method name="get_packet"> <return type="PoolByteArray"> </return> <description> - Get a raw packet. + Gets a raw packet. </description> </method> <method name="get_packet_error" qualifiers="const"> <return type="int" enum="Error"> </return> <description> - Return the error state of the last packet received (via [method get_packet] and [method get_var]). + Returns the error state of the last packet received (via [method get_packet] and [method get_var]). </description> </method> <method name="get_var"> <return type="Variant"> </return> + <argument index="0" name="allow_objects" type="bool" default="false"> + </argument> <description> - Get a Variant. + Gets a Variant. If [code]allow_objects[/code] (or [member allow_object_decoding]) 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"> @@ -45,7 +46,7 @@ <argument index="0" name="buffer" type="PoolByteArray"> </argument> <description> - Send a raw packet. + Sends a raw packet. </description> </method> <method name="put_var"> @@ -53,13 +54,18 @@ </return> <argument index="0" name="var" type="Variant"> </argument> + <argument index="1" name="full_objects" type="bool" default="false"> + </argument> <description> - Send a Variant as a packet. + Sends a [Variant] as a packet. If [code]full_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], encoding objects is allowed (and can potentially include code). </description> </method> </methods> <members> - <member name="allow_object_decoding" type="bool" setter="set_allow_object_decoding" getter="is_object_decoding_allowed"> + <member name="allow_object_decoding" type="bool" setter="set_allow_object_decoding" getter="is_object_decoding_allowed" default="false"> + [i]Deprecated.[/i] Use [code]get_var[/code] and [code]put_var[/code] parameters instead. + If [code]true[/code], the PacketPeer will allow encoding and decoding of object via [method get_var] and [method put_var]. + [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. </member> </members> <constants> |