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.

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.

Note

There are notable differences when using this API with C#. See C# API differences to GDScript for more information.

Constructors

PackedColorArray

PackedColorArray()

PackedColorArray

PackedColorArray(from: PackedColorArray)

PackedColorArray

PackedColorArray(from: Array)

Methods

bool

append(value: Color)

void

append_array(array: PackedColorArray)

int

bsearch(value: Color, before: bool = true)

void

clear()

int

count(value: Color) const

PackedColorArray

duplicate()

void

fill(value: Color)

int

find(value: Color, from: int = 0) const

bool

has(value: Color) const

int

insert(at_index: int, value: Color)

bool

is_empty() const

bool

push_back(value: Color)

void

remove_at(index: int)

int

resize(new_size: int)

void

reverse()

int

rfind(value: Color, from: int = -1) const

void

set(index: int, value: Color)

int

size() const

PackedColorArray

slice(begin: int, end: int = 2147483647) const

void

sort()

PackedByteArray

to_byte_array() const

Operators

bool

operator !=(right: PackedColorArray)

PackedColorArray

operator +(right: PackedColorArray)

bool

operator ==(right: PackedColorArray)

Color

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

bool append(value: Color)

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.


void fill(value: Color)

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.


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


bool is_empty() const

Returns true if the array is empty.


bool push_back(value: Color)

Appends a value to the array.


void remove_at(index: int)

Removes an element from the array by index.


int resize(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. 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.


int size() const

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.


User-contributed notes

Please read the User-contributed notes policy before submitting a comment.