dxDrawLine3D
Client-side
Server-side
Shared
Manual Review Required
Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.
This function draws a 3D line between two points in the 3D world - rendered for one frame. This should be used in conjunction with onClientRender in order to display continuously.
Syntax
bool dxDrawLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ int color = 0xFFFFFFFF, float width = 1.0, string stage = "postfx" ] )Required Arguments
- startX: The start X position of the 3D line, representing a coordinate in the GTA world.
- startY: The start Y position of the 3D line, representing a coordinate in the GTA world.
- startZ: The start Z position of the 3D line, representing a coordinate in the GTA world.
- endX: The end X position of the 3D line, representing a coordinate in the GTA world.
- endY: The end Y position of the 3D line, representing a coordinate in the GTA world.
- endZ: The end Z position of the 3D line, representing a coordinate in the GTA world.
Optional Arguments
NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.
- color (default: 0xFFFFFFFF): MISSING_PARAM_DESC
- width (default: 1.0): MISSING_PARAM_DESC
- stage (default: "postfx"): MISSING_PARAM_DESC
Returns
- bool: value
Returns a true if the operation was successful, false otherwise.
Code Examples
shared
This is a small example of creating 3D Line / "Rope" between vehicle and player.
function makeLineAppear() testVehicle = createVehicle ( 411, 0, 0, 5 ) -- Create our test vehicle. addEventHandler("onClientRender", root, createLine) -- onClientRender keeps the 3D Line visible.endfunction createLine ( ) x1, y1, z1 = getElementPosition ( testVehicle ) -- Get test vehicles position. x2, y2, z2 = getElementPosition ( localPlayer ) -- Get local players position. dxDrawLine3D ( x1, y1, z1, x2, y2, z2, tocolor ( 0, 255, 0, 230 ), 2) -- Create 3D Line between test vehicle and local player.endaddCommandHandler("line", makeLineAppear)See Also
Drawing Functions
- dxConvertPixels
- dxCreateFont
- dxCreateRenderTarget
- dxCreateScreenSource
- dxCreateShader
- dxCreateTexture
- dxDrawCircle
- dxDrawImage
- dxDrawImageSection
- dxDrawLine
- dxDrawLine3D
- dxDrawMaterialLine3D
- dxDrawMaterialPrimitive
- dxDrawMaterialPrimitive3D
- dxDrawMaterialSectionLine3D
- dxDrawModel3D
- dxDrawPrimitive
- dxDrawPrimitive3D
- dxDrawRectangle
- dxDrawText
- dxDrawWiredSphere
- dxGetBlendMode
- dxGetFontHeight
- dxGetMaterialSize
- dxGetPixelColor
- dxGetPixelsFormat
- dxGetPixelsSize
- dxGetStatus
- dxGetTextSize
- dxGetTexturePixels
- dxGetTextWidth
- dxIsAspectRatioAdjustmentEnabled
- dxSetAspectRatioAdjustmentEnabled
- dxSetBlendMode
- dxSetPixelColor
- dxSetRenderTarget
- dxSetShaderTessellation
- dxSetShaderTransform
- dxSetShaderValue
- dxSetTestMode
- dxSetTextureEdge
- dxSetTexturePixels
- dxUpdateScreenSource