Multi Theft Auto: Wiki - User contributions [en]

IsMouseInPosition

2015-10-14T12:34:03Z

Dealman: Added modified version for hovering the cursor over texts

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function allows you to check whether the mouse cursor/pointer is within a rectangular position
==Syntax==
<syntaxhighlight lang="lua">bool isMouseInPosition ( int x, int y, int width, int height )</syntaxhighlight>

===Required arguments===
* '''x''': Left-most X position for detection (absolute)
* '''y''': Top-most Y position for detection (absolute)
* '''width''': Width for detection (absolute)
* '''heigh''': Height for detection (absolute)

===Return===
Returns true/false depending on whether the mouse is within the specified position or not

==Code==
<syntaxhighlight lang="lua">
function isMouseInPosition ( x, y, width, height )
if ( not isCursorShowing ( ) ) then
return false
end

local sx, sy = guiGetScreenSize ( )
local cx, cy = getCursorPosition ( )
local cx, cy = ( cx * sx ), ( cy * sy )
if ( cx >= x and cx <= x + width ) and ( cy >= y and cy <= y + height ) then
return true
else
return false
end
end

-- Modified version for DX Text
function isCursorOverText(posX, posY, sizeX, sizeY)
if(isCursorShowing()) then
local cX, cY = getCursorPosition()
local cX, cY = (cX*screenWidth), (cY*screenHeight)
if(cX >= posX and cX <= posX+(sizeX - posX)) and (cY >= posY and cY <= posY+(sizeY - posY)) then
return true
else
return false
end
else
return false
end
end
</syntaxhighlight>

==Example==
<section name="Example" class="client" show="true">
Changes the image when you move your cursor over it.
<syntaxhighlight lang="lua">
addEventHandler ( "onClientRender", root,
function ( )
local imgX, imgY, imgWidth, imgHeight = 50, 50, 200, 200
dxDrawImage ( imgX, imgY, imgWidth, imgHeight, ( isMouseInPosition ( imgX, imgY, imgWidth, imgHeight ) and "myImage2.png" or "myImage.png" ), tocolor ( 255, 255, 255 ) )
end
)
</syntaxhighlight>
</section>

Author: Castillo

==See Also==
{{Useful_Functions}}

OnClientVehicleDamage

2014-03-14T22:33:52Z

Dealman: /* Example */

__NOTOC__
{{Client event}}
{{New items|4.0140|1.3.5|
This event is triggered when a vehicle is damaged.
}}

==Parameters==
<syntaxhighlight lang="lua">
element theAttacker, int theWeapon, float loss, float damagePosX, float damagePosY, float damagePosZ, int tyreID
</syntaxhighlight>

*'''theAttacker''': An element if there was an attacker.
*'''theWeapon''': An integer specifying the weapon ID if a weapon was used.
*'''loss''': A float representing the amount of damage taken.
*'''damagePosX''': A float representing the X co-ordinate of where the damage took place.
*'''damagePosX''': A float representing the Y co-ordinate of where the damage took place.
*'''damagePosX''': A float representing the Z co-ordinate of where the damage took place.
*'''tyreID''': A number representing the tyre which took damage, if there is one.

==Source==
The [[event system#Event source|source]] of this event is the [[vehicle]] that got damaged.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the vehicle will not be damaged.

==Example==
This example makes every SWAT tank immune from all weapon attacks.
<syntaxhighlight lang="lua">
function handleVehicleDamage(attacker, weapon, loss, x, y, z, tyre)
if (weapon and getElementModel(source) == 601) then
-- A weapon was used and the vehicle model ID is that of the SWAT tank so cancel the damage.
cancelEvent()
end
end
addEventHandler("onClientVehicleDamage", root, handleVehicleDamage)
</syntaxhighlight>

This example allows the Rhino to take damage from bullets even though they're bullet proof, this example doesn't work with explosions though.
<syntaxhighlight lang="lua">
-- Only let these weapons damage a Rhino
local weaponsToDamageRhino = {
[38] = true, -- minigun
[33] = true, -- country rifle
[34] = true, -- sniper rifle
[30] = true, -- AK-47
[31] = true, -- M4
}

function handleRhinoDamage(attacker, weapon, loss, x, y, z, tyre)
if (weapon and getElementModel(source) == 432 and loss > 0) then
if (weaponsToDamageRhino[weapon]) then
setElementHealth(source, getElementHealth(source) - loss)
end
end
end
addEventHandler("onClientVehicleDamage", root, handleRhinoDamage)
</syntaxhighlight>

This example will prevent your vehicle from taking damage by being lit on fire.
<syntaxhighlight lang="lua">
function preventFireDamage_Handler(theAttacker, theWeapon)
if(theWeapon == 37) then
cancelEvent()
end
end
addEventHandler("onClientVehicleDamage", getRootElement(), preventFireDamage_Handler)
</syntaxhighlight>

==See Also==
===Client vehicle events===
{{Client_vehicle_events}}
===Client event functions===
{{Client_event_functions}}

OnClientPreRender

2014-03-02T11:06:38Z

Dealman: /* Warning */

__NOTOC__
{{Client event}}
This event is triggered every time before GTA renders a new frame.

==Parameters==
<syntaxhighlight lang="lua">
float timeSlice
</syntaxhighlight>
*'''timeSlice:''' The interval between this frame and the previous one in milliseconds (delta time).

==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Example==
This example makes the camera follow the player in a GTA2-like way.
<syntaxhighlight lang="lua">
root = getRootElement ()
function updateCamera ()
local x, y, z = getElementPosition ( getLocalPlayer () )
setCameraMatrix ( x, y, z + 50, x, y, z )
end
addEventHandler ( "onClientPreRender", root, updateCamera )
</syntaxhighlight>

==Warning==
This event and [[onClientRender]] will trigger whatever function it is attached to with every frame. Depending on the server's maximum FPS and what your computer might handle - you might end up triggering the function 30-60 times '''per second'''.

As a result, this event may cause severe lag and/or even crashes if not used cautiously.

==See Also==
===[[Game_Processing_Order|Game Processing Order]]===
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

OnClientPreRender

2014-03-02T11:06:21Z

Dealman:

__NOTOC__
{{Client event}}
This event is triggered every time before GTA renders a new frame.

==Parameters==
<syntaxhighlight lang="lua">
float timeSlice
</syntaxhighlight>
*'''timeSlice:''' The interval between this frame and the previous one in milliseconds (delta time).

==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Example==
This example makes the camera follow the player in a GTA2-like way.
<syntaxhighlight lang="lua">
root = getRootElement ()
function updateCamera ()
local x, y, z = getElementPosition ( getLocalPlayer () )
setCameraMatrix ( x, y, z + 50, x, y, z )
end
addEventHandler ( "onClientPreRender", root, updateCamera )
</syntaxhighlight>

==Warning==
This event and [[onClientPreRender]] will trigger whatever function it is attached to with every frame. Depending on the server's maximum FPS and what your computer might handle - you might end up triggering the function 30-60 times '''per second'''.

As a result, this event may cause severe lag and/or even crashes if not used cautiously.

==See Also==
===[[Game_Processing_Order|Game Processing Order]]===
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

OnClientRender

2014-03-02T11:06:07Z

Dealman:

__NOTOC__
{{Client event}}
This event is triggered every time GTA renders a new frame. It is required for the DirectX drawing functions, and also useful for other clientside operations that have to be applied repeatedly with very short time differences between them.

==Parameters==
''None''

==Source==
The [[event system#Event source|source]] of this event is the client's [[root element]].

==Example==
This example makes the camera follow the player in a GTA2-like way. This will be a little bit laggy. If you want the camera to follow something (eg. player or vehicle) then use [[onClientPreRender]] instead.
<syntaxhighlight lang="lua">
function updateCamera ()
local x, y, z = getElementPosition ( localPlayer )
setCameraMatrix ( x, y, z + 50, x, y, z )
end
addEventHandler ( "onClientRender", root, updateCamera )
</syntaxhighlight>

==Warning==
This event and [[onClientPreRender]] will trigger whatever function it is attached to with every frame. Depending on the server's maximum FPS and what your computer might handle - you might end up triggering the function 30-60 times '''per second'''.

As a result, this event may cause severe lag and/or even crashes if not used cautiously.

==See Also==
===[[Game_Processing_Order|Game Processing Order]]===
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

DxGUI/dxCreateScrollBar

2013-04-26T14:50:08Z

Dealman: Created page with "==Example== {{Client function}} <syntaxhighlight lang="lua"> dxTestWindow = exports.dxgui:dxCreateWindow(resourceRoot, 445, 150, 608, 335, "Main Window", tocolor(255,255,255,255), "default", "Lig..."

==Example==
{{Client function}}
<syntaxhighlight lang="lua">
dxTestWindow = exports.dxgui:dxCreateWindow(resourceRoot, 445, 150, 608, 335, "Main Window", tocolor(255,255,255,255), "default", "Lighter Black")
dxTestScrollBar = exports.dxgui:dxCreateScrollBar(resourceRoot, 25, 102, 242, 19, dxTestWindow, "Horizontal/Vertical", 0, 100, "Lighter Black")
</syntaxhighlight>