PlayerStartEnterVehicle: Difference between revisions

From RAGE Multiplayer Wiki
m (Replaced HTML with template)
No edit summary
Line 1: Line 1:
This event is triggered when a player starts to get into a vehicle. This event is cancellable.
This event is triggered when a player starts to get into a vehicle. This event is cancellable.
 
{{ServersideCsJsEvent}}
==Parameters==
{{JSContainer|
{{Parameters}}
* '''player'''  - player, which sits down (serverside only)
* '''player'''  - player, which sits down (serverside only)
* '''vehicle''' - vehicle in which the player sits.
* '''vehicle''' - vehicle in which the player sits.
* '''seat'''  - the place where he sits down.
* '''seat'''  - the place where he sits down.


==Example==
{{Example}}
This example outputs a chat message when a player gets into a vehicle.
This example outputs a chat message when a player gets into a vehicle.
{{ServersideCode|
<pre>
<pre>
function playerStartEnterVehicleHandler(player, vehicle, seat) {
function playerStartEnterVehicleHandler(player, vehicle, seat) {
Line 22: Line 21:
}}
}}


{{ClientsideCsJsEvent}}
{{CSharpContainer|
<syntaxhighlight lang="c#">
public delegate void OnPlayerStartEnterVehicleDelegate(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel);
</syntaxhighlight>
{{Parameters}}
* '''vehicle''' - vehicle '''RAGE.Elements.Vehicle'''
* '''seatId''' - the id of the seat, expects'''System.Int32'''
* '''cancel''' - cancel, expects '''RAGE.Events.CancelEventArgs'''
{{Example}}
The example below sends a message to client when they get in a vehicle, showing whether they are a driver or passenger.
<syntaxhighlight lang="c#">
Events.OnPlayerStartEnterVehicle += OnPlayerStartEnterVehicle;
</syntaxhighlight>
<syntaxhighlight lang="c#">
public void OnPlayerStartEnterVehicle(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>
// The player is not emmited client-side assuming it's you
// The player is not emmited client-side assuming it's you

Revision as of 11:44, 29 November 2018

This event is triggered when a player starts to get into a vehicle. This event is cancellable.

Server-Side
Event

 C#  JavaScript



JavaScript Syntax

Parameters

  • player - player, which sits down (serverside only)
  • vehicle - vehicle in which the player sits.
  • seat - the place where he sits down.

Example

This example outputs a chat message when a player gets into a vehicle.

function playerStartEnterVehicleHandler(player, vehicle, seat) {
   const playerName = player.name;
   const vehicleID = vehicle.id;

   mp.players.broadcast(`${playerName} started to get into the car ID: ${vehicleID}. Seat: ${seat}`);
}

mp.events.add("playerStartEnterVehicle", playerStartEnterVehicleHandler);


Client-Side Event

 C#  JavaScript


C# Syntax

public delegate void OnPlayerStartEnterVehicleDelegate(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel);

Parameters

  • vehicle - vehicle RAGE.Elements.Vehicle
  • seatId - the id of the seat, expectsSystem.Int32
  • cancel - cancel, expects RAGE.Events.CancelEventArgs

Example

The example below sends a message to client when they get in a vehicle, showing whether they are a driver or passenger.

Events.OnPlayerStartEnterVehicle += OnPlayerStartEnterVehicle;
public void OnPlayerStartEnterVehicle(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

// The player is not emmited client-side assuming it's you
function playerStartEnterVehicleHandler(vehicle, seat) {
   const vehicleID = vehicle.id;

   mp.game.graphics.notify(`You started to get into the car ID: ${vehicleID}. Seat: ${seat}`);
}

mp.events.add("playerStartEnterVehicle", playerStartEnterVehicleHandler);


See also

Checkpoint

Colshape

Entity

Player

Streaming

Vehicle

Waypoint