Lua API
On this page

Group

Inherits from

Tip

This is a builtin dotnet type. The documentation and api interface are generated from dotnet source files.

Represents the results from a single capturing group.

Fields:

Captures CaptureCollection

read only

Gets a collection of all the captures matched by the capturing group, in innermost-leftmost-first order (or innermost-rightmost-first order if the regular expression is modified with the RegexOptions.RightToLeft option). The collection may have zero or more items.

Index number

read only

The position in the original string where the first character of the captured substring is found.

Length number

read only

Gets the length of the captured substring.

Name string

read only

Returns the name of the capturing group represented by the current instance.

Success boolean

read only

Gets a value indicating whether the match is successful.

Value string

read only

Gets the captured substring from the input string.

Methods:

GetPropertyKeys() : string[]

Returns a list of strings of all public property / field names. Useful for reflection on UserData in lua scripts

Returns:string[]

Synchronized(inner: Group) : Group

static

Returns a Group object equivalent to the one supplied that is safe to share between multiple threads.

Parameters:
NameTypeDefaultSummary
innerGroup

The input Group object.

Returns:Group

ToString() : string

Retrieves the captured substring from the input string by calling the Capture.Value property.

Returns:string