OnVehicleEnter: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Using "ped" instead of "player" when parameter refers to both)
 
(13 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
This event is triggered when a player enters a vehicle.
{{Server event}}
This event is triggered when a player or ped enters a vehicle.


==Syntax==  
==Parameters==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onVehicleEnter ( player player, int seat, player jacked )
ped thePed, int seat, player jacked
</syntaxhighlight>  
</syntaxhighlight>  


==Variables==
*'''thePed''': a [[player]] or [[ped]] element who is entering the [[vehicle]].
* The source of this event is the [[vehicle]] that is being entered by a ''player''.
*'''seat''': an [[int]] representing the seat in which the ped is entering. Seat 0 is the driver's seat.
*'''player''': A player element representing the player who is entering the vehicle
*'''jacked''': a [[player]] or [[ped]] element representing who has been jacked.
*'''seat''': An integer representing the seat in which the player is entering
 
*'''jacked''': A player element representing a player who has been jacked
==Source==
The [[event system#Event source|source]] of this event is the [[vehicle]] that was entered.


==Example==  
==Example==  
This example forces a player out of a police vehicle if he is not a policeman.
'''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 ( thePlayer, seat, jacked ) -- when a player enters a vehicle
    if ( policeVehicles[getElementModel ( source )] ) and ( not policeSkins[getElementModel ( thePlayer )] ) then -- if the vehicle is one of 4 police cars, and the skin is not a police skin
        removePedFromVehicle ( thePlayer ) -- force the player out of the vehicle
        outputChatBox ( "Only policeman can enter police cars!", thePlayer ) -- and tell the player why
    end
end
addEventHandler ( "onVehicleEnter", getRootElement(), enterVehicle ) -- add an event handler for onVehicleEnter
</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 (only works with players using CJ skin).
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler ( "onVehicleEnter", getRootElement(), "vehicleEnter" ) --add an event for onPlayerEnterVehicle
function addHelmetOnEnter ( thePlayer, seat, jacked )
function vehicleEnter ( player, seat, jacked ) --when a player enters a vehicle
    if ( getElementModel ( source ) == 522 ) then -- if its a nrg
     if ( source == 598 or 596 or 597 or 599 ) and ( getPlayerSkin ( player ) ~= 280 or 281 or 282 or 283 or 284 or 285 or 286 ) then --if the vehicle is one of 4 police cars, and the skin is not a police skin
        addPedClothes ( thePlayer, "moto", "moto", 16 ) -- add the helmet
         removePlayerFromVehicle ( player )--force the player out of the vehicle
    end
        outputChatBox ( "Only policeman can enter police cars!", player ) --and tell the player why
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
end
addEventHandler ( "onVehicleExit", getRootElement(), removeHelmetOnExit )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
{{See also/Server event|Vehicle events}}
{{Event_functions}}

Latest revision as of 18:49, 29 November 2020

This event is triggered when a player or ped enters a vehicle.

Parameters

ped thePed, int seat, player jacked
  • thePed: a player or ped element who is entering the vehicle.
  • seat: an int representing the seat in which the ped is entering. Seat 0 is the driver's seat.
  • jacked: a player or ped element representing who has been jacked.

Source

The source of this event is the vehicle that was entered.

Example

Example 1: This example forces 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 ( thePlayer, seat, jacked ) -- when a player enters a vehicle
    if ( policeVehicles[getElementModel ( source )] ) and ( not policeSkins[getElementModel ( thePlayer )] ) then -- if the vehicle is one of 4 police cars, and the skin is not a police skin
        removePedFromVehicle ( thePlayer ) -- force the player out of the vehicle
        outputChatBox ( "Only policeman can enter police cars!", thePlayer ) -- and tell the player why
    end
end
addEventHandler ( "onVehicleEnter", getRootElement(), enterVehicle ) -- add an event handler for onVehicleEnter

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 (only works with players using CJ skin).

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 )

See Also

Vehicle events


Event functions