string.format (formatstring, ···)

Gibt eine formatierte Version der zugehörigen variablen Anzahl von Argumenten zurück, die auf die Beschreibung folgen, die im ersten Argument angegeben wird (muss eine Zeichenfolge sein).

Die Formatierzeichenfolge folgt denselben Regeln wie die printf-Familie von C-Standardfunktionen. Die einzigen Unterschiede bestehen darin, dass die Optionen/Modifikatoren *, l, L, n, p und h nicht unterstützt werden und eine Zusatzoption q verfügbar ist. Die Option q formatiert eine Zeichenfolge in einem geeigneten Format, damit sie vom Lua-Interpreter sicher zurückgelesen werden kann: die Zeichenfolge wird zwischen Anführungszeichen geschrieben und alle Anführungszeichen, Zeilenumbrüche, eingebettete Leerzeichen und umgekehrte Schrägstriche in der Zeichenfolge werden beim Schreiben ordnungsgemäß mit Escapezeichen versehen. Beispiel: Der folgende Aufruf

string.format('%q', 'a string with "quotes" and \n new line')

erzeugt folgende Zeichenfolge

"a string with \"quotes\" and \
new line"

Die Optionen c, d, E, e, f, g, G, i, o, u, X und x erwarten alle eine Zahl als Argument, wohingegen q und s eine Zeichenfolge erwarten.

Diese Funktion akzeptiert keine Zeichenfolgewerte, die eingebettete Nullen enthalten, außer als Argumente für die Option q.