godot-docs/classes/class_packedint32array.rst

:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PackedInt32Array.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_PackedInt32Array:

PackedInt32Array
================

A packed :ref:`Array<class_Array>` of 32-bit integers.

Description
-----------

An :ref:`Array<class_Array>` specifically designed to hold 32-bit integer values. Packs data tightly, so it saves memory for large array sizes.

**Note:** This type is passed by value and not by reference.

**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, :ref:`int<class_int>` uses signed 64-bit integers which can hold much larger values. If you need to pack 64-bit integers tightly, see :ref:`PackedInt64Array<class_PackedInt64Array>`.

Methods
-------

+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`PackedInt32Array<class_PackedInt32Array_method_PackedInt32Array>` **(** :ref:`Array<class_Array>` from **)**                |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`append<class_PackedInt32Array_method_append>` **(** :ref:`int<class_int>` integer **)**                                     |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`append_array<class_PackedInt32Array_method_append_array>` **(** :ref:`PackedInt32Array<class_PackedInt32Array>` array **)** |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                         | :ref:`empty<class_PackedInt32Array_method_empty>` **(** **)**                                                                     |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`insert<class_PackedInt32Array_method_insert>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` integer **)**          |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`invert<class_PackedInt32Array_method_invert>` **(** **)**                                                                   |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`push_back<class_PackedInt32Array_method_push_back>` **(** :ref:`int<class_int>` integer **)**                               |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`remove<class_PackedInt32Array_method_remove>` **(** :ref:`int<class_int>` idx **)**                                         |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`resize<class_PackedInt32Array_method_resize>` **(** :ref:`int<class_int>` idx **)**                                         |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`set<class_PackedInt32Array_method_set>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` integer **)**                |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`size<class_PackedInt32Array_method_size>` **(** **)**                                                                       |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+

Method Descriptions
-------------------

.. _class_PackedInt32Array_method_PackedInt32Array:

- :ref:`PackedInt32Array<class_PackedInt32Array>` **PackedInt32Array** **(** :ref:`Array<class_Array>` from **)**

Constructs a new ``PackedInt32Array``. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.

----

.. _class_PackedInt32Array_method_append:

- void **append** **(** :ref:`int<class_int>` integer **)**

Appends an element at the end of the array (alias of :ref:`push_back<class_PackedInt32Array_method_push_back>`).

----

.. _class_PackedInt32Array_method_append_array:

- void **append_array** **(** :ref:`PackedInt32Array<class_PackedInt32Array>` array **)**

Appends a ``PackedInt32Array`` at the end of this array.

----

.. _class_PackedInt32Array_method_empty:

- :ref:`bool<class_bool>` **empty** **(** **)**

Returns ``true`` if the array is empty.

----

.. _class_PackedInt32Array_method_insert:

- :ref:`int<class_int>` **insert** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` integer **)**

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

----

.. _class_PackedInt32Array_method_invert:

- void **invert** **(** **)**

Reverses the order of the elements in the array.

----

.. _class_PackedInt32Array_method_push_back:

- void **push_back** **(** :ref:`int<class_int>` integer **)**

Appends a value to the array.

----

.. _class_PackedInt32Array_method_remove:

- void **remove** **(** :ref:`int<class_int>` idx **)**

Removes an element from the array by index.

----

.. _class_PackedInt32Array_method_resize:

- void **resize** **(** :ref:`int<class_int>` idx **)**

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.

----

.. _class_PackedInt32Array_method_set:

- void **set** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` integer **)**

Changes the integer at the given index.

----

.. _class_PackedInt32Array_method_size:

- :ref:`int<class_int>` **size** **(** **)**

Returns the array size.