DxDrawLinedRectangle

2013-08-02T17:30:37Z

XXMADEXx:

{{Useful Function}}
__NOTOC__
This is a function that will create a rectangle outline with dx lines.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawLinedRectangle( float x, float y, float width, float height, int color [int width=1, bool postGUI=false ] )</syntaxhighlight>

===Required Arguments===
* '''x:''' An integer representing the absolute start X position of the line, represented by pixels on the screen.
* '''y:''' An integer representing the absolute start Y position of the line, represented by pixels on the screen.
* '''width:''' An float representing the width of the area, drawn in a right direction from the origin.
* '''height:''' An float representing the height of the rectangle, drawn in a downwards direction from the origin.
* '''color:''' the hex color of the rectangle, produced using tocolor or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).

==Optional Arguments==
{{OptionalArg}}
* '''width:''' An integer representing how thick the lines will be.
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI.

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawLinedRectangle( x, y, width, height, color, _width, postGUI )
local _width = _width or 1
local postGUI = postGUI or false
dxDrawLine ( x, y, x+width, y, color, _width, postGUI ) -- Top Arross
dxDrawLine ( x, y, x, y+height, color, _width, post ) -- Left Down
dxDrawLine ( x, y+height, x+width, y+height, color, _width, postGUI ) --Bottom Across
return dxDrawLine ( x+width, y, x+width, y+height, color, _width, postGUI ) -- Right Down
end</syntaxhighlight>
</section>

==Example==
This draws a white rectangle in the middle of the GTA world for no reason
<syntaxhighlight lang="lua">
local sx, sy = guiGetScreenSize ( )
addEventHandler("onClientRender", root,
function()
dxDrawLinedRectangle( 5, 5, sx/2, sy/2, tocolor ( 0, 255, 0, 255 ), 3, true )
end
)
</syntaxhighlight>

Author: xXMADEXx

==See Also==
{{Useful_Functions}}

DxDrawLinedRectangle

2013-08-02T09:23:57Z

XXMADEXx: Created page with "{{Useful Function}} __NOTOC__ This is a function that will create a rectangle outline with dx lines. ==Syntax== <syntaxhighlight lang="lua">bool dxDrawLinedRectangle( float x, float y, float w..."

{{Useful Function}}
__NOTOC__
This is a function that will create a rectangle outline with dx lines.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawLinedRectangle( float x, float y, float width, float height, int color [int width=1, bool postGUI=false ] )</syntaxhighlight>

===Required Arguments===
* '''x:''' An integer representing the absolute start X position of the line, represented by pixels on the screen.
* '''y:''' An integer representing the absolute start Y position of the line, represented by pixels on the screen.
* '''width:''' An float representing the width of the area, drawn in a right direction from the origin.
* '''height:''' An float representing the height of the rectangle, drawn in a downwards direction from the origin.
* '''color:''' the hex color of the rectangle, produced using tocolor or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).

==Optional Arguments==
{{OptionalArg}}
* '''width:''' An integer representing how thick the lines will be.
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI.

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawLinedFrame ( x, y, width, height, color, _width, postGUI )
local _width = _width or 1
local postGUI = postGUI or false
dxDrawLine ( x, y, x+width, y, color, _width, postGUI ) -- Top Arross
dxDrawLine ( x, y, x, y+height, color, _width, post ) -- Left Down
dxDrawLine ( x, y+height, x+width, y+height, color, _width, postGUI ) --Bottom Across
return dxDrawLine ( x+width, y, x+width, y+height, color, _width, postGUI ) -- Right Down
end</syntaxhighlight>
</section>

==Example==
This draws a white rectangle in the middle of the GTA world for no reason
<syntaxhighlight lang="lua">
local sx, sy = guiGetScreenSize ( )
addEventHandler("onClientRender", root,
function()
dxDrawLinedFrame ( 5, 5, sx/2, sy/2, tocolor ( 0, 255, 0, 255 ), 3, true )
end
)
</syntaxhighlight>

Author: xXMADEXx

==See Also==
{{Useful_Functions}}

Multi Theft Auto: Wiki - User contributions [en]

DxDrawLinedRectangle

DxDrawLinedRectangle