OnVehicleStartEnter: Difference between revisions

Revision as of 14:45, 22 October 2007

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

Paramaters

player enteringPlayer, int seat, player jacked

Variables

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

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 ( "onVehicleEnter", getRootElement(), enterVehicle ) --add an event for onPlayerEnterVehicle

@@ Line 1: / Line 1: @@
 __NOTOC__
+{{Server event}}
 This event is triggered when a player starts to enter a vehicle. This event can be used to cancel entry, if necessary.
-==Syntax==
+==Paramaters==
 <syntaxhighlight lang="lua">
-void onVehicleStartEnter ( player player, int seat, player jacked )
+player enteringPlayer, int seat, player jacked
 </syntaxhighlight>
 ==Variables==
-*'''player''': 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
 *'''jacked''': A player element representing who is going to be jacked
+==Source==
+The [[event system#Event source|source]] of this event is the [[vehicle]] in which a player began to enter.
 ===Canceling===
@@ Line 17: / Line 20: @@
 ==Example==
-This example locks a police car if a player trying to enter is not a policeman
+This example blocks a player out of a police vehicle if he is not a policeman.
 <syntaxhighlight lang="lua">
---add an event for onVehicleStartEnter
+policeVehicles { [598]=true,[596]=true,[597]=true,[599]=true }
-addEventHandler ( "onVehicleStartEnter", getRootElement(), "playerStartEnter" )
+policeSkins { [280]=true,[281]=true,[282]=true,[283]=true,[284]=true,[285]=true,[286]=true }
-function playerStartEnter ( player, seat, jacked ) --when a player starts entering a vehicle
-if ( getVehicleName ( source ) == "police" ) and ( getPlayerSkin ( source ) > 279 ) then --if the vehicle is a police car, and the player's skin is higher than 279 i.e. a cop skin
+function enterVehicle ( player, seat, jacked ) --when a player enters a vehicle
-     setVehicleLocked ( source, false ) --open the 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
-else --if he's not a cop
+        cancelEvent()
-     setVehicleLocked ( source, true ) --lock the vehicle
+        outputChatBox ( "Only policeman can enter police cars!", player ) --and tell the player why
+    end
 end
+addEventHandler ( "onVehicleEnter", getRootElement(), enterVehicle ) --add an event for onPlayerEnterVehicle
 </syntaxhighlight>
 ==See Also==
 {{Event_functions}}