View source for WordWrap

__NOTOC__
{{Useful Function}}
{{Needs_Example}}
This function splits a long string into a table of lines no longer than ''maxwidth''.
{{Note|A line without any spaces in it will not break, meaning it may exceed ''maxwidth''.}}
{{Tip|This function may lag if used too often. Consider only calling this function when any of the arguments change (such as the text, maxwidth, it's scale or font, etc.) and caching the result, rather than calling it [[onClientRender]] or similarly frequent events.}}

==Syntax==
<syntaxhighlight lang="lua">
table wordWrap( string text, float maxwidth, [float scale=1, mixed font="default", bool bColorCoded=false] )
</syntaxhighlight>

===Required Arguments===
* '''text:''' The string to break into lines.
* '''maxwidth:''' The number of pixels of allowed length per line.

===Optional Arguments===
{{OptionalArg}}
* '''scale:''' The size of the text, as in [[dxGetTextWidth]]. Defaults to 1.
* '''font:''' Either a custom DX font element or the name of a built-in dx font, as in [[dxGetTextWidth]]. Defaults to "default".
* '''bColorCoded:''' Should color codes be excluded from the width? (false will include #rrggbb in the length calculations). Defaults to false.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
function wordWrap(text, maxwidth, scale, font, colorcoded)
    local lines = {}
    local words = split(text, " ") -- this unfortunately will collapse 2+ spaces in a row into a single space
    local line = 1 -- begin with 1st line
    local word = 1 -- begin on 1st word
    local endlinecolor
    while (words[word]) do -- while there are still words to read
        repeat
            if colorcoded and (not lines[line]) and endlinecolor and (not string.find(words[word], "^#%x%x%x%x%x%x")) then -- if on a new line, and endline color is set and the upcoming word isn't beginning with a colorcode
                lines[line] = endlinecolor -- define this line as beginning with the color code
            end
            lines[line] = lines[line] or "" -- define the line if it doesnt exist

            if colorcoded then
                local rw = string.reverse(words[word]) -- reverse the string
                local x, y = string.find(rw, "%x%x%x%x%x%x#") -- and search for the first (last) occurance of a color code
                if x and y then
                    endlinecolor = string.reverse(string.sub(rw, x, y)) -- stores it for the beginning of the next line
                end
            end
      
            lines[line] = lines[line]..words[word] -- append a new word to the this line
            lines[line] = lines[line] .. " " -- append space to the line

            word = word + 1 -- moves onto the next word (in preparation for checking whether to start a new line (that is, if next word won't fit)
        until ((not words[word]) or dxGetTextWidth(lines[line].." "..words[word], scale, font, colorcoded) > maxwidth) -- jumps back to 'repeat' as soon as the code is out of words, or with a new word, it would overflow the maxwidth
    
        lines[line] = string.sub(lines[line], 1, -2) -- removes the final space from this line
        if colorcoded then
            lines[line] = string.gsub(lines[line], "#%x%x%x%x%x%x$", "") -- removes trailing colorcodes
        end
        line = line + 1 -- moves onto the next line
    end -- jumps back to 'while' the a next word exists
    return lines
end
</syntaxhighlight>
Author: Addlibs (aka MrTasty)
</section>

==Example==
<syntaxhighlight lang="lua">
--define text do wrap
text = "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."
formatedtext = wordWrap(text, 300, 1, "default", false) --wrap text

addEventHandler("onClientRender", getRootElement(), function()
    dxDrawRectangle(5, 5, 300, 200, tocolor(0, 0, 0, 100)) --draw background
    for i = 1, #formatedtext do
        dxDrawText(formatedtext[i], 5, 5+((i-1)*dxGetFontHeight()), 5, 5+((i-1)*dxGetFontHeight()), tocolor(255, 255, 255, 255), 1, "default") --draw text
    end
end)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}