Class PackedByteArray

A packed array of bytes.

PackedByteArray

Remarks

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

PackedByteArray 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. The returned packed array of these are a copies, and changing it will not affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again.

Constructors

PackedByteArray

Constructs an empty PackedByteArray.

PackedByteArray PackedByteArray

PackedByteArray(PackedByteArray)

Constructs a PackedByteArray as a copy of the given PackedByteArray.

PackedByteArray PackedByteArray(PackedByteArray from)

Parameters

from PackedByteArray

PackedByteArray(Array)

Constructs a new PackedByteArray. Optionally, you can pass in a generic Array that will be converted.

PackedByteArray PackedByteArray(Array from)

Parameters

from Array

Methods

append(int)

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

bool append(int value)

Parameters

value int

append_array(PackedByteArray)

Appends a PackedByteArray at the end of this array.

void append_array(PackedByteArray array)

Parameters

array PackedByteArray

bsearch(int, bool)

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 PackedByteArray.bsearch on an unsorted array results in unexpected behavior.

int bsearch(int value, bool before)

Parameters

value int

before bool

clear

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

void clear

compress(int)

Qualifiers: const

Returns a new PackedByteArray with the data compressed. Set the compression mode using one of CompressionMode's constants.

PackedByteArray compress(int compression_mode)

Parameters

compression_mode int

count(int)

Qualifiers: const

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

int count(int value)

Parameters

value int

decode_double(int)

Qualifiers: 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_double(int byte_offset)

Parameters

byte_offset int

decode_float(int)

Qualifiers: 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_float(int byte_offset)

Parameters

byte_offset int

decode_half(int)

Qualifiers: 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.

float decode_half(int byte_offset)

Parameters

byte_offset int

decode_s8(int)

Qualifiers: 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_s8(int byte_offset)

Parameters

byte_offset int

decode_s16(int)

Qualifiers: 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_s16(int byte_offset)

Parameters

byte_offset int

decode_s32(int)

Qualifiers: 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_s32(int byte_offset)

Parameters

byte_offset int

decode_s64(int)

Qualifiers: 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_s64(int byte_offset)

Parameters

byte_offset int

decode_u8(int)

Qualifiers: 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_u8(int byte_offset)

Parameters

byte_offset int

decode_u16(int)

Qualifiers: 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_u16(int byte_offset)

Parameters

byte_offset int

decode_u32(int)

Qualifiers: 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_u32(int byte_offset)

Parameters

byte_offset int

decode_u64(int)

Qualifiers: 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.

int decode_u64(int byte_offset)

Parameters

byte_offset int

decode_var(int, bool)

Qualifiers: 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.

Variant decode_var(int byte_offset, bool allow_objects)

Parameters

byte_offset int

allow_objects bool

decode_var_size(int, bool)

Qualifiers: 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.

int decode_var_size(int byte_offset, bool allow_objects)

Parameters

byte_offset int

allow_objects bool

decompress(int, int)

Qualifiers: const

Returns a new PackedByteArray with the data decompressed. Set buffer_size to the size of the uncompressed data. Set the compression mode using one of CompressionMode's constants.

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

PackedByteArray decompress(int buffer_size, int compression_mode)

Parameters

buffer_size int

compression_mode int

decompress_dynamic(int, int)

Qualifiers: const

Returns a new PackedByteArray with the data decompressed. Set the compression mode using one of CompressionMode's constants. This method only accepts brotli, gzip, and deflate compression modes.

This method is potentially slower than PackedByteArray.decompress, as it may have to re-allocate its output buffer multiple times while decompressing, whereas PackedByteArray.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 Godot, for example if data compressed with the deflate compression mode lacks a checksum or header.

PackedByteArray decompress_dynamic(int max_output_size, int compression_mode)

Parameters

max_output_size int

compression_mode int

duplicate

Creates a copy of the array, and returns it.

PackedByteArray duplicate

encode_double(int, 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_double(int byte_offset, float value)

Parameters

byte_offset int

value float

encode_float(int, 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_float(int byte_offset, float value)

Parameters

byte_offset int

value float

encode_half(int, 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_half(int byte_offset, float value)

Parameters

byte_offset int

value float

encode_s8(int, 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_s8(int byte_offset, int value)

Parameters

byte_offset int

value int

encode_s16(int, 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_s16(int byte_offset, int value)

Parameters

byte_offset int

value int

encode_s32(int, 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_s32(int byte_offset, int value)

Parameters

byte_offset int

value int

encode_s64(int, 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_s64(int byte_offset, int value)

Parameters

byte_offset int

value int

encode_u8(int, 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_u8(int byte_offset, int value)

Parameters

byte_offset int

value int

encode_u16(int, 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_u16(int byte_offset, int value)

Parameters

byte_offset int

value int

encode_u32(int, 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_u32(int byte_offset, int value)

Parameters

byte_offset int

value int

encode_u64(int, 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.

void encode_u64(int byte_offset, int value)

Parameters

byte_offset int

value int

encode_var(int, Variant, bool)

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.

int encode_var(int byte_offset, Variant value, bool allow_objects)

Parameters

byte_offset int

value Variant

allow_objects bool

fill(int)

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

void fill(int value)

Parameters

value int

find(int, int)

Qualifiers: 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(int value, int from)

Parameters

value int

from int

get(int)

Qualifiers: const

Returns the byte at the given index in the array. This is the same as using the [] operator (array[index]).

int get(int index)

Parameters

index int

get_string_from_ascii

Qualifiers: 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 to_ascii_buffer.

String get_string_from_ascii

get_string_from_utf8

Qualifiers: 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 to_utf8_buffer.

String get_string_from_utf8

get_string_from_utf16

Qualifiers: const

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. This is the inverse of to_utf16_buffer.

String get_string_from_utf16

get_string_from_utf32

Qualifiers: const

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

String get_string_from_utf32

get_string_from_wchar

Qualifiers: 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 to_wchar_buffer.

String get_string_from_wchar

has(int)

Qualifiers: const

Returns true if the array contains value.

bool has(int value)

Parameters

value int

has_encoded_var(int, bool)

Qualifiers: 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.

bool has_encoded_var(int byte_offset, bool allow_objects)

Parameters

byte_offset int

allow_objects bool

hex_encode

Qualifiers: const

Returns a hexadecimal representation of this array as a String.

• gdscript
• C#

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

String hex_encode

insert(int, 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()).

int insert(int at_index, int value)

Parameters

at_index int

value int

is_empty

Qualifiers: const

Returns true if the array is empty.

bool is_empty

push_back(int)

Appends an element at the end of the array.

bool push_back(int value)

Parameters

value int

remove_at(int)

Removes an element from the array by index.

void remove_at(int index)

Parameters

index int

resize(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 PackedByteArray.resize once and assigning the new values is faster than adding new elements one by one.

int resize(int new_size)

Parameters

new_size int

reverse

Reverses the order of the elements in the array.

void reverse

rfind(int, int)

Qualifiers: 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(int value, int from)

Parameters

value int

from int

set(int, int)

Changes the byte at the given index.

void set(int index, int value)

Parameters

index int

value int

size

Qualifiers: const

Returns the number of elements in the array.

int size

slice(int, int)

Qualifiers: const

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

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)).

PackedByteArray slice(int begin, int end)

Parameters

begin int

end int

sort

Sorts the elements of the array in ascending order.

void sort

to_float32_array

Qualifiers: const

Returns a copy of the data converted to a PackedFloat32Array, where each block of 4 bytes has been converted to a 32-bit float (C++ float).

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.

PackedFloat32Array to_float32_array

to_float64_array

Qualifiers: const

Returns a copy of the data converted to a PackedFloat64Array, where each block of 8 bytes has been converted to a 64-bit float (C++ double, Godot 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.

PackedFloat64Array to_float64_array

to_int32_array

Qualifiers: const

Returns a copy of the data converted to a PackedInt32Array, 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.

PackedInt32Array to_int32_array

to_int64_array

Qualifiers: const

Returns a copy of the data converted to a PackedInt64Array, where each block of 8 bytes has been converted to a signed 64-bit integer (C++ int64_t, Godot 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.

PackedInt64Array to_int64_array

Operators

!= (PackedByteArray)

Returns true if contents of the arrays differ.

bool != (PackedByteArray right)

Parameters

right PackedByteArray

+ (PackedByteArray)

Returns a new PackedByteArray with contents of right added at the end of this array. For better performance, consider using PackedByteArray.append_array instead.

PackedByteArray + (PackedByteArray right)

Parameters

right PackedByteArray

== (PackedByteArray)

Returns true if contents of both arrays are the same, i.e. they have all equal bytes at the corresponding indices.

bool == (PackedByteArray right)

Parameters

right PackedByteArray

[] (int)

Returns the byte at index index. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error.

Note that the byte is returned as a 64-bit int.

int [] (int index)

Parameters

index int