godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/Marshalls.xml

75 lines
2.4 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Sync classref with current source
2019-07-05 09:32:53 +00:00
<class name="Marshalls" inherits="Reference" category="Core" version="3.1.2">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Added documentation for ClassDB and Marshalls
2017-09-12 22:18:26 +00:00
Data transformation (marshalling) and encoding helpers.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Added documentation for ClassDB and Marshalls
2017-09-12 22:18:26 +00:00
Provides data transformation and encoding utility functions.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="base64_to_raw">
<return type="PoolByteArray">
</return>
<argument index="0" name="base64_str" type="String">
</argument>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867 (cherry picked from commit 426bcc9941e98696c872b0f6421d2ef28b987e60)
2019-05-24 02:15:43 +00:00
Returns [PoolByteArray] of a given base64 encoded String.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="base64_to_utf8">
<return type="String">
</return>
<argument index="0" name="base64_str" type="String">
</argument>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867 (cherry picked from commit 426bcc9941e98696c872b0f6421d2ef28b987e60)
2019-05-24 02:15:43 +00:00
Returns utf8 String of a given base64 encoded String.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="base64_to_variant">
<return type="Variant">
</return>
<argument index="0" name="base64_str" type="String">
</argument>
Add object encoding param to serialization methods Network peers get_var/put_var File get_var/store_var GDScript/Mono/VisualScript bytes2var/var2bytes Add MultiplayerAPI.allow_object_decoding member which deprecates PacketPeer.allow_object_decoding. Break ABI compatibaility (API compatibility for GDNative). (cherry picked from commit 393e62b98a5a37ccdd7d860571e2f8cc7b970fe4)
2019-03-26 15:52:42 +00:00
<argument index="1" name="allow_objects" type="bool" default="false">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867 (cherry picked from commit 426bcc9941e98696c872b0f6421d2ef28b987e60)
2019-05-24 02:15:43 +00:00
Returns [Variant] of a given base64 encoded String. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed.
Add object encoding param to serialization methods Network peers get_var/put_var File get_var/store_var GDScript/Mono/VisualScript bytes2var/var2bytes Add MultiplayerAPI.allow_object_decoding member which deprecates PacketPeer.allow_object_decoding. Break ABI compatibaility (API compatibility for GDNative). (cherry picked from commit 393e62b98a5a37ccdd7d860571e2f8cc7b970fe4)
2019-03-26 15:52:42 +00:00
[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).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="raw_to_base64">
<return type="String">
</return>
<argument index="0" name="array" type="PoolByteArray">
</argument>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867 (cherry picked from commit 426bcc9941e98696c872b0f6421d2ef28b987e60)
2019-05-24 02:15:43 +00:00
Returns base64 encoded String of a given [PoolByteArray].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="utf8_to_base64">
<return type="String">
</return>
<argument index="0" name="utf8_str" type="String">
</argument>
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867 (cherry picked from commit 426bcc9941e98696c872b0f6421d2ef28b987e60)
2019-05-24 02:15:43 +00:00
Returns base64 encoded String of a given utf8 String.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="variant_to_base64">
<return type="String">
</return>
<argument index="0" name="variant" type="Variant">
</argument>
Add object encoding param to serialization methods Network peers get_var/put_var File get_var/store_var GDScript/Mono/VisualScript bytes2var/var2bytes Add MultiplayerAPI.allow_object_decoding member which deprecates PacketPeer.allow_object_decoding. Break ABI compatibaility (API compatibility for GDNative). (cherry picked from commit 393e62b98a5a37ccdd7d860571e2f8cc7b970fe4)
2019-03-26 15:52:42 +00:00
<argument index="1" name="full_objects" type="bool" default="false">
</argument>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867 (cherry picked from commit 426bcc9941e98696c872b0f6421d2ef28b987e60)
2019-05-24 02:15:43 +00:00
Returns 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).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<constants>
</constants>
</class>