Multi Theft Auto: Wiki - User contributions [en]

GetPedTargetCollision

2013-10-16T18:18:49Z

KryPtoHolYx: /* Example */

__NOTOC__
{{Client function}}
This function allows retrieval of where a ped's target is blocked. It will only be blocked if there is an obstacle within a ped's target range.

==Syntax==
<syntaxhighlight lang="lua">
float float float getPedTargetCollision ( ped targetingPed )
</syntaxhighlight>

===Required Arguments===
*'''targetingPed:''' This is the ped whose target collision you wish to retrieve

===Returns===
Returns three floats, ''x'',''y'',''z'', representing the position where the ped's target collides, or ''false'' if it was unsuccessful.

==Example==

This Example draws a line from where the Ped´s Target Starts to the Point where the Targets Collision is.
<syntaxhighlight lang="lua">
function drawline()
if (getPedTargetStart(localPlayer)) then --Checks if there is a Point to start From.

local x,y,z = getPedTargetStart(localPlayer) -- Gets the Point to start From.
local sx,sy,sz = getPedTargetCollision(localPlayer) -- Gets the Point where the Targets Collision is.

dxDrawLine3D(x,y,z,sx,sy,sz) -- Draws the Line
end
end
addEventHandler("onClientPreRender",getRootElement(),drawline) -- Adds the Handler.
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}
[[Category:Needs_Example]]

GetPedTargetCollision

2013-10-16T18:18:34Z

KryPtoHolYx: /* Example */

__NOTOC__
{{Client function}}
This function allows retrieval of where a ped's target is blocked. It will only be blocked if there is an obstacle within a ped's target range.

==Syntax==
<syntaxhighlight lang="lua">
float float float getPedTargetCollision ( ped targetingPed )
</syntaxhighlight>

===Required Arguments===
*'''targetingPed:''' This is the ped whose target collision you wish to retrieve

===Returns===
Returns three floats, ''x'',''y'',''z'', representing the position where the ped's target collides, or ''false'' if it was unsuccessful.

==Example==
<section name="Client" class="client" show="true">
This Example draws a line from where the Ped´s Target Starts to the Point where the Targets Collision is.
<syntaxhighlight lang="lua">
function drawline()
if (getPedTargetStart(localPlayer)) then --Checks if there is a Point to start From.

local x,y,z = getPedTargetStart(localPlayer) -- Gets the Point to start From.
local sx,sy,sz = getPedTargetCollision(localPlayer) -- Gets the Point where the Targets Collision is.

dxDrawLine3D(x,y,z,sx,sy,sz) -- Draws the Line
end
end
addEventHandler("onClientPreRender",getRootElement(),drawline) -- Adds the Handler.
</syntaxhighlight>
</section>

==See Also==
{{Client_ped_functions}}
[[Category:Needs_Example]]

GetPedTargetCollision

2013-10-16T18:10:15Z

KryPtoHolYx: /* Example */

__NOTOC__
{{Client function}}
This function allows retrieval of where a ped's target is blocked. It will only be blocked if there is an obstacle within a ped's target range.

==Syntax==
<syntaxhighlight lang="lua">
float float float getPedTargetCollision ( ped targetingPed )
</syntaxhighlight>

===Required Arguments===
*'''targetingPed:''' This is the ped whose target collision you wish to retrieve

===Returns===
Returns three floats, ''x'',''y'',''z'', representing the position where the ped's target collides, or ''false'' if it was unsuccessful.

==Example==
This Example draws a line from where the Ped´s Target Starts to the Point where the Targets Collision is.
<syntaxhighlight lang="lua">
function drawline()
if (getPedTargetStart(localPlayer)) then --Checks if there is a Point to start From.

local x,y,z = getPedTargetStart(localPlayer) -- Gets the Point to start From.
local sx,sy,sz = getPedTargetCollision(localPlayer) -- Gets the Point where the Targets Collision is.

dxDrawLine3D(x,y,z,sx,sy,sz) -- Draws the Line
end
end
addEventHandler("onClientPreRender",getRootElement(),drawline) -- Adds the Handler.
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}
[[Category:Needs_Example]]

GetPedTargetEnd

2013-10-16T18:09:38Z

KryPtoHolYx: /* Example */

__NOTOC__
{{Client function}}
This function allows retrieval of the position where a ped's target range ends, when he is aiming with a weapon.

==Syntax==
<syntaxhighlight lang="lua">
float float float getPedTargetEnd ( ped targetingPed )
</syntaxhighlight>

===Required Arguments===
*'''targetingPed:''' The ped who is targeting whose target end you wish to retrieve

===Returns===
Returns three floats, ''x'',''y'',''z'', representing the position where the ped's target ends according to his range, or ''false'' if it was unsuccessful.

==Example==
This Example draws a line from where the Ped´s Target Starts to the Point where the Target Ends
<syntaxhighlight lang="lua">
function drawline()
if (getPedTargetStart(localPlayer)) then --Checks if there is a Point to start From.

local x,y,z = getPedTargetStart(localPlayer) -- Gets the Point to start From
local sx,sy,sz = getPedTargetEnd(localPlayer) -- Gets the Point where the Target Ends

dxDrawLine3D(x,y,z,sx,sy,sz) -- Draws the Line
end
end
addEventHandler("onClientPreRender",getRootElement(),drawline) -- Adds the Handler
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}
[[Category:Needs_Example]]

GetPedTargetStart

2013-10-16T18:08:08Z

KryPtoHolYx:

__NOTOC__
{{Client function}}
This function allows retrieval of the position a ped's target range begins, when he is aiming with a weapon.

==Syntax==
<syntaxhighlight lang="lua">
float float float getPedTargetStart ( ped targetingPed )
</syntaxhighlight>

===Required Arguments===
*'''targetingPed:''' The ped whose target start you wish to retrieve

===Returns===
Returns three floats, x,y,z, representing the position where the ped's target starts, or ''false'' if it was unsuccessful.

==Example==
This Example draws a line from where the Ped´s Target Starts to the Point where the Target Ends
<syntaxhighlight lang="lua">
function drawline()
if (getPedTargetStart(localPlayer)) then --Checks if there is a Point to start From.

local x,y,z = getPedTargetStart(localPlayer) -- Gets the Point to start From
local sx,sy,sz = getPedTargetEnd(localPlayer) -- Gets the Point where the Target Ends

dxDrawLine3D(x,y,z,sx,sy,sz) -- Draws the Line
end
end
addEventHandler("onClientPreRender",getRootElement(),drawline) -- Adds the Handler
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}
[[Category:Needs_Example]]

DxDrawMaterialLine3D

2013-04-05T16:28:16Z

KryPtoHolYx:

__NOTOC__
{{Client function}}
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|game processing order]], so use [[onClientPreRender]] for drawing if you are attaching them to world elements.

==Syntax==
<syntaxhighlight lang="lua">
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 ] )
</syntaxhighlight>

===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==
{{OptionalArg}}
* '''color:''' An [[int|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==
<section name="Client" class="client" show="true">
Draws an Image ( "test.png" Download : [http://i.epvpimg.com/dwsTe.png test.png] ) from the Position 0,0,3 to 0,0,15
<syntaxhighlight lang="lua">local img = dxCreateTexture("test.png")
addEventHandler("onClientRender", root,
function() -- x,y,z, targetx,targety,targetz,texture,width,color
dxDrawMaterialLine3D (0,0,3,0,0,15,img, 7, tocolor(255,255,255,255))
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3.0-9.03931|}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

DxDrawMaterialLine3D

2013-04-05T16:26:30Z

KryPtoHolYx: /* Example */

__NOTOC__
{{Client function}}
{{Needs Example}}
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|game processing order]], so use [[onClientPreRender]] for drawing if you are attaching them to world elements.

==Syntax==
<syntaxhighlight lang="lua">
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 ] )
</syntaxhighlight>

===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==
{{OptionalArg}}
* '''color:''' An [[int|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==
<section name="Client" class="client" show="true">
Draws an Image ( "test.png" Download : [http://i.epvpimg.com/dwsTe.png test.png] ) from the Position 0,0,3 to 0,0,15
<syntaxhighlight lang="lua">local img = dxCreateTexture("test.png")
addEventHandler("onClientRender", root,
function() -- x,y,z, targetx,targety,targetz,texture,width,color
dxDrawMaterialLine3D (0,0,3,0,0,15,img, 7, tocolor(255,255,255,255))
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.3.0-9.03931|}}

==See Also==
{{Drawing_functions}}
[[Category:Needs Example]]

SetVehicleDirtLevel

2012-10-21T21:11:15Z

KryPtoHolYx: /* Example */

__NOTOC__
{{server client function}}
{{Disabled|This function doesn't work actually. See the bugtracker for updates and more information.}}
This function sets the dirt level on a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleDirtLevel ( vehicle theVehicle, int dirtLevel )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle that you want to set the dirt level from
*'''dirtLevel:''' The dirt level

===Returns===
Returns ''true'' if the dirt level was set on the vehicle, ''false'' if the dirt level was not set or if invalid arguments are specified.

==Example==
Sets the Dirt level from the Bobcat to Zero ( 0 )
<syntaxhighlight lang="lua">
setVehicleDirtLevel ( 422, 0 )
</syntaxhighlight>

==Issues==
{{Issues|
{{Issue|3164|Not fixable and closed}}
}}

==See Also==
{{Vehicle functions}}

FireWeapon

2012-10-16T17:16:21Z

KryPtoHolYx:

__NOTOC__
{{Client function}}
Fires one shot from a custom weapon.

==Syntax==
<syntaxhighlight lang="lua">bool fireWeapon ( weapon theWeapon )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to be fired.

===Returns===
Returns ''true'' if the shot weapon is valid and therefore the shot was fired, ''false'' otherwise.

==Example==
This Function create and Fires a Weapon
<syntaxhighlight lang="lua">
function fireandcreate ()
local weapon = createWeapon("mp5",0,0,0) --Create a Mp5 at the Cordinates 0,0,0
fireWeapon(weapon) --Fires the Weapon
end
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See Also==
{{Client weapon creation functions}}
[[Category:Needs Example]]