PlayerStartEnterVehicle: Difference between revisions

From RAGE Multiplayer Wiki
mNo edit summary
mNo edit summary
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This event is triggered when a player starts to get into a vehicle. This event is cancellable (Eg. Using the cancel property [this.cancel = true]).
This event is triggered when a player starts to get into a vehicle. This event is cancellable.


==Parameters==
{{ServersideJsEvent}}
* '''player'''  - player, which sits down (serverside only)
* '''vehicle''' - vehicle in which the player sits.
* '''seat'''  - the place where he sits down.


==Example==
{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - player, which sits down (serverside only)
* '''vehicle''': {{RageType|Vehicle}} - vehicle in which the player sits.
* '''seat''': {{RageType|Number}} - the place where he sits down.
 
{{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.
 
<pre>
{{ServerSide}}
<syntaxhighlight lang="javascript" style="width: 98%; background-color: #E4F1FE;">
function playerStartEnterVehicleHandler(player, vehicle, seat) {
function playerStartEnterVehicleHandler(player, vehicle, seat) {
   const playerName = player.name;
   const playerName = player.name;
Line 19: Line 20:


mp.events.add("playerStartEnterVehicle", playerStartEnterVehicleHandler);
mp.events.add("playerStartEnterVehicle", playerStartEnterVehicleHandler);
</pre>
}}
{{ClientsideCsJsEvent}}
{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerStartEnterVehicleDelegate(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel);
</syntaxhighlight>
</syntaxhighlight>
{{Parameters}}
* '''vehicle''' - vehicle '''RAGE.Elements.Vehicle'''
* '''seatId''' - the id of the seat, expects'''System.Int32'''
* '''cancel''' - cancel, expects '''RAGE.Events.CancelEventArgs'''


{{ClientSide}}
{{Example}}
<syntaxhighlight lang="javascript" style="width: 98%; background-color: #E4F1FE;">
The example below sends a message to client when they start to get in a vehicle, showing whether they are a driver or passenger.
 
<syntaxhighlight lang="csharp">
Events.OnPlayerStartEnterVehicle += OnPlayerStartEnterVehicle;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerStartEnterVehicle(RAGE.Elements.Vehicle vehicle, int seatId, RAGE.Events.CancelEventArgs cancel)
{
    if (seatId == -1)
    {
        RAGE.Chat.Output("You started to get in the driver's seat");
    }
    else
    {
        RAGE.Chat.Output("You started to get in a passenger seat");
    }
}
</syntaxhighlight>
}}
 
{{JSContainer|
<pre>
// The player is not emmited client-side assuming it's you
// The player is not emmited client-side assuming it's you
function playerStartEnterVehicleHandler(vehicle, seat) {
function playerStartEnterVehicleHandler(vehicle, seat) {
Line 31: Line 65:


mp.events.add("playerStartEnterVehicle", playerStartEnterVehicleHandler);
mp.events.add("playerStartEnterVehicle", playerStartEnterVehicleHandler);
</syntaxhighlight>
</pre>
}}


==See also==
==See also==
{{Player_events}}
{{Player_events}}
[[Category:Player]]
[[Category:Vehicle]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

Latest revision as of 14:09, 23 May 2019

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

Server-Side
Event

 JavaScript



JavaScript Syntax

Parameters

  • player: Player - player, which sits down (serverside only)
  • vehicle: Vehicle - vehicle in which the player sits.
  • seat: Number - 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 start to 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 started to get in the driver's seat");
    }
    else
    {
        RAGE.Chat.Output("You started to get 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

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