f5836b40d4
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
(cherry picked from commit 7adf4cc9b5)
60 lines
2.4 KiB
XML
60 lines
2.4 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Marshalls" inherits="Object" version="3.4">
|
|
<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" />
|
|
<argument index="0" name="base64_str" type="String" />
|
|
<description>
|
|
Returns a decoded [PoolByteArray] corresponding to the Base64-encoded string [code]base64_str[/code].
|
|
</description>
|
|
</method>
|
|
<method name="base64_to_utf8">
|
|
<return type="String" />
|
|
<argument index="0" name="base64_str" type="String" />
|
|
<description>
|
|
Returns a decoded string corresponding to the Base64-encoded string [code]base64_str[/code].
|
|
</description>
|
|
</method>
|
|
<method name="base64_to_variant">
|
|
<return type="Variant" />
|
|
<argument index="0" name="base64_str" type="String" />
|
|
<argument index="1" name="allow_objects" type="bool" default="false" />
|
|
<description>
|
|
Returns a decoded [Variant] corresponding to the Base64-encoded string [code]base64_str[/code]. If [code]allow_objects[/code] 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="raw_to_base64">
|
|
<return type="String" />
|
|
<argument index="0" name="array" type="PoolByteArray" />
|
|
<description>
|
|
Returns a Base64-encoded string of a given [PoolByteArray].
|
|
</description>
|
|
</method>
|
|
<method name="utf8_to_base64">
|
|
<return type="String" />
|
|
<argument index="0" name="utf8_str" type="String" />
|
|
<description>
|
|
Returns a Base64-encoded string of the UTF-8 string [code]utf8_str[/code].
|
|
</description>
|
|
</method>
|
|
<method name="variant_to_base64">
|
|
<return type="String" />
|
|
<argument index="0" name="variant" type="Variant" />
|
|
<argument index="1" name="full_objects" type="bool" default="false" />
|
|
<description>
|
|
Returns a Base64-encoded string of the [Variant] [code]variant[/code]. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code).
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<constants>
|
|
</constants>
|
|
</class>
|