godot-docs/classes/class_poolvector3array.rst

:github_url: hide

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

.. _class_PoolVector3Array:

PoolVector3Array
================

A pooled :ref:`Array<class_Array>` of :ref:`Vector3<class_Vector3>`.

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

An :ref:`Array<class_Array>` specifically designed to hold :ref:`Vector3<class_Vector3>`. Optimized for memory usage, does not fragment the memory.

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

Methods
-------

+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolVector3Array<class_PoolVector3Array>` | :ref:`PoolVector3Array<class_PoolVector3Array_method_PoolVector3Array>` **(** :ref:`Array<class_Array>` from **)**                |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`append<class_PoolVector3Array_method_append>` **(** :ref:`Vector3<class_Vector3>` vector3 **)**                             |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`append_array<class_PoolVector3Array_method_append_array>` **(** :ref:`PoolVector3Array<class_PoolVector3Array>` array **)** |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                         | :ref:`empty<class_PoolVector3Array_method_empty>` **(** **)**                                                                     |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`insert<class_PoolVector3Array_method_insert>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` vector3 **)**  |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`invert<class_PoolVector3Array_method_invert>` **(** **)**                                                                   |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`push_back<class_PoolVector3Array_method_push_back>` **(** :ref:`Vector3<class_Vector3>` vector3 **)**                       |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`remove<class_PoolVector3Array_method_remove>` **(** :ref:`int<class_int>` idx **)**                                         |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`resize<class_PoolVector3Array_method_resize>` **(** :ref:`int<class_int>` idx **)**                                         |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void                                            | :ref:`set<class_PoolVector3Array_method_set>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` vector3 **)**        |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                           | :ref:`size<class_PoolVector3Array_method_size>` **(** **)**                                                                       |
+-------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+

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

.. _class_PoolVector3Array_method_PoolVector3Array:

- :ref:`PoolVector3Array<class_PoolVector3Array>` **PoolVector3Array** **(** :ref:`Array<class_Array>` from **)**

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

----

.. _class_PoolVector3Array_method_append:

- void **append** **(** :ref:`Vector3<class_Vector3>` vector3 **)**

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

----

.. _class_PoolVector3Array_method_append_array:

- void **append_array** **(** :ref:`PoolVector3Array<class_PoolVector3Array>` array **)**

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

----

.. _class_PoolVector3Array_method_empty:

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

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

----

.. _class_PoolVector3Array_method_insert:

- :ref:`int<class_int>` **insert** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` vector3 **)**

Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``).

----

.. _class_PoolVector3Array_method_invert:

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

Reverses the order of the elements in the array.

----

.. _class_PoolVector3Array_method_push_back:

- void **push_back** **(** :ref:`Vector3<class_Vector3>` vector3 **)**

Inserts a :ref:`Vector3<class_Vector3>` at the end.

----

.. _class_PoolVector3Array_method_remove:

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

Removes an element from the array by index.

----

.. _class_PoolVector3Array_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_PoolVector3Array_method_set:

- void **set** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_Vector3>` vector3 **)**

Changes the :ref:`Vector3<class_Vector3>` at the given index.

----

.. _class_PoolVector3Array_method_size:

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

Returns the size of the array.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`