DxDrawShadedText - Revision history

Kezoto at 17:43, 12 August 2022

2022-08-12T17:43:36Z

← Older revision		Revision as of 17:43, 12 August 2022
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">table dxDrawShadedText( string text, float leftX, float topY, float rightX, float bottomY, int color, int shadowColor, float offsetX, ~~number~~ float)</syntaxhighlight>		<syntaxhighlight lang="lua">table dxDrawShadedText( string text, float leftX, float topY, float rightX, float bottomY, int color, int shadowColor, float offsetX, float offsetY, 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, float fLineSpacing = 0.0] )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

Kezoto at 17:42, 12 August 2022

2022-08-12T17:42:44Z

← Older revision		Revision as of 17:42, 12 August 2022
Line 10:		Line 10:

	===Required Arguments===		===Required Arguments===
	* '''text''': the string with your text.
	*'''text:''' the text to draw		*'''text:''' the text to draw
	*'''leftX:''' the absolute X coordinate of the top left corner of the text		*'''leftX:''' the absolute X coordinate of the top left corner of the text

Kezoto at 17:41, 12 August 2022

2022-08-12T17:41:44Z

← Older revision		Revision as of 17:41, 12 August 2022
Line 49:		Line 49:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function dxDrawShadedText(text, leftX, topY, rightX, bottomY, color, shadowColor, offsetX, offsetY, ...)		function dxDrawShadedText(text, leftX, topY, rightX, bottomY, color, shadowColor, offsetX, offsetY, ...)
	~~leftX = leftX or 0~~
	rightX = rightX or 0		rightX = rightX or 0
			bottomY = bottomY or 0
	shadowColor = shadowColor or -16777216		shadowColor = shadowColor or -16777216
	dxDrawText(text, leftX + offsetX, topY + offsetY, rightX + offsetX, rightX + offsetY, shadowColor, ...)		dxDrawText(text, leftX + offsetX, topY + offsetY, rightX + offsetX, rightX + offsetY, shadowColor, ...)

Kezoto at 17:40, 12 August 2022

2022-08-12T17:40:32Z

← Older revision		Revision as of 17:40, 12 August 2022
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">table dxDrawShadedText( string text, float leftX, float topY, float rightX, float bottomY, ~~color~~ color, ~~color~~ shadowColor, float offsetX, number float)</syntaxhighlight>		<syntaxhighlight lang="lua">table dxDrawShadedText( string text, float leftX, float topY, float rightX, float bottomY, int color, int shadowColor, float offsetX, number float)</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

Kezoto at 17:40, 12 August 2022

2022-08-12T17:40:10Z

← Older revision		Revision as of 17:40, 12 August 2022
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">table dxDrawShadedText( string text, ~~number~~ leftX, ~~number~~ topY, ~~number~~ rightX, ~~number~~ bottomY, color color, color shadowColor, ~~number~~ offsetX, number ~~offsetY~~)</syntaxhighlight>		<syntaxhighlight lang="lua">table dxDrawShadedText( string text, float leftX, float topY, float rightX, float bottomY, color color, color shadowColor, float offsetX, number float)</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

Kezoto: Created page with "{{Useful Function}} NOTOC This function creates shadow effect for the dxText.
'''Important : WORKS ONLY FOR DX TEXT!'''
==Syntax== table dxDrawShadedText( string text, number leftX, number topY, number rightX, number bottomY, color color, color shadowColor, number offsetX, number offsetY) ===Required Arguments=== * '''text''': the string with your text. '''text:''' the text to draw '''leftX:''' the absolute..."

2022-08-12T17:39:31Z

Created page with "{{Useful Function}} __NOTOC__ This function creates shadow effect for the dxText. <br> '''Important : WORKS ONLY FOR DX TEXT!''' <br> ==Syntax== <syntaxhighlight lang="lua">table dxDrawShadedText( string text, number leftX, number topY, number rightX, number bottomY, color color, color shadowColor, number offsetX, number offsetY)</syntaxhighlight> ===Required Arguments=== * '''text''': the string with your text. *'''text:''' the text to draw *'''leftX:''' the absolute..."

New page

{{Useful Function}}
__NOTOC__
This function creates shadow effect for the dxText.
<br>
'''Important : WORKS ONLY FOR DX TEXT!'''
<br>

==Syntax==
<syntaxhighlight lang="lua">table dxDrawShadedText( string text, number leftX, number topY, number rightX, number bottomY, color color, color shadowColor, number offsetX, number offsetY)</syntaxhighlight>

===Required Arguments===
* '''text''': the string with your text.
*'''text:''' the text to draw
*'''leftX:''' the absolute X coordinate of the top left corner of the text
*'''topY:''' the absolute Y coordinate of the top left corner of the text
* '''color''': the color of your text.
* '''offsetX''': the number that offsets your text along the X axis.
* '''offsetY''': the number that offsets your text along the Y axis.
===Optional Arguments===
* '''shadowColor''': the color of the text shadow.
*'''rightX:''' the absolute X coordinate of the right side of the text bounding box. Used for text aligning, clipping and word breaking.
*'''bottomY:''' 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).
{{New feature/item|3.0130|1.3.0|3986|
*'''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.
}}
{{New feature/item|3.0135|1.3.5|6054|
*'''fRotation:''' Rotation'''
*'''fRotationCenterX:''' Rotation Origin X'''
*'''fRotationCenterY:''' Rotation Origin Y'''
}}
{{Added feature/item|1.5.9|1.5.8|20957|
*'''fLineSpacing:''' Distance in pixels between the lines of text, this can be a negative number, works only when '''colorCoded''' is set to true''
}}

===Author===
Kezoto

==Code==
<syntaxhighlight lang="lua">
function dxDrawShadedText(text, leftX, topY, rightX, bottomY, color, shadowColor, offsetX, offsetY, ...)
leftX = leftX or 0
rightX = rightX or 0
shadowColor = shadowColor or -16777216
dxDrawText(text, leftX + offsetX, topY + offsetY, rightX + offsetX, rightX + offsetY, shadowColor, ...)
dxDrawText(text, leftX, topY, rightX, rightX, color, ...)
end
</syntaxhighlight>

==Example==
The code below will create shadow for the text.
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", root, function()
dxDrawShadedText("Hello World!", 0, 0, nil, nil, tocolor(255, 255, 255), nil, 1, 1)
end)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}