DxDrawBorderedText

2018-12-21T16:01:18Z

Ma2med:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__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}}

Multi Theft Auto: Wiki - User contributions [en]

DxDrawBorderedText