godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source 
And move GLTF docs to its module folder.
This commit is contained in:
Rémi Verschelde
2021-03-18 14:44:42 +01:00
parent 2fd445cc18
commit 4ca1e73ff9
48 changed files with 535 additions and 395 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/classes/PackedByteArray.xml
View File

@@ -52,7 +52,7 @@
Appends a [PackedByteArray] at the end of this array.
</description>
</method>
<method name="compress">
<method name="compress" qualifiers="const">
<return type="PackedByteArray">
</return>
<argument index="0" name="compression_mode" type="int" default="0">
@@ -61,7 +61,7 @@
Returns a new [PackedByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants.
</description>
</method>
<method name="decompress">
<method name="decompress" qualifiers="const">
<return type="PackedByteArray">
</return>
<argument index="0" name="buffer_size" type="int">
@@ -72,7 +72,7 @@
Returns a new [PackedByteArray] with the data decompressed. Set [code]buffer_size[/code] to the size of the uncompressed data. Set the compression mode using one of [enum File.CompressionMode]'s constants.
</description>
</method>
<method name="decompress_dynamic">
<method name="decompress_dynamic" qualifiers="const">
<return type="PackedByteArray">
</return>
<argument index="0" name="max_output_size" type="int">
@@ -92,28 +92,28 @@
Creates a copy of the array, and returns it.
</description>
</method>
<method name="get_string_from_ascii">
<method name="get_string_from_ascii" qualifiers="const">
<return type="String">
</return>
<description>
Converts ASCII/Latin-1 encoded array to [String]. Fast alternative to [method get_string_from_utf8] if the content is ASCII/Latin-1 only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use [method get_string_from_utf8].
</description>
</method>
<method name="get_string_from_utf16">
<method name="get_string_from_utf16" qualifiers="const">
<return type="String">
</return>
<description>
Converts UTF-16 encoded array to [String]. If the BOM is missing, system endianness is assumed. Returns empty string if source array is not valid UTF-16 string.
</description>
</method>
<method name="get_string_from_utf32">
<method name="get_string_from_utf32" qualifiers="const">
<return type="String">
</return>
<description>
Converts UTF-32 encoded array to [String]. System endianness is assumed. Returns empty string if source array is not valid UTF-32 string.
</description>
</method>
<method name="get_string_from_utf8">
<method name="get_string_from_utf8" qualifiers="const">
<return type="String">
</return>
<description>
@@ -129,7 +129,7 @@
Returns [code]true[/code] if the array contains [code]value[/code].
</description>
</method>
<method name="hex_encode">
<method name="hex_encode" qualifiers="const">
<return type="String">
</return>
<description>
@@ -164,7 +164,7 @@
Reverses the order of the elements in the array.
</description>
</method>
<method name="is_empty">
<method name="is_empty" qualifiers="const">
<return type="bool">
</return>
<description>
@@ -241,7 +241,7 @@
Changes the byte at the given index.
</description>
</method>
<method name="size">
<method name="size" qualifiers="const">
<return type="int">
</return>
<description>
@@ -255,7 +255,7 @@
Sorts the elements of the array in ascending order.
</description>
</method>
<method name="subarray">
<method name="subarray" qualifiers="const">
<return type="PackedByteArray">
</return>
<argument index="0" name="from" type="int">