Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

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 ( PackedColorArray from )
PackedColorArray	PackedColorArray ( Array from )

Methods

bool	append ( Color value )
void	append_array ( PackedColorArray array )
int	bsearch ( Color value, bool before=true )
void	clear ( )
int	count ( Color value ) const
PackedColorArray	duplicate ( )
void	fill ( Color value )
int	find ( Color value, int from=0 ) const
bool	has ( Color value ) const
int	insert ( int at_index, Color value )
bool	is_empty ( ) const
bool	push_back ( Color value )
void	remove_at ( int index )
int	resize ( int new_size )
void	reverse ( )
int	rfind ( Color value, int from=-1 ) const
void	set ( int index, Color value )
int	size ( ) const
PackedColorArray	slice ( int begin, int end=2147483647 ) const
void	sort ( )
PackedByteArray	to_byte_array ( ) const

Operators

bool	operator != ( PackedColorArray right )
PackedColorArray	operator + ( PackedColorArray right )
bool	operator == ( PackedColorArray right )
Color	operator [] ( int index )

---

Constructor Descriptions

PackedColorArray PackedColorArray ( )

Constructs an empty PackedColorArray.

---

PackedColorArray PackedColorArray ( PackedColorArray from )

Constructs a PackedColorArray as a copy of the given PackedColorArray.

---

PackedColorArray PackedColorArray ( Array from )

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 ( Color value )

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

---

void append_array ( PackedColorArray array )

Appends a PackedColorArray at the end of this array.

---

int bsearch ( Color value, bool before=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 ( Color value ) 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 ( Color value )

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 ( Color value, int from=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 ( Color value ) const

Returns true if the array contains value.

---

int insert ( int at_index, Color value )

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 ( Color value )

Appends a value to the array.

---

void remove_at ( int index )

Removes an element from the array by index.

---

int resize ( int new_size )

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 ( Color value, int from=-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 ( int index, Color value )

Changes the Color at the given index.

---

int size ( ) const

Returns the number of elements in the array.

---

PackedColorArray slice ( int begin, int end=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