OnVehicleStartEnter: Difference between revisions
Jump to navigation
Jump to search
m (See Also for server events) |
Zangomangu (talk | contribs) m (Using "ped" instead of "player" when parameter refers to both) |
||
| (11 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server event}} | {{Server event}} | ||
This event is triggered when a player starts to enter a vehicle. This event can be used to cancel entry, if necessary. | This event is triggered when a player or ped starts to enter a vehicle. This event can be used to cancel entry, if necessary. | ||
==Parameters== | ==Parameters== | ||
{{Deprecated feature|3|1.0| | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
ped enteringPed, int seat, ped jacked | |||
</syntaxhighlight> | </syntaxhighlight> | ||
}} | |||
{{New feature/item|3|1.0|| | |||
<syntaxhighlight lang="lua"> | |||
ped enteringPed, int seat, ped jacked, int door | |||
</syntaxhighlight>}} | |||
*''' | *'''enteringPed''': a [[player]] or [[ped]] element who is starting to enter a vehicle. | ||
*'''seat''': | *'''seat''': an [[int]] representing the seat in which the ped is entering. | ||
*'''jacked''': | *'''jacked''': a [[player]] or [[ped]] element representing who is going to be jacked. | ||
*'''door''': an [[int]] of which door is being used (0-3). 0 is driver side door, 1 is front passenger, 2 is back left, 3 is back right. | |||
==Source== | ==Source== | ||
The [[event system#Event source|source]] of this event is the [[vehicle]] in which a | The [[event system#Event source|source]] of this event is the [[vehicle]] in which a ped began to enter. | ||
===Canceling=== | ===Canceling=== | ||
If this event is [[Event system #Canceling|canceled]], the | If this event is [[Event system #Canceling|canceled]], the ped will not enter the vehicle. | ||
==Example== | ==Example== | ||
| Line 25: | Line 32: | ||
function enterVehicle ( player, seat, jacked ) --when a player enters a vehicle | function enterVehicle ( player, seat, jacked ) --when a player enters a vehicle | ||
if ( policeVehicles[ | if ( policeVehicles[getElementModel(source)] ) and ( not policeSkins[getElementModel(player)] ) then --if the vehicle is one of 4 police cars, and the skin is not a police skin | ||
cancelEvent() | cancelEvent() | ||
outputChatBox ( "Only policeman can enter police cars!", player ) --and tell the player why | outputChatBox ( "Only policeman can enter police cars!", player ) --and tell the player why | ||
end | end | ||
end | end | ||
addEventHandler ( "onVehicleStartEnter", getRootElement(), enterVehicle ) --add an event for | addEventHandler ( "onVehicleStartEnter", getRootElement(), enterVehicle ) --add an event handler for onVehicleStartEnter | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{See also/Server event|Vehicle events}} | {{See also/Server event|Vehicle events}} | ||
Latest revision as of 18:53, 29 November 2020
This event is triggered when a player or ped starts to enter a vehicle. This event can be used to cancel entry, if necessary.
Parameters
ped enteringPed, int seat, ped jacked, int door
- enteringPed: a player or ped element who is starting to enter a vehicle.
- seat: an int representing the seat in which the ped is entering.
- jacked: a player or ped element representing who is going to be jacked.
- door: an int of which door is being used (0-3). 0 is driver side door, 1 is front passenger, 2 is back left, 3 is back right.
Source
The source of this event is the vehicle in which a ped began to enter.
Canceling
If this event is canceled, the ped will not enter the vehicle.
Example
This example blocks a player out of a police vehicle if he is not a policeman.
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 ( player, seat, jacked ) --when a player enters a vehicle
if ( policeVehicles[getElementModel(source)] ) and ( not policeSkins[getElementModel(player)] ) then --if the vehicle is one of 4 police cars, and the skin is not a police skin
cancelEvent()
outputChatBox ( "Only policeman can enter police cars!", player ) --and tell the player why
end
end
addEventHandler ( "onVehicleStartEnter", getRootElement(), enterVehicle ) --add an event handler for onVehicleStartEnter
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