virtualx-engine/doc/classes/Marshalls.xml
Sean Heffernan 426bcc9941 Change "Return" to "Returns" where necessary in XML documentation
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".

Fixes #28867
2019-05-23 21:11:24 -07:00

74 lines
2.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Marshalls" inherits="Reference" category="Core" version="3.2">
<brief_description>
Data transformation (marshalling) and encoding helpers.
</brief_description>
<description>
Provides data transformation and encoding utility functions.
</description>
<tutorials>
</tutorials>
<methods>
<method name="base64_to_raw">
<return type="PoolByteArray">
</return>
<argument index="0" name="base64_str" type="String">
</argument>
<description>
Returns [PoolByteArray] of a given base64 encoded String.
</description>
</method>
<method name="base64_to_utf8">
<return type="String">
</return>
<argument index="0" name="base64_str" type="String">
</argument>
<description>
Returns utf8 String of a given base64 encoded String.
</description>
</method>
<method name="base64_to_variant">
<return type="Variant">
</return>
<argument index="0" name="base64_str" type="String">
</argument>
<argument index="1" name="allow_objects" type="bool" default="false">
</argument>
<description>
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">
<return type="String">
</return>
<argument index="0" name="array" type="PoolByteArray">
</argument>
<description>
Returns base64 encoded String of a given [PoolByteArray].
</description>
</method>
<method name="utf8_to_base64">
<return type="String">
</return>
<argument index="0" name="utf8_str" type="String">
</argument>
<description>
Returns base64 encoded String of a given utf8 String.
</description>
</method>
<method name="variant_to_base64">
<return type="String">
</return>
<argument index="0" name="variant" type="Variant">
</argument>
<argument index="1" name="full_objects" type="bool" default="false">
</argument>
<description>
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>
<constants>
</constants>
</class>