StringName

唯一字符串内置类型。

描述

StringName 是不可变的字符串，用于唯一名称的通用表示（也叫“字符串内嵌”）。值相同的两个 StringName 是同一个对象。进行比较时比普通 String 要快很多。

需要 StringName 的方法通常可以传 String，会自动进行转换（经常发生在编译时），不过有时候你可能会想要提前使用 StringName 构造函数来构造 StringName，在 GDScript 中也可以用字面量语法 &"example"。你可以通过手动构造 StringName 来控制 String 的转换时机，使用字面量则可以完全消除掉转换过程。

另见 NodePath，这是与此类似的概念，针对存储预解析的场景树路径设计。

String 的所有方法都在这个类中可用。它们会将 StringName 转换为字符串，返回的也是字符串。这样做效率非常低，应该只在需要字符串时使用。

注意：在 C# 中，需要显式转换为 System.String 才能使用本页列出的方法。使用 ToString() 方法将 StringName 转换为字符串，然后使用 System.String 或 StringExtensions 中的等效方法。

注意：转换为布尔值时，空的 StringName（StringName("")）为 false，其他 StringName 均为 true。不能使用 not 运算符。请改用 is_empty 来检查空的 StringName。

备注

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

构造函数

方法

运算符

构造函数说明

StringName StringName() 🔗

构造空的 StringName。

StringName StringName(from: StringName)

构造给定 StringName 的副本。

StringName StringName(from: String)

从给定的 String 创建 StringName。在 GDScript 中，StringName("example") 与 &"example" 等价。

方法说明

bool begins_with(text: String) const 🔗

如果该字符串以给定的 text 开始，则返回 true。另见 ends_with。

PackedStringArray bigrams() const 🔗

返回包含该字符串的双字母组（连续字母的组合）的数组。

print("Get up!".bigrams()) # 输出 ["Ge", "et", "t ", " u", "up", "p!"]

int bin_to_int() const 🔗

将表示二进制数的字符串转换为 int。该字符串可以前缀 "0b"，负数可以前缀 -。

GDScriptC#

print("101".bin_to_int())   # 输出 5
print("0b101".bin_to_int()) # 输出 5
print("-0b10".bin_to_int()) # 输出 -2

GD.Print("101".BinToInt());   // 输出 5
GD.Print("0b101".BinToInt()); // 输出 5
GD.Print("-0b10".BinToInt()); // 输出 -2

String c_escape() const 🔗

返回该字符串的副本，按照 C 语言标准对特殊字符进行转义。

String c_unescape() const 🔗

返回该字符串的副本，转义字符均使用本义代替。支持的转义序列有 \'、\"、\\、\a、\b、\f、\n、\r、\t、\v。

注意：与 GDScript 解析器不同，这个方法不支持 \uXXXX 转义序列。

String capitalize() const 🔗

改变字符串的外观：用空格代替下划线（_），在单词中间的大写字母前添加空格，将所有字母转换为小写，然后将第一个字母和空格后的每个字母转换为大写。

GDScriptC#

"move_local_x".capitalize()   # 返回 "Move Local X"
"sceneFile_path".capitalize() # 返回 "Scene File Path"
"2D, FPS, PNG".capitalize()   # 返回 "2d, Fps, Png"

"move_local_x".Capitalize();   // 返回 "Move Local X"
"sceneFile_path".Capitalize(); // 返回 "Scene File Path"
"2D, FPS, PNG".Capitalize();   // 返回 "2d, Fps, Png"

int casecmp_to(to: String) const 🔗

与另一个字符串进行比较，区分大小写。小于时返回 -1、大于时返回 1、等于时返回 0。“小于”和“大于”比较的是字符串中的 Unicode 码位，大致与字母表顺序一致。

如果字符串长度不同，这个字符串比 to 字符串长时返回 1，短时返回 -1。请注意空字符串的长度始终为 0。

要从字符串比较中获得 bool 结果，请改用 == 运算符。另请参阅 nocasecmp_to、filecasecmp_to 和 naturalcasecmp_to。

bool contains(what: String) const 🔗

如果该字符串包含 what，则返回 true。在 GDScript 中对应 in 运算符。

GDScriptC#

print("Node".contains("de")) # 输出 true
print("team".contains("I"))  # 输出 false
print("I" in "team")         # 输出 false

GD.Print("Node".Contains("de")); // 输出 true
GD.Print("team".Contains("I"));  // 输出 false

如果想要知道 what 在该字符串中的位置，请使用 find。另见 containsn。

bool containsn(what: String) const 🔗

如果忽略大小写，字符串包含 what，则返回 true。

如果你需要知道 what 在字符串中的位置，请使用 findn。另请参阅 contains。

int count(what: String, from: int = 0, to: int = 0) const 🔗

返回子串 what 在 from 和 to 位置之间出现的次数。如果 to 为 0，会在剩余字符串中继续搜索。

int countn(what: String, from: int = 0, to: int = 0) const 🔗

返回子串 what 在 from 和 to 位置之间出现的次数，忽略大小写。如果 to 为 0，会在剩余字符串中继续搜索。

String dedent() const 🔗

返回删除了缩进（前导制表符和空格）的字符串副本。添加缩进请参阅 indent。

bool ends_with(text: String) const 🔗

如果该字符串以给定的 text 结束，则返回 true。另见 begins_with。

String erase(position: int, chars: int = 1) const 🔗

返回从 position 开始擦除 chars 个字符后的字符串。如果在指定 position 的基础上 chars 超过字符串的长度，返回的字符串中擦除的字符数会少于请求的数量。如果 position 或 chars 为负数，则返回空字符串。如果 chars 为 0 则返回原字符串，不进行修改。

int filecasecmp_to(to: String) const 🔗

与 naturalcasecmp_to 类似，但优先考虑以句点（.）和下划线（_）开头的字符串，然后再考虑其他字符。在对文件夹或文件名进行排序时很有用。

要从字符串比较中获取 bool 结果，请改用 == 运算符。另请参阅 filenocasecmp_to、naturalcasecmp_to 和 casecmp_to。

int filenocasecmp_to(to: String) const 🔗

与 naturalnocasecmp_to 类似，但优先考虑以句点（.）和下划线（_）开头的字符串，然后再考虑其他字符。在对文件夹或文件名进行排序时很有用。

要从字符串比较中获取 bool 结果，请改用 == 运算符。另请参阅 filecasecmp_to、naturalnocasecmp_to 和 nocasecmp_to。

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

返回 what 在该字符串中第一次出现的索引，如果不存在则返回 -1。搜索的起点可以用 from 指定，持续到字符串结尾。

GDScriptC#

print("Team".find("I")) # 输出 -1
print("Potato".find("t"))    # 输出 2
print("Potato".find("t", 3)) # 输出 4
print("Potato".find("t", 5)) # 输出 -1

GD.Print("Team".Find("I")); // 输出 -1
GD.Print("Potato".Find("t"));    // 输出 2
GD.Print("Potato".Find("t", 3)); // 输出 4
GD.Print("Potato".Find("t", 5)); // 输出 -1

注意：如果你只是想要知道该字符串中是否包含 what，请使用 contains。在 GDScript 中，你还可以使用 in 运算符。

int findn(what: String, from: int = 0) const 🔗

返回这个字符串中 what 首次出现的索引，不区分大小写，不存在时则为 -1。搜索的起点可以用 from 指定，终点为该字符串的末尾。

String format(values: Variant, placeholder: String = “{_}”) const 🔗

通过将所有出现的 placeholder 替换为 values 的元素来格式化字符串。

values 可以是 Dictionary 或 Array。placeholder 中的任何下划线将被预先被替换为对应的键。数组元素使用它们的索引作为键。

# 输出：Waiting for Godot 是 Samuel Beckett 的戏剧，Godot 引擎由此得名。
var use_array_values = "Waiting for {0} 是 {1} 的戏剧，{0} 引擎由此得名。"
print(use_array_values.format(["Godot", "Samuel Beckett"]))
# 输出：第 42 号用户是 Godot。
print("第 {id} 号用户是 {name}。".format({"id": 42, "name": "Godot"}))

当 values 是 Array 时还会执行一些额外的处理。 如果 placeholder 不包含下划线，则 values 数组的元素将用于按顺序替换出现的占位符；如果 values 的元素是另一个 2 元素数组，则它将被解释为键值对。

# 输出：第 42 号用户是 Godot。
print("第 {} 号用户是 {}。".format([42, "Godot"], "{}"))
print("第 {id} 号用户是 {name}。".format([["id", 42], ["name", "Godot"]]))

另请参阅 GDScript 格式化字符串教程。

注意：在 C# 中推荐改为使用“$”插入字符串。

String get_base_dir() const 🔗

如果该字符串是有效的文件路径，则返回基础目录名称。

var dir_path = "/path/to/file.txt".get_base_dir() # dir_path 为 "/path/to"

String get_basename() const 🔗

如果该字符串是有效的文件路径，则返回完整文件路径，不包括扩展名。

var base = "/path/to/file.txt".get_basename() # base 为 "/path/to/file"

String get_extension() const 🔗

如果该字符串是有效的文件名或路径，则返回该文件的扩展名，不含开头的点号（.）。否则返回空字符串。

var a = "/path/to/file.txt".get_extension() # a 为 "txt"
var b = "cool.txt".get_extension()          # b 为 "txt"
var c = "cool.font.tres".get_extension()    # c 为 "tres"
var d = ".pack1".get_extension()            # d 为 "pack1"
var e = "file.txt.".get_extension()  # e 为 ""
var f = "file.txt..".get_extension() # f 为 ""
var g = "txt".get_extension()        # g 为 ""
var h = "".get_extension()           # h 为 ""

String get_file() const 🔗

如果该字符串是有效的文件路径，则返回文件名，包括扩展名。

var file = "/path/to/icon.png".get_file() # file 为 "icon.png"

String get_slice(delimiter: String, slice: int) const 🔗

使用分隔符 delimiter 拆分该字符串，返回索引为 slice 的子串。如果 slice 不存在则返回空字符串。

只需要一个子串时这个方法比 split 快。

示例：

print("i/am/example/hi".get_slice("/", 2)) # 输出 "example"

int get_slice_count(delimiter: String) const 🔗

返回使用给定的分隔符 delimiter 拆分该字符串后切片的总数（见 split）。

String get_slicec(delimiter: int, slice: int) const 🔗

使用 Unicode 字符码分隔符 delimiter 拆分该字符串，返回索引为 slice 的子串。如果 slice 不存在则返回空字符串。

只需要一个子串时这个方法比 split 快。

int hash() const 🔗

返回代表该字符串内容的 32 位哈希值。

注意：由于哈希碰撞的缘故，哈希相同的字符串不一定相同。而相对的是，哈希不同的字符串一定不同。

PackedByteArray hex_decode() const 🔗

将十六进制字符串解码为 PackedByteArray。

GDScriptC#

var text = "hello world"
var encoded = text.to_utf8_buffer().hex_encode() # 输出 "68656c6c6f20776f726c64"
print(buf.hex_decode().get_string_from_utf8())

var text = "hello world";
var encoded = text.ToUtf8Buffer().HexEncode(); // 输出 "68656c6c6f20776f726c64"
GD.Print(buf.HexDecode().GetStringFromUtf8());

int hex_to_int() const 🔗

将表示十六进制数的字符串转换为 int。该字符串可以前缀 "0x"，负数可以前缀 -。

GDScriptC#

print("0xff".hex_to_int()) # 输出 255
print("ab".hex_to_int())   # 输出 171

GD.Print("0xff".HexToInt()); // 输出 255
GD.Print("ab".HexToInt());   // 输出 171

String indent(prefix: String) const 🔗

使用前缀 prefix 将该字符串中的每一行进行缩进。空行不缩进。移除缩进请参阅 dedent。

例如，该字符串可以用 "\t\t" 缩进两个制表位，用 " " 缩进四个空格。

String insert(position: int, what: String) const 🔗

在该字符串中的 position 位置插入 what。

bool is_absolute_path() const 🔗

如果该字符串为文件或目录的路径，并且显式指定了起点，则返回 true。这个方法与 is_relative_path 相反。

包括以 "res://"、"user://"、"C:\"、"/" 等开头的路径。

bool is_empty() const 🔗

如果该字符串的长度为 0（""），则返回 true。另见 length。

bool is_relative_path() const 🔗

如果该字符串为文件或目录的路径，并且起点依赖于上下文，则返回 true。路径可以是从当前目录开始，也可以是从当前 Node 开始（如果该字符串是从 NodePath 得到的），有时候也可以是使用了 "./" 前缀。这个方法与 is_absolute_path 相反。

bool is_subsequence_of(text: String) const 🔗

如果这个字符串中的所有字符都能在 text 中按照原始顺序找到，则返回 true。

var text = "Wow, incredible!"
print("inedible".is_subsequence_of(text)) # 输出 true
print("Word!".is_subsequence_of(text))    # 输出 true
print("Window".is_subsequence_of(text))   # 输出 false
print("".is_subsequence_of(text))         # 输出 true

bool is_subsequence_ofn(text: String) const 🔗

如果这个字符串中的所有字符都能在 text 中按照原始顺序找到，忽略大小写，则返回 true。

bool is_valid_filename() const 🔗

如果该字符串不包含文件名中不允许的字符，则返回 true（不允许的字符有：: / \ ? * " | % < >）。

bool is_valid_float() const 🔗

如果该字符串代表有效的浮点数，则返回 true。浮点数只能包含数字、一个小数点（.）以及指数字符（e）。还可以前缀正号（+）或负号（-）。有效的整数同时也是有效的浮点数（见 is_valid_int）。另见 to_float。

print("1.7".is_valid_float())   # 输出 true
print("24".is_valid_float())    # 输出 true
print("7e3".is_valid_float())   # 输出 true
print("Hello".is_valid_float()) # 输出 false

bool is_valid_hex_number(with_prefix: bool = false) const 🔗

如果该字符串代表有效的十六进制数，则返回 true。有效的十六进制数只能包含数字或字母 A 到 F（大小写均可），还可以前缀正号（+）或负号（-）。

如果 with_prefix 为 true，则十六进制数需要有 "0x" 前缀才算有效。

print("A08E".is_valid_hex_number())    # 输出 true
print("-AbCdEf".is_valid_hex_number()) # 输出 true
print("2.5".is_valid_hex_number())     # 输出 false
print("0xDEADC0DE".is_valid_hex_number(true)) # 输出 true

bool is_valid_html_color() const 🔗

如果该字符串是有效的十六进制 HTML 颜色标记，则返回 true。该字符串必须为 3 位、4 位、6 位或 8 位字符的十六进制值（见 is_valid_hex_number），也可以带有井号前缀（#）。名称、hsl() 等其他 HTML 颜色标记法无效。另见 Color.html。

bool is_valid_identifier() const 🔗

如果该字符串为有效的标识符，则返回 true。有效的标识符仅可以包含字母、数字和下划线（_），第一个字符不能为数字。

print("node_2d".is_valid_identifier())    # 输出 true
print("TYPE_FLOAT".is_valid_identifier()) # 输出 true
print("1st_method".is_valid_identifier()) # 输出 false
print("MyMethod#2".is_valid_identifier()) # 输出 false

bool is_valid_int() const 🔗

如果该字符串代表有效的整数，则返回 true。有效的整数仅可以包含数字，还可以前缀正号（+）或负号（-）。另见 to_int。

print("7".is_valid_int())    # 输出 true
print("1.65".is_valid_int()) # 输出 false
print("Hi".is_valid_int())   # 输出 false
print("+3".is_valid_int())   # 输出 true
print("-12".is_valid_int())  # 输出 true

bool is_valid_ip_address() const 🔗

如果该字符串表示格式正确的 IPv4 或 IPv6 地址，则返回 true。这个方法认为 0.0.0.0、"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff" 等保留 IP 地址是有效的。

String join(parts: PackedStringArray) const 🔗

返回将 parts 中的元素连接组成的字符串，元素间使用调用该方法的字符串进行分隔。该方法和 split 相反。

示例：

GDScriptC#

var fruits = ["Apple", "Orange", "Pear", "Kiwi"]
print(", ".join(fruits))  # 输出 "Apple, Orange, Pear, Kiwi"
print("---".join(fruits)) # 输出 "Apple---Orange---Pear---Kiwi"

var fruits = new string[] {"Apple", "Orange", "Pear", "Kiwi"};
// 这个方法在 C# 中是静态的。
GD.Print(string.Join(", ", fruits));   // 输出 "Apple, Orange, Pear, Kiwi"
GD.Print(string.Join("---", fruits)); // 输出 "Apple---Orange---Pear---Kiwi"

String json_escape() const 🔗

返回该字符串的副本，使用 JSON 标准对特殊字符进行转义。因为与 C 标准非常类似，所以需要时可以用 c_unescape 取消转义。

String left(length: int) const 🔗

返回该字符串开头的前 length 个字符。如果 length 为负，则会从该字符串的末尾剥离最后 length 个字符。

print("Hello World!".left(3))  # 输出 "Hel"
print("Hello World!".left(-4)) # 输出 "Hello Wo"

int length() const 🔗

返回该字符串中的字符数。空字符串（""）始终返回 0。另见 is_empty。

String lpad(min_length: int, character: String = “ “) const 🔗

必要时在该字符串的左侧添加若干 character 字符，使其长度至少为 min_length。另见 rpad。

String lstrip(chars: String) const 🔗

从该字符串的开头移除 chars 中定义的字符。另见 rstrip。

注意：chars 不是前缀。如果要移除前缀而不是一组字符，请使用 trim_prefix。

bool match(expr: String) const 🔗

进行简单的表达式匹配（也叫“通配”），* 匹配零个或多个任意字符，? 匹配除英文句号外的任意字符（.）。使用空字符串或空表达式时始终为 false。

bool matchn(expr: String) const 🔗

进行简单的大小写不敏感表达式匹配（也叫“通配”），* 匹配零个或多个任意字符，? 匹配除英文句号外的任意字符（.）。使用空字符串或空表达式时始终为 false。

PackedByteArray md5_buffer() const 🔗

返回该字符串的 MD5 哈希，类型为 PackedByteArray。

String md5_text() const 🔗

返回该字符串的 MD5 哈希，类型 String。

int naturalcasecmp_to(to: String) const 🔗

与另一个字符串进行不区分大小写的自然顺序比较。小于时返回 -1、大于时返回 1、等于时返回 0。“小于”和“大于”比较的是字符串中的 Unicode 码位，大致与字母表顺序一致。内部实现时，会将小写字符转换为大写后进行比较。

使用自然顺序进行排序时，会和常见预期一样将连续的数字进行组合，而不是一个个数字进行比较。排序后的数列为 ["1", "2", "3", ...] 而不是 ["1", "10", "2", "3", ...]。

如果字符串长度不同，这个字符串比 to 字符串长时返回 1，短时返回 -1。请注意空字符串的长度始终为 0。

要从字符串比较中获得 bool 结果，请改用 == 运算符。另请参阅 naturalnocasecmp_to、filecasecmp_to 和 nocasecmp_to。

int naturalnocasecmp_to(to: String) const 🔗

与另一个字符串进行不区分大小写的自然顺序比较。小于时返回 -1、大于时返回 1、等于时返回 0。“小于”和“大于”比较的是字符串中的 Unicode 码位，大致与字母表顺序一致。内部实现时，会将小写字符转换为大写后进行比较。

使用自然顺序进行排序时，会和常见预期一样将连续的数字进行组合，而不是一个个数字进行比较。排序后的数列为 ["1", "2", "3", ...] 而不是 ["1", "10", "2", "3", ...]。

如果字符串长度不同，这个字符串比 to 字符串长时返回 1，短时返回 -1。请注意空字符串的长度始终为 0。

要从字符串比较中获得 bool 结果，请改用 == 运算符。另请参阅 naturalcasecmp_to、filenocasecmp_to 和 casecmp_to。

int nocasecmp_to(to: String) const 🔗

与另一个字符串进行不区分大小写的比较。小于时返回 -1、大于时返回 1、等于时返回 0。“小于”和“大于”比较的是字符串中的 Unicode 码位，大致与字母表顺序一致。内部实现时，会将小写字符转换为大写后进行比较。

如果字符串长度不同，这个字符串比 to 字符串长时返回 1，短时返回 -1。请注意空字符串的长度始终为 0。

要从字符串比较中获得 bool 结果，请改用 == 运算符。另请参阅 casecmp_to、filenocasecmp_to 和 naturalnocasecmp_to。

String pad_decimals(digits: int) const 🔗

格式化表示数字的字符串，使其小数点后的位数为 digits。

String pad_zeros(digits: int) const 🔗

格式化表示数字的字符串，使其小数点前的位数为 digits。

String path_join(file: String) const 🔗

将 file 作为子路径连接到该字符串的末尾，必要时会添加 /。

示例："this/is".path_join("path") == "this/is/path"。

String repeat(count: int) const 🔗

将该字符串重复若干次。次数 count 需要大于0 。否则返回空字符串。

String replace(what: String, forwhat: String) const 🔗

将该字符串中出现的所有 what 都替换为给定的 forwhat。

String replacen(what: String, forwhat: String) const 🔗

将该字符串中出现的所有 what 都替换为给定的 forwhat，大小写不敏感。

String reverse() const 🔗

返回该字符串的逆序的副本。该操作适用于 Unicode 代码点，而不是代码点序列，并且可能会破坏复合字母或表情符号等内容。

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

返回这个字符串中 what 最后一次出现时的索引，不存在时则为 -1。搜索的起点可以用 from 指定，终点为该字符串的末尾。这个方法与 find 相对。

int rfindn(what: String, from: int = -1) const 🔗

返回这个字符串中 what 最后一次出现时的索引，不区分大小写，不存在时则为 -1。搜索的起点可以用 from 指定，终点为该字符串的末尾。这个方法与 findn 相对。

String right(length: int) const 🔗

返回该字符串末尾的最后 length 个字符。如果 length 为负，则会从该字符串的开头剥离前 length 个字符。

print("Hello World!".right(3))  # 输出 "ld!"
print("Hello World!".right(-4)) # 输出 "o World!"

String rpad(min_length: int, character: String = “ “) const 🔗

必要时在该字符串的右侧添加若干 character 字符，使其长度至少为 min_length。另见 lpad。

PackedStringArray rsplit(delimiter: String = “”, allow_empty: bool = true, maxsplit: int = 0) const 🔗

使用分隔符 delimiter 将该字符串从末尾开始进行拆分，返回子字符串数组。返回的数组中，每部分的出现顺序与它们在原字符串中的出现顺序一致。如果 delimiter 为空，则子串为单个字符。

如果 allow_empty 为 false，数组中会排除相邻分隔符之间的空字符串。

如果 maxsplit 大于 0，则拆分次数不能超过 maxsplit。默认拆分整个字符串，基本与 split 一致。

示例：

GDScriptC#

var some_string = "One,Two,Three,Four"
var some_array = some_string.rsplit(",", true, 1)
print(some_array.size()) # 输出 2
print(some_array[0])     # 输出 "One,Two,Three"
print(some_array[1])     # 输出 "Four"

// C# 中没有 String.RSplit() 方法。

String rstrip(chars: String) const 🔗

从该字符串的结尾移除 chars 中定义的字符。另见 rstrip。

注意：chars 不是后缀。如果要移除后缀而不是一组字符，请使用 trim_suffix。

PackedByteArray sha1_buffer() const 🔗

返回该字符串的 SHA-1 哈希，类型为 PackedByteArray。

String sha1_text() const 🔗

返回该字符串的 SHA-1 哈希，类型为 String。

PackedByteArray sha256_buffer() const 🔗

返回该字符串的 SHA-256 哈希，类型为 PackedByteArray。

String sha256_text() const 🔗

返回该字符串的 SHA-256 哈希，类型为 String。

float similarity(text: String) const 🔗

返回该字符串与另一个字符串的相似指数（索伦森-戴斯系数）。结果为 1.0 表示完全相似，0.0 表示完全不相似。

print("ABC123".similarity("ABC123")) # 输出 1.0
print("ABC123".similarity("XYZ456")) # 输出 0.0
print("ABC123".similarity("123ABC")) # 输出 0.8
print("ABC123".similarity("abc123")) # 输出 0.4

String simplify_path() const 🔗

如果该字符串为有效的文件路径，则将其转换为规范路径。规范路径是最短路径，不带 "./" 和所有不必要的 ".." 和 "/"。

var simple_path = "./path/to///../file".simplify_path()
print(simple_path) # 输出 "path/file"

PackedStringArray split(delimiter: String = “”, allow_empty: bool = true, maxsplit: int = 0) const 🔗

使用分隔符 delimiter 将该字符串进行拆分，返回子字符串数组。如果 delimiter 为空，则子串为单个字符。这个方法与 join 相对。

如果 allow_empty 为 false，数组中会排除相邻分隔符之间的空字符串。

如果 maxsplit 大于 0，则拆分次数不能超过 maxsplit。默认拆分整个字符串。

示例：

GDScriptC#

var some_array = "One,Two,Three,Four".split(",", true, 2)
print(some_array.size()) # 输出 3
print(some_array[0])     # 输出 "One"
print(some_array[1])     # 输出 "Two"
print(some_array[2])     # 输出 "Three,Four"

// C# 的 `Split()` 不支持 `maxsplit` 参数。
var someArray = "One,Two,Three".Split(",");
GD.Print(someArray[0]); // 输出 "One"
GD.Print(someArray[1]); // 输出 "Two"
GD.Print(someArray[2]); // 输出 "Three"

注意：如果你只需要数组中的某一个子串，请考虑使用更快的 get_slice。如果你需要用更复杂的规则来拆分字符串，请改用 RegEx 类。

PackedFloat64Array split_floats(delimiter: String, allow_empty: bool = true) const 🔗

使用分隔符 delimiter 将该字符串拆分为浮点数，返回 PackedFloat64Array。

如果 allow_empty 为 false，则会排除相邻分隔符之间为空或无法转换为 float 的内容。

var a = "1,2,4.5".split_floats(",")         # a 为 [1.0, 2.0, 4.5]
var c = "1| ||4.5".split_floats("|")        # c 为 [1.0, 0.0, 0.0, 4.5]
var b = "1| ||4.5".split_floats("|", false) # b 为 [1.0, 4.5]

String strip_edges(left: bool = true, right: bool = true) const 🔗

从该字符串的开头和结尾剥离所有不可打印的字符。其中包括空格、制表符（\t）以及换行符（\n \r）。

如果 left 为 false，会忽略该字符串的开头。与此类似，如果 right 为 false，则会忽略该字符串的结尾。

String strip_escapes() const 🔗

从该字符串中剥离所有转义字符。其中包括 ASCII 表第一页的所有不可打印控制字符（值为 0 到 32），例如制表符（C 中的 \t）和换行符（\n 和 ]\r) 字符，但不包括空格。

String substr(from: int, len: int = -1) const 🔗

返回该字符串中的某一部分，位置从 from 开始，长度为 len。如果 len 为 -1（默认值），将返回开给定位置开始的剩余字符。

PackedByteArray to_ascii_buffer() const 🔗

将该字符串转换为 ASCII/Latin-1 编码的 PackedByteArray。这个方法比 to_utf8_buffer 稍快，但会把不支持的字符都替换为空格。

String to_camel_case() const 🔗

返回将该字符串转换为小驼峰命名 camelCase 的结果。

float to_float() const 🔗

将代表十进制数的字符串转换为 float。该方法会在首个非数字字符处停止，除非是首次遇到 .（小数点）以及表示指数的 e。另见 is_valid_float。

var a = "12.35".to_float() # a 为 12.35
var b = "1.2.3".to_float() # b 为 1.2
var c = "12xy3".to_float() # c 为 12.0
var d = "1e3".to_float()   # d 为 1000.0
var e = "Hello!".to_int()  # e 为 0.0

int to_int() const 🔗

将代表整数的字符串转换为 int。该方法会删除所有非数字字符，并在遇到 . 后停止。另见 is_valid_int。

var a = "123".to_int()    # a 为 123
var b = "x1y2z3".to_int() # b 为 123
var c = "-1.2.3".to_int() # c 为 -1
var d = "Hello!".to_int() # d 为 0

String to_lower() const 🔗

返回将该字符串转换为小写 lowercase 的结果。

String to_pascal_case() const 🔗

返回将该字符串转换为大驼峰命名 PascalCase 的结果。

String to_snake_case() const 🔗

返回将该字符串转换为蛇形命名 snake_case 的结果。

注意：如果数字之后存在的是单个字符，则不会进行拆分，这是为了保证某些单词的连贯（例如“2D”）。

GDScriptC#

"Node2D".to_snake_case()               # 返回 "node_2d"
"2nd place".to_snake_case()            # 返回 "2_nd_place"
"Texture3DAssetFolder".to_snake_case() # 返回 "texture_3d_asset_folder"

"Node2D".ToSnakeCase();               // 返回 "node_2d"
"2nd place".ToSnakeCase();            // 返回 "2_nd_place"
"Texture3DAssetFolder".ToSnakeCase(); // 返回 "texture_3d_asset_folder"

String to_upper() const 🔗

返回将该字符串转换为大写 UPPERCASE 的结果。

PackedByteArray to_utf8_buffer() const 🔗

将该字符串转换为 UTF-8 编码的 PackedByteArray。这个方法比 to_ascii_buffer 稍慢，但支持所有 UTF-8 字符。大多数情况下请优先使用这个方法。

PackedByteArray to_utf16_buffer() const 🔗

将该字符串转换为 UTF-16 编码的 PackedByteArray。

PackedByteArray to_utf32_buffer() const 🔗

将该字符串转换为 UTF-32 编码的 PackedByteArray。

PackedByteArray to_wchar_buffer() const 🔗

将该字符串转换为 宽字符（wchat_t，Windows 上为 UTF-16，其他平台上为 UTF-32）编码的 PackedByteArray。

String trim_prefix(prefix: String) const 🔗

移除该字符串开头的 prefix 前缀，否则原样返回该字符串。

String trim_suffix(suffix: String) const 🔗

移除该字符串末尾的 suffix 后缀，否则原样返回该字符串。

int unicode_at(at: int) const 🔗

返回位于 at 处的字符的代码。

String uri_decode() const 🔗

将该字符串从 URL 编码格式中解码。该方法的目的是在收到 HTTP 请求时正确解码 URL 中的参数。

GDScriptC#

var url = "$DOCS_URL/?highlight=Godot%20Engine%3%docs"
print(url.uri_decode()) # 输出 "$DOCS_URL/?highlight=Godot Engine:docs"

var url = "$DOCS_URL/?highlight=Godot%20Engine%3%docs"
GD.Print(url.URIDecode()) // 输出 "$DOCS_URL/?highlight=Godot Engine:docs"

String uri_encode() const 🔗

将该字符串按照对 URL 友好的格式进行编码。该方法的目的是在发送 HTTP 请求时，正确编码 URL 中的参数。

GDScriptC#

var prefix = "$DOCS_URL/?highlight="
var url = prefix + "Godot Engine:docs".uri_encode()
print(url) # 输出 "$DOCS_URL/?highlight=Godot%20Engine%3%docs"

var prefix = "$DOCS_URL/?highlight=";
var url = prefix + "Godot Engine:docs".URIEncode();
GD.Print(url); // 输出 "$DOCS_URL/?highlight=Godot%20Engine%3%docs"

String validate_filename() const 🔗

返回该字符串的副本，所有 is_valid_filename 中不允许的字符都会被替换为下划线。

String validate_node_name() const 🔗

返回该字符串的副本，所有 Node.name 中不允许的字符都会被替换为下划线（. : @ / " %)）。

String xml_escape(escape_quotes: bool = false) const 🔗

返回该字符串的副本，使用 XML 标准对特殊字符进行转义。如果 escape_quotes 为 true，则单引号（'）和双引号（"）字符也会被转义。

String xml_unescape() const 🔗

返回该字符串的副本，转义字符均按照 XML 标准使用本义代替。

运算符说明

bool operator !=(right: String) 🔗

如果该 StringName 与给定的 String 不等价，则返回 true。

bool operator !=(right: StringName) 🔗

如果该 StringName 与 right 不指向同一个名称，则返回 true。StringName 间的比较比常规 String 间的比较要快很多。

String operator %(right: Variant) 🔗

格式化该 StringName，使用若干参数替换占位符，返回的是 String。要传递多个参数时，right 应为 Array。

更多信息见《GDScript 格式字符串》教程。

注意：C# 中没有等价的运算符。见如何使用“$”插入字符串。

String operator +(right: String) 🔗

将 right 追加到该 StringName 的末尾，返回的是 String。也称作字符串连接。

String operator +(right: StringName) 🔗

将 right 追加到该 StringName 的末尾，返回的是 String。也称作字符串连接。

bool operator <(right: StringName) 🔗

如果左侧的 StringName 的指针比 right 靠前，则返回 true。注意，这与 Unicode 顺序是不同的。

bool operator <=(right: StringName) 🔗

如果左侧的 StringName 的指针比 right 靠前或者相同，则返回 true。注意，这与 Unicode 顺序是不同的。

bool operator ==(right: String) 🔗

如果该 StringName 与给定的 String 等价，则返回 true。

bool operator ==(right: StringName) 🔗

如果该 StringName 与 right 指向同一个名称，则返回 true。StringName 间的比较比常规 String 间的比较要快很多。

bool operator >(right: StringName) 🔗

如果左侧的 StringName 的指针比 right 靠后，则返回 true。注意，这与 Unicode 顺序是不同的。

bool operator >=(right: StringName) 🔗

如果左侧的 StringName 的指针比 right 靠后或相同，则返回 true。注意，这与 Unicode 顺序是不同的。