Description

An array specifically designed to holdColor. 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 versusArray[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 asArray.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, useduplicate(). This isnot the case for built-in properties and methods. The returned packed array of these are a copies, and changing it willnot 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.

Constructors

Methods

Operators

Constructor Descriptions

PackedColorArrayPackedColorArray()🔗

Constructs an emptyPackedColorArray.

PackedColorArrayPackedColorArray(from:PackedColorArray)

Constructs aPackedColorArray as a copy of the givenPackedColorArray.

PackedColorArrayPackedColorArray(from:Array)

Constructs a newPackedColorArray. Optionally, you can pass in a genericArray that will be converted.

Note: When initializing aPackedColorArray with elements, it must be initialized with anArray ofColor values:

vararray=PackedColorArray([Color(0.1,0.2,0.3),Color(0.4,0.5,0.6)])

Method Descriptions

boolappend(value:Color)🔗

Appends an element at the end of the array (alias ofpush_back()).

voidappend_array(array:PackedColorArray)🔗

Appends aPackedColorArray at the end of this array.

intbsearch(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, abefore specifier can be passed. Iffalse, the returned index comes after all existing entries of the value in the array.

Note: Callingbsearch() on an unsorted array results in unexpected behavior.

voidclear()🔗

Clears the array. This is equivalent to usingresize() with a size of0.

intcount(value:Color)const🔗

Returns the number of times an element is in the array.

PackedColorArrayduplicate()🔗

Creates a copy of the array, and returns it.

voidfill(value:Color)🔗

Assigns the given value to all elements in the array. This can typically be used together withresize() to create an array with a given size and initialized elements.

intfind(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.

Colorget(index:int)const🔗

Returns theColor at the givenindex in the array. This is the same as using the[] operator (array[index]).

boolhas(value:Color)const🔗

Returnstrue if the array containsvalue.

intinsert(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()).

boolis_empty()const🔗

Returnstrue if the array is empty.

boolpush_back(value:Color)🔗

Appends a value to the array.

voidremove_at(index:int)🔗

Removes an element from the array by index.

intresize(new_size:int)🔗

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. Callingresize() once and assigning the new values is faster than adding new elements one by one.

voidreverse()🔗

Reverses the order of the elements in the array.

intrfind(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.

voidset(index:int, value:Color)🔗

Changes theColor at the given index.

intsize()const🔗

Returns the number of elements in the array.

PackedColorArrayslice(begin:int, end:int = 2147483647)const🔗

Returns the slice of thePackedColorArray, frombegin (inclusive) toend (exclusive), as a newPackedColorArray.

The absolute value ofbegin andend will be clamped to the array size, so the default value forend makes it slice to the size of the array by default (i.e.arr.slice(1) is a shorthand forarr.slice(1,arr.size())).

If eitherbegin orend are negative, they will be relative to the end of the array (i.e.arr.slice(0,-2) is a shorthand forarr.slice(0,arr.size()-2)).

voidsort()🔗

Sorts the elements of the array in ascending order.

PackedByteArrayto_byte_array()const🔗

Returns aPackedByteArray with each color encoded as bytes.

Operator Descriptions

booloperator !=(right:PackedColorArray)🔗

Returnstrue if contents of the arrays differ.

PackedColorArrayoperator +(right:PackedColorArray)🔗

Returns a newPackedColorArray with contents ofright added at the end of this array. For better performance, consider usingappend_array() instead.

booloperator ==(right:PackedColorArray)🔗

Returnstrue if contents of both arrays are the same, i.e. they have all equalColors at the corresponding indices.

Coloroperator [](index:int)🔗

Returns theColor at indexindex. 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.