Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

RegExMatch

Inherits: RefCounted < Object

Contains the results of a RegEx search.

Description

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

Dictionary

names

{}

PackedStringArray

strings

PackedStringArray()

String

subject

""

Methods

int

get_end ( Variant name=0 ) const

int

get_group_count ( ) const

int

get_start ( Variant name=0 ) const

String

get_string ( Variant name=0 ) const


Property Descriptions

Dictionary 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.


PackedStringArray strings = PackedStringArray()

An Array of the match and its capturing groups.