DxDrawMaterialLine3D: Difference between revisions

Revision as of 09:06, 6 October 2012

	Script Example Missing Function DxDrawMaterialLine3D needs a script example, help out by writing one.
	Before submitting check out Editing Guidelines Script Examples.

ADDED/UPDATED IN VERSION 1.3.0 r3931:

This function draws a textured 3D line between two points in the 3D world - rendered for one frame. This should be used in conjunction with onClientPreRender in order to display continuously.

The 3D line with a large width value effectively becomes a rectangle, so it it possible to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.

3D lines are drawn at a particular place in the game processing order, so use onClientPreRender for drawing if you are attaching them to world elements.

Syntax

bool dxDrawMaterialLine3D ( float startX, float startY, float startZ, float endX, float endY, float endZ,
                            element material, int width, [, int color = white, float faceTowardX, float faceTowardY, float faceTowardZ ] )

Required Arguments

startX/Y/Z: The start position of the 3D line, representing a coordinate in the GTA world.
endX/Y/Z: The end position of the 3D line, representing a coordinate in the GTA world.
material: A material to draw the line with.
width: The width/thickness of the line in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)

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.

color: An integer of the hex color, produced using tocolor or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
faceTowardX/Y/Z: The direction the front of the line should face towards. If this is not set, the front of the line always faces toward the camera.

Returns

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

Example

Click to collapse [-]

Client

  TODO

Requirements

This template will be deleted.

@@ Line 42: / Line 42: @@
 ==See Also==
 {{Drawing_functions}}
+[[Category:Needs Example]]