Up to date

This page is up to date for Godot 4.2. 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.

Nota

There are notable differences when using this API with C#. See C# API differences to GDScript for more information.

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_s8 ( 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_u8 ( 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

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

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_utf8 ( ) const

String

get_string_from_utf16 ( ) const

String

get_string_from_utf32 ( ) const

String

get_string_from_wchar ( ) 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 (