Attention: Here be dragons (unstable version)
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Redot.
Checking the stable version of the documentation...
PackedColorArray
A packed array of Colors.
Description
An array specifically designed to hold Color. Packs data tightly, so it saves memory for large array sizes.
Differences between packed arrays, typed arrays, and untyped arrays: Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. PackedColorArray versus Array[Color]). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as Array.map. Typed arrays are in turn faster to iterate on and modify than untyped arrays.
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
PackedColorArray(from: PackedColorArray) |
|
PackedColorArray(from: Array) |
Methods
void |
append_array(array: PackedColorArray) |
void |
clear() |
void |
|
is_empty() const |
|
void |
|
void |
reverse() |
void |
|
size() const |
|
void |
sort() |
to_byte_array() const |
Operators
operator !=(right: PackedColorArray) |
|
operator +(right: PackedColorArray) |
|
operator ==(right: PackedColorArray) |
|
operator [](index: int) |
Constructor Descriptions
PackedColorArray PackedColorArray() 🔗
Constructs an empty PackedColorArray.
PackedColorArray PackedColorArray(from: PackedColorArray)
Constructs a PackedColorArray as a copy of the given PackedColorArray.
PackedColorArray PackedColorArray(from: Array)
Constructs a new PackedColorArray. Optionally, you can pass in a generic Array that will be converted.
Note: When initializing a PackedColorArray with elements, it must be initialized with an Array of Color values:
var array = PackedColorArray([Color(0.1, 0.2, 0.3), Color(0.4, 0.5, 0.6)])
Method Descriptions
Appends an element at the end of the array (alias of push_back).
void append_array(array: PackedColorArray) 🔗
Appends a PackedColorArray at the end of this array.
int bsearch(value: Color, 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.
void clear() 🔗
Clears the array. This is equivalent to using resize with a size of 0.
int count(value: Color) const 🔗
Returns the number of times an element is in the array.
PackedColorArray duplicate() 🔗
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.
int find(value: Color, 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.
Returns the Color at the given index in the array. This is the same as using the [] operator (array[index]).
bool has(value: Color) const 🔗
Returns true if the array contains value.
int insert(at_index: int, value: Color) 🔗
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.
bool push_back(value: Color) 🔗
Appends a value to the array.
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.
void reverse() 🔗
Reverses the order of the elements in the array.
int rfind(value: Color, 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.
void set(index: int, value: Color) 🔗
Changes the Color at the given index.
Returns the number of elements in the array.
PackedColorArray slice(begin: int, end: int = 2147483647) const 🔗
Returns the slice of the PackedColorArray, from begin (inclusive) to end (exclusive), as a new PackedColorArray.
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.
PackedByteArray to_byte_array() const 🔗
Returns a PackedByteArray with each color encoded as bytes.
Operator Descriptions
bool operator !=(right: PackedColorArray) 🔗
Returns true if contents of the arrays differ.
PackedColorArray operator +(right: PackedColorArray) 🔗
Returns a new PackedColorArray with contents of right added at the end of this array. For better performance, consider using append_array instead.
bool operator ==(right: PackedColorArray) 🔗
Returns true if contents of both arrays are the same, i.e. they have all equal Colors at the corresponding indices.
Color operator [](index: int) 🔗
Returns the Color 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.