Functions.text.wrap

Aufruf als

Functions.text.wrap(str, limit)

Erfassen Sie sie als Abhängigkeit mit dem Namen Functions.text.wrap (das Übernehmen der Vervollständigung erledigt das) und rufen Sie sie dann unter diesem Namen auf.

Wird auch unter dem früheren Namensraum utils akzeptiert.

Was sie bewirkt

Text an Leerraumgrenzen nahe einer Ziel-Spaltenzahl umbrechen. Lange Wörter bleiben unversehrt.

Argumente

Name	Typ	Was sie bewirkt
`str`	`string`	Umzubrechender Text.
`limit`	`number \| nil`	Ziel-Zeilenbreite, standardmäßig 72 Zeichen.

Rückgabewerte

1	`string`	Text mit an Wortgrenzen eingefügten Zeilenumbrüchen.

Editionen

Integrierte Hilfsfunktionen werden auf jeder Edition registriert. Unterschiedlich ist die Spiel-API, die sie lesen; fehlt eine, weicht die Hilfsfunktion aus oder gibt nil mit einem Grund zurück.

Sie liest keine Spiel-API direkt.

Beispiel

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

Quelle

Functions/text.lua, Zeile 37. Im Spiel schreibgeschützt; Duplizieren erstellt eine bearbeitbare Kopie.

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)

Zurück zu Funktionsreferenz