diff options
Diffstat (limited to 'doc/classes/Marshalls.xml')
| -rw-r--r-- | doc/classes/Marshalls.xml | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index 687f81eec7..c7118a4d9f 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="Marshalls" inherits="Reference" category="Core" version="3.1"> +<class name="Marshalls" inherits="Reference" category="Core" version="3.2"> <brief_description> Data transformation (marshalling) and encoding helpers. </brief_description> @@ -8,8 +8,6 @@ </description> <tutorials> </tutorials> - <demos> - </demos> <methods> <method name="base64_to_raw"> <return type="PoolByteArray"> @@ -17,7 +15,7 @@ <argument index="0" name="base64_str" type="String"> </argument> <description> - Return [PoolByteArray] of a given base64 encoded String. + Returns [PoolByteArray] of a given base64 encoded String. </description> </method> <method name="base64_to_utf8"> @@ -26,7 +24,7 @@ <argument index="0" name="base64_str" type="String"> </argument> <description> - Return utf8 String of a given base64 encoded String. + Returns utf8 String of a given base64 encoded String. </description> </method> <method name="base64_to_variant"> @@ -34,8 +32,11 @@ </return> <argument index="0" name="base64_str" type="String"> </argument> + <argument index="1" name="allow_objects" type="bool" default="false"> + </argument> <description> - Return [Variant] of a given base64 encoded String. + Returns [Variant] of a given base64 encoded String. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed. + [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). </description> </method> <method name="raw_to_base64"> @@ -44,7 +45,7 @@ <argument index="0" name="array" type="PoolByteArray"> </argument> <description> - Return base64 encoded String of a given [PoolByteArray]. + Returns base64 encoded String of a given [PoolByteArray]. </description> </method> <method name="utf8_to_base64"> @@ -53,7 +54,7 @@ <argument index="0" name="utf8_str" type="String"> </argument> <description> - Return base64 encoded String of a given utf8 String. + Returns base64 encoded String of a given utf8 String. </description> </method> <method name="variant_to_base64"> @@ -61,8 +62,10 @@ </return> <argument index="0" name="variant" type="Variant"> </argument> + <argument index="1" name="full_objects" type="bool" default="false"> + </argument> <description> - Return base64 encoded String of a given [Variant]. + Returns base64 encoded String of a given [Variant]. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). </description> </method> </methods> |