This page is incomplete! Help wanted!

Please finish this page using the corresponding Old Wiki article.
Go to Contribution guidelines for more information.

---

Returns a copy of the original input string with replaced matches from the pattern by the replacement value.

Caution

This function may modify your input string even if no changes were made. Try it with runcode: srun utf8.gsub(utf8.char(66376), "", "") == utf8.char(66376)

Syntax

 utf8.gsub ( )

Code Examples

Example 1 Example 2 Example 3

server

This example shows how to remove color codes from a string and how to uppercase each single character in a string.

local text= "#ff0000This text is red"
local colorless = utf8.gsub( text, "#%x%x%x%x%x%x", "" )
print( colorless ) -- This text is red

print( utf8.gsub( "Nice wiki!", ".", utf8.upper ) ) -- NICE WIKI!

server

This example uses a table to replace specific words in the input string by an other value.

local input = "We have nice weather in London"

local replacements = {
    ["weather"] = "food",
    ["London"] = "Germany"
}

local output = utf8.gsub( input, "%w+", replacements )
print( output ) -- We have nice food in Germany

server

This example shows a simple bad word filter, which censors the word 'ugly' in the input string.

local input = "You are ugly!"

local badwords = {
    ["ugly"] = true
}

local output = utf8.gsub( input, "%w+",
    function (match)
        local lowerCase = utf8.lower( match )

        if badwords[ lowerCase ] then
            return string.rep( '*', utf8.len( match ) )
        end

        return match
    end
)

outputConsole( output ) -- You are ****!

See Also

Reference

• Scripting Functions