diff options
Diffstat (limited to 'doc/classes/PackedByteArray.xml')
| -rw-r--r-- | doc/classes/PackedByteArray.xml | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index 75fb7c1465..3c7f0f4fad 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -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"> @@ -81,7 +81,7 @@ </argument> <description> Returns a new [PackedByteArray] with the data decompressed. Set the compression mode using one of [enum File.CompressionMode]'s constants. [b]This method only accepts gzip and deflate compression modes.[/b] - This method is potentially slower than [code]decompress[/code], as it may have to re-allocate it's output buffer multiple times while decompressing, where as [code]decompress[/code] knows it's output buffer size from the beginning. + This method is potentially slower than [code]decompress[/code], as it may have to re-allocate its output buffer multiple times while decompressing, whereas [code]decompress[/code] knows it's output buffer size from the beginning. GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a small compressed payload to decompress to a potentially very large output. To guard against this, you may provide a maximum size this function is allowed to allocate in bytes via [code]max_output_size[/code]. Passing -1 will allow for unbounded output. If any positive value is passed, and the decompression exceeds that amount in bytes, then an error will be returned. </description> </method> @@ -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"> |