RAGE Multiplayer Wiki - User contributions [en]

Pool::at

2017-05-07T07:12:53Z

Niks:

This function used for return element from pool at ID.

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

==Example==
That's example will return player by ID and output his name in console.

<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>

==See Also==
{{EntityPool_function}}

Vector3::Vector3

2017-04-13T19:20:41Z

Niks: /* Syntax */

This function create a vector object.
== Syntax ==
<syntaxhighlight lang="javascript">
let vector = new mp.Vector3(Number x, Number y, Number z)
</syntaxhighlight>

Vector3::Vector3

2017-04-13T19:16:52Z

Niks: /* Syntax */

This function create a vector object.
== Syntax ==
<syntaxhighlight lang="javascript">
let vector = new mp.Vector3(Number x, Number y, Number z) JORIK
</syntaxhighlight>

PlayerJoin

2017-01-10T13:54:06Z

Niks: /* Example */

This event is triggered when a player joins the server.

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

==Example==
This example outputs chat message, when player joins to the server.
<syntaxhighlight lang="javascript">
function playerJoinHandler(player) {
console.log(player.name + " join.");
}

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

Vehicle::brake

2017-01-06T21:35:41Z

Niks:

This property returns brake state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let brakeUsing = vehicle.brake
</source>

Vehicle::brake

2017-01-05T19:12:44Z

Niks: Created page with "This property returns brake state. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let brakeUsing = vehicle.brakeUsing </source>"

This property returns brake state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let brakeUsing = vehicle.brakeUsing
</source>

Vehicle::rocketBoost

2017-01-05T19:12:19Z

Niks: Created page with "This property returns rocket boost state (voltic2). '''Note: this property is read-only.''' == Example == <source lang="javascript"> let rocketBoost = vehicle.rocketBoost </s..."

This property returns rocket boost state (voltic2).

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let rocketBoost = vehicle.rocketBoost
</source>

Vehicle::steerAngle

2017-01-05T19:05:32Z

Niks: Created page with "This property returns steer angle value: from -1 to 1. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let steerAngle = vehicle.steerAngle </..."

This property returns steer angle value: from -1 to 1.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let steerAngle = vehicle.steerAngle
</source>

Vehicle::bodyHealth

2017-01-05T19:04:41Z

Niks: Created page with "This functions using for getting or setting body health. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let bodyHealth = vehicle.bodyHealth..."

This functions using for getting or setting body health.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let bodyHealth = vehicle.bodyHealth
</source>

Vehicle::engineHealth

2017-01-05T18:53:33Z

Niks: Created page with "This functions using for getting or setting engine health. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let engineHealth = vehicle.engineH..."

This functions using for getting or setting engine health.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let engineHealth = vehicle.engineHealth
</source>

Vehicle::highbeams

2017-01-05T18:50:48Z

Niks: Created page with "This property returns high beams state. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let highbeamsEnabled = vehicle.highbeams </source>"

This property returns high beams state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let highbeamsEnabled = vehicle.highbeams
</source>

Vehicle::engine

2017-01-05T18:49:59Z

Niks:

This property returns engine state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let engineEnabled = vehicle.engine
</source>

Vehicle::engine

2017-01-05T18:47:43Z

Niks: Created page with "This property returns enging state. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let engineEnabled = vehicle.engine </source>"

This property returns enging state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let engineEnabled = vehicle.engine
</source>

Vehicle::horn

2017-01-05T18:47:07Z

Niks: Created page with "This property returns horn state. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let hornEnabled = vehicle.horn </source>"

This property returns horn state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let hornEnabled = vehicle.horn
</source>

Vehicle::siren

2017-01-05T18:46:31Z

Niks: Created page with "This property returns siren state. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let sirenEnabled = vehicle.siren </source>"

This property returns siren state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let sirenEnabled = vehicle.siren
</source>

Vehicle::velocity

2017-01-05T18:45:45Z

Niks: Created page with "This property using for getting or setting vehicle velocity. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let velocity = vehicle.velocity..."

This property using for getting or setting vehicle velocity.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let velocity = vehicle.velocity
vehicle.velocity = new mp.Vector3(0.2, 0.3, 0.4)
</source>

Vehicle::rotation

2017-01-05T18:21:23Z

Niks: Created page with "This property using for getting or setting vehicle rotation. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let rotation = vehicle.rotation..."

This property using for getting or setting vehicle rotation.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let rotation = vehicle.rotation
vehicle.rotation = new mp.Vector3(0, 0, 90)
</source>

Vehicle::position

2017-01-05T18:19:21Z

Niks: Created page with "This property using for getting or setting vehicle position. == Example == <syntaxhighlight lang="javascript"> let position = vehicle.position vehicle.position = new mp.Vector..."

This property using for getting or setting vehicle position.
== Example ==
<syntaxhighlight lang="javascript">
let position = vehicle.position
vehicle.position = new mp.Vector3(1, 2, 3)
</syntaxhighlight>

Vehicle::model

2017-01-05T17:37:04Z

Niks:

This property using for getting or setting vehicle model.
== Example ==
<syntaxhighlight lang="javascript">
let model = vehicle.model
vehicle.model = mp.joaat('sultanrs')
</syntaxhighlight>

Vehicle::model

2017-01-05T17:36:44Z

Niks:

This property using for getting or setting vehicle model.
== Syntax ==
<syntaxhighlight lang="javascript">
let model = vehicle.model
vehicle.model = mp.joaat('sultanrs')
</syntaxhighlight>

Vehicle::model

2017-01-05T17:36:34Z

Niks:

This property using for getting or setting vehicle model.
== Syntax ==
<syntaxhighlight lang="javascript">
let model = Vehicle.model
vehicle.model = mp.joaat('sultanrs')
</syntaxhighlight>

Vehicle::model

2017-01-05T17:36:22Z

Niks: Created page with "This property using for getting or setting vehicle model. == Syntax == <syntaxhighlight lang="javascript"> let model = Vehicle.model Vehicle.model = mp.joaat('sultanrs') </syn..."

This property using for getting or setting vehicle model.
== Syntax ==
<syntaxhighlight lang="javascript">
let model = Vehicle.model
Vehicle.model = mp.joaat('sultanrs')
</syntaxhighlight>

Vehicle::repair

2017-01-05T13:44:05Z

Niks:

This function repairs a vehicle.
== Syntax ==
<syntaxhighlight lang="javascript">
vehicle.repair()
</syntaxhighlight>
== Example ==
This example repairs a vehicle, in which the player sits.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, cmd) => {
let arr = cmd.split(' ');
if (arr[0] == 'repair' && player.vehicle) {
player.vehicle.repair();
}
});
</syntaxhighlight>

Vehicle::destroy

2017-01-05T13:43:46Z

Niks:

This functions destroys a vehicle.
== Syntax ==
<syntaxhighlight lang="javascript">
vehicle.destroy()
</syntaxhighlight>
== Example ==
This example destroys a random car from command.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, cmd) => {
let arr = cmd.split(' ');
if (arr[0] == 'destroyrandomveh') {
let vehicles = mp.vehicles.toArray();
if (vehicles.length > 0) {
let randomValue = Math.floor(Math.random() * vehicles.length);
vehicles[randomValue].destroy();
} else {
player.outputChatBox('Vehicles does not exist!');
}
}
});
</syntaxhighlight>

Vehicle::destroy

2017-01-05T13:41:43Z

Niks:

This functions destroys a vehicle.
== Syntax ==
<syntaxhighlight lang="javascript">
Vehicle vehicle.destroy()
</syntaxhighlight>
== Example ==
This example destroys a random car from command.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, cmd) => {
let arr = cmd.split(' ');
if (arr[0] == 'destroyrandomveh') {
let vehicles = mp.vehicles.toArray();
if (vehicles.length > 0) {
let randomValue = Math.floor(Math.random() * vehicles.length);
vehicles[randomValue].destroy();
} else {
player.outputChatBox('Vehicles does not exist!');
}
}
});
</syntaxhighlight>

Vehicle::destroy

2017-01-05T13:41:00Z

Niks:

<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, cmd) => {
let arr = cmd.split(' ');
if (arr[0] == 'destroyrandomveh') {
let vehicles = mp.vehicles.toArray();
if (vehicles.length > 0) {
let randomValue = Math.floor(Math.random() * vehicles.length);
vehicles[randomValue].destroy();
} else {
player.outputChatBox('Vehicles does not exist!');
}
}
});
</syntaxhighlight>

Vehicle::destroy

2017-01-05T13:39:33Z

Niks:

<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, cmd) => {
let arr = cmd.split(' ');
if (arr[0] == 'destroyrandomveh') {
let vehicles = mp.vehicles.toArray();
let randomValue = Math.floor(Math.random() * vehicles.length);
vehicles[randomValue].destroy();
}
});
</syntaxhighlight>

Vehicle::destroy

2017-01-05T13:39:19Z

Niks: Created page with "This functions destroys a vehicle. == Syntax == <syntaxhighlight lang="javascript"> Vehicle vehicle.destroy() </syntaxhighlight> == Example == Destroys a random vehicle from c..."

This functions destroys a vehicle.
== Syntax ==
<syntaxhighlight lang="javascript">
Vehicle vehicle.destroy()
</syntaxhighlight>
== Example ==
Destroys a random vehicle from command.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, cmd) => {
let arr = cmd.split(' ');
if (arr[0] == 'destroyrandomveh' && player.vehicle) {
let vehicles = mp.vehicles.toArray();
let randomValue = Math.floor(Math.random() * vehicles.length);
vehicles[randomValue].destroy();
}
});
</syntaxhighlight>

Vehicle::repair

2017-01-05T13:34:25Z

Niks:

This function repairs a vehicle.
== Syntax ==
<syntaxhighlight lang="javascript">
Vehicle vehicle.repair()
</syntaxhighlight>
== Example ==
This example repairs a vehicle, in which the player sits.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, cmd) => {
let arr = cmd.split(' ');
if (arr[0] == 'repair' && player.vehicle) {
player.vehicle.repair();
}
});
</syntaxhighlight>

Vehicle::repair

2017-01-05T13:32:52Z

Niks: Created page with "This function repairs a vehicle. == Syntax == <syntaxhighlight lang="javascript"> Vehicle vehicle.repair() </syntaxhighlight>"

This function repairs a vehicle.
== Syntax ==
<syntaxhighlight lang="javascript">
Vehicle vehicle.repair()
</syntaxhighlight>

Vehicle::Vehicle

2017-01-05T13:30:33Z

Niks: /* Syntax */

This function creates the vehicle.
== Syntax ==
<syntaxhighlight lang="javascript">
let vehicle = mp.vehicles.new(Number modelHash, Vector3 position)
</syntaxhighlight>

== Example ==
This example creates the vehicle from name.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, cmd) => {
let arr = cmd.split(' ');
if (arr[0] == 'veh') {
if (!arr[1]) {
return player.outputChatBox('Use syntax: /veh [vehicle_name]');
} else {
let pos = player.position;
pos.x += 3;
mp.vehicles.new(mp.joaat(arr[1]), pos);
}
}
});
</syntaxhighlight>

Vehicle::Vehicle

2017-01-05T13:30:18Z

Niks: Created page with "This function creates the vehicle. == Syntax == <syntaxhighlight lang="javascript"> let vehicle = mp.vehicles.new(Number hash, Vector3 position) </syntaxhighlight> == Example..."

This function creates the vehicle.
== Syntax ==
<syntaxhighlight lang="javascript">
let vehicle = mp.vehicles.new(Number hash, Vector3 position)
</syntaxhighlight>
== Example ==
This example creates the vehicle from name.
<syntaxhighlight lang="javascript">
mp.events.add('playerCommand', (player, cmd) => {
let arr = cmd.split(' ');
if (arr[0] == 'veh') {
if (!arr[1]) {
return player.outputChatBox('Use syntax: /veh [vehicle_name]');
} else {
let pos = player.position;
pos.x += 3;
mp.vehicles.new(mp.joaat(arr[1]), pos);
}
}
});
</syntaxhighlight>

Player::ip

2017-01-04T19:53:52Z

Niks: Created page with "This property returns players ip adress. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let playerIP = player.ip </source>"

This property returns players ip adress.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerIP = player.ip
</source>

Player::ping

2017-01-04T19:53:27Z

Niks: Created page with "This property returns players ping. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let playerPing = player.ping </source>"

This property returns players ping.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerPing = player.ping
</source>

Player::aimTarget

2017-01-04T19:48:27Z

Niks:

This property is the aim target of a player.
<br/>
'''Note: this property is read-only. If player currently [[Player::isAiming|isn't aiming]], this property will be last aim target'''
== Example ==
<source lang="javascript">
if (player.isAiming)
player.outputChatBox('Your aim target is ' + player.aimTarget);
</source>

Player::aimTarget

2017-01-04T19:48:21Z

Niks:

Player::aimTarget

2017-01-04T19:47:58Z

Niks:

Player::isClimbing

2017-01-04T19:46:33Z

Niks:

This property returns true or false of player climbing state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerIsClimbing = player.isClimbing
if (playerIsClimbing)
player.outputChatBox('You are climbing right now!');
else
player.outputChatBox('You are not climbing right now!');
</source>

Player::isAiming

2017-01-04T19:46:12Z

Niks:

This property returns true or false of player aim state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerIsAiming = player.isAiming
if (playerIsAiming)
player.outputChatBox('You are aiming right now!');
else
player.outputChatBox('You are not aiming right now!');
</source>

Player::weapon

2017-01-04T19:44:52Z

Niks: Created page with "This property returns players weapon. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let playerWeapon = player.weapon </source>"

This property returns players weapon.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerWeapon = player.weapon
</source>

Player::seat

2017-01-04T19:43:28Z

Niks:

This property returns players vehicle seat or nil.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
if (player.seat)
player.outputChatBox('Your vehicle seat is ' + player.seat);
else
player.outputChatBox('You are not in the vehicle right now!');
</source>

Player::seat

2017-01-04T19:43:12Z

Niks:

This property returns players vehicle seat or nil.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
if (player.seat)
player.outputChatBox('Your vehicle set is ' + player.seat);
else
player.outputChatBox('You are not in the vehicle right now!');
</source>

Player::seat

2017-01-04T19:43:00Z

Niks: Created page with "This property returns player current vehicle seat or nil. '''Note: this property is read-only.''' == Example == <source lang="javascript"> if (player.seat) player.outputCha..."

This property returns player current vehicle seat or nil.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
if (player.seat)
player.outputChatBox('Your vehicle set is ' + player.seat);
else
player.outputChatBox('You are not in the vehicle right now!');
</source>

Player::vehicle

2017-01-04T19:39:44Z

Niks: Created page with "This property returns player vehicle or nil. '''Note: this property is read-only.''' == Example == <source lang="javascript"> if (player.vehicle) player.outputChatBox('You..."

This property returns player vehicle or nil.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
if (player.vehicle)
player.outputChatBox('You are in the vehicle right now!');
else
player.outputChatBox('You are not in the vehicle right now!');
</source>

Player::isLeavingVehicle

2017-01-04T19:33:20Z

Niks:

This property returns true or false of player vehicle leave state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerIsLeavingVehicle = player.isLeavingVehicle
if (playerIsLeavingVehicle)
player.outputChatBox('You are leaving the vehicle right now!');
else
player.outputChatBox('You are not leaving the vehicle right now!');
</source>

Player::isLeavingVehicle

2017-01-04T19:33:04Z

Niks: Created page with "This property returns true or false of player vehicle leave state. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let playerIsLeavingVehicle..."

This property returns true or false of player vehicle leave state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerIsLeavingVehicle = player.isEnteringVehicle
if (playerIsLeavingVehicle)
player.outputChatBox('You are leaving the vehicle right now!');
else
player.outputChatBox('You are not leaving the vehicle right now!');
</source>

Player::isEnteringVehicle

2017-01-04T19:31:27Z

Niks: Created page with "This property returns true or false of player vehicle enter state. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let playerIsEnteringVehicl..."

This property returns true or false of player vehicle enter state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerIsEnteringVehicle = player.isEnteringVehicle
if (playerIsEnteringVehicle)
player.outputChatBox('You are entering to the vehicle right now!');
else
player.outputChatBox('You are not entering to the vehicle right now!');
</source>

Player::isClimbing

2017-01-04T19:28:36Z

Niks: Created page with "This property returns true or false of player climbing state. '''Note: this property is read-only.''' == Example == <source lang="javascript"> let playerIsClimbing = player.i..."

This property returns true or false of player climbing state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerIsClimbing = player.isClimbing
if (playerIsClimbing)
player.outputChatBox('You are climbing now!');
else
player.outputChatBox('You are not climbing right now!');
</source>

Player::isInCover

2017-01-04T19:26:29Z

Niks:

This property returns true or false of player cover state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerIsInCover = player.isInCover
if (playerIsInCover)
player.outputChatBox('You are in the cover right now!');
else
player.outputChatBox('You are not in the cover right now!');
</source>

Player::isInCover

2017-01-04T19:26:02Z

Niks:

This property returns true or false of player cover state.

'''Note: this property is read-only.'''
== Example ==
<source lang="javascript">
let playerIsCovering = player.isInCover
if (playerIsCovering)
player.outputChatBox('You are in the cover right now!');
else
player.outputChatBox('You are not in the cover right now!');
</source>