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.
Checking the stable version of the documentation...
PackedColorArray
Color 紧缩数组。
描述
一种专门用来存放 Color（颜色）的数组。它对数据进行了紧密打包，因此在数组规模很大时能有效节省内存。
打包数组、类型化数组与非类型化数组的区别：与同类型的类型化数组（例如 PackedColorArray 对比 Array[Color]）相比，打包数组在迭代和修改时通常速度更快，并且占用的内存也更少。不过，打包数组的灵活性稍差，因为它没有提供像 Array.map() 这样丰富的便捷方法。而类型化数组在迭代和修改速度上，又比非类型化数组要快。
注意： 打包数组始终是通过引用传递的。如果想获取一个可以独立于原数组进行修改的副本，请使用 duplicate() 方法。内置属性和方法不属于这种情况。在这些情况下，返回的打包数组是一个副本，修改它不会影响原始值。如果要更新这种类型的内置属性，需要先修改返回的数组，然后再将其重新赋值给该属性。
注意： 在布尔值（boolean）语境下，如果打包数组为空，它的求值结果为 false；否则，打包数组的求值结果始终为 true。
备注
通过 C# 使用该 API 时会有显著不同，详见 C# API 与 GDScript 的差异。
构造函数
PackedColorArray(from: PackedColorArray) |
|
PackedColorArray(from: Array) |
方法
void |
append_array(array: PackedColorArray) |
void |
clear() |
duplicate() const |
|
void |
|
is_empty() const |
|
void |
|
void |
reverse() |
void |
|
size() const |
|
void |
sort() |
to_byte_array() const |
运算符
operator !=(right: PackedColorArray) |
|
operator +(right: PackedColorArray) |
|
operator ==(right: PackedColorArray) |
|
operator [](index: int) |
构造函数说明
PackedColorArray PackedColorArray() 🔗
构造空的 PackedColorArray。
PackedColorArray PackedColorArray(from: PackedColorArray)
构造给定 PackedColorArray 的副本。
PackedColorArray PackedColorArray(from: Array)
构造新的 PackedColorArray。你也可以传一个通用 Array 进行转换。
注意：使用元素初始化 PackedColorArray 时，必须使用元素为 Color 的 Array：
var array = PackedColorArray([Color(0.1, 0.2, 0.3), Color(0.4, 0.5, 0.6)])
方法说明
向数组末尾追加一个元素（push_back() 的别名）。
void append_array(array: PackedColorArray) 🔗
在该数组的末尾追加一个 PackedColorArray。
int bsearch(value: Color, before: bool = true) const 🔗
使用二进法查找已有值的索引（如果该值尚未存在于数组中，则为保持排序顺序的插入索引）。传递 before 说明符是可选的。如果该参数为 false，则返回的索引位于数组中该值的所有已有的条目之后。
注意：在未排序的数组上调用 bsearch() 会产生预料之外的行为。
void clear() 🔗
清空数组。相当于调用 resize() 时指定大小为 0。
int count(value: Color) const 🔗
返回元素在数组中出现的次数。
PackedColorArray duplicate() const 🔗
创建该数组的副本，并将该副本返回。
在数组中移除首次出现的某个值并返回 true。如果数组中不存在该值，则不会发生任何事情，返回 false。要按照索引移除元素，请改用 remove_at()。
将数组中的所有元素都设为给定的值。通常与 resize() 一起使用，创建给定大小的数组并初始化元素。
int find(value: Color, from: int = 0) const 🔗
在数组中搜索值并返回其索引，如果未找到则返回 -1 。可选地，可以传递起始搜索索引。
返回数组中索引为 index 的 Color。如果 index 越界或为负数，则该方法失败并返回 Color(0, 0, 0, 1)。
该方法类似于 [] 运算符（但不等价）。最显著的区别就是从编辑器中运行时，该方法失败不会暂停项目运行。
bool has(value: Color) const 🔗
如果该数组包含 value，则返回 true。
int insert(at_index: int, value: Color) 🔗
在数组中给定的位置插入一个新元素。这个位置必须是有效的，或者是在数组的末端（idx == size()）。
该数组为空时，返回 true。
bool push_back(value: Color) 🔗
将一个值添加到数组中。
从数组中删除位于索引的元素。
设置数组的大小。如果数组增大，则预留数组末端的元素。如果数组缩小，则将数组截断到新的大小。调用一次 resize() 然后赋值比逐个添加新元素要快。
成功时返回 @GlobalScope.OK，失败时返回下列 Error 常量：大小为负数则返回 @GlobalScope.ERR_INVALID_PARAMETER，分配失败则返回 @GlobalScope.ERR_OUT_OF_MEMORY。请使用 size() 获取调整后的实际大小。
void reverse() 🔗
将数组中的元素逆序排列。
int rfind(value: Color, from: int = -1) const 🔗
逆序搜索数组。还可以传递起始搜索位置索引。如果为负，则起始索引被视为相对于数组的结尾。
void set(index: int, value: Color) 🔗
更改给定索引处的 Color。
返回数组中元素的个数。
PackedColorArray slice(begin: int, end: int = 2147483647) const 🔗
返回该 PackedColorArray 的切片，是从 begin（含）到 end（不含）的全新 PackedColorArray。
begin 和 end 的绝对值会按数组大小进行限制，所以 end 的默认值会切到数组大小为止（即 arr.slice(1) 是 arr.slice(1, arr.size()) 的简写）。
如果 begin 或 end 为负，则表示相对于数组的末尾（即 arr.slice(0, -2) 是 arr.slice(0, arr.size() - 2) 的简写）。
void sort() 🔗
将该数组中的元素按升序排列。
PackedByteArray to_byte_array() const 🔗
返回 PackedByteArray，每个颜色都被编码为字节。
运算符说明
bool operator !=(right: PackedColorArray) 🔗
如果数组内容不同，则返回 true。
PackedColorArray operator +(right: PackedColorArray) 🔗
返回新的 PackedColorArray，新数组的内容为此数组在末尾加上 right。为了提高性能，请考虑改用 append_array()。
bool operator ==(right: PackedColorArray) 🔗
如果两个数组的内容相同，即对应索引号的 Color 相等，则返回 true。
Color operator [](index: int) 🔗
返回索引 index 处的Color。负数索引可以从末端开始访问元素。使用超出数组范围的索引将导致出错。