DxDrawLine: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Changed the example entirely, because I fail at editing.)
Line 25: Line 25:
==Example==
==Example==
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
Example code for drawing crosshair for Tank.
This example draws an 'X' across the screen.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local width, height = guiGetScreenSize ( )     -- Get player's screen resolution (width and height).
local screenWidth, screenHeight = guiGetScreenSize()  
local centerX, centerY = ( width / 2 ), ( height / 2 )  -- Get x and y co-ordinates of the center of the screen.
local lineColor = tocolor(255, 0, 0)
local colGreen = tocolor ( 0, 255, 0, 255 )   -- Get green color.
function drawLinesAcrossScreen()
 
dxDrawLine(0, 0, screenWidth, screenHeight, lineColor)
function draw2DLine( )
dxDrawLine(screenWidth, 0, 0, screenHeight, lineColor)
  dxDrawLine ( centerX, centerY - 200, centerX, centerY - 170, colGreen, 1 )             -- Draw vertical crosshair line
end
  dxDrawLine ( centerY - 20, centerY - 185, centerX + 20, centerY - 185, colGreen, 1 )   -- Draw horizontal crosshair line
addEventHandler("onClientRender", root, drawLinesAcrossScreen)
end
addEventHandler ( "onClientRender", resourceRoot, draw2DLine)
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Revision as of 04:32, 22 January 2012

This function draws a 2D line across the screen - rendered for one frame. This should be used in conjunction with onClientRender in order to display continuously.

Syntax

bool dxDrawLine ( int startX, int startY, int endX, int endY, int color, [float width=1, bool postGUI=false] )

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.
  • color: An integer of the hex color, produced using tocolor or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • 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 a true if the operation was successful, false otherwise.

Example

Click to collapse [-]
Client

This example draws an 'X' across the screen.

local screenWidth, screenHeight = guiGetScreenSize() 
local lineColor = tocolor(255, 0, 0)
function drawLinesAcrossScreen()
	dxDrawLine(0, 0, screenWidth, screenHeight, lineColor)
	dxDrawLine(screenWidth, 0, 0, screenHeight, lineColor)
end
addEventHandler("onClientRender", root, drawLinesAcrossScreen)

See Also