DxDrawBorderedText - Revision history

LordHenry: /* Code */ Allow scaleY parameter.

2023-06-16T20:23:00Z

Code: Allow scaleY parameter.

← Older revision		Revision as of 20:23, 16 June 2023
Line 54:		Line 54:
	This second version makes the outline width adapts to the font scale instead of using a fixed outline width. If you increase the font size, the outline width will also increase.		This second version makes the outline width adapts to the font scale instead of using a fixed outline width. If you increase the font size, the outline width will also increase.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function dxDrawBorderedText (outline, text, left, top, right, bottom, color, ~~scale~~, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		function dxDrawBorderedText (outline, text, left, top, right, bottom, color, scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
	local outline = (~~scale~~ or 1) * (1.333333333333334 * (outline or 1))		if type(scaleY) == "string" then
	dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - ~~outline~~, top - ~~outline~~, right - ~~outline~~, bottom - ~~outline~~, tocolor (0, 0, 0, 225), ~~scale~~, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		scaleY, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY = scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX
	dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + ~~outline~~, top - ~~outline~~, right + ~~outline~~, bottom - ~~outline~~, tocolor (0, 0, 0, 225), ~~scale~~, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		end
	dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - ~~outline~~, top + ~~outline~~, right - ~~outline~~, bottom + ~~outline~~, tocolor (0, 0, 0, 225), ~~scale~~, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		local outlineX = (scaleX or 1) * (1.333333333333334 * (outline or 1))
	dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + ~~outline~~, top + ~~outline~~, right + ~~outline~~, bottom + ~~outline~~, tocolor (0, 0, 0, 225), ~~scale~~, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		local outlineY = (scaleY or 1) * (1.333333333333334 * (outline or 1))
	dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - ~~outline~~, top, right - ~~outline~~, bottom, tocolor (0, 0, 0, 225), ~~scale~~, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - outlineX, top - outlineY, right - outlineX, bottom - outlineY, tocolor (0, 0, 0, 225), scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
	dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + ~~outline~~, top, right + ~~outline~~, bottom, tocolor (0, 0, 0, 225), ~~scale~~, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + outlineX, top - outlineY, right + outlineX, bottom - outlineY, tocolor (0, 0, 0, 225), scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
	dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left, top - ~~outline~~, right, bottom - ~~outline~~, tocolor (0, 0, 0, 225), ~~scale~~, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - outlineX, top + outlineY, right - outlineX, bottom + outlineY, tocolor (0, 0, 0, 225), scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
	dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left, top + ~~outline~~, right, bottom + ~~outline~~, tocolor (0, 0, 0, 225), ~~scale~~, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + outlineX, top + outlineY, right + outlineX, bottom + outlineY, tocolor (0, 0, 0, 225), scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
	dxDrawText (text, left, top, right, bottom, color, ~~scale~~, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - outlineX, top, right - outlineX, bottom, tocolor (0, 0, 0, 225), scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + outlineX, top, right + outlineX, bottom, tocolor (0, 0, 0, 225), scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left, top - outlineY, right, bottom - outlineY, tocolor (0, 0, 0, 225), scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left, top + outlineY, right, bottom + outlineY, tocolor (0, 0, 0, 225), scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text, left, top, right, bottom, color, scaleX, scaleY, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
	end		end
	</syntaxhighlight>		</syntaxhighlight>

LordHenry: /* Code */

2023-03-03T05:33:32Z

Code

← Older revision		Revision as of 05:33, 3 March 2023
Line 68:		Line 68:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
	'''Author:''' LordHenry		'''Author:''' [[User:LordHenry\|LordHenry]]

	==Example==		==Example==

LordHenry: /* Example */

2020-06-28T20:34:21Z

Example

← Older revision		Revision as of 20:34, 28 June 2020
Line 76:		Line 76:

	addEventHandler ("onClientRender", root, function()		addEventHandler ("onClientRender", root, function()
	dxDrawBorderedText (3, "mission completed!", 0, 0, screenX, screenY - (screenY * 0.1), tocolor (150, 100, 0, 255), 3, "pricedown", "center", "center", true, false)		dxDrawBorderedText (3, "mission completed!", 0, 0, screenX, screenY - (screenY * 0.1), tocolor (150, 100, 0, 255), 3, "pricedown", "center", "center", true, false)
	dxDrawBorderedText (3, "$1000000", 0, screenY * 0.1, screenX, screenY, tocolor (255, 255, 255, 255), 3, "pricedown", "center", "center", true, false)		dxDrawBorderedText (3, "$1000000", 0, screenY * 0.1, screenX, screenY, tocolor (255, 255, 255, 255), 3, "pricedown", "center", "center", true, false)
	end)		end)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

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

LordHenry at 20:43, 9 September 2019

2019-09-09T20:43:05Z

← Older revision		Revision as of 20:43, 9 September 2019
Line 38:		Line 38:

	==Code==		==Code==
			<section name="Version1" class="client" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function dxDrawBorderedText (outline, text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		function dxDrawBorderedText (outline, text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
Line 48:		Line 49:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
			</section>

			<section name="Version2" class="client" show="true">
	This second version makes the outline width adapts to the font scale instead of using a fixed outline width. If you increase the font size, the outline width will also increase.		This second version makes the outline width adapts to the font scale instead of using a fixed outline width. If you increase the font size, the outline width will also increase.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 64:		Line 67:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
			</section>
	'''Author:''' LordHenry		'''Author:''' LordHenry

	==Example==		==Example==
	This example draws a text with outline on the screen.		This example draws a text with outline on the screen.
	<section name="~~Clientside script~~" class="client" show="true">		<section name="Client" class="client" show="true">
	<syntaxhighlight lang="lua">local screenX, screenY = guiGetScreenSize()		<syntaxhighlight lang="lua">local screenX, screenY = guiGetScreenSize()

LordHenry: /* Code */

2019-08-02T19:56:42Z

Code

← Older revision		Revision as of 19:56, 2 August 2019
Line 40:		Line 40:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function dxDrawBorderedText (outline, text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		function dxDrawBorderedText (outline, text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
	for oX = (outline * -1), outline do		for oX = (outline * -1), outline do
	for oY = (outline * -1), outline do		for oY = (outline * -1), outline do
	dxDrawText (text, left + oX, top + oY, right + oX, bottom + oY, tocolor(0, 0, 0, 255), scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		dxDrawText (text, left + oX, top + oY, right + oX, bottom + oY, tocolor(0, 0, 0, 255), scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
	end		end
	end		end
	dxDrawText (text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)		dxDrawText (text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			end
			</syntaxhighlight>

			This second version makes the outline width adapts to the font scale instead of using a fixed outline width. If you increase the font size, the outline width will also increase.
			<syntaxhighlight lang="lua">
			function dxDrawBorderedText (outline, text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			local outline = (scale or 1) * (1.333333333333334 * (outline or 1))
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - outline, top - outline, right - outline, bottom - outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + outline, top - outline, right + outline, bottom - outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - outline, top + outline, right - outline, bottom + outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + outline, top + outline, right + outline, bottom + outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left - outline, top, right - outline, bottom, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left + outline, top, right + outline, bottom, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left, top - outline, right, bottom - outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text:gsub("#%x%x%x%x%x%x", ""), left, top + outline, right, bottom + outline, tocolor (0, 0, 0, 225), scale, font, alignX, alignY, clip, wordBreak, postGUI, false, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
			dxDrawText (text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
	end		end
	</syntaxhighlight>		</syntaxhighlight>

LordHenry: /* Code */

2019-07-28T18:13:53Z

Code

← Older revision		Revision as of 18:13, 28 July 2019
Line 48:		Line 48:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
	'''Author:''' ~~Lord Henry~~		'''Author:''' LordHenry

	==Example==		==Example==

Ma2med at 16:01, 21 December 2018

2018-12-21T16:01:18Z

← Older revision		Revision as of 16:01, 21 December 2018
Line 58:		Line 58:
	dxDrawBorderedText (3, "mission completed!", 0, 0, screenX, screenY - (screenY * 0.1), tocolor (150, 100, 0, 255), 3, "pricedown", "center", "center", true, false)		dxDrawBorderedText (3, "mission completed!", 0, 0, screenX, screenY - (screenY * 0.1), tocolor (150, 100, 0, 255), 3, "pricedown", "center", "center", true, false)
	dxDrawBorderedText (3, "$1000000", 0, screenY * 0.1, screenX, screenY, tocolor (255, 255, 255, 255), 3, "pricedown", "center", "center", true, false)		dxDrawBorderedText (3, "$1000000", 0, screenY * 0.1, screenX, screenY, tocolor (255, 255, 255, 255), 3, "pricedown", "center", "center", true, false)
	end		end)
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>
	==See Also==		==See Also==
	{{Useful_Functions}}		{{Useful_Functions}}

LordHenry: NOTOC

2018-11-15T21:48:39Z

__NOTOC__

← Older revision		Revision as of 21:48, 15 November 2018
Line 1:		Line 1:
	{{Useful Function}}		{{Useful Function}}
			<lowercasetitle></lowercasetitle>
	__NOTOC__		__NOTOC__
	This function renders a text with an outline. In order for the text to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]).		This function renders a text with an outline. In order for the text to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]).

LordHenry: Created page with "{{Useful Function}} NOTOC This function renders a text with an outline. In order for the text to stay visible continuously, you need to call this function with the same pa..."

2018-11-15T21:40:23Z

Created page with "{{Useful Function}} __NOTOC__ This function renders a text with an outline. In order for the text to stay visible continuously, you need to call this function with the same pa..."

New page

{{Useful Function}}
__NOTOC__
This function renders a text with an outline. In order for the text to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]).

== Syntax ==
<syntaxhighlight lang="lua">bool dxDrawBorderedText ( int outline, string text, float left, float top [, float right = left, float bottom = top, int color = white,
float scaleXY = 1.0 [, float scaleY = 1.0 ], mixed font = "default", string alignX = "left", string alignY = "top",
bool clip = false, bool wordBreak = false, bool postGUI = false, bool colorCoded = false, bool subPixelPositioning = false,
float fRotation = 0.0, float fRotationCenterX = 0.0, float fRotationCenterY = 0.0 ] )</syntaxhighlight>

===Required Arguments===
*'''outline:''' an integer representing the text outline weight.
*'''text:''' the text to draw.
*'''left:''' the absolute X coordinate of the top left corner of the text.
*'''top:''' the absolute Y coordinate of the top left corner of the text.

===Optional Arguments===
*'''right:''' the absolute X coordinate of the right side of the text bounding box. Used for text aligning, clipping and word breaking.
*'''bottom:''' the absolute Y coordinate of the bottom side of the text bounding box. Used for text aligning, clipping and word breaking.
*'''color:''' the color of the text, a value produced by [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
*'''scale:''' the size of the text.{{New feature|3.0110|1.1|'''scale:''' can (optionally) be specified as two floats. i.e. '''scaleX, scaleY'''}}
*'''font:''' Either a custom [[DX font]] element or the name of a built-in DX font: '''Note: Some fonts are incompatible with certain languages such as Arabic.'''
{{DxFonts}}
*'''alignX:''' horizontal alignment of the text within the bounding box. Can be '''"left"''', '''"center"''' or '''"right"'''.
*'''alignY:''' vertical alignment of the text within the bounding box. Can be '''"top"''', '''"center"''' or '''"bottom"'''.
*'''clip:''' if set to ''true'', the parts of the text that don't fit within the bounding box will be cut off.
*'''wordBreak:''' if set to ''true'', the text will wrap to a new line whenever it reaches the right side of the bounding box. If ''false'', the text will always be completely on one line.
* '''postGUI:''' A bool representing whether the text should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes. '''Note: clip and wordBreak are forced false if this is set.'''
*'''subPixelPositioning:''' A bool representing whether the text can be positioned sub-pixel-ly. Looks nicer for moving/scaling animations.
*'''fRotation:''' Rotation'''
*'''fRotationCenterX:''' Rotation Origin X'''
*'''fRotationCenterY:''' Rotation Origin Y'''

===Returns===
This function doesn't return values.

==Code==
<syntaxhighlight lang="lua">
function dxDrawBorderedText (outline, text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
for oX = (outline * -1), outline do
for oY = (outline * -1), outline do
dxDrawText (text, left + oX, top + oY, right + oX, bottom + oY, tocolor(0, 0, 0, 255), scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
end
end
dxDrawText (text, left, top, right, bottom, color, scale, font, alignX, alignY, clip, wordBreak, postGUI, colorCoded, subPixelPositioning, fRotation, fRotationCenterX, fRotationCenterY)
end
</syntaxhighlight>
'''Author:''' Lord Henry

==Example==
This example draws a text with outline on the screen.
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">local screenX, screenY = guiGetScreenSize()

addEventHandler ("onClientRender", root, function()
dxDrawBorderedText (3, "mission completed!", 0, 0, screenX, screenY - (screenY * 0.1), tocolor (150, 100, 0, 255), 3, "pricedown", "center", "center", true, false)
dxDrawBorderedText (3, "$1000000", 0, screenY * 0.1, screenX, screenY, tocolor (255, 255, 255, 255), 3, "pricedown", "center", "center", true, false)
end
</syntaxhighlight>
</section>
==See Also==
{{Useful_Functions}}

DxDrawBorderedText - Revision history

LordHenry: /* Code */ Allow scaleY parameter.

LordHenry: /* Code */

LordHenry: /* Example */

LordHenry at 20:43, 9 September 2019

LordHenry: /* Code */

LordHenry: /* Code */

Ma2med at 16:01, 21 December 2018

LordHenry: __NOTOC__

LordHenry: Created page with "{{Useful Function}} __NOTOC__ This function renders a text with an outline. In order for the text to stay visible continuously, you need to call this function with the same pa..."

LordHenry: NOTOC

LordHenry: Created page with "{{Useful Function}} NOTOC This function renders a text with an outline. In order for the text to stay visible continuously, you need to call this function with the same pa..."