Return value#

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

Types and methods

Parameters#

Name Type
format string
values... any

? 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 text = string.format("%s: %d", "Ships", 3)

What happens: text = "Ships: 3".

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.