Class PackedInt32Array

A packed array of 32-bit integers.

PackedInt32Array

Remarks

An array specifically designed to hold 32-bit integer values. Packs data tightly, so it saves memory for large array sizes.

Note: This type stores signed 32-bit integers, which means it can take values in the interval [-2^31, 2^31 - 1], i.e. [-2147483648, 2147483647]. Exceeding those bounds will wrap around. In comparison, int uses signed 64-bit integers which can hold much larger values. If you need to pack 64-bit integers tightly, see PackedInt64Array.

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

PackedInt32Array

Constructs an empty PackedInt32Array.

PackedInt32Array PackedInt32Array

PackedInt32Array(PackedInt32Array)

Constructs a PackedInt32Array as a copy of the given PackedInt32Array.

PackedInt32Array PackedInt32Array(PackedInt32Array from)

Parameters

from PackedInt32Array

PackedInt32Array(Array)

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

PackedInt32Array PackedInt32Array(Array from)

Parameters

from Array

Methods

append(int)

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

bool append(int value)

Parameters

value int

append_array(PackedInt32Array)

Appends a PackedInt32Array at the end of this array.

void append_array(PackedInt32Array array)

Parameters

array PackedInt32Array

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 PackedInt32Array.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 PackedInt32Array.resize with a size of 0.

void clear

count(int)

Qualifiers: const

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

int count(int value)

Parameters

value int

duplicate

Creates a copy of the array, and returns it.

PackedInt32Array duplicate

fill(int)

Assigns the given value to all elements in the array. This can typically be used together with PackedInt32Array.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 32-bit integer at the given index in the array. This is the same as using the [] operator (array[index]).

int get(int index)

Parameters

index int

has(int)

Qualifiers: const

Returns true if the array contains value.

bool has(int value)

Parameters

value int

insert(int, int)

Inserts a new integer 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 a value to 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 PackedInt32Array.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 integer 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 PackedInt32Array, from begin (inclusive) to end (exclusive), as a new PackedInt32Array.

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

PackedInt32Array slice(int begin, int end)

Parameters

begin int

end int

sort

Sorts the elements of the array in ascending order.

void sort

to_byte_array

Qualifiers: const

Returns a copy of the data converted to a PackedByteArray, where each element has been encoded as 4 bytes.

The size of the new array will be int32_array.size() * 4.

PackedByteArray to_byte_array

Operators

!= (PackedInt32Array)

Returns true if contents of the arrays differ.

bool != (PackedInt32Array right)

Parameters

right PackedInt32Array

+ (PackedInt32Array)

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

PackedInt32Array + (PackedInt32Array right)

Parameters

right PackedInt32Array

== (PackedInt32Array)

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

bool == (PackedInt32Array right)

Parameters

right PackedInt32Array

[] (int)

Returns the int 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 int type is 64-bit, unlike the values stored in the array.

int [] (int index)

Parameters

index int