Return value#

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

Types and methods

Parameters#

Name Type
func function
index number

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

Example and context#

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.