Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
PackedVector4Array¶
A packed array of Vector4s.
Description¶
An array specifically designed to hold Vector4. Packs data tightly, so it saves memory for large array sizes.
Note: Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use duplicate. This is not the case for built-in properties and methods. The returned packed array of these are a copies, and changing it will not affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again.
Note
There are notable differences when using this API with C#. See C# API differences to GDScript for more information.
Constructors¶
PackedVector4Array(from: Array) |
Methods¶
void |
append_array(array: PackedVector4Array) |
void |
clear() |
void |
|
is_empty() const |
|
void |
|
void |
reverse() |
void |
|
size() const |
|
void |
sort() |
to_byte_array() const |
Operators¶
operator !=(right: PackedVector4Array) |
|
operator +(right: PackedVector4Array) |
|
operator ==(right: PackedVector4Array) |
|
operator [](index: int) |
Constructor Descriptions¶
PackedVector4Array PackedVector4Array()
Constructs an empty PackedVector4Array.
PackedVector4Array PackedVector4Array(from: PackedVector4Array)
Constructs a PackedVector4Array as a copy of the given PackedVector4Array.
PackedVector4Array PackedVector4Array(from: Array)
Constructs a new PackedVector4Array. Optionally, you can pass in a generic Array that will be converted.
Note: When initializing a PackedVector4Array with elements, it must be initialized with an Array of Vector4 values:
var array = PackedVector4Array([Vector4(12, 34, 56, 78), Vector4(90, 12, 34, 56)])
Method Descriptions¶
Appends an element at the end of the array (alias of push_back).
void append_array(array: PackedVector4Array)
Appends a PackedVector4Array at the end of this array.
int bsearch(value: Vector4, before: bool = true)
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.
void clear()
Clears the array. This is equivalent to using resize with a size of 0.
int count(value: Vector4) const
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.
PackedVector4Array duplicate()
Creates a copy of the array, and returns it.
void fill(value: Vector4)
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.
int find(value: Vector4, from: int = 0) const
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.
bool has(value: Vector4) const
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.
int insert(at_index: int, value: Vector4)
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()).
bool is_empty() const
Returns true if the array is empty.
bool push_back(value: Vector4)
Inserts a Vector4 at the end.
void remove_at(index: int)
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.
int rfind(value: Vector4, from: int = -1) const
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.
void set(index: int, value: Vector4)
Changes the Vector4 at the given index.
int size() const
Returns the number of elements in the array.
PackedVector4Array slice(begin: int, end: int = 2147483647) const
Returns the slice of the PackedVector4Array, from begin (inclusive) to end (exclusive), as a new PackedVector4Array.
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.
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.
PackedByteArray to_byte_array() const
Returns a PackedByteArray with each vector encoded as bytes.
Operator Descriptions¶
bool operator !=(right: PackedVector4Array)
Returns true if contents of the arrays differ.
PackedVector4Array operator +(right: PackedVector4Array)
Returns a new PackedVector4Array with contents of right added at the end of this array. For better performance, consider using append_array instead.
bool operator ==(right: PackedVector4Array)
Returns true if contents of both arrays are the same, i.e. they have all equal Vector4s at the corresponding indices.
Vector4 operator [](index: int)
Returns the Vector4 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.