mirror of
https://github.com/godotengine/godot.git
synced 2024-12-15 10:12:40 +08:00
f7f6115f76
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
75 lines
2.6 KiB
XML
75 lines
2.6 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 a decoded [PoolByteArray] corresponding to the Base64-encoded string [code]base64_str[/code].
|
|
</description>
|
|
</method>
|
|
<method name="base64_to_utf8">
|
|
<return type="String">
|
|
</return>
|
|
<argument index="0" name="base64_str" type="String">
|
|
</argument>
|
|
<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">
|
|
</return>
|
|
<argument index="0" name="base64_str" type="String">
|
|
</argument>
|
|
<argument index="1" name="allow_objects" type="bool" default="false">
|
|
</argument>
|
|
<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">
|
|
</return>
|
|
<argument index="0" name="array" type="PoolByteArray">
|
|
</argument>
|
|
<description>
|
|
Returns a 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 a Base64-encoded string of the UTF-8 string [code]utf8_str[/code].
|
|
</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 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>
|