Multi Theft Auto: Wiki - User contributions [en]

DxDrawCircle

2014-08-03T09:10:11Z

Michael89: added second example for new optional arguments

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a number of 2D lines in order to achieve a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( int posX, int posY [, int radius = 50, int, width = 5, int angleAmount = 1, int startAngle = 0, int stopAngle = 360, int color = white, bool postGUI = false ] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_example.png|thumb|An example of how dxDrawCircle function works in practice.]]
* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.

===Optional Arguments===
{{OptionalArg}}
* '''radius''': An integer representing the radius scale of the circle that is being drawn.
* '''width''': An integer representing the width of the line that is being drawn.
* '''angleAmount''': An integer representing the tightness of the circle. Lower amount makes it smoother, higher amount makes it more of a clock looking circle.
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''color''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

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

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawCircle( posX, posY, radius, width, angleAmount, startAngle, stopAngle, color, postGUI )
if ( type( posX ) ~= "number" ) or ( type( posY ) ~= "number" ) then
return false
end

radius = radius or 50
width = width or 5
angleAmount = angleAmount or 1
startAngle = startAngle or 0
stopAngle = stopAngle or 360
color = color or tocolor( 255, 255, 255, 200 )
postGUI = postGUI or false

for i = startAngle, stopAngle, angleAmount do
local startX = math.cos( math.rad( i ) ) * ( radius - width )
local startY = math.sin( math.rad( i ) ) * ( radius - width )
local endX = math.cos( math.rad( i ) ) * ( radius + width )
local endY = math.sin( math.rad( i ) ) * ( radius + width )

dxDrawLine( startX + posX, startY + posY, endX + posX, endY + posY, color, width, postGUI )
end

return true
end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example draws a complete circle shape in the middle of the screen after the resource is loaded for the client.
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", resourceRoot,
function( )
screenWidth, screenHeight = guiGetScreenSize( )
addEventHandler( "onClientRender", root,
function( )
dxDrawCircle( screenWidth / 2, screenHeight / 2 )
end
)
end
)
</syntaxhighlight>
</section>

<br />'''Author:''' Socialz<br /><br />

<section name="Client" class="client" show="true">
This example permanently draws the shape of a circle arc with an angle of 90°.
<syntaxhighlight lang="lua">
addEventHandler ( "onClientRender", root,
function ( )
-- We're starting to draw the circle at 0° which means that the first point of the arc is ( 200+50 | 200 )
-- Therefore the last point is ( 200 | 200+50 ). > Our arc is the "lower right" quarter of the circle.
dxDrawCircle ( 200, 200, 50, 5, 1, 0, 90 )
end )
</syntaxhighlight>
</section>

<br />'''Author:''' Michael89/Trevit

==See Also==
{{Useful_Functions}}

DxDrawCircle

2014-08-02T21:18:10Z

Michael89: /* Optional Arguments */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a 2D line in a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( int posX, int posY, [int radius = 50, int, width = 5, int angleAmount = 1, int startAngle = 0, int stopAngle = 360, int color = white, bool postGUI = false] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_example.png|thumb|An example of how dxDrawCircle function works in practice.]]
* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.

===Optional Arguments===
{{OptionalArg}}
* '''radius''': An integer representing the radius scale of the circle that is being drawn.
* '''width''': An integer representing the width of the line that is being drawn.
* '''angleAmount''': An integer representing the tightness of the circle. Lower amount makes it smoother, higher amount makes it more of a clock looking circle.
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''color''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

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

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawCircle ( posX, posY, radius, width, angleAmount, startAngle, stopAngle, color, postGUI )

local rtn = false
radius = radius or 50
width = width or 5
angleAmount = angleAmount or 1
startAngle = startAngle or 0
stopAngle = stopAngle or 360
color = color or tocolor(255, 255, 255, 200)
postGUI = postGUI or false

for i = startAngle, stopAngle, angleAmount do

local x1 = math.cos ( math.rad ( i ) ) * ( radius-width )
local x2 = math.cos ( math.rad ( i ) ) * ( radius+width )
local y1 = math.sin ( math.rad ( i ) ) * ( radius-width )
local y2 = math.sin ( math.rad ( i ) ) * ( radius+width )

rtn = dxDrawLine ( x1+posX, y1+posY, x2+posX, y2+posY, color, width, postGUI )

end

return rtn

end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example draws a circle shape in the middle of the screen on resource start.
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
sx, sy = guiGetScreenSize()
addEventHandler("onClientRender", root,
function()
dxDrawCircle(sx/2, sy/2)
end
)
end
)
</syntaxhighlight>
</section>

<br />'''Author:''' Socialz

==See Also==
{{Useful_Functions}}

DxDrawCircle

2014-08-02T21:15:36Z

Michael89: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a 2D line in a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( int posX, int posY, [int radius = 50, int, width = 5, int angleAmount = 1, int startAngle = 0, int stopAngle = 360, int color = white, bool postGUI = false] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_example.png|thumb|An example of how dxDrawCircle function works in practice.]]
* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.

===Optional Arguments===
{{OptionalArg}}
* '''radius''': An integer representing the radius scale of the circle that is being drawn.
* '''width''': An integer representing the width of the line that is being drawn.
* '''angleAmount''': An integer representing the tightness of the circle. Lower amount makes it smoother, higher amount makes it more of a clock looking circle.
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''color''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawCircle ( posX, posY, radius, width, angleAmount, startAngle, stopAngle, color, postGUI )

local rtn = false
radius = radius or 50
width = width or 5
angleAmount = angleAmount or 1
startAngle = startAngle or 0
stopAngle = stopAngle or 360
color = color or tocolor(255, 255, 255, 200)
postGUI = postGUI or false

for i = startAngle, stopAngle, angleAmount do

local x1 = math.cos ( math.rad ( i ) ) * ( radius-width )
local x2 = math.cos ( math.rad ( i ) ) * ( radius+width )
local y1 = math.sin ( math.rad ( i ) ) * ( radius-width )
local y2 = math.sin ( math.rad ( i ) ) * ( radius+width )

rtn = dxDrawLine ( x1+posX, y1+posY, x2+posX, y2+posY, color, width, postGUI )

end

return rtn

end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example draws a circle shape in the middle of the screen on resource start.
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
sx, sy = guiGetScreenSize()
addEventHandler("onClientRender", root,
function()
dxDrawCircle(sx/2, sy/2)
end
)
end
)
</syntaxhighlight>
</section>

<br />'''Author:''' Socialz

==See Also==
{{Useful_Functions}}

DxDrawCircle

2014-08-02T21:15:17Z

Michael89: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a 2D line in a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( int posX, int posY, [int radius = 50, int, width = 5, int angleAmount = 1, int startAngle = 0, int stopAngle = 360, int color = white, bool postGUI = false] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_example.png|thumb|An example of how dxDrawCircle function works in practice.]]
* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.

===Optional Arguments===
{{OptionalArg}}
* '''radius''': An integer representing the radius scale of the circle that is being drawn.
* '''width''': An integer representing the width of the line that is being drawn.
* '''angleAmount''': An integer representing the tightness of the circle. Lower amount makes it smoother, higher amount makes it more of a clock looking circle.
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''color''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawCircle ( posX, posY, radius, width, angleAmount, startAngle, stopAngle, color, postGUI )

local bool = false
radius = radius or 50
width = width or 5
angleAmount = angleAmount or 1
startAngle = startAngle or 0
stopAngle = stopAngle or 360
color = color or tocolor(255, 255, 255, 200)
postGUI = postGUI or false

for i = startAngle, stopAngle, angleAmount do

local x1 = math.cos ( math.rad ( i ) ) * ( radius-width )
local x2 = math.cos ( math.rad ( i ) ) * ( radius+width )
local y1 = math.sin ( math.rad ( i ) ) * ( radius-width )
local y2 = math.sin ( math.rad ( i ) ) * ( radius+width )

bool = dxDrawLine ( x1+posX, y1+posY, x2+posX, y2+posY, color, width, postGUI )

end

return bool

end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example draws a circle shape in the middle of the screen on resource start.
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
sx, sy = guiGetScreenSize()
addEventHandler("onClientRender", root,
function()
dxDrawCircle(sx/2, sy/2)
end
)
end
)
</syntaxhighlight>
</section>

<br />'''Author:''' Socialz

==See Also==
{{Useful_Functions}}

DxDrawCircle

2014-08-02T21:14:16Z

Michael89: /* Syntax */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a 2D line in a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( int posX, int posY, [int radius = 50, int, width = 5, int angleAmount = 1, int startAngle = 0, int stopAngle = 360, int color = white, bool postGUI = false] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_example.png|thumb|An example of how dxDrawCircle function works in practice.]]
* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.

===Optional Arguments===
{{OptionalArg}}
* '''radius''': An integer representing the radius scale of the circle that is being drawn.
* '''width''': An integer representing the width of the line that is being drawn.
* '''angleAmount''': An integer representing the tightness of the circle. Lower amount makes it smoother, higher amount makes it more of a clock looking circle.
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''color''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawCircle ( posX, posY, radius, width, angleAmount, startAngle, stopAngle, color, postGUI )

radius = radius or 50
width = width or 5
angleAmount = angleAmount or 1
startAngle = startAngle or 0
stopAngle = stopAngle or 360
color = color or tocolor(255, 255, 255, 200)
postGUI = postGUI or false

for i = startAngle, stopAngle, angleAmount do

local x1 = math.cos ( math.rad ( i ) ) * ( radius-width )
local x2 = math.cos ( math.rad ( i ) ) * ( radius+width )
local y1 = math.sin ( math.rad ( i ) ) * ( radius-width )
local y2 = math.sin ( math.rad ( i ) ) * ( radius+width )

dxDrawLine ( x1+posX, y1+posY, x2+posX, y2+posY, color, width, postGUI )

end

return true

end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example draws a circle shape in the middle of the screen on resource start.
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
sx, sy = guiGetScreenSize()
addEventHandler("onClientRender", root,
function()
dxDrawCircle(sx/2, sy/2)
end
)
end
)
</syntaxhighlight>
</section>

<br />'''Author:''' Socialz

==See Also==
{{Useful_Functions}}

DxDrawCircle

2014-08-02T21:13:47Z

Michael89: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a 2D line in a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( int posX, int posY [, int radius = 50, int, width = 5, int angleAmount = 1, int startAngle = 0, int stopAngle = 360, int color = white, bool postGUI = false ] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_example.png|thumb|An example of how dxDrawCircle function works in practice.]]
* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.

===Optional Arguments===
{{OptionalArg}}
* '''radius''': An integer representing the radius scale of the circle that is being drawn.
* '''width''': An integer representing the width of the line that is being drawn.
* '''angleAmount''': An integer representing the tightness of the circle. Lower amount makes it smoother, higher amount makes it more of a clock looking circle.
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''color''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawCircle ( posX, posY, radius, width, angleAmount, startAngle, stopAngle, color, postGUI )

radius = radius or 50
width = width or 5
angleAmount = angleAmount or 1
startAngle = startAngle or 0
stopAngle = stopAngle or 360
color = color or tocolor(255, 255, 255, 200)
postGUI = postGUI or false

for i = startAngle, stopAngle, angleAmount do

local x1 = math.cos ( math.rad ( i ) ) * ( radius-width )
local x2 = math.cos ( math.rad ( i ) ) * ( radius+width )
local y1 = math.sin ( math.rad ( i ) ) * ( radius-width )
local y2 = math.sin ( math.rad ( i ) ) * ( radius+width )

dxDrawLine ( x1+posX, y1+posY, x2+posX, y2+posY, color, width, postGUI )

end

return true

end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example draws a circle shape in the middle of the screen on resource start.
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
sx, sy = guiGetScreenSize()
addEventHandler("onClientRender", root,
function()
dxDrawCircle(sx/2, sy/2)
end
)
end
)
</syntaxhighlight>
</section>

<br />'''Author:''' Socialz

==See Also==
{{Useful_Functions}}

DxDrawCircle

2014-08-02T21:13:25Z

Michael89: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a 2D line in a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( int posX, int posY [, int radius = 50, int, width = 5, int angleAmount = 1, int startAngle = 0, int stopAngle = 360, int color = white, bool postGUI = false ] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_example.png|thumb|An example of how dxDrawCircle function works in practice.]]
* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.

===Optional Arguments===
{{OptionalArg}}
* '''radius''': An integer representing the radius scale of the circle that is being drawn.
* '''width''': An integer representing the width of the line that is being drawn.
* '''angleAmount''': An integer representing the tightness of the circle. Lower amount makes it smoother, higher amount makes it more of a clock looking circle.
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''color''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawCircle ( posX, posY, radius, width, angleAmount, startAngle, stopAngle, color, postGUI )

radius = radius or 50
width = width or 5
angleAmount = angleAmount or 1
startAngle = startAngle or 0
stopAngle = stopAngle or 260
color = color or tocolor(255, 255, 255, 200)
postGUI = postGUI or false

for i = startAngle, stopAngle, angleAmount do

local x1 = math.cos ( math.rad ( i ) ) * ( radius-width )
local x2 = math.cos ( math.rad ( i ) ) * ( radius+width )
local y1 = math.sin ( math.rad ( i ) ) * ( radius-width )
local y2 = math.sin ( math.rad ( i ) ) * ( radius+width )

dxDrawLine ( x1+posX, y1+posY, x2+posX, y2+posY, color, width, postGUI )

end

return true

end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example draws a circle shape in the middle of the screen on resource start.
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
sx, sy = guiGetScreenSize()
addEventHandler("onClientRender", root,
function()
dxDrawCircle(sx/2, sy/2)
end
)
end
)
</syntaxhighlight>
</section>

<br />'''Author:''' Socialz

==See Also==
{{Useful_Functions}}

DxDrawCircle

2014-08-02T21:12:30Z

Michael89: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a 2D line in a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( int posX, int posY [, int radius = 50, int, width = 5, int angleAmount = 1, int startAngle = 0, int stopAngle = 360, int color = white, bool postGUI = false ] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_example.png|thumb|An example of how dxDrawCircle function works in practice.]]
* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.

===Optional Arguments===
{{OptionalArg}}
* '''radius''': An integer representing the radius scale of the circle that is being drawn.
* '''width''': An integer representing the width of the line that is being drawn.
* '''angleAmount''': An integer representing the tightness of the circle. Lower amount makes it smoother, higher amount makes it more of a clock looking circle.
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''color''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawCircle ( posX, posY, radius, width, angleAmount, startAngle, stopAngle, color, postGUI )

radius = radius or 50
width = width or 5
angleAmount = angleAmount or 1
startAngle = startAngle or 0
stopAngle = stopAngle or 260
color = color or tocolor(255, 255, 255, 200)
postGUI = postGUI or false

for i = startAngle, stopAngle, angleAmount do

local x1 = math.cos ( math.rad ( i ) ) * ( radius-width )
local x2 = math.cos ( math.rad ( i ) ) * ( radius+width )
local y1 = math.sin ( math.rad ( i ) ) * ( radius-width )
local y2 = math.sin ( math.rad ( i ) ) * ( radius+width )

dxDrawLine ( x1+x, y1+y, x2+x, y2+y, color, width )

end

return true

end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example draws a circle shape in the middle of the screen on resource start.
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
sx, sy = guiGetScreenSize()
addEventHandler("onClientRender", root,
function()
dxDrawCircle(sx/2, sy/2)
end
)
end
)
</syntaxhighlight>
</section>

<br />'''Author:''' Socialz

==See Also==
{{Useful_Functions}}

DxDrawCircle

2014-08-02T21:09:56Z

Michael89: /* Syntax */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a 2D line in a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( int posX, int posY [, int radius = 50, int, width = 5, int angleAmount = 1, int startAngle = 0, int stopAngle = 360, int color = white, bool postGUI = false ] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_example.png|thumb|An example of how dxDrawCircle function works in practice.]]
* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.

===Optional Arguments===
{{OptionalArg}}
* '''radius''': An integer representing the radius scale of the circle that is being drawn.
* '''width''': An integer representing the width of the line that is being drawn.
* '''angleAmount''': An integer representing the tightness of the circle. Lower amount makes it smoother, higher amount makes it more of a clock looking circle.
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''color''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''postGUI''': A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawCircle(posX, posY, radius, width, angleAmount, color, postGUI)
radius = radius or 50
width = width or 5
angleAmount = angleAmount or 1
color = color or tocolor(255, 255, 255, 200)
postGUI = postGUI or false

for i=0,360,angleAmount do
local _i = i*(math.pi/180)
dxDrawLine(math.cos(_i)*(radius-width)+posX, math.sin(_i)*(radius-width)+posY, math.cos(_i)*(radius+width)+posX, math.sin(_i)*(radius+width)+posY, color, width, postGUI)
end

return true
end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This example draws a circle shape in the middle of the screen on resource start.
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
sx, sy = guiGetScreenSize()
addEventHandler("onClientRender", root,
function()
dxDrawCircle(sx/2, sy/2)
end
)
end
)
</syntaxhighlight>
</section>

<br />'''Author:''' Socialz

==See Also==
{{Useful_Functions}}

DbPoll

2012-07-06T18:47:09Z

Michael89: /* Example */

__NOTOC__
{{Server function}}
This function checks the progress of a database query.

==Syntax==
<syntaxhighlight lang="lua">
table dbPoll ( handle queryHandle, int timeout )
</syntaxhighlight>

===Required Arguments===
*'''queryHandle:''' A query handle previously returned from [[dbQuery]]
*'''timeout:''' How many milliseconds to wait for a result. Use 0 for and instant response (which may return nil). Use -1 to wait until a result is ready. Note: A wait here will freeze the entire server just like the executeSQL* functions

===Returns===
*''nil:'' Returns nil if the query results are not yet ready. You should try again in a little while. (If you give up waiting for a result, be sure to call [[dbFree]])
*''false'' Returns false if the query string contained an error, the connection has been lost or the query handle is incorrect. This automatically frees the query handle, so you do not have to call [[dbFree]].
** This also returns two extra values: error code and error message. See the example on how to retrieve them,
*''table:'' Returns a table when the results are ready. This automatically frees the query handle, so you do not have to call [[dbFree]].
** This also returns an extra value: number of affected rows

==Example==
This example waits until a result is ready:
<syntaxhighlight lang="lua">
local result = dbPoll ( qh, -1 )
</syntaxhighlight>

This example shows the possible return values:
<syntaxhighlight lang="lua">
local result, numrows, errmsg = dbPoll ( qh, -1 )

if result == nil then
outputConsole( "dbPoll result not ready yet" )
elseif result == false then
outputConsole( "dbPoll failed. Error code: " .. tostring(numrows) .. " Error message: " .. tostring(errmsg) )
else
outputConsole( "dbPoll succeeded. Number of affected rows: " .. tostring(numrows) )
end
</syntaxhighlight>

This example shows how to handle the result if the query selected data:
<syntaxhighlight lang="lua">
local result, numrows, errmsg = dbPoll ( qh, -1 )

if numrows > 0 then

for result, row in pairs ( result ) do
-- by using a second loop (use it if you want to get the values of all columns the query selected):
for column, value in pairs ( row ) do
-- column = the mysql column of the table in the query
-- value = the value of that column in this certain row
end

-- or without a second loop (use it if you want to handle every value in a special way):
outputChatBox ( row["column"] ) -- it will output the value of the column "column" in this certain row
end

end
</syntaxhighlight>

==Requirements==
{{Requirements|1.1.1-9.03328|n/a}}

==See Also==
{{Registry_functions}}