PlayerEnterVehicle: Difference between revisions

From RAGE Multiplayer Wiki
m (Replaced HTML with template)
No edit summary
Line 1: Line 1:
__NOTOC__
This event is triggered when a player is in the car.
This event is triggered when a player is in the car.


{{ServersideCsJsEvent}}
{{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'.
*'''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'''
* '''vehicle''' - The current vehicle the player is sitting in.
* '''vehicle''' - The current vehicle the player is sitting in.
* '''seat'''  - The seat ID the player sits down on.
* '''seat'''  - The seat ID the player sits down on.


==Example==
{{Example}}
This example outputs chat message, when player is in the car.
This example outputs chat message, when player is in the car.
{{ServersideCode|
<pre>
<pre>
function playerEnterVehicleHandler(player, vehicle, seat) {
function playerEnterVehicleHandler(player, vehicle, seat) {
Line 22: Line 21:
}}
}}


{{ClientsideCsJsEvent}}
{{CSharpContainer|
<syntaxhighlight lang="c#">
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 does nothing on invoke of event
<syntaxhighlight lang="c#">
Events.OnPlayerEnterVehicle += OnPlayerEnterVehicle;
</syntaxhighlight>
<syntaxhighlight lang="c#">
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>
}}


{{ClientsideCode|
{{JSContainer|
<pre>
<pre>
function playerEnterVehicleHandler(vehicle, seat) {
function playerEnterVehicleHandler(vehicle, seat) {

Revision as of 13:44, 29 November 2018

This event is triggered when a player is in the car.

Server-Side
Event

 C#  JavaScript



JavaScript Syntax

  • 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
  • vehicle - The current vehicle the player is sitting in.
  • seat - 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 does nothing on invoke of event 

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

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=16326"