Up to date

This page is up to date for Godot 4.0. If you still find outdated information, please open an issue.

PackedByteArray

A packed array of bytes.

Description

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.

Constructors

PackedByteArray

PackedByteArray ( )

PackedByteArray

PackedByteArray ( PackedByteArray from )

PackedByteArray

PackedByteArray ( Array from )

Methods

bool

append ( int value )

void

append_array ( PackedByteArray array )

int

bsearch ( int value, bool before=true )

void

clear ( )

PackedByteArray

compress ( int compression_mode=0 ) const

int

count ( int value ) const

float

decode_double ( int byte_offset ) const

float

decode_float ( int byte_offset ) const

float

decode_half ( int byte_offset ) const

int

decode_s16 ( int byte_offset ) const

int

decode_s32 ( int byte_offset ) const

int

decode_s64 ( int byte_offset ) const

int

decode_s8 ( int byte_offset ) const

int

decode_u16 ( int byte_offset ) const

int

decode_u32 ( int byte_offset ) const

int

decode_u64 ( int byte_offset ) const

int

decode_u8 ( int byte_offset ) const

Variant

decode_var ( int byte_offset, bool allow_objects=false ) const

int

decode_var_size ( int byte_offset, bool allow_objects=false ) const

PackedByteArray

decompress ( int buffer_size, int compression_mode=0 ) const

PackedByteArray

decompress_dynamic ( int max_output_size, int compression_mode=0 ) const

PackedByteArray

duplicate ( )

void

encode_double ( int byte_offset, float value )

void

encode_float ( int byte_offset, float value )

void

encode_half ( int byte_offset, float value )

void

encode_s16 ( int byte_offset, int value )

void

encode_s32 ( int byte_offset, int value )

void

encode_s64 ( int byte_offset, int value )

void

encode_s8 ( int byte_offset, int value )

void

encode_u16 ( int byte_offset, int value )

void

encode_u32 ( int byte_offset, int value )

void

encode_u64 ( int byte_offset, int value )

void

encode_u8 ( int byte_offset, int value )

int

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

void

fill ( int value )

int

find ( int value, int from=0 ) const

String

get_string_from_ascii ( ) const

String

get_string_from_utf16 ( ) const

String

get_string_from_utf32 ( ) const

String

get_string_from_utf8 ( ) const

bool

has ( int value ) const

bool

has_encoded_var ( int byte_offset, bool allow_objects=false ) const

String

hex_encode ( ) const

int

insert ( int at_index, int value )

bool

is_empty ( ) const

bool

push_back ( int value )

void

remove_at ( int index )

int

resize ( int new_size )

void

reverse ( )

int

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

void

set ( int index, int value )

int

size ( ) const

PackedByteArray

slice ( int begin, int end=2147483647 ) const

void

sort ( )

PackedFloat32Array

to_float32_array ( ) const

PackedFloat64Array

to_float64_array ( ) const

PackedInt32Array

to_int32_array ( ) const

PackedInt64Array

to_int64_array ( ) const

Operators

bool

operator != ( PackedByteArray right )

PackedByteArray

operator + ( PackedByteArray right )

bool

operator == ( PackedByteArray right )

int

operator [] ( int index )

Constructor Descriptions

PackedByteArray PackedByteArray ( )

Constructs an empty PackedByteArray.

PackedByteArray PackedByteArray ( PackedByteArray from )

Constructs a PackedByteArray as a copy of the given PackedByteArray.

PackedByteArray PackedByteArray ( Array from )

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

Method Descriptions

bool append ( int value )

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

void append_array ( PackedByteArray array )

Appends a PackedByteArray at the end of this array.

int bsearch ( int value, bool before=true )

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.

void clear ( )

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

PackedByteArray compress ( int compression_mode=0 ) const

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

int count ( int value ) const

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

float decode_double ( int byte_offset ) 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 ( int byte_offset ) 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 ( int byte_offset ) 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_s16 ( int byte_offset ) 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 ( int byte_offset ) 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 ( int byte_offset ) 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_s8 ( int byte_offset ) 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_u16 ( int byte_offset ) 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 ( int byte_offset ) 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 ( int byte_offset ) 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_u8 ( int byte_offset ) 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.

Variant decode_var ( int byte_offset, bool allow_objects=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 ( int byte_offset, bool allow_objects=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.

PackedByteArray decompress ( int buffer_size, int compression_mode=0 ) 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.

PackedByteArray decompress_dynamic ( int max_output_size, int compression_mode=0 ) const

Returns a new PackedByteArray with the data decompressed. Set the compression mode using one of CompressionMode's constants. This method only accepts 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.

PackedByteArray duplicate ( )

Creates a copy of the array, and returns it.

void encode_double ( int byte_offset, float value )

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

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

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

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

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

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

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

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, star