string.format (cadenaformato, ---)

Devuelve una versión formateada de su número variable de argumentos siguiendo la descripción dada en su primer argumento (que debe ser una cadena).

La cadena de formato sigue las mismas reglas que la familia ' printf de funciones C estándar. Las únicas diferencias son que las opciones/modificadores ' *, ' l, ' L, ' n, ' p, y ' h no son compatibles y que hay una opción extra, ' q. La opción ' q ' formatea una cadena en una forma adecuada para ser leída con seguridad por el intérprete de Lua: la cadena se escribe entre comillas dobles, y todas las comillas dobles, nuevas líneas, ceros incrustados y barras invertidas en la cadena se escapan correctamente cuando se escriben. Por ejemplo, la llamada

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

producirá la cadena:

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

Las opciones ' c' , ' d, ' E, ' e, ' f, ' g, ' G, ' i, ' o, ' u, ' X, y ' x esperan un número como argumento, mientras que ' q y ' s esperan una cadena.

Esta función no acepta valores de cadena que contengan ceros incrustados, excepto como argumentos de la opción ' q.