DxDrawImage3D

2019-12-19T13:48:43Z

Kirukiru: Typo? (another float width arg after element material

__NOTOC__
{{Useful Function}}
This function draws a textured 3D line between two points in the 3D world that appers to be a 3D image - 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 and a texture effectively becomes a 3D image, hence the possibility 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|game processing order]], so use [[onClientPreRender]] for drawing if you are attaching them to world elements.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawImage3D ( float x, float y, float z, float width, float height, element material,
[ int color = white, float rotation = 0, [ bool postGUI = false, ] float faceTowardX, float faceTowardY, float faceTowardZ ] )</syntaxhighlight>

===Required Arguments===
* '''X/Y/Z:''' The start position of the 3D image, representing a coordinate in the GTA world.
* '''width:''' The width of the image in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)
* '''height:''' The height of the image in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)
* '''material:''' A material to draw the image with.

==Optional Arguments==
{{OptionalArg}}
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''rotation:''' Rotation (end point of the image) offset
{{New items|3.0156|1.5.5|
* '''postGUI''': A bool representing whether the image should be drawn on top of or behind any ingame GUI.
|11998}}
* '''faceTowardX/Y/Z:''' The direction the front of the image should face towards. If this is not set, the front of the image always faces toward the camera.

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

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawImage3D( x, y, z, width, height, material, color, rotation, ... )
return dxDrawMaterialLine3D( x, y, z, x + width, y + height, z + tonumber( rotation or 0 ), material, height, color or 0xFFFFFFFF, ... )
end
</syntaxhighlight>
</section>

==Example==
This draws a trollface in the middle of the GTA world for no reason
<syntaxhighlight lang="lua">
local face = dxCreateTexture( "trollface.png" )

addEventHandler( "onClientRender", root,
function( )
dxDrawImage3D( 0,0, 20, 20, 20, face, tocolor( 255, 255, 255, 255 ) )
end
)
</syntaxhighlight>

'''Author:''' qaisjp

==See Also==
{{Useful_Functions}}

Multi Theft Auto: Wiki - User contributions [en]

DxDrawImage3D