OnClientVehicleStartEnter: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
mNo edit summary
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
{{Client event}}
__NOTOC__
This event is triggered when a [[ped]] or [[player]] starts entering a vehicle. Once the entering animation completes, [[onClientVehicleEnter]] is triggered.


__NOTOC__
==Parameters==
This event is blahblah and is used for blahblah.
<syntaxhighlight lang="lua">
ped thePed, int seat, int door
</syntaxhighlight>
*'''thePed:''' the ped that just started entering a vehicle.
*'''seat:''' the number of the seat he is going to sit on.
*'''door:''' An integer of which door the ped used (0-3). 0 is driver side door, 1 is front passenger, 2 is back left, 3 is back right.
 
==Source==
The source of this event is the vehicle the ped is entering.


==Syntax==  
==Cancel effect==
<syntaxhighlight lang="lua">
This event can be [[Event system#Canceling|canceled]], but only for the local player or peds synced by the client. If cancelled, they will not begin to the enter the vehicle.
void onClientVehicleStartEnter ( player thePlayer, int seat )
 
</syntaxhighlight>  
==Example==
This example outputs if the local player is about to enter the drivers seat.
<syntaxhighlight lang="lua">addEventHandler("onClientVehicleStartEnter", root, function(player,seat,door)
if (player == localPlayer and seat == 0)then
outputChatBox("You are going to sit in the drivers seat.")
end
end)</syntaxhighlight>


==Example==  
==See Also==
This example does...
===Client vehicle events===
<syntaxhighlight lang="lua">
{{Client_vehicle_events}}
--This line does...
===Client event functions===
blabhalbalhb --abababa
{{Client_event_functions}}
--This line does this...
[[es:onClientVehicleStartEnter]]
mooo
</syntaxhighlight>

Latest revision as of 12:58, 29 November 2020

This event is triggered when a ped or player starts entering a vehicle. Once the entering animation completes, onClientVehicleEnter is triggered.

Parameters

ped thePed, int seat, int door
  • thePed: the ped that just started entering a vehicle.
  • seat: the number of the seat he is going to sit on.
  • door: An integer of which door the ped used (0-3). 0 is driver side door, 1 is front passenger, 2 is back left, 3 is back right.

Source

The source of this event is the vehicle the ped is entering.

Cancel effect

This event can be canceled, but only for the local player or peds synced by the client. If cancelled, they will not begin to the enter the vehicle.

Example

This example outputs if the local player is about to enter the drivers seat.

addEventHandler("onClientVehicleStartEnter", root, function(player,seat,door)
	if (player == localPlayer and seat == 0)then
		outputChatBox("You are going to sit in the drivers seat.")
	end
end)

See Also

Client vehicle events


Client event functions

Shared