Return value#

Type Meaning
(number, number, ...) | nil Types describe the declared interface, not proof of a successful game effect.

Types and methods

Parameters#

Name Type
text string
pattern string
start? number
plain? boolean

? 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
local first, last = string.find("ship_name", "name", 1, true)

What happens: first = 6, last = 9; Lua indices start at 1.

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.