Multi Theft Auto: Wiki - User contributions [en]

OnPlayerClick

2022-12-31T14:58:53Z

Mkl: /* Use of predefined variable in example */

__NOTOC__
{{Server event}}
This event is triggered when a player clicks using the mouse cursor.

==Parameters==
<syntaxhighlight lang="lua">
string mouseButton, string buttonState, element clickedElement, float worldPosX, float worldPosY, float worldPosZ, float screenPosX, float screenPosY
</syntaxhighlight>

*'''mouseButton''': a [[string]] representing the mouse button that was pressed. Value can be ''left'', ''middle'' or ''right''.
*'''buttonState''': a [[string]] representing the button state. Value can be ''up'' or ''down''.
*'''clickedElement''': the [[element]] the [[player]] clicked on. This value is ''nil'' if none.
*'''worldPosX''': the X position in the world the [[player]] clicked on.
*'''worldPosY''': the Y position in the world the [[player]] clicked on.
*'''worldPosZ''': the Z position in the world the [[player]] clicked on.
*'''screenPosX''': the X position on the screen the [[player]] clicked on.
*'''screenPosY''': the Y position on the screen the [[player]] clicked on.

==Source==
The [[event system#Event source|source]] of this event is the [[player]] that clicked.

==Example==
This example outputs the state of the button they just pressed.
<syntaxhighlight lang="lua">
function outputClick(mouseButton, buttonState)
outputChatBox("Your "..mouseButton.." mouse button is now "..buttonState,source,255,255,0) -- output the state of the button they just pressed.
end
addEventHandler("onPlayerClick", root, outputClick) -- When a player clicks trigger the outputClick function
</syntaxhighlight>

{{See also/Server event|Player events}}

OnPlayerBan

2022-12-31T14:56:32Z

Mkl: /* Use of predefined variable root instead of getRootElement() in example */

__NOTOC__
{{Server event}}
This event is triggered when a player added a [[ban]] (like [[onBan]]).

==Parameters==
<syntaxhighlight lang="lua">
ban banPointer, player responsibleElement
</syntaxhighlight>

*'''banPointer''': the [[ban]] pointer which was added.
*'''responsibleElement''': the [[player]] who added the ban.

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who was banned.

==Example==
This example outputs the responsible element and the banned player's name when a ban takes place.
<syntaxhighlight lang="lua">
function outputBan ( banPointer, responsibleElement ) -- Define the banner and the ban pointer in the function.
local banner = getPlayerName( responsibleElement ) or "Console" -- Get the banner's name.

outputChatBox ( banner .." has banned ".. getPlayerName( source ) ..".", root, 255, 0, 0 ) -- Output the ban.
end
addEventHandler ( "onPlayerBan", root, outputBan ) -- Trigger the function when there is a ban.
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.03908|Fixed responsible element parameter}}

{{See also/Server event|Player events}}

[[ru:onPlayerBan]]

OnElementDimensionChange

2022-12-31T14:32:47Z

Mkl: /* Explanation and comments for the example*/

__NOTOC__
{{Server event}}
{{Added feature/item|1.5.9|1.5.8|20724|This event is triggered when the dimension of an [[element]] is changed using [[setElementDimension]].}}

==Parameters==
<syntaxhighlight lang="lua">
int oldDimension, int newDimension
</syntaxhighlight>
*'''oldDimension''': An [[int]] representing the dimension the [[element]] was in before.
*'''newDimension''': An [[int]] representing the dimension the [[element]] is in now.

==Source==
The [[event system#Event source|source]] of this event is the [[element]] that changed its dimension.

==Example==
This example prints the old and the new dimension of a vehicle
<syntaxhighlight lang="lua">
local vehicle = createVehicle (411, 0, 0, 3) -- create a vehicle
setTimer (setElementDimension, 1000, 1, vehicle, 10) -- set a new dimension to the vehicle after 1 second

-- add an event handler to onElementDimensionChange attached to the vehicle
addEventHandler ("onElementDimensionChange", vehicle,
function (oldDimension, newDimension)
-- print the old and the new vehicle's dimension
outputChatBox (inspect (source) .. "'s dimension changed from " .. oldDimension .. " to " .. newDimension)
end
)
</syntaxhighlight>

==Requirements==
{{Requirements|1.5.8-9.20724|n/a|}}

{{See also/Server event|Element events}}

OnElementColShapeHit

2022-12-31T14:08:55Z

Mkl: /* Use of predefine variable root instead of getRootElement() in example */

__NOTOC__
{{Server event}}
This event is triggered when an player or vehicle element collides with a colshape.

==Parameters==
<syntaxhighlight lang="lua">
colshape theColShape, bool matchingDimension
</syntaxhighlight>

*'''theColShape''': the [[colshape]] that this [[element]] collided with.
*'''matchingDimension''': a [[boolean]] representing if the [[element]] and the [[colshape]] are in the same [[dimension]].

==Source==
The [[event system#Event source|source]] of this event is the [[player]] or [[vehicle]] that collided with the colshape.

==Example==
This example prints type of the element which entered the created colshape to chatbox.
<syntaxhighlight lang="lua">
colArea = createColCircle( 1400.0, -700.0, 5.0 ) -- create the colshape

function elementColShapeHit( colShapeHit )
if colShapeHit == colArea then -- if element entered the created colshape
outputChatBox( getElementType( source ) .. " entered the colCircle!" ) -- print the type of the element to chatbox
end
end
addEventHandler( "onElementColShapeHit", root, elementColShapeHit ) -- add a handler function for the event
</syntaxhighlight>

{{See also/Server event|Element events}}

OnColShapeHit

2022-12-31T14:06:33Z

Mkl: /*Use of predefine variable root instead of getRootElement() in examples*/

__NOTOC__
{{Server event}}
{{Note|The hit won't be detected if the [[element]] that entered the colshape is a colshape.}}
This event is triggered when a physical [[element]] hits a [[colshape]].

==Parameters==
<syntaxhighlight lang="lua">
element hitElement, bool matchingDimension
</syntaxhighlight>

*'''hitElement''': the [[element]] that entered the colshape.
*'''matchingDimension''': a [[boolean]] referring to whether the hit collision shape was in the same [[dimension]] as the element.

==Source==
The [[event system#Event source|source]] of this event is the [[colshape]] that got hit by a player or vehicle.

==Example==
This example creates a hill area for a ''King of the hill'' gamemode. When a player enters or leaves the area, it's announced in the chatbox.
<syntaxhighlight lang="lua">
-- create our hill area for our gamemode
local hillArea = createColRectangle ( -2171.0678710938, 678.17950439453, 15, 15 )

-- add hill_Enter as a handler for when a player enters the hill area
function hill_Enter ( thePlayer, matchingDimension )
if getElementType ( thePlayer ) == "player" then --if the element that entered was player
--let's get the name of the player
local nameOfThePlayer = getPlayerName ( thePlayer )
--announce to everyone that the player entered the hill
outputChatBox ( nameOfThePlayer.." entered the zone!", root, 255, 255, 109 )
end
end
addEventHandler ( "onColShapeHit", hillArea, hill_Enter )

-- add hill_Enter as a handler for when a player leaves the hill area
function hill_Exit ( thePlayer, matchingDimension )
if getElementType ( thePlayer ) == "player" then --if the element that left was player
--check if the player is not dead
if isPlayerDead ( thePlayer ) ~= true then
--let's get the name of the player
local nameOfThePlayer = getPlayerName ( thePlayer )
--if he was alive, announce to everyone that the player has left the hill
outputChatBox ( nameOfThePlayer.." left the zone!", root, 255, 255, 109 )
end
end
end
addEventHandler ( "onColShapeLeave", hillArea, hill_Exit )
</syntaxhighlight>

{{See also/Server event|Colshape events}}

OnPlayerVehicleEnter

2022-12-31T13:45:41Z

Mkl: /* Use of predefined variable root instead of getRootElement() */

__NOTOC__
{{Server event}}
This event is triggered when a [[player]] enters a vehicle.

==Parameters==
<syntaxhighlight lang="lua">
vehicle theVehicle, int seat, ped jacked
</syntaxhighlight>

*'''theVehicle''': a [[vehicle]] element representing the vehicle that was entered.
*'''seat''': an [[int]] representing the seat in which the player is entering.
*'''jacked''': a [[player]] or [[ped]] element representing who has been jacked.

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

==Example==
'''Example 1:''' This example forces a player out of a police vehicle if he is not a policeman.
<syntaxhighlight lang="lua">
policeVehicles = { [598]=true, [596]=true, [597]=true, [599]=true }
policeSkins = { [280]=true, [281]=true, [282]=true, [283]=true, [284]=true, [285]=true, [286]=true }

function enterVehicle ( theVehicle, seat, jacked ) --when a player enters a vehicle
if ( policeVehicles[getElementModel ( theVehicle )] ) and ( not policeSkins[getElementModel ( source )] ) then -- if the vehicle is one of 4 police cars, and the skin is not a police skin
removePedFromVehicle ( source ) -- force the player out of the vehicle
outputChatBox ( "Only policeman can enter police cars!", source ) -- and tell the player why
end
end
addEventHandler ( "onPlayerVehicleEnter", root, enterVehicle ) -- add an event handler for onPlayerVehicleEnter
</syntaxhighlight>

'''Example 2:''' This example adds a 'moto' helmet to a player when he gets on a nrg bike, and removes it when he gets off.
<syntaxhighlight lang="lua">
function addHelmetOnEnter ( theVehicle, seat, jacked )
if ( getElementModel ( theVehicle ) == 522 ) then -- if its a nrg
addPedClothes ( source, "moto", "moto", 16 ) -- add the helmet
end
end
addEventHandler ( "onPlayerVehicleEnter", root, addHelmetOnEnter )

function removeHelmetOnExit ( theVehicle, seat, jacked )
if ( getElementModel ( theVehicle ) == 522 ) then -- if its a nrg
removePedClothes ( source, 16 ) -- remove the helmet
end
end
addEventHandler ( "onPlayerVehicleExit", root, removeHelmetOnExit )
</syntaxhighlight>

{{See also/Server event|Player events}}