OnClientVehicleEnter: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
{{Client event}}
{{Client event}}
__NOTOC__
__NOTOC__
This event gets fired when a player or ped enters a vehicle.
This event gets fired when a [[player]] or [[ped]] enters a vehicle.


==Parameters==
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
player thePlayer, int seat
player thePed, int seat
</syntaxhighlight>
</syntaxhighlight>
*'''thePlayer:''' the [[player]] or [[ped]] that entered the vehicle
*'''thePed:''' the [[player]] or [[ped]] that entered the vehicle
*'''seat:''' the number of the seat that the player is now sitting on. 0 = driver, higher numbers are passenger seats.
*'''seat:''' the number of the seat that the ped is now sitting on. 0 = driver, higher numbers are passenger seats.


==Source==
==Source==
The [[event system#Event source|source]] of the event is the [[vehicle]] that the player entered.
The [[event system#Event source|source]] of the event is the [[vehicle]] that the ped entered.


==Example==
==Example==

Revision as of 12:55, 29 November 2020

This event gets fired when a player or ped enters a vehicle.

Parameters

player thePed, int seat
  • thePed: the player or ped that entered the vehicle
  • seat: the number of the seat that the ped is now sitting on. 0 = driver, higher numbers are passenger seats.

Source

The source of the event is the vehicle that the ped entered.

Example

This code updates a GUI label with the name of the vehicle the local player is in.

lblVehicle = guiCreateLabel(10, 200, 150, 20, "Currently on foot", false)
addEventHandler("onClientVehicleEnter", getRootElement(),
    function(thePlayer, seat)
        if thePlayer == getLocalPlayer() then
            guiSetText(lblVehicle, "Currently in a " .. getVehicleName(source))
        end
    end
)
addEventHandler("onClientVehicleExit", getRootElement(),
    function(thePlayer, seat)
        if thePlayer == getLocalPlayer() then
            guiSetText(lblVehicle, "Currently on foot")
        end
    end
)

This example disables helikills & blade collisions upon entering a heli

function onHeliEnter()
   if getVehicleType(source) == "Helicopter" then
           setHeliBladeCollisionsEnabled (source, false)
    end
end
addEventHandler ("onClientVehicleEnter", root, onHeliEnter)

See Also

Client vehicle events


Client event functions