Return value#

Type Meaning
function Types describe the declared interface, not proof of a successful game effect.

Types and methods

Parameters#

Name Type
text string
pattern string

? marks an optional argument; ... means a variable number of arguments. Invalid input can raise a Lua error rather than return nil.

Example and context#

LUA
for word in string.gmatch("ship station", "%a+") do
  local upper = string.upper(word)
end

What happens: The iterator yields "ship" and "station"; upper becomes "SHIP" and "STATION".

This fragment does not print or write a log message. The values shown are the expected results of the example.

See language basics, types and methods and Lua / MD events. Examples there are independent learning examples. No project source files or private implementation fragments are distributed with this reference.