summaryrefslogtreecommitdiff
path: root/doc/classes/Marshalls.xml
blob: 0d07d8b64981f6f450cd43a37f978b1dc4b098b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<?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>
				Return [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>
				Return 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>
				Return [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>
				Return 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>
				Return 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>
				Return 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>