Functions.text.wrap

Appel

Functions.text.wrap(str, limit)

Enregistrez-la comme dépendance nommée Functions.text.wrap (accepter la complétion le fait pour vous), puis appelez-la sous ce nom.

Également acceptée sous l'ancien espace de noms utils.

Ce qu'elle fait

Ajoute des retours à la ligne aux espaces les plus proches d'un nombre de colonnes cible. Les mots longs restent intacts.

Arguments

Nom	Type	Ce qu'elle fait
`str`	`string`	Texte à mettre en forme avec retours à la ligne.
`limit`	`number \| nil`	Largeur de ligne cible, 72 caractères par défaut.

Retours

1	`string`	Texte avec des retours à la ligne insérés aux limites des mots.

Éditions

Les fonctions utilitaires intégrées sont enregistrées sur toutes les éditions. Ce qui diffère, c'est l'API du jeu qu'elles lisent ; quand l'une manque, la fonction utilitaire se rabat sur une alternative ou renvoie nil avec une raison.

Elle ne lit directement aucune API du jeu.

Exemple

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

Source

Functions/text.lua, ligne 37. En lecture seule dans le jeu ; Dupliquer crée une copie modifiable.

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)

Retour à Référence des fonctions