PlayerEnterVehicle: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
No edit summary
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This event is triggered when a player is in the car.
This event is triggered when a player entered vehicle.


{{ServersideCsJsEvent}}
{{ServersideCsJsEvent}}
{{CSharpContainer|1=
See [[OnPlayerEnterVehicle]].
}}
{{JSContainer|
{{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}}
{{Parameters}}
* '''player'''
* '''player''': {{RageType|Player}} - The [[:Category:Player API|player]] which entered vehicle.
* '''vehicle''' - The current vehicle the player is sitting in.
* '''vehicle''': {{RageType|Vehicle}} - The current [[:Category:Vehicle API|vehicle]] the player is sitting in.
* '''seat''' - The seat ID the player sits down on.
* '''seat''': {{RageType|Number}} - The seat ID the player sits down on.


{{Example}}
{{Example}}
Line 22: Line 25:


{{ClientsideCsJsEvent}}
{{ClientsideCsJsEvent}}
{{CSharpContainer|
{{CSharpContainer|
<syntaxhighlight lang="c#">
<syntaxhighlight lang="csharp">
public delegate void OnPlayerEnterVehicleDelegate(Vehicle vehicle, int seatId);
public delegate void OnPlayerEnterVehicleDelegate(Vehicle vehicle, int seatId);
</syntaxhighlight>
</syntaxhighlight>
Line 31: Line 35:


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


<syntaxhighlight lang="c#">
<syntaxhighlight lang="csharp">
Events.OnPlayerEnterVehicle += OnPlayerEnterVehicle;
Events.OnPlayerEnterVehicle += OnPlayerEnterVehicle;
</syntaxhighlight>
</syntaxhighlight>
<syntaxhighlight lang="c#">
<syntaxhighlight lang="csharp">
public void OnPlayerEnterVehicle(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel)
public void OnPlayerEnterVehicle(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel)
{
{
Line 52: Line 56:


{{JSContainer|
{{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>
<pre>
function playerEnterVehicleHandler(vehicle, seat) {
function playerEnterVehicleHandler(vehicle, seat) {
Line 63: Line 72:
==See also==
==See also==
{{Player_events}}
{{Player_events}}
[[Category:Player]]
[[Category:Vehicle]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

Latest revision as of 19:01, 15 May 2024

This event is triggered when a player entered vehicle.

Server-Side
Event

 C#  JavaScript




C# Syntax


JavaScript Syntax

Parameters

  • player: Player - The player which entered vehicle.
  • vehicle: Vehicle - The current vehicle the player is sitting in.
  • seat: Number - The seat ID the player sits down on.

Example

This example outputs chat message, when player is in the car. 

function playerEnterVehicleHandler(player, vehicle, seat) {
	player.outputChatBox(`${player.name} got into the car with ID: ${vehicle.id}. Seat: ${seat}`);
}
 
mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);


Client-Side Event

 C#  JavaScript



C# Syntax

public delegate void OnPlayerEnterVehicleDelegate(Vehicle vehicle, int seatId);

Parameters

  • vehicle - vehicle RAGE.Elements.Vehicle
  • seatId - the id of the seat, expectsSystem.Int32

Example

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

Events.OnPlayerEnterVehicle += OnPlayerEnterVehicle;

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");
    }
}


JavaScript Syntax

Parameters

  • vehicle: Vehicle - The current vehicle the player entered.
  • seat: Number - The seat ID the player sits down on.

Example

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

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);


See also

Checkpoint

Colshape

Entity

Player

Streaming

Vehicle

Waypoint

Retrieved from "https://wiki.rage.mp/w/index.php?title=PlayerEnterVehicle&oldid=25460"