Class PackedColorArray

A packed array of Colors.

PackedColorArray

Remarks

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.

Constructors

PackedColorArray

Constructs an empty PackedColorArray.

PackedColorArray PackedColorArray

PackedColorArray(PackedColorArray)

Constructs a PackedColorArray as a copy of the given PackedColorArray.

PackedColorArray PackedColorArray(PackedColorArray from)

Parameters

from PackedColorArray

PackedColorArray(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)])

PackedColorArray PackedColorArray(Array from)

Parameters

from Array

Methods

append(Color)

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

bool append(Color value)

Parameters

value Color

append_array(PackedColorArray)

Appends a PackedColorArray at the end of this array.

void append_array(PackedColorArray array)

Parameters

array PackedColorArray

bsearch(Color, bool)

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 PackedColorArray.bsearch on an unsorted array results in unexpected behavior.

int bsearch(Color value, bool before)

Parameters

value Color

before bool

clear

Clears the array. This is equivalent to using PackedColorArray.resize with a size of 0.

void clear

count(Color)

Qualifiers: const

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

int count(Color value)

Parameters

value Color

duplicate

Creates a copy of the array, and returns it.

PackedColorArray duplicate

fill(Color)

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

void fill(Color value)

Parameters

value Color

find(Color, int)

Qualifiers: const

Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.

int find(Color value, int from)

Parameters

value Color

from int

get(int)

Qualifiers: const

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

Color get(int index)

Parameters

index int

has(Color)

Qualifiers: const

Returns true if the array contains value.

bool has(Color value)

Parameters

value Color

insert(int, 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()).

int insert(int at_index, Color value)

Parameters

at_index int

value Color

is_empty

Qualifiers: const

Returns true if the array is empty.

bool is_empty

push_back(Color)

Appends a value to the array.

bool push_back(Color value)

Parameters

value Color

remove_at(int)

Removes an element from the array by index.

void remove_at(int index)

Parameters

index int

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

int resize(int new_size)

Parameters

new_size int

reverse

Reverses the order of the elements in the array.

void reverse

rfind(Color, int)

Qualifiers: 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.

int rfind(Color value, int from)

Parameters

value Color

from int

set(int, Color)

Changes the Color at the given index.

void set(int index, Color value)

Parameters

index int

value Color

size

Qualifiers: const

Returns the number of elements in the array.

int size

slice(int, int)

Qualifiers: 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)).

PackedColorArray slice(int begin, int end)

Parameters

begin int

end int

sort

Sorts the elements of the array in ascending order.

void sort

to_byte_array

Qualifiers: const

Returns a PackedByteArray with each color encoded as bytes.

PackedByteArray to_byte_array

Operators

!= (PackedColorArray)

Returns true if contents of the arrays differ.

bool != (PackedColorArray right)

Parameters

right PackedColorArray

+ (PackedColorArray)

Returns a new PackedColorArray with contents of right added at the end of this array. For better performance, consider using PackedColorArray.append_array instead.

PackedColorArray + (PackedColorArray right)

Parameters

right PackedColorArray

== (PackedColorArray)

Returns true if contents of both arrays are the same, i.e. they have all equal Colors at the corresponding indices.

bool == (PackedColorArray right)

Parameters

right PackedColorArray

[] (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.

Color [] (int index)

Parameters

index int