| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the PoolVector2Array.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_PoolVector2Array:
- PoolVector2Array
- ================
- **Category:** Built-In Types
- Brief Description
- -----------------
- An Array of Vector2.
- Member Functions
- ----------------
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PoolVector2Array<class_poolvector2array>` | :ref:`PoolVector2Array<class_PoolVector2Array_PoolVector2Array>` **(** :ref:`Array<class_array>` from **)** |
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`append<class_PoolVector2Array_append>` **(** :ref:`Vector2<class_vector2>` vector2 **)** |
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`append_array<class_PoolVector2Array_append_array>` **(** :ref:`PoolVector2Array<class_poolvector2array>` array **)** |
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`insert<class_PoolVector2Array_insert>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` vector2 **)** |
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`invert<class_PoolVector2Array_invert>` **(** **)** |
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`push_back<class_PoolVector2Array_push_back>` **(** :ref:`Vector2<class_vector2>` vector2 **)** |
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove<class_PoolVector2Array_remove>` **(** :ref:`int<class_int>` idx **)** |
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`resize<class_PoolVector2Array_resize>` **(** :ref:`int<class_int>` idx **)** |
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set<class_PoolVector2Array_set>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` vector2 **)** |
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`size<class_PoolVector2Array_size>` **(** **)** |
- +--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
- Description
- -----------
- An Array specifically designed to hold Vector2. Note that this type is passed by value and not by reference.
- Member Function Description
- ---------------------------
- .. _class_PoolVector2Array_PoolVector2Array:
- - :ref:`PoolVector2Array<class_poolvector2array>` **PoolVector2Array** **(** :ref:`Array<class_array>` from **)**
- Construct a new ``PoolVector2Array``. Optionally, you can pass in an Array that will be converted.
- .. _class_PoolVector2Array_append:
- - void **append** **(** :ref:`Vector2<class_vector2>` vector2 **)**
- Append an element at the end of the array (alias of :ref:`push_back<class_PoolVector2Array_push_back>`).
- .. _class_PoolVector2Array_append_array:
- - void **append_array** **(** :ref:`PoolVector2Array<class_poolvector2array>` array **)**
- Append an ``PoolVector2Array`` at the end of this array.
- .. _class_PoolVector2Array_insert:
- - :ref:`int<class_int>` **insert** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` vector2 **)**
- Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).
- .. _class_PoolVector2Array_invert:
- - void **invert** **(** **)**
- Reverse the order of the elements in the array (so first element will now be the last).
- .. _class_PoolVector2Array_push_back:
- - void **push_back** **(** :ref:`Vector2<class_vector2>` vector2 **)**
- Insert a :ref:`Vector2<class_vector2>` at the end.
- .. _class_PoolVector2Array_remove:
- - void **remove** **(** :ref:`int<class_int>` idx **)**
- Remove an element from the array by index.
- .. _class_PoolVector2Array_resize:
- - void **resize** **(** :ref:`int<class_int>` idx **)**
- Set the size of the array. If the array is grown reserve elements at the end of the array. If the array is shrunk truncate the array to the new size.
- .. _class_PoolVector2Array_set:
- - void **set** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` vector2 **)**
- Change the :ref:`Vector2<class_vector2>` at the given index.
- .. _class_PoolVector2Array_size:
- - :ref:`int<class_int>` **size** **(** **)**
- Return the size of the array.
|
