Inheritance #
Table of contents
-
func append(value: Color) -> bool -
func append_array(array: PackedColorArray) -> void -
func bsearch(before: bool = true) -> int -
func clear() -> void -
const func count(value: Color) -> int -
func duplicate() -> PackedColorArray -
func fill(value: Color) -> void -
const func find(from: int = 0) -> int -
const func get(index: int) -> Color -
const func has(value: Color) -> bool -
func insert(value: Color) -> int -
const func is_empty() -> bool -
func push_back(value: Color) -> bool -
func remove_at(index: int) -> void -
func resize(new_size: int) -> int -
func reverse() -> void -
const func rfind(from: int = -1) -> int -
func set(value: Color) -> void -
const func size() -> int -
const func slice(end: int = 2147483647) -> PackedColorArray -
func sort() -> void -
const func to_byte_array() -> PackedByteArray -
PackedColorArray() -> PackedColorArray -
PackedColorArray(from: PackedColorArray) -> PackedColorArray -
PackedColorArray(from: Array) -> PackedColorArray -
PackedColorArray != PackedColorArray -> bool -
PackedColorArray + PackedColorArray -> PackedColorArray -
PackedColorArray == PackedColorArray -> bool -
PackedColorArray[int] -> Color
PackedColorArray #
A packed array of Colors.
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 ArrayColor). 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.
Members #
Methods #
func append_array(array: PackedColorArray) -> void#
Appends a PackedColorArray at the end of this array.
func bsearch(before: bool = true) -> int#
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.
const func count(value: Color) -> int#
Returns the number of times an element is in the array.
func duplicate() -> PackedColorArray#
Creates a copy of the array, and returns it.
func fill(value: Color) -> void#
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.
const func find(from: int = 0) -> int#
Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.
const func get(index: int) -> Color#
Returns the Color at the given index in the array. This is the same as using the [] operator (arrayindex).
const func has(value: Color) -> bool#
Returns true if the array contains value.
func insert(value: Color) -> int#
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()).
const func is_empty() -> bool#
Returns true if the array is empty.
func push_back(value: Color) -> bool#
Appends a value to the array.
func remove_at(index: int) -> void#
Removes an element from the array by index.
func resize(new_size: int) -> 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.
func reverse() -> void#
Reverses the order of the elements in the array.
const func rfind(from: int = -1) -> int#
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.
const func size() -> int#
Returns the number of elements in the array.
const func slice(end: int = 2147483647) -> PackedColorArray#
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)).
func sort() -> void#
Sorts the elements of the array in ascending order.
const func to_byte_array() -> PackedByteArray#
Returns a PackedByteArray with each color encoded as bytes.
Annotations #
Constants #
Constructors #
PackedColorArray() -> PackedColorArray #
Constructs an empty PackedColorArray.
PackedColorArray(from: PackedColorArray) -> PackedColorArray #
Constructs a PackedColorArray as a copy of the given PackedColorArray.
PackedColorArray(from: Array) -> PackedColorArray #
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)])Enums #
Operators #
PackedColorArray != PackedColorArray -> bool#
Returns true if contents of the arrays differ.
PackedColorArray + PackedColorArray -> PackedColorArray#
Returns a new PackedColorArray with contents of right added at the end of this array. For better performance, consider using append_array instead.
PackedColorArray == PackedColorArray -> bool#
Returns true if contents of both arrays are the same, i.e. they have all equal Colors at the corresponding indices.
PackedColorArray[int] -> Color#
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.