A packed array of 32-bit integers.


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.



PackedInt32Array ( )


PackedInt32Array ( PackedInt32Array from )


PackedInt32Array ( Array from )



append ( int value )


append_array ( PackedInt32Array array )


bsearch ( int value, bool before=true )


count ( int value ) const


duplicate ( )


fill ( int value )


find ( int value, int from=0 ) const


has ( int value ) const


insert ( int at_index, int value )


is_empty ( ) const


push_back ( int value )


remove_at ( int index )


resize ( int new_size )


reverse ( )


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


set ( int index, int value )


size ( ) const


slice ( int begin, int end=2147483647 ) const


sort ( )


to_byte_array ( ) const



operator != ( PackedInt32Array right )


operator + ( PackedInt32Array right )


operator == ( PackedInt32Array right )


operator [] ( int index )

Constructor Descriptions

Constructs an empty PackedInt32Array.

Constructs a PackedInt32Array as a copy of the given PackedInt32Array.

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

Method Descriptions

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

Appends a PackedInt32Array at the end of this array.

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 count ( int value ) const

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

Creates a copy of the array, and returns it.

  • void fill ( int value )

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.

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

Returns true if the array contains value.

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

  • bool is_empty ( ) const

Returns true if the array is empty.

Appends a value to the array.

  • void remove_at ( int index )

Removes an element from the array by index.

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.

  • void reverse ( )

Reverses the order of the elements in the array.

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.

  • void set ( int index, int value )

Changes the integer at the given index.

  • int size ( ) const

Returns the number of elements in the array.

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

  • void sort ( )

Sorts the elements of the array in ascending order.

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

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

Operator Descriptions

  • int operator [] ( int index )