PlayerEnterVehicle

2019-08-19T00:49:19Z

Mentanding:

This event is triggered when a player entered vehicle.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerEnterVehicle on GTA Network Wiki].
}}

{{JSContainer|
*'''Known issue''': Client side this event is triggered when the player starts to enter the vehicle and not once they've completely sat down. This also causes the seat parameter to return 'undefined'.

{{Parameters}}
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] which entered vehicle.
* '''vehicle''': {{RageType|Vehicle}} - The current [[:Category:Vehicle API|vehicle]] the player is sitting in.
* '''seat''': {{RageType|Number}} - The seat ID the player sits down on.

{{Example}}
This example outputs chat message, when player is in the car.
<pre>
function playerEnterVehicleHandler(player, vehicle, seat) {
mp.gui.chat.push(`${player.name} got into the car with ID: ${vehicle.id}. Seat: ${seat}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</pre>
}}

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerEnterVehicleDelegate(Vehicle vehicle, int seatId);
</syntaxhighlight>
{{Parameters}}
* '''vehicle''' - vehicle '''RAGE.Elements.Vehicle'''
* '''seatId''' - the id of the seat, expects'''System.Int32'''

{{Example}}
The example below sends a chat message to play when they enter a vehicle, showing whether they are driver or passenger.

<syntaxhighlight lang="csharp">
Events.OnPlayerEnterVehicle += OnPlayerEnterVehicle;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerEnterVehicle(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel)
{
if (seatId == -1)
{
RAGE.Chat.Output("You got in the driver's seat");
}
else
{
RAGE.Chat.Output("You got in a passenger seat");
}
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''vehicle''': {{RageType|Vehicle}} - The current [[:Category:Vehicle API|vehicle]] the player entered.
* '''seat''': {{RageType|Number}} - The seat ID the player sits down on.

{{Example}}
<pre>
function playerEnterVehicleHandler(vehicle, seat) {
mp.gui.chat.push(`You got into the car with ID: ${vehicle.id}. Seat: ${seat}`);
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Vehicle]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

RAGE Multiplayer Wiki - User contributions [en]

PlayerEnterVehicle