WordWrap - Revision history

FeaturedPro: Removed "needs example"

2020-05-31T16:32:11Z

Removed "needs example"

← Older revision		Revision as of 16:32, 31 May 2020
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Useful Function}}		{{Useful Function}}
	~~{{Needs_Example}}~~
	This function splits a long string into a table of lines no longer than ''maxwidth''.		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''.}}		{{Note\|A line without any spaces in it will not break, meaning it may exceed ''maxwidth''.}}

Xyrusek: add example

2020-02-12T21:41:00Z

add example

← Older revision		Revision as of 21:41, 12 February 2020
Line 64:		Line 64:

	==Example==		==Example==
			<section name="Client" class="client" show="true">
			Word wrap text in black box
	<syntaxhighlight lang="lua">		<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."		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		formatedtext = wordWrap(text, 300, 1, "default", false) --wrap text
Line 76:		Line 77:
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Useful_Functions}}		{{Useful_Functions}}

Xyrusek: /* Example */

2020-02-09T16:33:40Z

Example

← Older revision		Revision as of 16:33, 9 February 2020
Line 67:		Line 67:
	--define text do wrap		--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."		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."
	~~--wrap text~~		formatedtext = wordWrap(text, 300, 1, "default", false) --wrap text
	formatedtext = wordWrap(text, 300, 1, "default", false)

	addEventHandler("onClientRender", getRootElement(), function()		addEventHandler("onClientRender", getRootElement(), function()

Xyrusek: /* Example */

2020-02-09T16:24:05Z

Example

← Older revision		Revision as of 16:24, 9 February 2020
Line 65:		Line 65:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<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."		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."
			--wrap text
	formatedtext = wordWrap(text, 300, 1, "default", false)		formatedtext = wordWrap(text, 300, 1, "default", false)

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

Xyrusek: /* Example */

2020-02-09T16:18:21Z

Example

← Older revision		Revision as of 16:18, 9 February 2020
Line 65:		Line 65:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- ~~todo~~		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)

			addEventHandler("onClientRender", getRootElement(), function()
			dxDrawRectangle(5, 5, 300, 200, tocolor(0, 0, 0, 100))
			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")
			end
			end)
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Useful_Functions}}		{{Useful_Functions}}

MrTasty at 07:45, 22 October 2018

2018-10-22T07:45:10Z

← Older revision		Revision as of 07:45, 22 October 2018
Line 3:		Line 3:
	{{Needs_Example}}		{{Needs_Example}}
	This function splits a long string into a table of lines no longer than ''maxwidth''.		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 ~~exceepd~~ ''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.}}		{{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.}}

MrTasty: Updated code to append colorcodes on every new line, preserving the color from the previous line (that is, if there are colorcodes present in the text)

2018-10-22T07:41:38Z

Updated code to append colorcodes on every new line, preserving the color from the previous line (that is, if there are colorcodes present in the text)

← Older revision		Revision as of 07:41, 22 October 2018
Line 29:		Line 29:
	local line = 1 -- begin with 1st line		local line = 1 -- begin with 1st line
	local word = 1 -- begin on 1st word		local word = 1 -- begin on 1st word
			local endlinecolor
	while (words[word]) do -- while there are still words to read		while (words[word]) do -- while there are still words to read
	repeat		repeat
	lines[line] = lines[line] ~~and (~~lines[line].." ") ~~or ""~~ -- ~~appends space~~ if ~~line already exists~~, ~~or defines~~ it ~~to an empty string~~		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]..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)		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		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		line = line + 1 -- moves onto the next line
	end -- jumps back to 'while' the a next word exists		end -- jumps back to 'while' the a next word exists

MrTasty: /* Optional Arguments */

2018-10-20T10:53:39Z

Optional Arguments

← Older revision		Revision as of 10:53, 20 October 2018
Line 19:		Line 19:
	* '''scale:''' The size of the text, as in [[dxGetTextWidth]]. Defaults to 1.		* '''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".		* '''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.		* '''bColorCoded:''' Should color codes be excluded from the width? (false will include #rrggbb in the length calculations). Defaults to false.

	==Code==		==Code==

MrTasty: Created page with "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 wi..."

2018-10-20T10:49:22Z

Created page with "__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 wi..."

New page

__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 exceepd ''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
while (words[word]) do -- while there are still words to read
repeat
lines[line] = lines[line] and (lines[line].." ") or "" -- appends space if line already exists, or defines it to an empty string
lines[line] = lines[line]..words[word] -- append a new word to the this 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

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">
-- todo
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

WordWrap - Revision history

FeaturedPro: Removed "needs example"

Xyrusek: add example

Xyrusek: /* Example */

Xyrusek: /* Example */

Xyrusek: /* Example */

MrTasty at 07:45, 22 October 2018

MrTasty: Updated code to append colorcodes on every new line, preserving the color from the previous line (that is, if there are colorcodes present in the text)

MrTasty: /* Optional Arguments */

MrTasty: Created page with "__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 wi..."

MrTasty: Created page with "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 wi..."