RegEx
继承： RefCounted < Object
使用正则表达式搜索文本的类。
描述
A regular expression (or regex) is a compact language that can be used to recognize strings that follow a specific pattern, such as URLs, email addresses, complete sentences, etc. For example, a regex of ab[0-9] would find any string that is ab followed by any number from 0 to 9. For a more in-depth look, you can easily find various tutorials and detailed explanations on the Internet.
To begin, the RegEx object needs to be compiled with the search pattern using compile() before it can be used. Alternatively, the static method create_from_string() can be used to create and compile a RegEx object in a single method call.
var regex = RegEx.new()
regex.compile("\\w-(\\d+)")
# Shorthand to create and compile a regex (used in the examples below):
var regex2 = RegEx.create_from_string("\\w-(\\d+)")
The search pattern must be escaped first for GDScript before it is escaped for the expression. For example, compile("\\d+") would be read by RegEx as \d+. Similarly, compile("\"(?:\\\\.|[^\"])*\"") would be read as "(?:\\.|[^"])*". In GDScript, you can also use raw string literals (r-strings). For example, compile(r'"(?:\\.|[^"])*"') would be read the same.
Using search(), you can find the pattern within the given text. If a pattern is found, RegExMatch is returned and you can retrieve details of the results using methods such as RegExMatch.get_string() and RegExMatch.get_start().
var regex = RegEx.create_from_string("\\w-(\\d+)")
var result = regex.search("abc n-0123")
if result:
print(result.get_string()) # Prints "n-0123"
The results of capturing groups () can be retrieved by passing the group number to the various methods in RegExMatch. Group 0 is the default and will always refer to the entire pattern. In the above example, calling result.get_string(1) would give you 0123.
This version of RegEx also supports named capturing groups, and the names can be used to retrieve the results. If two or more groups have the same name, the name would only refer to the first one with a match.
var regex = RegEx.create_from_string("d(?<digit>[0-9]+)|x(?<digit>[0-9a-f]+)")
var result = regex.search("the number is x2f")
if result:
print(result.get_string("digit")) # Prints "2f"
If you need to process multiple results, search_all() generates a list of all non-overlapping results. This can be combined with a for loop for convenience.
# Prints "01 03 0 3f 42"
for result in regex.search_all("d01, d03, d0c, x3f and x42"):
print(result.get_string("digit"))
Example: Split a string using a RegEx:
var regex = RegEx.create_from_string("\\S+") # Negated whitespace character class.
var results = []
for result in regex.search_all("One Two \n\tThree"):
results.push_back(result.get_string())
print(results) # Prints ["One", "Two", "Three"]
Note: Godot's regex implementation is based on the PCRE2 library. You can view the full pattern reference here.
Tip: You can use Regexr to test regular expressions online.
方法
void |
clear() |
create_from_string(pattern: String, show_error: bool = true) static |
|
get_group_count() const |
|
get_names() const |
|
get_pattern() const |
|
is_valid() const |
|
search(subject: String, offset: int = 0, end: int = -1) const |
|
search_all(subject: String, offset: int = 0, end: int = -1) const |
|
sub(subject: String, replacement: String, all: bool = false, offset: int = 0, end: int = -1) const |
方法说明
void clear() 🔗
这个方法重置了对象的状态，就像它是新创建的一样。也就是说，它取消了这个对象的正则表达式的赋值。
Error compile(pattern: String, show_error: bool = true) 🔗
编译并指定要使用的搜索模式。如果编译成功则返回 @GlobalScope.OK。如果遇到错误则返回 @GlobalScope.FAILED，show_error 为 true 时会将细节打印到标准输出。
RegEx create_from_string(pattern: String, show_error: bool = true) static 🔗
创建并编译新 RegEx 对象。另见 compile()。
返回编译的模式中捕获组的数量。
PackedStringArray get_names() const 🔗
返回一个数组，元素为编译的模式中具名捕获组的名称，按出现顺序排序。
返回被编译的原始搜索模式。
返回此对象是否分配了有效的搜索模式。
RegExMatch search(subject: String, offset: int = 0, end: int = -1) const 🔗
在文本中搜索编译后的模式。如果找到，则将首个匹配结果放在 RegExMatch 容器中返回，否则返回 null。
可以使用 offset 和 end 指定要搜索的区域。这对在上一次成功后再次调用该方法，以相同的 subject 搜索另一个匹配项时很有用。请注意，设置这些参数不同于传递缩短后的字符串。例如，起始锚点 ^ 不受 offset 的影响，会为单词边界 \b 检查 offset 之前的字符。
Array[RegExMatch] search_all(subject: String, offset: int = 0, end: int = -1) const 🔗
在文本中搜索编译后的模式。返回 RegExMatch 容器的数组，其中每个容器包含的是互不重叠的匹配结果。如果没有找到结果，则返回一个空数组。
可以使用 offset 和 end 指定要搜索的区域。这对在上一次成功后再次调用该方法，以相同的 subject 搜索另一个匹配项时很有用。请注意，设置这些参数不同于传递缩短后的字符串。例如，起始锚点 ^ 不受 offset 的影响，会为单词边界 \b 检查 offset 之前的字符。
String sub(subject: String, replacement: String, all: bool = false, offset: int = 0, end: int = -1) const 🔗
在文本中搜索编译后的模式，并将其替换为指定的字符串。诸如 $1 和 $name 等转义和反向引用会被扩展和解析。默认情况下，只有第一个实例被替换，但可以修改为针对所有实例（全局替换）。
可以使用 offset 和 end 指定要搜索的区域。这对在上一次成功后再次调用该方法，以相同的 subject 搜索另一个匹配项时很有用。请注意，设置这些参数不同于传递缩短后的字符串。例如，起始锚点 ^ 不受 offset 的影响，会为单词边界 \b 检查 offset 之前的字符。