An array specifically designed to hold Vector3. Packs data tightly, so it saves memory for large array sizes.
Constructs an empty PackedVector3Array.
Constructs a PackedVector3Array as a copy of the given PackedVector3Array.
Constructs a new PackedVector3Array. Optionally, you can pass in a generic Array that will be converted.
Note: When initializing a PackedVector3Array with elements, it must be initialized with an Array of Vector3 values:
Returns true
if contents of the arrays differ.
Returns a new PackedVector3Array with all vectors in this array inversely transformed (multiplied) by the given Transform3D transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).
array * transform
is equivalent to transform.inverse() * array
. See Transform3D.inverse.
For transforming by inverse of an affine transformation (e.g. with scaling) transform.affine_inverse() * array
can be used instead. See Transform3D.affine_inverse.
Returns a new PackedVector3Array with contents of right
added at the end of this array. For better performance, consider using append_array instead.
Returns true
if contents of both arrays are the same, i.e. they have all equal Vector3s at the corresponding indices.
Returns the Vector3 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.
Appends an element at the end of the array (alias of push_back).
Appends a PackedVector3Array 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.
Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
Clears the array. This is equivalent to using resize with a size of 0
.
Returns the number of times an element is in the array.
Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
Creates a copy of the array, and returns it.
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.
Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
Returns true
if the array contains value
.
Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
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()
).
Returns true
if the array is empty.
Inserts a Vector3 at the end.
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. Calling resize once and assigning the new values is faster than adding new elements one by one.
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.
Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
Changes the Vector3 at the given index.
Returns the number of elements in the array.
Returns the slice of the PackedVector3Array, from begin
(inclusive) to end
(exclusive), as a new PackedVector3Array.
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)
).
Sorts the elements of the array in ascending order.
Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
Returns a PackedByteArray with each vector encoded as bytes.