string.PatternSafe

From Garry's Mod
Jump to: navigation, search
 string.PatternSafe( )

Contents

Description

Escapes all special characters within a string, making the string safe for inclusion in a Lua pattern.

Arguments

string str

The string to be sanitized

Returns

string

The string that has been sanitized for inclusion in Lua patterns

Examples

Example

Replaces all occurrences of "100%" in a string with "0%" and prints it.

We call string.PatternSafe here as '%' is a special character when used in Lua patterns.

local result = string.gsub( "You scored 100%!", 
							string.PatternSafe( "100%" ), 
							string.PatternSafe( "0%" ) )

print( result )

Output:

You scored 0%!
Personal tools
Navigation