Up to date

This page is up to date for Godot 4.1. 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

Methods

Property Descriptions

Dictionary names = {}

• Dictionary get_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()

• PackedStringArray get_strings ( )

An Array of the match and its capturing groups.

String subject = ""

• String get_subject ( )

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

Method Descriptions

int get_end ( Variant name=0 ) 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_group_count ( ) const

Returns the number of capturing groups.

int get_start ( Variant name=0 ) 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.

String get_string ( Variant name=0 ) 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.