Renkon: /* Optional Arguments */

2017-12-27T00:45:00Z

Optional Arguments

← Older revision		Revision as of 00:45, 27 December 2017
Line 18:		Line 18:
	*'''lengthSpace:''' An integer representing the length of the empty space between the dashes.		*'''lengthSpace:''' An integer representing the length of the empty space between the dashes.
	*'''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).		*'''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
			*'''width:''' The width/thickness of the line
			*'''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

	===Returns===		===Returns===

Renkon: /* Example */

2017-12-27T00:38:46Z

Example

← Older revision		Revision as of 00:38, 27 December 2017
Line 59:		Line 59:
	addEventHandler("onClientRender", root, function()		addEventHandler("onClientRender", root, function()
	dxDrawDashedLine(100, 100, sW - 100, sH - 100, 10, 5, tocolor(255, 255, 255, 255), 2, false);		dxDrawDashedLine(100, 100, sW - 100, sH - 100, 10, 5, tocolor(255, 255, 255, 255), 2, false);
	dxDrawDashedLine(100, sW - 100, sH - 100, 100, 10, 5, tocolor(255, 255, 255, 255), 2, false);		dxDrawDashedLine(100, sH - 100, sW - 100, 100, 10, 5, tocolor(255, 255, 255, 255), 2, false);
	end )		end )
	</syntaxhighlight>		</syntaxhighlight>

Renkon: Created page with "NOTOC {{Useful Function}} This function lets you draw a line with dashes or dots. ==Syntax== dxDrawDashedLine ( int startX, int startY, int..."

2017-12-27T00:36:39Z

Created page with "__NOTOC__ {{Useful Function}} This function lets you draw a line with dashes or dots. ==Syntax== <syntaxhighlight lang="lua"> dxDrawDashedLine ( int startX, int startY, int..."

New page

__NOTOC__
{{Useful Function}}
This function lets you draw a line with dashes or dots.

==Syntax==
<syntaxhighlight lang="lua">
dxDrawDashedLine ( int startX, int startY, int endX, int endY, int lengthLine, [ int lengthSpace = lengthLine, int color = 0xFFFFFFFF, int width = 1, bool postGUI = false ] )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' An integer representing the absolute start X position of the line, represented by pixels on the screen.
*'''startY:''' An integer representing the absolute start Y position of the line, represented by pixels on the screen.
*'''endX:''' An integer representing the absolute end X position of the line, represented by pixels on the screen.
*'''endY:''' An integer representing the absolute end Y position of the line, represented by pixels on the screen.
*'''lengthLine:''' An integer representing the length of each dash.

===Optional Arguments===
*'''lengthSpace:''' An integer representing the length of the empty space between the dashes.
*'''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).

===Returns===
This function does not return anything.

==Code==
<section name="Client-Side Script" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawDashedLine(sX, sY, eX, eY, lengthLine, lengthSpace, color, width, postGUI)
lengthSpace = lengthSpace or lengthLine;
color = color or tocolor(255, 255, 255, 255);
width = width or 1;
postGUI = postGUI or false;
local length = getDistanceBetweenPoints2D(sX, sY, eX, eY);
local linePartLength = lengthLine + lengthSpace;
local lineParts = length / linePartLength;
local xToAdd = (eX - sX) / lineParts;
local yToAdd = (eY - sY) / lineParts;
local lineRatio = lengthSpace / lengthLine;
while (length > 0) do
if (lengthLine > length) then
dxDrawLine(sX, sY, eX, eY, color, width, postGUI);
length = 0;
else
dxDrawLine(sX, sY, sX + xToAdd - xToAdd * lineRatio, sY + yToAdd - yToAdd * lineRatio, color, width, postGUI);
sX = sX + xToAdd;
sY = sY + yToAdd;
length = length - linePartLength;
end
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Client-Side Example" class="client" show="true">
This example shows how to draw an X on the screen.
<syntaxhighlight lang="lua">
local sW, sH = guiGetScreenSize()

addEventHandler("onClientRender", root, function()
dxDrawDashedLine(100, 100, sW - 100, sH - 100, 10, 5, tocolor(255, 255, 255, 255), 2, false);
dxDrawDashedLine(100, sW - 100, sH - 100, 100, 10, 5, tocolor(255, 255, 255, 255), 2, false);
end )
</syntaxhighlight>
</section>

'''Author: Renkon'''

==See Also==
{{Useful_Functions}}
[[:Category:Useful_Functions]]

DxDrawDashedLine - Revision history

Renkon: /* Optional Arguments */

Renkon: /* Example */

Renkon: Created page with "__NOTOC__ {{Useful Function}} This function lets you draw a line with dashes or dots. ==Syntax== dxDrawDashedLine ( int startX, int startY, int..."

Renkon: Created page with "NOTOC {{Useful Function}} This function lets you draw a line with dashes or dots. ==Syntax== dxDrawDashedLine ( int startX, int startY, int..."