string.gsub · nanos world API Reference

Syntax

Lua

string.gsub(string, pattern, replacement, maxReplaces)

Parameters

Name	Type	Default	Description
`string`	string	—	String which should be modified.
`pattern`	string	—	The pattern that defines what should be matched and eventually be replaced.
`replacement`	string	—	In case of a string the matched sequence will be replaced with it. In case of a table, the matched sequence will be used as key and the table will tested for the key, if a value exists it will be used as replacement. In case of a function all matches will be passed as parameters to the function, the return value(s) of the function will then be used as replacement.
`maxReplaces`	number	—	Maximum number of replacements to be made.

Returns

string
number

string

This library provides generic functions for string manipulation, such as finding and extracting substrings, and pattern matching. When indexing a string in Lua, the first character is at position 1 (not at 0, as in C). Indices are allowed to be negative and are interpreted as indexing backwards, from the end of the string. Thus, the last character is at position -1, and so on.

See on string