Class RegExMatch

Contains the results of a RegEx search.

Inheritance

RefCounted

Object

RegExMatch

Remarks

Contains the results of a single RegEx match returned by RegEx.search and RegEx.search_all. It can be used to find the position and range of the match and its capturing groups, and it can extract its substring for you.

Properties

names

A dictionary of named groups and its corresponding group number. Only groups that were matched are included. If multiple groups have the same name, that name would refer to the first matching one.

var names : Dictionary = {}

Property Value

Dictionary

Remarks

• Dictionary get_names

strings

An Array of the match and its capturing groups.

var strings : PackedStringArray = PackedStringArray()

Property Value

PackedStringArray

Remarks

• PackedStringArray get_strings

subject

The source string used with the search pattern to find this matching result.

var subject : String = ""

Property Value

String

Remarks

• String get_subject

Methods

get_end(Variant)

Qualifiers: const

Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.

Returns -1 if the group did not match or doesn't exist.

int get_end(Variant name)

Parameters

name Variant

get_group_count

Qualifiers: const

Returns the number of capturing groups.

int get_group_count

get_start(Variant)

Qualifiers: const

Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.

Returns -1 if the group did not match or doesn't exist.

int get_start(Variant name)

Parameters

name Variant

get_string(Variant)

Qualifiers: const

Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern.

Returns an empty string if the group did not match or doesn't exist.

String get_string(Variant name)

Parameters

name Variant