Referencia › Referencia de funciones › Functions

Functions.text.wrap

pública

Llamar como

Functions.text.wrap(str, limit)

Regístrala como dependencia con el nombre Functions.text.wrap (aceptar la sugerencia de autocompletado lo hace por ti) y luego llámala con ese nombre.

También se acepta con el antiguo espacio de nombres utils.

Qué hace

Ajusta el texto en los límites de espacios cerca de un número de columnas objetivo. Las palabras largas se mantienen intactas.

Argumentos

NombreTipoQué hace
strstringTexto que se ajustará.
limitnumber | nilAncho de línea objetivo, 72 caracteres por defecto.

Retornos

1stringTexto con saltos de línea insertados en los límites de palabra.

Ediciones

Las funciones auxiliares integradas se registran en todas las ediciones. Lo que cambia es la API del juego que leen; donde falta alguna, la función auxiliar recurre a una alternativa o devuelve nil con un motivo.

No lee directamente ninguna API del juego.

Ejemplo

local note = Functions.text.wrap("Use defensive cooldowns before the tank swap", 20)
local _, breaks = note:gsub("\n", "")
return breaks >= 1

Código fuente

Functions/text.lua, línea 37. Solo lectura en el juego; Duplicar crea una copia editable.

Functions.text.wrap(str, limit)
    limit = limit or 72
    local here = 1

    -- the "".. is there because :gsub returns multiple values
    return ""..str:gsub("(%s+)()(%S+)()",
            function(_, st, word, fi)
                if fi-here > limit then
                    here = st
                    return "\n"..word
                end
            end)

Volver a Referencia de funciones