String

简要描述

内置字符串类。

描述

这是内置的字符串类（以及IVRScript使用的字符串类）。

方法

返回值类型	方法名称
String	String(#method-String)(from: bool)
String	String(#method-String)(from: int)
String	String(#method-String)(from: float)
String	String(#method-String)(from: Vector2)
String	String(#method-String)(from: Rect2)
String	String(#method-String)(from: Vector3)
String	String(#method-String)(from: Transform2D)
String	String(#method-String)(from: Plane)
String	String(#method-String)(from: Quat)
String	String(#method-String)(from: AABB)
String	String(#method-String)(from: Basis)
String	String(#method-String)(from: Transform)
String	String(#method-String)(from: Color)
String	String(#method-String)(from: NodePath)
String	String(#method-String)(from: RID)
String	String(#method-String)(from: Dictionary)
String	String(#method-String)(from: Array)
String	String(#method-String)(from: PoolByteArray)
String	String(#method-String)(from: PoolIntArray)
String	String(#method-String)(from: PoolRealArray)
String	String(#method-String)(from: PoolStringArray)
String	String(#method-String)(from: PoolVector2Array)
String	String(#method-String)(from: PoolVector3Array)
String	String(#method-String)(from: PoolColorArray)
bool	begins_with(text: String)
PoolStringArray	bigrams()
String	c_escape()
String	c_unescape()
String	capitalize()
int	casecmp_to(to: String)
int	count(what: String, from: int = 0, to: int = 0)
int	countn(what: String, from: int = 0, to: int = 0)
String	dedent()
bool	empty()
bool	ends_with(text: String)
	erase(position: int, chars: int)
int	find(what: String, from: int = 0)
int	find_last(what: String)
int	findn(what: String, from: int = 0)
String	format(values: Variant, placeholder: String = "{_}")
String	get_base_dir()
String	get_basename()
String	get_extension()
String	get_file()
int	hash()
int	hex_to_int()
String	http_escape()
String	http_unescape()
String	humanize_size(size: int)
String	insert(position: int, what: String)
bool	is_abs_path()
bool	is_rel_path()
bool	is_subsequence_of(text: String)
bool	is_subsequence_ofi(text: String)
bool	is_valid_filename()
bool	is_valid_float()
bool	is_valid_hex_number(with_prefix: bool = false)
bool	is_valid_html_color()
bool	is_valid_identifier()
bool	is_valid_integer()
bool	is_valid_ip_address()
String	json_escape()
String	left(position: int)
int	length()
String	lstrip(chars: String)
bool	match(expr: String)
bool	matchn(expr: String)
PoolByteArray	md5_buffer()
String	md5_text()
int	nocasecmp_to(to: String)
int	ord_at(at: int)
String	pad_decimals(digits: int)
String	pad_zeros(digits: int)
String	percent_decode()
String	percent_encode()
String	plus_file(file: String)
String	repeat(count: int)
String	replace(what: String, forwhat: String)
String	replacen(what: String, forwhat: String)
int	rfind(what: String, from: int = -1)
int	rfindn(what: String, from: int = -1)
String	right(position: int)
PoolStringArray	rsplit(delimiter: String, allow_empty: bool = true, maxsplit: int = 0)
String	rstrip(chars: String)
PoolByteArray	sha1_buffer()
String	sha1_text()
PoolByteArray	sha256_buffer()
String	sha256_text()
float	similarity(text: String)
PoolStringArray	split(delimiter: String, allow_empty: bool = true, maxsplit: int = 0)
PoolRealArray	split_floats(delimiter: String, allow_empty: bool = true)
String	strip_edges(left: bool = true, right: bool = true)
String	strip_escapes()
String	substr(from: int, len: int = -1)
PoolByteArray	to_ascii()
float	to_float()
int	to_int()
String	to_lower()
String	to_upper()
PoolByteArray	to_utf8()
String	trim_prefix(prefix: String)
String	trim_suffix(suffix: String)
String	xml_escape()
String	xml_unescape()

方法说明

• String String(from: bool)

从给定的bool构造一个新的String。

---

• String String(from: int)

从给定的int构造一个新的String。

---

• String String(from: float)

从给定的float构造一个新的String。

---

• String String(from: Vector2)

从给定的Vector2构造一个新的String。

---

• String String(from: Rect2)

从给定的Rect2构造一个新的String。

---

• String String(from: Vector3)

从给定的Vector3构造一个新的String。

---

• String String(from: Transform2D)

从给定的Transform2D构造一个新的String。

---

• String String(from: Plane)

根据给定的Plane构造一个新的String。

---

• String String(from: Quat)

从给定的Quat构造一个新的String。

---

• String String(from: AABB)

根据给定的AABB构造一个新的String。

---

• String String(from: Basis)

根据给定的Basis构造一个新的String。

---

• String String(from: Transform)

从给定的Transform构造一个新的String。

---

• String String(from: Color)

从给定的Color构造一个新的String。

---

• String String(from: NodePath)

从给定的NodePath构造一个新的String。

---

• String String(from: RID)

根据给定的RID构造一个新的String。

---

• String String(from: Dictionary)

根据给定的Dictionary构造一个新的String。

---

• String String(from: Array)

从给定的Array构造一个新的String。

---

• String String(from: PoolByteArray)

从给定的PoolByteArray构造一个新的String。

---

• String String(from: PoolIntArray)

从给定的PoolIntArray构造一个新的String。

---

• String String(from: PoolRealArray)

从给定的PoolRealArray构造一个新的String。

---

• String String(from: PoolStringArray)

从给定的PoolStringArray构造一个新的String。

---

• String String(from: PoolVector2Array)

从给定的PoolVector2Array构造一个新的String。

---

• String String(from: PoolVector3Array)

从给定的PoolVector3Array构造一个新的String。

---

• String String(from: PoolColorArray)

从给定的PoolColorArray构造一个新的String。

---

• begins_with begins_with(text: String)

如果字符串以给定的字符串开头，则返回true。

---

• bigrams bigrams()

返回此字符串的双字（连续字母对）。

---

• c_escape c_escape()

返回使用C语言标准转义的带有特殊字符的字符串的副本。

---

• c_unescape c_unescape()

返回字符串的副本，其中转义字符根据C语言标准用其含义代替。

---

• capitalize capitalize()

更改某些字母的大小写。

---

• casecmp_to casecmp_to(to: String)

对另一个字符串执行区分大小写的比较。

---

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

返回from和to位置之间子字符串what的出现次数。

---

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

返回from和to位置之间子字符串what的出现次数（忽略大小写）。

---

• dedent dedent()

返回删除缩进（前导制表符和空格）的字符串的副本。

---

• empty empty()

如果字符串为空，则返回true。

---

• ends_with ends_with(text: String)

如果字符串以给定字符串结尾，则返回true。

---

• erase erase(position: int, chars: int)

从position开始的字符串中删除chars字符。

---

• find find(what: String, from: int = 0)

查找第一次出现的子字符串位置。

---

• find_last find_last(what: String)

查找子字符串的最后一次出现位置。

---

• findn findn(what: String, from: int = 0)

查找子字符串的第一个匹配项，忽略大小写。

---

• format format(values: Variant, placeholder: String = "{_}")

通过用values替换所有出现的placeholder来格式化字符串。

---

• get_base_dir get_base_dir()

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

---

• get_basename get_basename()

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

---

• get_extension get_extension()

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

---

• get_file get_file()

如果字符串是有效的文件路径，则返回文件名。

---

• hash hash()

对字符串进行哈希处理并返回32位整数。

---

• hex_to_int hex_to_int()

将包含十六进制数字的字符串转换为整数。

print("0xff".hex_to_int())

---

• http_escape http_escape()

将字符串转义（编码）为URL友好格式。

print("https://example.org/?escaped=" + "IdeaXR Engine：'docs'".http_escape())

---

• http_unescape http_unescape()

取消转义（解码）URL编码格式的字符串。

print("https://example.org/?escaped=" + "IdeaXR Engine：'docs'".http_unescape())

---

• humanize_size humanize_size(size: int)

使用国际化的数据大小单位集（即B，KiB，MiB，GiB，TiB，PiB，EiB）将表示为字节数的size转换为人类可读的格式。

var bytes = 133790307
var size = String.humanize_size(bytes)
print(size) # prints "127.5 MiB"

---

• insert insert(position: int, what: String)

返回在给定位置插入子字符串what的字符串的副本。

---

• is_abs_path is_abs_path()

如果字符串是文件或目录的路径，则如果该路径是绝对路径，则返回true。

---

• is_rel_path is_rel_path()

如果字符串是文件或目录的路径，则如果该路径是相对的，则返回true。

---

• is_subsequence_of is_subsequence_of(text: String)

如果此字符串是给定字符串的子序列，则返回true。

---

• is_subsequence_ofi is_subsequence_ofi(text: String)

如果此字符串是给定字符串的子序列（不考虑大小写），则返回true。

---

• is_valid_filename is_valid_filename()

如果此字符串没有文件名中不允许的字符，则返回true，这些字符是：

：/\？

---

• is_valid_float is_valid_float()

如果此字符串包含有效的浮点数，则返回true。

---

• is_valid_hex_number is_valid_hex_number(with_prefix: bool = false)

如果此字符串包含有效的十六进制数字，则返回true。

---

• is_valid_html_color is_valid_html_color()

如果此字符串包含十六进制HTML表示法的有效颜色，则返回true。

---

• is_valid_identifier is_valid_identifier()

如果此字符串是有效的标识符，则返回true。

---

• is_valid_integer is_valid_integer()

如果此字符串包含有效整数，则返回true。

---

• is_valid_ip_address is_valid_ip_address()

如果此字符串包含有效的IP地址，则返回true。

---

• json_escape json_escape()

返回带有使用JSON标准转义的特殊字符的字符串的副本。

---

• left left(position: int)

从字符串的左边返回一些字符。

---

• length length()

返回字符串的字符数。

---

• lstrip lstrip(chars: String)

返回字符串的副本，其中字符从左侧删除。

---

• match match(expr: String)

是否简单区分大小写的表达式匹配，其中"*"匹配零个或多个任意字符，"?"匹配除（"."）之外的任何单个字符。

---

• matchn matchn(expr: String)

是否简单不区分大小写的表达式匹配，其中"*"匹配零个或多个任意字符，"?"匹配除（"."）之外的任何单个字符。

---

• md5_buffer md5_buffer()

以字节数组形式返回字符串的MD5哈希值。

---

• md5_text md5_text()

以字符串形式返回字符串的MD5哈希值。

---

• nocasecmp_to nocasecmp_to(to: String)

对另一个字符串执行不区分大小写的比较。

---

• ord_at ord_at(at: int)

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

---

• pad_decimals pad_decimals(digits: int)

将数字格式化为小数点后的digits个确切数字。

---

• pad_zeros pad_zeros(digits: int)

将数字格式化为小数点前的digits个确切数字。

---

• percent_decode percent_decode()

解码一个percent-encoded的字符串。

---

• percent_encode percent_encode()

对字符串进行percent-encoded。

---

• plus_file plus_file(file: String)

如果字符串是路径，则将字符串末尾的file连接为子路径。

---

• repeat repeat(count: int)

返回原始字符串重复多次。

---

• replace replace(what: String, forwhat: String)

用字符串中给定的一个替换区分大小写的子字符串。

---

• replacen replacen(what: String, forwhat: String)

将不区分大小写的子字符串替换为字符串内给定的子字符串。

---

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

对子字符串执行区分大小写的搜索，但是从字符串的末尾而不是开头开始。

---

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

对子字符串执行不区分大小写的搜索，但是从字符串的末尾而不是开头开始。

---

• right right(position: int)

从给定位置返回字符串的右侧。

---

• rsplit rsplit(delimiter: String, allow_empty: bool = true, maxsplit: int = 0)

用delimiter字符串分割字符串，并从右开始返回子字符串数组。

返回数组中的拆分按与原始字符串相同的顺序从左到右排序。

如果指定了maxsplit，则它将定义从右到maxsplit的分割数。

例：

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

---

• rstrip rstrip(chars: String)

返回字符串的副本，其中右边的字符已删除。

---

• sha1_buffer sha1_buffer()

以字节数组形式返回字符串的SHA-1哈希值。

---

• sha1_text sha1_text()

以字符串形式返回字符串的SHA-1哈希值。

---

• sha256_buffer sha256_buffer()

以字节数组形式返回字符串的SHA-256哈希值。

---

• sha256_text sha256_text()

以字符串形式返回字符串的SHA-256哈希值。

---

• similarity similarity(text: String)

返回与此字符串相比的文本的相似性索引。

---

• split split(delimiter: String, allow_empty: bool = true, maxsplit: int = 0)

用delimiter字符串分割字符串，并返回子字符串数组。

如果指定了maxsplit，则它定义了从左到maxsplit的分割数。

例：

var some_string = "One,Two,Three,Four"
var some_array = some_string.split(",", true, 1)
print(some_array.size()) # Prints 2
print(some_array[0]) # 打印"One"
print(some_array[1]) # 打印"Two,Three,Four"

---

• split_floats split_floats(delimiter: String, allow_empty: bool = true)

通过使用定界符字符串以浮点数形式拆分字符串，并返回子字符串数组。

例如，如果将"1,2.5,3"除以","，将返回[1,2.5,3]。

---

• strip_edges strip_edges(left: bool = true, right: bool = true)

返回开头和结尾去除所有不可打印字符（包括制表符，空格和换行符）的字符串的副本。

---

• strip_escapes strip_escapes()

返回去除了任何转义字符的字符串的副本。

---

• substr substr(from: int, len: int = -1)

从位置from返回字符串的一部分，长度为len。

---

• to_ascii to_ascii()

将字符串（它是一个字符数组）转换为PoolByteArray（它是一个字节数组）。

---

• to_float to_float()

将包含十进制数字的字符串转换为float。

---

• to_int to_int()

将包含整数的字符串转换为int。

---

• to_lower to_lower()

返回转换为小写的字符串。

---

• to_upper to_upper()

返回转换为大写的字符串。

---

• to_utf8 to_utf8()

将字符串（一个字符数组）转换为PoolByteArray（一个字节数组）。

---

• trim_prefix trim_prefix(prefix: String)

如果开头是给定的字符串，则从开头删除该字符串，或者保留该字符串不变。

---

• trim_suffix trim_suffix(suffix: String)

如果结尾是给定的字符串，则从结尾删除该字符串，或者保留该字符串不变。

---

• xml_escape xml_escape()

返回带有使用XML标准转义的特殊字符的字符串的副本。

---

• xml_unescape xml_unescape()

返回字符串的副本，其中转义字符根据XML标准用其含义代替。

---