RAGE Multiplayer Wiki - User contributions [en]

Vehicle::getTrailer

2017-09-20T14:54:47Z

CurtisVL: Fix

Returns the trailer of a vehicle.

'''This function is being updated, it might not work correctly in the current version!'''
==Syntax==
<syntaxhighlight lang="javascript">vehicle.getTrailer(vehicle);</syntaxhighlight>
=== Required Arguments ===
*'''vehicle:''' Vehicle handle
===Return value===
*'''Vehicle'''
==Example==
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
</div>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::getTrailer

2017-09-20T14:54:09Z

CurtisVL: Corrected errors

Gets the trailer of a vehicle and puts it into the trailer parameter.
'''This function is being updated, it might not work correctly in the current version!'''
==Syntax==
<syntaxhighlight lang="javascript">vehicle.getTrailer(vehicle);</syntaxhighlight>
=== Required Arguments ===
*'''vehicle:''' Vehicle handle
===Return value===
*'''Vehicle'''
==Example==
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
</div>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Entity::id

2017-09-20T10:12:23Z

CurtisVL: Fixed grammar

This property is used for getting an entity ID. The ID is a unique identifier for the entity.

==Getter==
* '''<span style="color:#008017>Number</span>'''

== Example ==
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
const playerID = mp.players.at(1).id;
console.log(playerID); // Player ID, e.g. 1 ( ??? )
</syntaxhighlight>
</div>

==See Also==
{{Entity_block}}

Pool::at

2017-09-20T10:10:50Z

CurtisVL: Updated example border

This function is used to return an element from a pool at an ID.

==Syntax==
<syntaxhighlight lang="javascript">
void pool.at(int ID)
</syntaxhighlight>

===Required Arguments===
*'''ID:''' Element ID, what you need get from the pool.

==Example==
This example will return a player by ID and output his name in the console.

<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
let player = mp.players.at(1488);
if (player) {
console.log(`Player with id 1488 have nickname ${player.name}`);
} else {
console.log(`Player by id 1488 does not exists...`);
};
</syntaxhighlight>
</div>

==See Also==
{{EntityPool_function}}

Pool::forEach

2017-09-20T10:08:54Z

CurtisVL: Small fix

This function is used for calling a function for each element in a pool.

==Syntax==
<syntaxhighlight lang="javascript">
void pool.forEach(function callingFunction);
</syntaxhighlight>
===Required Arguments===
*'''callingFunction:''' Function, what will be called.

==Example #1==
This example will generate text with all player nicknames.

<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
let getNicknamesText = () => {
let text = ``;
mp.players.forEach(
(player, id) => {
text = text == `` ? player.name : `${text} , ${player.name}`;
}
);
return text;
};

let blahBlah = getNicknamesText();
console.log(blahBlah != `` ? blahBlah : `Server not have players.`);
</syntaxhighlight>
</div>

==Example #2==
This example will add a command to remove all server vehicles by forEach.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
mp.events.addCommand(`removeAll`,
(player) => {
mp.vehicles.forEach(
(vehicle) => {
vehicle.destroy();
}
);
mp.players.broadcast(`${player.name} DESTROY ALL CARS!`);
}
);
</syntaxhighlight>
</div>

==See Also==
{{EntityPool_function}}

Pool::forEach

2017-09-20T10:08:13Z

CurtisVL: Updated example borders, fixed English

This function is used for calling a function for each element a in pool.

==Syntax==
<syntaxhighlight lang="javascript">
void pool.forEach(function callingFunction);
</syntaxhighlight>
===Required Arguments===
*'''callingFunction:''' Function, what will be called.

==Example #1==
This example will generate text with all player nicknames.

<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
let getNicknamesText = () => {
let text = ``;
mp.players.forEach(
(player, id) => {
text = text == `` ? player.name : `${text} , ${player.name}`;
}
);
return text;
};

let blahBlah = getNicknamesText();
console.log(blahBlah != `` ? blahBlah : `Server not have players.`);
</syntaxhighlight>
</div>

==Example #2==
This example will add a command to remove all server vehicles by forEach.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
mp.events.addCommand(`removeAll`,
(player) => {
mp.vehicles.forEach(
(vehicle) => {
vehicle.destroy();
}
);
mp.players.broadcast(`${player.name} DESTROY ALL CARS!`);
}
);
</syntaxhighlight>
</div>

==See Also==
{{EntityPool_function}}

Pool::forEachInRange

2017-09-20T10:06:05Z

CurtisVL: Small fix

This function is used for calling a function for each element in a pool, but only if it in range of position.

==Syntax==
<syntaxhighlight lang="javascript">
void pool.forEachInRange(Vector3 position, int range [, int dimension], function callingFunction);
</syntaxhighlight>

===Required Arguments===
*'''callingFunction:''' Function, what will be called.

==Example==
This example will generate an array of vehicles within 100 units of the player (game distance, meters).

<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
let getVehiclesNearbyMe = (player) => {
const returnVehicles = [];

mp.vehicles.forEachInRange(player.position, 100,
(vehicle) => {
returnVehicles.push(vehicle);
}
);

return returnVehicles;
};

let vehiclesNearbyMe = getVehiclesNearbyMe(mp.players.at(0));
console.log(`Vehicles nearby me: x${vehiclesNearbyMe.length}`);
</syntaxhighlight>
</div>

==See Also==
{{EntityPool_function}}

Pool::forEachInRange

2017-09-20T10:05:18Z

CurtisVL: Fixed some English, and fixed example border

This function is used for calling a function for each element in a pool, but only if it in range of position.

==Syntax==
<syntaxhighlight lang="javascript">
void pool.forEachInRange(Vector3 position, int range [, int dimension], function callingFunction);
</syntaxhighlight>

===Required Arguments===
*'''callingFunction:''' Function, what will be called.

==Example #1==
That's example will generate an array with vehicles within 100 units of the player (game distance, meters).

<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
let getVehiclesNearbyMe = (player) => {
const returnVehicles = [];

mp.vehicles.forEachInRange(player.position, 100,
(vehicle) => {
returnVehicles.push(vehicle);
}
);

return returnVehicles;
};

let vehiclesNearbyMe = getVehiclesNearbyMe(mp.players.at(0));
console.log(`Vehicles nearby me: x${vehiclesNearbyMe.length}`);
</syntaxhighlight>
</div>

==See Also==
{{EntityPool_function}}

Pool::toArray

2017-09-20T10:02:03Z

CurtisVL: Updated example border

This function converts a pool to a [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array JavaScript array].

==Syntax==
<syntaxhighlight lang="javascript">
pool.toArray();
</syntaxhighlight>

==Example==
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
var suchJavascript = mp.players.toArray();
if(suchJavascript.every((player) => { return player.isAiming; } ))
console.log("everyone are aiming");
</syntaxhighlight>
</div>

Entity::model

2017-09-20T10:01:06Z

CurtisVL: Fixed incorrect colours on example

This property is used for setting or getting an entity's model.

==Getter==
* '''<span style="color:#008017">Number</span>'''
==Setter==
* '''<span style="color:#008017">Number</span>'''

== Example ==
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
const model = player.model;
console.log(model) // return e.g. 867126926
player.model = mp.joaat('player_zero');
</syntaxhighlight>
</div>

<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
const model = player.model;
alert(model) // return e.g. 867126926
player.model = mp.game.joaat('player_zero');
</syntaxhighlight>
</div>

==See Also==
{{Entity_block}}

Pool::length

2017-09-20T09:59:07Z

CurtisVL: Fixed bad English, updated example border

This property is used to get the element count of a pool.

'''Note: this property is read-only.'''

==Syntax==
<syntaxhighlight lang="javascript">
int pool.length;
</syntaxhighlight>

==Example==
This example will return vehicles and players count.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
let getStuffCount = () => {
return [mp.players.length, mp.vehicles.length];
};

let [players, vehicles] = getStuffCount();
console.log(`Server have ${vehicles} vehicles and ${players} players.`)
</syntaxhighlight>
</div>

==See Also==
{{EntityPool_function}}

Pool::forEachInDimension

2017-09-18T20:44:30Z

CurtisVL: Fix

This function is used to call a function for each elements in the pool.

==Syntax==
<syntaxhighlight lang="javascript">
void pool.forEachInDimension(int dimension, function callingFunction);
</syntaxhighlight>
===Required Arguments===
*'''Dimension:''' Int, dimension
*'''callingFunction:''' Function, what will be called.

==Example==
This example will print the names of players in dimension 0 to the server console. (Dimension 0 is the default dimension)
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
mp.players.forEachInDimension(0, (player, id) => {
console.log("Player: " + player.name);
});
</syntaxhighlight>
</div>

==See Also==
{{EntityPool_function}}

Pool::forEachInDimension

2017-09-18T20:44:07Z

CurtisVL: Initial description

This function is used to call a function for each elements in the pool.

==Syntax==
<syntaxhighlight lang="javascript">
void pool.forEachInDimension(int dimension, function callingFunction);
</syntaxhighlight>
===Required Arguments===
*'''Dimension:''' Dimension
*'''callingFunction:''' Function, what will be called.

==Example==
This example will print the names of players in dimension 0 to the server console. (Dimension 0 is the default dimension)
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
mp.players.forEachInDimension(0, (player, id) => {
console.log("Player: " + player.name);
});
</syntaxhighlight>
</div>

==See Also==
{{EntityPool_function}}

Entity::dimension

2017-09-18T20:31:36Z

CurtisVL: Fixed English

This property used for setting or getting an entity's dimension. The dimension determines who the entity is visible to.

==Getter==
* '''<span style="color:#008017">Number</span>'''
==Setter==
* '''<span style="color:#008017">Number</span>'''

== Example ==
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
let dimension = player.dimension;
player.dimension = 2; // set player dimension to 2
</syntaxhighlight>
</div>
==See Also==
{{Entity_block}}

PlayerExitColshape

2017-09-18T20:25:18Z

CurtisVL: Added client-side example

This event is triggered when a player exits a colshape.

==Parameters==
* '''player''' - player which exited the colshape
* '''shape''' - the colshape the player left

==Example==
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);

function playerExitColshapeHandler(player, shape) {
if(shape == someColShape) {
console.log(player.name + " left the colshape!");
}
}

mp.events.add("playerExitColshape", playerExitColshapeHandler);
</syntaxhighlight>
</div>

<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);

function playerExitColshapeHandler(shape) {
if(shape == someColShape) {
//Local player left the colshape
}
}

mp.events.add("playerExitColshape", playerExitColshapeHandler);
</syntaxhighlight>
</div>

==See also==
{{Player_events}}

PlayerEnterColshape

2017-09-18T20:23:06Z

CurtisVL: Added client-side example

This event is triggered when a player enters a colshape.

==Parameters==
* '''player''' - player which entered the colshape
* '''shape''' - the colshape the player entered

==Example==
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);

function playerEnterColshapeHandler(player, shape) {
if(shape == someColShape) {
console.log(player.name + " entered the colshape!");
}
}

mp.events.add("playerEnterColshape", playerEnterColshapeHandler);
</syntaxhighlight>
</div>

<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);

function playerEnterColshapeHandler(shape) {
if(shape == someColShape) {
//Local player entered the colshape
}
}

mp.events.add("playerEnterColshape", playerEnterColshapeHandler);
</syntaxhighlight>
</div>

==See also==
{{Player_events}}

PlayerJoin

2017-09-18T20:04:41Z

CurtisVL: Fixed some English, and updated border around Example

This event is triggered when a player joins the server.

==Parameters==
* '''player''' - player which joined the server.

==Example==
This example outputs chat message, when player joins to the server.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
function playerJoinHandler(player) {
console.log(player.name + " join.");
}

mp.events.add("playerJoin", playerJoinHandler);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerQuit

2017-09-18T20:03:30Z

CurtisVL: Fixed some English, and updated border around Example

This event is triggered when a player quits the server.

==Parameters==
* '''player''' - player, which quit from the server
* '''exitType ''' - exit types:
**''disconnect''
**''timeout''
**''kicked''
* '''reason''' - kick reason

==Example==
This example outputs chat message, when player quits or kicked from the server.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript" style="width: 98%; background-color: #E4F1FE;">
function playerQuitHandler(player, exitType, reason) {
if (exitType != "kicked") {
var str = player.name + " quit.";
} else {
var str = player.name + " kicked. Reason: " + reason + ".";
}
console.log(str);
}

mp.events.add("playerQuit", playerQuitHandler);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerDeath

2017-09-18T20:00:52Z

CurtisVL: Made example look cooler

This event is triggered when a player dies.

==Parameters==
* '''player''' - player, which died.
* '''reason ''' - cause of death player:
* '''killer''' - he who killed the player.

==Example==
This example outputs chat message, when player dies.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript" style="width: 98%; background-color: #E4F1FE;">
function playerDeathHandler(player, reason, killer) {
const deathName = player.name
const killerName = killer.name
const srt = killerName + " killed: " + deathName + " Reason: " + reason
mp.players.broadcast(str)
}

mp.events.add("playerDeath", playerDeathHandler);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerSpawn

2017-09-18T20:00:26Z

CurtisVL: Made example look cooler

This event is triggered when a player spawns.

==Parameters==
* '''player''' - player, which has spawned

==Example==
This example outputs a console chat message, when a player spawns.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
function playerSpawn(player) {
console.log(player.name + " has spawned");
}

mp.events.add("playerSpawn", playerSpawn);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerChat

2017-09-18T19:59:53Z

CurtisVL: Fix the bad English. ;)

This event is triggered when a player send a message in the chat.

==Parameters==
* '''player''' - player, who send message
* '''text''' - the text that was sent

==Example==
This example will kick a player if his nickname is "Modernß" and he types "хай гэрлз" in chat.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>

<syntaxhighlight lang="javascript">
let checkChatMessage = (player, text) => {
let playerNickname = player.name;
if ((playerNickname == "Modernß") && (text == "хай гэрлз")) {
player.kick();
};
};

mp.events.add(
{
"playerChat": checkChatMessage
}
);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerChat

2017-09-18T19:59:23Z

CurtisVL: Fix the bad English. ;)

This event is triggered when player send message in the chat.

==Parameters==
* '''player''' - player, who send message
* '''text''' - the text that was sent

==Example==
This example will kick a player if his nickname is "Modernß" and he types "хай гэрлз" in chat.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>

<syntaxhighlight lang="javascript">
let checkChatMessage = (player, text) => {
let playerNickname = player.name;
if ((playerNickname == "Modernß") && (text == "хай гэрлз")) {
player.kick();
};
};

mp.events.add(
{
"playerChat": checkChatMessage
}
);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerChat

2017-09-18T19:58:26Z

CurtisVL: Made example look cooler

This event is triggered when player send message in the chat.

==Parameters==
* '''player''' - player, who send message.
* '''text''' - sent text. (Rly? Wow)

==Example==
This example will kick a player if his nickname is "Modernß" and he types "хай гэрлз" in chat.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>

<syntaxhighlight lang="javascript">
let checkChatMessage = (player, text) => {
let playerNickname = player.name;
if ((playerNickname == "Modernß") && (text == "хай гэрлз")) {
player.kick();
};
};

mp.events.add(
{
"playerChat": checkChatMessage
}
);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerEnterVehicle

2017-09-18T19:56:10Z

CurtisVL: Made example look cooler

This event is triggered when a player started get into vehicle.

==Parameters==
* '''player''' - player, which sits down.
* '''vehicle''' - vehicle in which the player sits.
* '''seat''' - the place where he sits down.

==Example==
This example outputs chat message, when player get into vehicle.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript" style="width: 98%; background-color: #E4F1FE;">
function playerEnterVehicleHandler(player, vehicle, seat) {
const playerName = player.name
const vehicleID = vehicle.id
const srt = playerName + " tarted to get into the car ID: " + vehicleID + " Seat: " + seat
mp.players.broadcast(str)
}

mp.events.add("playerEnterVehicle", playerEnterVehicleHandler);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerEnteredVehicle

2017-09-18T19:54:39Z

CurtisVL: Made example look cooler

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

==Parameters==
* '''player''' - player, which sits down.
* '''vehicle''' - vehicle in which the player sits.

==Example==
This example outputs chat message, when player is in the car.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript" style="width: 98%; background-color: #E4F1FE;">
function playerEnteredVehicleHandler(player, vehicle) {
const playerName = player.name
const vehicleID = vehicle.id
const srt = playerName + " got into the car: " + vehicleID
mp.players.broadcast(str)
}

mp.events.add("playerEnteredVehicle", playerEnteredVehicleHandler);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerStartExitVehicle

2017-09-18T19:53:47Z

CurtisVL: /* Example */

==Parameters==
* '''player''' - player, which left car
==Example==
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript" style="width: 98%; background-color: #E4F1FE;">
function playerExitVehicle(player) {
const playerName = player.name
const srt = playerName + " left the car"
mp.players.broadcast(str)
}

mp.events.add("playerExitVehicle", playerExitVehicle);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerLeftVehicle

2017-09-18T19:52:23Z

CurtisVL: Made example look cooler

This event is triggered when a player lefts a vehicle.

==Parameters==
* '''player''' - player, which left the vehicle
* '''vehicle''' - vehicle, which was left by the player.

==Example==
This example outputs a console chat message, when player lefts a vehicle.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<syntaxhighlight lang="javascript">
function playerLeftVehicle(player, vehicle) {
console.log(player.name + " left " + vehicle.id);
}

mp.events.add("playerLeftVehicle", playerLeftVehicle);
</syntaxhighlight>
</div>

==See also==
[[Category:Player Events API]]

PlayerExitColshape

2017-09-18T19:51:32Z

CurtisVL: Made example look cooler

PlayerEnterColshape

2017-09-18T19:49:42Z

CurtisVL: /* Example */

PlayerExitColshape

2017-09-18T19:45:26Z

CurtisVL: Initial description

This event is triggered when a player exits a colshape.

==Parameters==
* '''player''' - player which exited the colshape
* '''shape''' - the colshape the player left

==Example==
<syntaxhighlight lang="javascript">
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);

function playerExitColshapeHandler(player, shape) {
if(shape == someColShape) {
console.log(player.name + " left the colshape!");
}
}

mp.events.add("playerExitColshape", playerExitColshapeHandler);
</syntaxhighlight>

==See also==
[[Category:Player Events API]]

PlayerEnterColshape

2017-09-18T19:41:07Z

CurtisVL: Initial description

This event is triggered when a player enters a colshape.

==Parameters==
* '''player''' - player which entered the colshape
* '''shape''' - the colshape the player entered

==Example==
<syntaxhighlight lang="javascript">
let someColShape = mp.colshapes.newRectangle(0, 0, 100, 100);

function playerEnterColshapeHandler(player, shape) {
if(shape == someColShape) {
console.log(player.name + " entered the colshape!");
}
}

mp.events.add("playerEnterColshape", playerEnterColshapeHandler);
</syntaxhighlight>

==See also==
[[Category:Player Events API]]