OnVehicleExit: Difference between revisions
Jump to navigation
Jump to search
(Added forcedByScript parameter) |
m (correct event name) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server event}} | {{Server event}} | ||
This event is triggered when a player leaves a vehicle. | This event is triggered when a player or ped leaves a vehicle. | ||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
ped thePed, int seat, ped jacker, bool forcedByScript | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*''' | *'''thePed''': a [[player]] or [[ped]] element who exited the [[vehicle]]. | ||
*'''seat''': an [[int]] representing the seat in which the | *'''seat''': an [[int]] representing the seat in which the ped exited from. | ||
*'''jacker''': a [[player]] element | *'''jacker''': a [[player]] or [[ped]] element who jacked the driver. | ||
{{New feature/item|3.0154|1.5.3|11247| | {{New feature/item|3.0154|1.5.3|11247| | ||
*'''forcedByScript:''' a [[boolean]] representing whether the exit was forced using [[removePedFromVehicle]] or by the player. | *'''forcedByScript:''' a [[boolean]] representing whether the exit was forced using [[removePedFromVehicle]] or by the ped/player. | ||
}} | }} | ||
Line 40: | Line 40: | ||
This example will turn off a vehicle's engine when the driver gets out of the car. | This example will turn off a vehicle's engine when the driver gets out of the car. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addEventHandler ( " | addEventHandler ( "onVehicleExit", getRootElement(), function(theVehicle, leftSeat, jackerPlayer) | ||
if leftSeat == 0 and not jackerPlayer then | if leftSeat == 0 and not jackerPlayer then | ||
setVehicleEngineState( theVehicle, false) | setVehicleEngineState( theVehicle, false) |
Latest revision as of 14:50, 18 June 2024
This event is triggered when a player or ped leaves a vehicle.
Parameters
ped thePed, int seat, ped jacker, bool forcedByScript
- thePed: a player or ped element who exited the vehicle.
- seat: an int representing the seat in which the ped exited from.
- jacker: a player or ped element who jacked the driver.
- forcedByScript: a boolean representing whether the exit was forced using removePedFromVehicle or by the ped/player.
Source
The source of this event is the vehicle that was exited.
Example
This example adds a 'moto' helmet to a player when he gets on a nrg bike, and removes it when he gets off.
function addHelmetOnEnter ( thePlayer, seat, jacked ) if ( getElementModel ( source ) == 522 ) then -- if its a nrg addPedClothes ( thePlayer, "moto", "moto", 16 ) -- add the helmet end end addEventHandler ( "onVehicleEnter", getRootElement(), addHelmetOnEnter ) function removeHelmetOnExit ( thePlayer, seat, jacked ) if ( getElementModel ( source ) == 522 ) then -- if its a nrg removePedClothes ( thePlayer, 16 ) -- remove the helmet end end addEventHandler ( "onVehicleExit", getRootElement(), removeHelmetOnExit )
Example 2
This example will turn off a vehicle's engine when the driver gets out of the car.
addEventHandler ( "onVehicleExit", getRootElement(), function(theVehicle, leftSeat, jackerPlayer) if leftSeat == 0 and not jackerPlayer then setVehicleEngineState( theVehicle, false) end end)
Changelog
Version | Description |
---|
1.5.3-9.11247 | Added forcedByScript argument |
See Also
Vehicle events
- onTrailerAttach
- onTrailerDetach
- onVehicleDamage
- onVehicleEnter
- onVehicleExit
- onVehicleExplode
- onVehicleRespawn
- onVehicleStartEnter
- onVehicleStartExit
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled