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.

PackedStringArray

String 紧缩数组。

描述

一种专门用于存储 String(字符串)的数组。它会对数据进行紧密打包,因此在数组规模较大时能节省内存。

如果你想将数组中的字符串连接起来,可以使用 String.join()

var string_array = PackedStringArray(["hello", "world"])
var string = " ".join(string_array)
print(string) # "hello world"

打包数组、类型化数组与无类型数组之间的区别:与相同类型的类型化数组(例如 PackedStringArray 对比 Array[String])相比,打包数组在迭代和修改时通常速度更快。同时,打包数组占用的内存也更少。但缺点在于,打包数组的灵活性较差,因为它们没有提供像 Array.map() 这样丰富的便捷方法。而类型化数组在迭代和修改速度上,又优于无类型数组。

注意: 打包数组总是通过引用(reference)传递。如果你想获取一个可以独立于原数组进行修改的副本,请使用 duplicate() 方法。不过,内置属性和方法的情况并如此。在这些情况下,返回的打包数组是一个副本,修改它并不会影响原始值。若要更新此类内置属性,你需要修改返回的数组,然后将其重新赋值给该属性。

注意: 在布尔值上下文中,如果打包数组为空,其计算结果将为 false。否则,打包数组总是会被计算为 true

备注

通过 C# 使用该 API 时会有显著不同,详见 C# API 与 GDScript 的差异

教程

构造函数

PackedStringArray

PackedStringArray()

PackedStringArray

PackedStringArray(from: PackedStringArray)

PackedStringArray

PackedStringArray(from: Array)

方法

bool

append(value: String)

void

append_array(array: PackedStringArray)

int

bsearch(value: String, before: bool = true) const

void

clear()

int

count(value: String) const

PackedStringArray

duplicate() const

bool

erase(value: String)

void

fill(value: String)

int

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

String

get(index: int) const

bool

has(value: String) const

int

insert(at_index: int, value: String)

bool

is_empty() const

bool

push_back(value: String)

void

remove_at(index: int)

int

resize(new_size: int)

void

reverse()

int

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

void

set(index: int, value: String)

int

size() const

PackedStringArray

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

void

sort()

PackedByteArray

to_byte_array() const

运算符

bool

operator !=(right: PackedStringArray)

PackedStringArray

operator +(right: PackedStringArray)

bool

operator ==(right: PackedStringArray)

String

operator [](index: int)


构造函数说明

PackedStringArray PackedStringArray() 🔗

构造空的 PackedStringArray


PackedStringArray PackedStringArray(from: PackedStringArray)

构造给定 PackedStringArray 的副本。


PackedStringArray PackedStringArray(from: Array)

构造新 PackedStringArray。你还可以传入通用 Array 进行转换。


方法说明

bool append(value: String) 🔗

向数组末尾追加一个元素(push_back() 的别名)。


void append_array(array: PackedStringArray) 🔗

在该数组的末尾追加一个 PackedStringArray


int bsearch(value: String, before: bool = true) const 🔗

使用二进法查找已有值的索引(如果该值尚未存在于数组中,则为保持排序顺序的插入索引)。传递 before 说明符是可选的。如果该参数为 false,则返回的索引位于数组中该值的所有已有的条目之后。

注意:在未排序的数组上调用 bsearch() 会产生预料之外的行为。


void clear() 🔗

清空数组。相当于调用 resize() 时指定大小为 0


int count(value: String) const 🔗

返回元素在数组中出现的次数。


PackedStringArray duplicate() const 🔗

创建该数组的副本,并将该副本返回。


bool erase(value: String) 🔗

在数组中移除首次出现的某个值并返回 true。如果数组中不存在该值,则不会发生任何事情,返回 false。要按照索引移除元素,请改用 remove_at()


void fill(value: String) 🔗

将数组中的所有元素都设为给定的值。通常与 resize() 一起使用,创建给定大小的数组并初始化元素。


int find(value: String, from: int = 0) const 🔗

在数组中搜索值并返回其索引,如果未找到则返回 -1 。可选地,可以传递起始搜索索引。


String get(index: int) const 🔗

返回数组中给定 index 处的 String 值。如果 index 越界或为负数,则该方法失败并返回空字符串。

该方法类似于 [] 运算符(但不等价)。最显著的区别就是从编辑器中运行时,该方法失败不会暂停项目运行。


bool has(value: String) const 🔗

如果该数组包含 value,则返回 true


int insert(at_index: int, value: String) 🔗

在数组中给定的位置插入一个新元素。这个位置必须是有效的,或者是在数组的末端(idx == size())。


bool is_empty() const 🔗

该数组为空时,返回 true


bool push_back(value: String) 🔗

在数组的末尾追加字符串元素。


void remove_at(index: int) 🔗

从数组中删除位于索引的元素。


int resize(new_size: int) 🔗

设置数组的大小。如果数组增大,则预留数组末端的元素。如果数组缩小,则将数组截断到新的大小。调用一次 resize() 然后赋值比逐个添加新元素要快。

成功时返回 @GlobalScope.OK,失败时返回下列 Error 常量:大小为负数则返回 @GlobalScope.ERR_INVALID_PARAMETER,分配失败则返回 @GlobalScope.ERR_OUT_OF_MEMORY。请使用 size() 获取调整后的实际大小。


void reverse() 🔗

将数组中的元素逆序排列。


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

逆序搜索数组。还可以传递起始搜索位置索引。如果为负,则起始索引被视为相对于数组的结尾。


void set(index: int, value: String) 🔗

更改给定索引处的 String


int size() const 🔗

返回数组中元素的个数。


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

返回该 PackedStringArray 的切片,是从 begin(含)到 end(不含)的全新 PackedStringArray

beginend 的绝对值会按数组大小进行限制,所以 end 的默认值会切到数组大小为止(即 arr.slice(1)arr.slice(1, arr.size()) 的简写)。

如果 beginend 为负,则表示相对于数组的末尾(即 arr.slice(0, -2)arr.slice(0, arr.size() - 2) 的简写)。


void sort() 🔗

将该数组中的元素按升序排列。


PackedByteArray to_byte_array() const 🔗

返回 PackedByteArray,每个字符串都按照 UTF-8 编码。字符串以 null 结尾。


运算符说明

bool operator !=(right: PackedStringArray) 🔗

如果数组内容不同,则返回 true


PackedStringArray operator +(right: PackedStringArray) 🔗

返回新的 PackedStringArray,新数组的内容为此数组在末尾加上 right。为了提高性能,请考虑改用 append_array()


bool operator ==(right: PackedStringArray) 🔗

如果两个数组的内容相同,即对应索引号的 String 相等,则返回 true


String operator [](index: int) 🔗

返回索引为 indexString。负数索引能从末尾开始访问元素。使用数组范围外的索引会导致出错。