OnPlayerStartEnterVehicle: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Event|Client|1.0}} {{FuncDescription|Called when a player presses the key to start entering a vehicle. You can return '''false''' in this event to stop the player from...")
 
mNo edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 3: Line 3:
{{FuncDescription|Called when a player presses the key to start entering a vehicle. You can return '''false''' in this event to stop the player from entering.}}
{{FuncDescription|Called when a player presses the key to start entering a vehicle. You can return '''false''' in this event to stop the player from entering.}}


{{FuncSyntax|OnPlayerStartEnterVehicle(vehicle)}}
{{FuncSyntax|OnPlayerStartEnterVehicle(vehicle, seat)}}
{{FuncParam|vehicle|The vehicle identifier.}}
{{FuncParam|vehicle|The vehicle identifier.}}
{{FuncParam|seat|The vehicle seat in which the player tries to get in.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
AddEvent("OnPlayerStartEnterVehicle", function(vehicleId, seatId)
    if seatId == 0 then
        print("Entered as a driver.")
    end
end)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
{{ClientEvents}}
{{VehicleClientEvents}}

Latest revision as of 08:42, 16 January 2020

OnPlayerStartEnterVehicle

Type: Event
Context: Client
Introduced: v1.0

Description

Called when a player presses the key to start entering a vehicle. You can return false in this event to stop the player from entering.

Syntax

OnPlayerStartEnterVehicle(vehicle, seat)
  • vehicle
    The vehicle identifier.
  • seat
    The vehicle seat in which the player tries to get in.

Example

AddEvent("OnPlayerStartEnterVehicle", function(vehicleId, seatId)
    if seatId == 0 then
        print("Entered as a driver.")
    end
end)

See also