Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Marshalls

Inherits: Object

Data transformation (marshaling) and encoding helpers.

Description

Provides data transformation and encoding utility functions.

Methods

PackedByteArray

base64_to_raw ( String base64_str )

String

base64_to_utf8 ( String base64_str )

Variant

base64_to_variant ( String base64_str, bool allow_objects=false )

String

raw_to_base64 ( PackedByteArray array )

String

utf8_to_base64 ( String utf8_str )

String

variant_to_base64 ( Variant variant, bool full_objects=false )


Method Descriptions

PackedByteArray base64_to_raw ( String base64_str )

Returns a decoded PackedByteArray corresponding to the Base64-encoded string base64_str.


String base64_to_utf8 ( String base64_str )

Returns a decoded string corresponding to the Base64-encoded string base64_str.


Variant base64_to_variant ( String base64_str, bool allow_objects=false )

Returns a decoded Variant corresponding to the Base64-encoded string base64_str. If allow_objects is true, decoding objects is allowed.

Internally, this uses the same decoding mechanism as the @GlobalScope.bytes_to_var method.

Warning: 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.


String raw_to_base64 ( PackedByteArray array )

Returns a Base64-encoded string of a given PackedByteArray.


String utf8_to_base64 ( String utf8_str )

Returns a Base64-encoded string of the UTF-8 string utf8_str.


String variant_to_base64 ( Variant variant, bool full_objects=false )

Returns a Base64-encoded string of the Variant variant. If full_objects is true, encoding objects is allowed (and can potentially include code).

Internally, this uses the same encoding mechanism as the @GlobalScope.var_to_bytes method.