Skip to content
Download
API reference

PackedByteArray

A packed array of bytes ([]u8 in Grost).

An array specifically designed to hold bytes. Packs data tightly, so it saves memory for large array sizes.

In Grost this array is written []u8: an array of u8 (ints from 0 to 255) stores them packed, one after another, with no Variant each. It has Array’s methods (map(), filter(), reduce(), sort_custom()…), and what finds no element in an empty array (front(), pop_back(), min()…) is an Option[u8]. The engine takes and gives it as it is, without converting each value.

[]u8 also provides methods to encode/decode various types to/from bytes. The way values are encoded is an implementation detail and shouldn’t be relied upon when interacting with external apps.

Note: Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use duplicate(). This is not the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will not affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again.

Note: In a boolean context, a packed array will evaluate to false if it’s empty. Otherwise, a packed array will always evaluate to true.

ReturnsMethod
boolall(method)
boolany(method)
voidappend(value)
voidappend_array(array)
Variantback()
intbsearch(value, before)
intbsearch_custom(value, func, before)
voidbswap16(offset, count)
voidbswap32(offset, count)
voidbswap64(offset, count)
voidclear()
[]u8compress(compression_mode)
intcount(value)
floatdecode_double(byte_offset)
floatdecode_float(byte_offset)
floatdecode_half(byte_offset)
intdecode_s8(byte_offset)
intdecode_s16(byte_offset)
intdecode_s32(byte_offset)
intdecode_s64(byte_offset)
intdecode_u8(byte_offset)
intdecode_u16(byte_offset)
intdecode_u32(byte_offset)
intdecode_u64(byte_offset)
Variantdecode_var(byte_offset, allow_objects)
intdecode_var_size(byte_offset, allow_objects)
[]u8decompress(buffer_size, compression_mode)
[]u8decompress_dynamic(max_output_size, compression_mode)
[]u8duplicate()
voidencode_double(byte_offset, value)
voidencode_float(byte_offset, value)
voidencode_half(byte_offset, value)
voidencode_s8(byte_offset, value)
voidencode_s16(byte_offset, value)
voidencode_s32(byte_offset, value)
voidencode_s64(byte_offset, value)
voidencode_u8(byte_offset, value)
voidencode_u16(byte_offset, value)
voidencode_u32(byte_offset, value)
voidencode_u64(byte_offset, value)
intencode_var(byte_offset, value, allow_objects)
boolerase(value)
voidfill(value)
[]u8filter(method)
intfind(value, from)
intfind_custom(method, from)
Variantfront()
intget(index)
Stringget_string_from_ascii()
Stringget_string_from_multibyte_char(encoding)
Stringget_string_from_utf8()
Stringget_string_from_utf16()
Stringget_string_from_utf32()
Stringget_string_from_wchar()
boolhas(value)
boolhas_encoded_var(byte_offset, allow_objects)
Stringhex_encode()
intinsert(at_index, value)
boolis_empty()
Arraymap(method)
Variantmax()
Variantmin()
Variantpick_random()
Variantpop_at(position)
Variantpop_back()
Variantpop_front()
voidpush_back(value)
voidpush_front(value)
Variantreduce(method, accum)
voidremove_at(index)
intresize(new_size)
voidreverse()
intrfind(value, from)
intrfind_custom(method, from)
voidset(index, value)
voidshuffle()
intsize()
[]u8slice(begin, end)
voidsort()
voidsort_custom(func)
[]Colorto_color_array()
[]f32to_float32_array()
[]floatto_float64_array()
[]i32to_int32_array()
[]intto_int64_array()
[]Vector2to_vector2_array()
[]Vector3to_vector3_array()
[]Vector4to_vector4_array()

bool all(method: Callable) const

Calls method with each element and returns true if it returns true for all of them (or the array is empty). As Array.all().

bool any(method: Callable) const

Calls method with each element and returns true as soon as it returns true for one of them. As Array.any().

void append(value: int)

Appends an element at the end of the array (alias of push_back()).

void append_array(array: []u8)

Appends a []u8 at the end of this array.

Variant back() const

Returns the last element. In Grost it is an Option[u8]: none when the array is empty.

int bsearch(value: int, before: bool = true) const

Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array.

Note: Calling bsearch() on an unsorted array results in unexpected behavior.

int bsearch_custom(value: int, func: Callable, before: bool = true) const

Finds where value goes in an array sorted by func (which returns true when its first argument goes before the second), with a binary search. As Array.bsearch_custom().

void bswap16(offset: int = 0, count: int = -1)

Swaps the byte order of count 16-bit segments of the array starting at offset. Swap is done in-place. If count is less than zero, all segments to the end of array are processed, if processed data size is not a multiple of 2, the byte after the last processed 16-bit segment is not modified.

void bswap32(offset: int = 0, count: int = -1)

Swaps the byte order of count 32-bit segments of the array starting at offset. Swap is done in-place. If count is less than zero, all segments to the end of array are processed, if processed data size is not a multiple of 4, bytes after the last processed 32-bit segment are not modified.

void bswap64(offset: int = 0, count: int = -1)

Swaps the byte order of count 64-bit segments of the array starting at offset. Swap is done in-place. If count is less than zero, all segments to the end of array are processed, if processed data size is not a multiple of 8, bytes after the last processed 64-bit segment are not modified.

void clear()

Clears the array. This is equivalent to using resize() with a size of 0.

[]u8 compress(compression_mode: int = 0) const

Returns a new []u8 with the data compressed. Set the compression mode using one of FileAccess.CompressionMode’s constants.

int count(value: int) const

Returns the number of times an element is in the array.

float decode_double(byte_offset: int) const

Decodes a 64-bit floating-point number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0.0 if a valid number can’t be decoded.

float decode_float(byte_offset: int) const

Decodes a 32-bit floating-point number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0.0 if a valid number can’t be decoded.

float decode_half(byte_offset: int) const

Decodes a 16-bit floating-point number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0.0 if a valid number can’t be decoded.

int decode_s8(byte_offset: int) const

Decodes a 8-bit signed integer number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0 if a valid number can’t be decoded.

int decode_s16(byte_offset: int) const

Decodes a 16-bit signed integer number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0 if a valid number can’t be decoded.

int decode_s32(byte_offset: int) const

Decodes a 32-bit signed integer number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0 if a valid number can’t be decoded.

int decode_s64(byte_offset: int) const

Decodes a 64-bit signed integer number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0 if a valid number can’t be decoded.

int decode_u8(byte_offset: int) const

Decodes a 8-bit unsigned integer number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0 if a valid number can’t be decoded.

int decode_u16(byte_offset: int) const

Decodes a 16-bit unsigned integer number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0 if a valid number can’t be decoded.

int decode_u32(byte_offset: int) const

Decodes a 32-bit unsigned integer number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0 if a valid number can’t be decoded.

int decode_u64(byte_offset: int) const

Decodes a 64-bit unsigned integer number from the bytes starting at byte_offset. Fails if the byte count is insufficient. Returns 0 if a valid number can’t be decoded.

Variant decode_var(byte_offset: int, allow_objects: bool = false) const

Decodes a Variant from the bytes starting at byte_offset. Returns null if a valid variant can’t be decoded or the value is Object-derived and allow_objects is false.

int decode_var_size(byte_offset: int, allow_objects: bool = false) const

Decodes a size of a Variant from the bytes starting at byte_offset. Requires at least 4 bytes of data starting at the offset, otherwise fails.

[]u8 decompress(buffer_size: int, compression_mode: int = 0) const

Returns a new []u8 with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of FileAccess.CompressionMode’s constants.

Note: Decompression is not guaranteed to work with data not compressed by Gobu, for example if data compressed with the deflate compression mode lacks a checksum or header.

[]u8 decompress_dynamic(max_output_size: int, compression_mode: int = 0) const

Returns a new []u8 with the data decompressed. Set the compression mode using one of FileAccess.CompressionMode’s constants. This method only accepts brotli, gzip, and deflate compression modes.

This method is potentially slower than decompress(), as it may have to re-allocate its output buffer multiple times while decompressing, whereas decompress() 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 max_output_size. 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.

Note: Decompression is not guaranteed to work with data not compressed by Gobu, for example if data compressed with the deflate compression mode lacks a checksum or header.

[]u8 duplicate() const

Creates a copy of the array, and returns it.

void encode_double(byte_offset: int, value: float)

Encodes a 64-bit floating-point number as bytes at the index of byte_offset bytes. The array must have at least 8 bytes of allocated space, starting at the offset.

void encode_float(byte_offset: int, value: float)

Encodes a 32-bit floating-point number as bytes at the index of byte_offset bytes. The array must have at least 4 bytes of space, starting at the offset.

void encode_half(byte_offset: int, value: float)

Encodes a 16-bit floating-point number as bytes at the index of byte_offset bytes. The array must have at least 2 bytes of space, starting at the offset.

void encode_s8(byte_offset: int, value: int)

Encodes a 8-bit signed integer number (signed byte) at the index of byte_offset bytes. The array must have at least 1 byte of space, starting at the offset.

void encode_s16(byte_offset: int, value: int)

Encodes a 16-bit signed integer number as bytes at the index of byte_offset bytes. The array must have at least 2 bytes of space, starting at the offset.

void encode_s32(byte_offset: int, value: int)

Encodes a 32-bit signed integer number as bytes at the index of byte_offset bytes. The array must have at least 4 bytes of space, starting at the offset.

void encode_s64(byte_offset: int, value: int)

Encodes a 64-bit signed integer number as bytes at the index of byte_offset bytes. The array must have at least 8 bytes of space, starting at the offset.

void encode_u8(byte_offset: int, value: int)

Encodes a 8-bit unsigned integer number (byte) at the index of byte_offset bytes. The array must have at least 1 byte of space, starting at the offset.

void encode_u16(byte_offset: int, value: int)

Encodes a 16-bit unsigned integer number as bytes at the index of byte_offset bytes. The array must have at least 2 bytes of space, starting at the offset.

void encode_u32(byte_offset: int, value: int)

Encodes a 32-bit unsigned integer number as bytes at the index of byte_offset bytes. The array must have at least 4 bytes of space, starting at the offset.

void encode_u64(byte_offset: int, value: int)

Encodes a 64-bit unsigned integer number as bytes at the index of byte_offset bytes. The array must have at least 8 bytes of space, starting at the offset.

int encode_var(byte_offset: int, value: Variant, allow_objects: bool = false)

Encodes a Variant at the index of byte_offset bytes. A sufficient space must be allocated, depending on the encoded variant’s size. If allow_objects is false, Object-derived values are not permitted and will instead be serialized as ID-only.

bool erase(value: int)

Removes the first occurrence of a value from the array and returns true. If the value does not exist in the array, nothing happens and false is returned. To remove an element by index, use remove_at() instead.

void fill(value: int)

Assigns the given value to all elements in the array. This can typically be used together with resize() to create an array with a given size and initialized elements.

[]u8 filter(method: Callable) const

Returns a new array of the same type ([]u8 in Grost) with the elements for which method returns true. As Array.filter().

int find(value: int, from: int = 0) const

Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.

int find_custom(method: Callable, from: int = 0) const

Returns the index of the first element, from from, for which method returns true, or -1. As Array.find_custom().

Variant front() const

Returns the first element. In Grost it is an Option[u8]: none when the array is empty.

int get(index: int) const

Returns the byte at the given index in the array. If index is out-of-bounds or negative, this method fails and returns 0.

This method is similar (but not identical) to the [] operator. Most notably, when this method fails, it doesn’t pause project execution if run from the editor.

String get_string_from_ascii() const

Converts ASCII/Latin-1 encoded array to String. Fast alternative to 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 get_string_from_utf8(). This is the inverse of String.to_ascii_buffer().

String get_string_from_multibyte_char(encoding: String = "") const

Converts system multibyte code page encoded array to String. If conversion fails, empty string is returned. This is the inverse of String.to_multibyte_char_buffer().

The values permitted for encoding are system dependent. If encoding is empty string, system default encoding is used.

  • For Windows, see Code Page Identifiers .NET names.

  • For macOS and Linux/BSD, see libiconv library documentation and iconv --list for a list of supported encodings.

String get_string_from_utf8() const

Converts UTF-8 encoded array to String. Slower than get_string_from_ascii() but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. Returns empty string if source array is not valid UTF-8 string. This is the inverse of String.to_utf8_buffer().

String get_string_from_utf16() const

Converts UTF-16 encoded array to String. If the BOM is missing, little-endianness is assumed. Returns empty string if source array is not valid UTF-16 string. This is the inverse of String.to_utf16_buffer().

String get_string_from_utf32() const

Converts UTF-32 encoded array to String. Returns empty string if source array is not valid UTF-32 string. This is the inverse of String.to_utf32_buffer().

String get_string_from_wchar() const

Converts wide character (wchar_t, UTF-16 on Windows, UTF-32 on other platforms) encoded array to String. Returns empty string if source array is not valid wide string. This is the inverse of String.to_wchar_buffer().

bool has(value: int) const

Returns true if the array contains value.

bool has_encoded_var(byte_offset: int, allow_objects: bool = false) const

Returns true if a valid Variant value can be decoded at the byte_offset. Returns false otherwise or when the value is Object-derived and allow_objects is false.

String hex_encode() const

Returns a hexadecimal representation of this array as a String.

array : []u8 = [11, 46, 255]
print(array.hex_encode()) # Prints "0b2eff"

int insert(at_index: int, value: int)

Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (idx == size()).

bool is_empty() const

Returns true if the array is empty.

Array map(method: Callable) const

Returns an Array with what method returns for each element. As Array.map().

Variant max() const

Returns the largest element. In Grost it is an Option[u8]: none when the array is empty.

Variant min() const

Returns the smallest element. In Grost it is an Option[u8]: none when the array is empty.

Variant pick_random() const

Returns a random element. In Grost it is an Option[u8]: none when the array is empty.

Variant pop_at(position: int)

Removes the element at position (negative counts from the end) and returns it. In Grost it is an Option[u8]: none when the array is empty.

Variant pop_back()

Removes the last element and returns it. In Grost it is an Option[u8]: none when the array is empty.

Variant pop_front()

Removes the first element and returns it. In Grost it is an Option[u8]: none when the array is empty.

void push_back(value: int)

Appends an element at the end of the array.

void push_front(value: int)

Inserts value at the start of the array.

Variant reduce(method: Callable, accum: Variant = null) const

Calls method with the value so far and each element, in order, and returns the last result. accum is the start value (without one, the first element). As Array.reduce(). In Grost, with a lambda and a start value of the type it returns, the result has that type (values.reduce(fn(a : int, b : int) => a + b, 0) is an int).

void remove_at(index: int)

Removes an element from the array by index.

int resize(new_size: int)

Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling resize() once and assigning the new values is faster than adding new elements one by one.

Returns OK on success, or one of the following Error constants if this method fails: ERR_INVALID_PARAMETER if the size is negative, or ERR_OUT_OF_MEMORY if allocations fail. Use size() to find the actual size of the array after resize.

void reverse()

Reverses the order of the elements in the array.

int rfind(value: int, from: int = -1) const

Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.

int rfind_custom(method: Callable, from: int = -1) const

Returns the index of the last element, from from backwards, for which method returns true, or -1. As Array.rfind_custom().

void set(index: int, value: int)

Changes the byte at the given index.

void shuffle()

Puts the elements in a random order.

int size() const

Returns the number of elements in the array.

[]u8 slice(begin: int, end: int = 2147483647) const

Returns the slice of the []u8, from begin (inclusive) to end (exclusive), as a new []u8.

The absolute value of begin and end will be clamped to the array size, so the default value for end makes it slice to the size of the array by default (i.e. arr.slice(1) is a shorthand for arr.slice(1, arr.size())).

If either begin or end are negative, they will be relative to the end of the array (i.e. arr.slice(0, -2) is a shorthand for arr.slice(0, arr.size() - 2)).

void sort()

Sorts the elements of the array in ascending order.

void sort_custom(func: Callable)

Sorts the array with func, which returns true when its first argument goes before the second. As Array.sort_custom().

[]Color to_color_array() const

Returns a copy of the data converted to a []Color, where each block of 16 bytes has been converted to a Color variant.

Note: The size of the input array must be a multiple of 16 (size of four 32-bit float variables). The size of the new array will be byte_array.size() / 16. If the original data can’t be converted to Color variants, the resulting data is undefined.

[]f32 to_float32_array() const

Returns a copy of the data converted to a []f32, where each block of 4 bytes has been converted to a 32-bit float (C++ [code skip-lint]float[/code]).

The size of the input array must be a multiple of 4 (size of 32-bit float). The size of the new array will be byte_array.size() / 4.

If the original data can’t be converted to 32-bit floats, the resulting data is undefined.

[]float to_float64_array() const

Returns a copy of the data converted to a []float, where each block of 8 bytes has been converted to a 64-bit float (C++ double, Gobu [float]).

The size of the input array must be a multiple of 8 (size of 64-bit double). The size of the new array will be byte_array.size() / 8.

If the original data can’t be converted to 64-bit floats, the resulting data is undefined.

[]i32 to_int32_array() const

Returns a copy of the data converted to a []i32, where each block of 4 bytes has been converted to a signed 32-bit integer (C++ int32_t).

The size of the input array must be a multiple of 4 (size of 32-bit integer). The size of the new array will be byte_array.size() / 4.

If the original data can’t be converted to signed 32-bit integers, the resulting data is undefined.

[]int to_int64_array() const

Returns a copy of the data converted to a []int, where each block of 8 bytes has been converted to a signed 64-bit integer (C++ int64_t, Gobu [int]).

The size of the input array must be a multiple of 8 (size of 64-bit integer). The size of the new array will be byte_array.size() / 8.

If the original data can’t be converted to signed 64-bit integers, the resulting data is undefined.

[]Vector2 to_vector2_array() const

Returns a copy of the data converted to a []Vector2, where each block of 8 bytes or 16 bytes (32-bit or 64-bit) has been converted to a Vector2 variant.

Note: The size of the input array must be a multiple of 8 or 16 (depending on the build settings, see Vector2 for more details). The size of the new array will be byte_array.size() / (8 or 16). If the original data can’t be converted to Vector2 variants, the resulting data is undefined.

[]Vector3 to_vector3_array() const

Returns a copy of the data converted to a []Vector3, where each block of 12 or 24 bytes (32-bit or 64-bit) has been converted to a Vector3 variant.

Note: The size of the input array must be a multiple of 12 or 24 (depending on the build settings, see Vector3 for more details). The size of the new array will be byte_array.size() / (12 or 24). If the original data can’t be converted to Vector3 variants, the resulting data is undefined.

[]Vector4 to_vector4_array() const

Returns a copy of the data converted to a []Vector4, where each block of 16 or 32 bytes (32-bit or 64-bit) has been converted to a Vector4 variant.

Note: The size of the input array must be a multiple of 16 or 32 (depending on the build settings, see Vector4 for more details). The size of the new array will be byte_array.size() / (16 or 32). If the original data can’t be converted to Vector4 variants, the resulting data is undefined.