Skip to content

OnPlayerEnterVehicleSeat

This function triggers when a player enters a specific seat in a vehicle. This provides more granular control than OnPlayerEnterVehicle, allowing you to differentiate between driver and passenger seats.

Syntax

export function OnPlayerEnterVehicleSeat(
    eventPlayer: mod.Player,
    eventVehicle: mod.Vehicle,
    eventSeat: mod.Object
): void;

Parameters

Parameter Type Description
eventPlayer mod.Player The player who entered the vehicle seat
eventVehicle mod.Vehicle The vehicle containing the seat
eventSeat mod.Object The specific seat object that was entered

Example

export function OnPlayerEnterVehicleSeat(
    eventPlayer: mod.Player,
    eventVehicle: mod.Vehicle,
    eventSeat: mod.Object
) {
  const seatNum = mod.GetPlayerVehicleSeat(eventPlayer);
  // Display message stating if player is driver or passenger
  if (seatNum == 0) {
    const msg = mod.Message(mod.stringkeys.veh_driver, eventPlayer);
    mod.DisplayNotificationMessage(msg, eventPlayer);
  } else {
    const msg = mod.Message(mod.stringkeys.veh_pax, eventPlayer);
    mod.DisplayNotificationMessage(msg, eventPlayer);
  }
}

{
  "veh_driver": "{} is now the driver.",
  "veh_pax": "{} is a passenger."
}

Screen recording of player changing seats

See Also