string.match

From GMod Wiki

Jump to: navigation, search
Function
Syntax string.match( String string, String pattern, Integer startindex )
Where is this used?
Description:
If it finds a match in the pattern, it returns that. Otherwise, it will return Nil.
Returns: String [,String, String, ...]
Part of Library: String
Available On:
BBCode Link: [b][url=http://wiki.garrysmod.com/?title=String.match]String.match [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b]



Examples

DescriptionCheck's whether the string is a map or not.
Used on
Code
local str = "test.bsp";
 
if( string.match(str, "(%.bsp)$") )then
	print( "This is a map!" );
else
	print( "This is not a map." );
end
Output"This is a map!" is printed in the console.
DescriptionShows the use of multiple captures.
Used on
Code
local a = "one: two"
local one,two = string.match(a, "(%l*): (%l*)")
print("One: " .. one .. ", two: " .. two);
OutputOne: one, two: two

Additional Notes

  • This is like string.find, but it returns the matched string instead of an Integer.
  • Allows the usage of Regular Expressions.
  • If () captures are used, it will return each of the captures as a separate value

See Also

Retrieved from "http://wiki.garrysmod.com/?title=String.match"
Personal tools