Difference between revisions of "OnVehicleStartEnter"

From Multi Theft Auto: Wiki
m
(Added before 1.0 template and from 1.0 template)
Line 3: Line 3:
 
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 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">
 +
player enteringPlayer, int seat, player jacked
 +
</syntaxhighlight>
 +
}}
 +
{{New feature|3|1.0|
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
player enteringPlayer, int seat, player jacked, int door
 
player enteringPlayer, int seat, player jacked, int door
</syntaxhighlight>  
+
</syntaxhighlight>}}
  
 
*'''enteringPlayer''': A player element representing the player who is starting to enter a vehicle
 
*'''enteringPlayer''': A player element representing the player who is starting to enter a vehicle
 
*'''seat''': An integer representing the seat in which the player is entering
 
*'''seat''': An integer representing the seat in which the player is entering
 
*'''jacked''': A player element representing who is going to be jacked
 
*'''jacked''': A player element representing who is going to be jacked
*'''door''': An integer of which door the player used (0-3). 0 is driver side door, 1 is front passenger, 2 is back right, 3 is back left.
+
*{{New feature|3|1.0|'''door''': An integer of which door the player used (0-3). 0 is driver side door, 1 is front passenger, 2 is back right, 3 is back left.}}
  
 
==Source==
 
==Source==

Revision as of 14:28, 24 April 2009

This event is triggered when a player starts to enter a vehicle. This event can be used to cancel entry, if necessary.

Parameters

player enteringPlayer, int seat, player jacked, int door
  • enteringPlayer: A player element representing the player who is starting to enter a vehicle
  • seat: An integer representing the seat in which the player is entering
  • jacked: A player element representing who is going to be jacked
  • door: An integer of which door the player used (0-3). 0 is driver side door, 1 is front passenger, 2 is back right, 3 is back left.

Source

The source of this event is the vehicle in which a player began to enter.

Canceling

If this event is canceled, the player 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[getVehicleID ( source )] ) and ( not policeSkins[getPlayerSkin ( 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

Event functions