virtualx-engine/doc/classes/Marshalls.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Marshalls" inherits="Reference" 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>