RAGE Multiplayer Wiki - User contributions [en]

IncomingDamage

2020-06-05T16:24:34Z

CommanderDonkey:

{{ClientsideCsJsEvent}}

[1.1]

Triggered upon damage that is about to be given to the player.

This event is also cancellable.

{{JSContainer|
=== Parameters ===
*'''sourceEntity''': {{RageType|Object}}
*'''sourcePlayer''': {{RageType|Object}}
*'''targetEntity''': {{RageType|Object}}
*'''weapon''': {{RageType|Int}}
*'''boneIndex''': {{RageType|Int}}
*'''damage''': {{RageType|Int}}

== Example ==

{{ClientsideCode|
<pre>
// To do
</pre>
}}
}}

== See Also ==

[[Category:TODO: Example]]
[[Category:Clientside API]]
[[Category:Client-side Event]]

Vehicle::dead

2020-05-06T16:28:28Z

CommanderDonkey: /* Example */

The getter property, says that the vehicle is dead or not
The Setter property, sets the vehicle dead state.

==Getter==
* '''Boolean'''

==Setter==
* '''Boolean'''

== Example ==
{{ServersideCode|
<pre>
let vehicleDead = vehicle.dead;
console.log(vehicleDead);
</pre>

<pre>
0.3.7
vehicle.dead = true/false;
</pre>
}}

==See Also==
{{Vehicle_definition}}

Vehicle::setEnginePowerMultiplier

2020-04-26T22:17:59Z

CommanderDonkey:

Vehicle power multiplier. Does not have to be looped each frame. Can be set once. Values lower than 1f don't work. Note: If the value is set with GET_RANDOM_FLOAT_IN_RANGE, the vehicle will have an absurdly high ammount of power, and will become almost undrivable for the player or NPCs. The range doesn't seem to matter. An high value like 10000000000f will visually remove the wheels that apply the power (front wheels for FWD, rear wheels for RWD), but the power multiplier will still apply, and the wheels still work.
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setEnginePowerMultiplier(value);</syntaxhighlight>
=== Required Arguments ===
*'''value:''' float
===Return value===
*'''Undefined'''

===Example===
{{ClientsideCode|
<pre>

//Boosting all emergency vehicles
mp.events.add('render', () => {
if (mp.players.local.vehicle) {
if (mp.players.local.vehicle.getClass() === 18) {
mp.players.local.vehicle.setEnginePowerMultiplier(12)
}
}
})
</pre>
}}

==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]

Vehicle::setEnginePowerMultiplier

2020-04-26T22:14:33Z

CommanderDonkey: /* Example */

Vehicle power multiplier. Does not have to be looped each frame. Can be set once. Values lower than 1f don't work. Note: If the value is set with GET_RANDOM_FLOAT_IN_RANGE, the vehicle will have an absurdly high ammount of power, and will become almost undrivable for the player or NPCs. The range doesn't seem to matter. An high value like 10000000000f will visually remove the wheels that apply the power (front wheels for FWD, rear wheels for RWD), but the power multiplier will still apply, and the wheels still work.
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setEnginePowerMultiplier(value);</syntaxhighlight>
=== Required Arguments ===
*'''value:''' float
===Return value===
*'''Undefined'''
==(Clientside) Example==
Boost Emergency Vehicles

<syntaxhighlight lang="javascript">
mp.events.add('render', () => {
if (mp.players.local.vehicle) {
if (mp.players.local.vehicle.getClass() === 18) {
mp.players.local.vehicle.setEnginePowerMultiplier(12)
}
}
})
</syntaxhighlight>

==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Vehicle::dead

2020-03-18T18:29:44Z

CommanderDonkey:

The getter property, says that the vehicle is dead or not
The Setter property, sets the vehicle dead state.

==Getter==
* '''Boolean'''

==Setter==
* '''Boolean'''

== Example ==
{{ServersideCode|
<pre>
let vehicleDead = vehicle.dead;
console.log(vehicleDead);
</pre>

<pre>
vehicle.dead = true/false;
</pre>
}}
==See Also==
{{Vehicle_definition}}

Vehicle::dead

2020-03-18T18:29:12Z

CommanderDonkey:

This getter property, says that the transport is dead or not

==Getter==
* '''Boolean'''

==Setter==
* '''Boolean'''

== Example ==
{{ServersideCode|
<pre>
let vehicleDead = vehicle.dead;
console.log(vehicleDead);
</pre>

<pre>
vehicle.dead = true/false;
</pre>
}}
==See Also==
{{Vehicle_definition}}

Browser::active

2020-03-05T01:31:45Z

CommanderDonkey:

'''Function''': Gets or sets if the browser is active

==Parameters==
* '''Toggle''': {{RageType|Boolean}}

==Syntax==
{{ClientsideCode|
<pre>
browser.active;
</pre>
}}

==Example==
Setter:
{{ClientsideCode|
<pre>
let browser = mp.browsers.new("package://index.html");
browser.active = false;
</pre>
}}
Getter:
{{ClientsideCode|
<pre>
let active = browser.active;
</pre>
}}
See [[Package Protocol]] for more info on the <code>package://</code> url.

==See Also==
{{Browser_definition_c}}
[[Category:Clientside API]]

Ui::hideHudComponentThisFrame

2019-11-21T21:03:20Z

CommanderDonkey:

{{ClientsideJsFunction}}

{{JSContainer|
==Syntax==
<syntaxhighlight lang="javascript">mp.game.ui.hideHudComponentThisFrame(componentIndex);</syntaxhighlight>

=== Required Arguments ===
*'''componentIndex:''' int

=== Components ===
*'''Full list:''' [[HUD Components|HUD Components list]]

===Return value===
*'''Undefined'''

== Example ==
{{ClientsideCode|
<syntaxhighlight lang="javascript">
//Disables the HUD
mp.game.ui.hideHudComponentThisFrame(0);
</syntaxhighlight>
}}
==See also==
{{Ui_functions_c}}
[[Category:Clientside API]]
[[Category:UI API]]

Ui::hideHudComponentThisFrame

2019-11-21T21:03:09Z

CommanderDonkey:

{{ClientsideJsFunction}}

{{JSContainer|
==Syntax==
<syntaxhighlight lang="javascript">mp.game.ui.hideHudComponentThisFrame(componentIndex);</syntaxhighlight>

=== Required Arguments ===
*'''componentIndex:''' int

=== Components ===
*'''Full list''' [[HUD Components|HUD Components list]])

===Return value===
*'''Undefined'''

== Example ==
{{ClientsideCode|
<syntaxhighlight lang="javascript">
//Disables the HUD
mp.game.ui.hideHudComponentThisFrame(0);
</syntaxhighlight>
}}
==See also==
{{Ui_functions_c}}
[[Category:Clientside API]]
[[Category:UI API]]

Ui::hideHudComponentThisFrame

2019-11-21T21:02:47Z

CommanderDonkey:

{{ClientsideJsFunction}}

{{JSContainer|
==Syntax==
<syntaxhighlight lang="javascript">mp.game.ui.hideHudComponentThisFrame(componentIndex);</syntaxhighlight>

=== Required Arguments ===
*'''componentIndex:''' int

=== Components ===
*'''componentIndex:''' int (Full list: [[HUD Components|HUD Components list]])

===Return value===
*'''Undefined'''

== Example ==
{{ClientsideCode|
<syntaxhighlight lang="javascript">
//Disables the HUD
mp.game.ui.hideHudComponentThisFrame(0);
</syntaxhighlight>
}}
==See also==
{{Ui_functions_c}}
[[Category:Clientside API]]
[[Category:UI API]]

Keys::isDown

2019-05-13T21:58:49Z

CommanderDonkey:

Returns true if the key specified is pressed. Otherwise, returns false.

==Parameters==
* '''[https://keycode.info keycode]''' - code of the key (Number).

==Example==
An interval that runs every half-second and outputs the state of the F2 key (pressed or not).
{{ClientSide}}
<syntaxhighlight lang="javascript">
setInterval(() => {
if (mp.keys.isDown(113) === true) { // 113 is the key code for F2
mp.gui.chat.push('F2 key is pressed!');
} else {
mp.gui.chat.push('F2 key is not pressed!');
}
}, 500);
</syntaxhighlight>

==See also==
{{Keys_functions_c}}

Vehicle::Vehicle

2019-01-10T09:51:06Z

CommanderDonkey:

{{sharedFunctionJS}}

Creates a vehicle. 
'''Notes:''' 
- Colors don't always work as expected if you use them inside the function. Also plate won't work propperly. Better set those after vehicle is created. 
- Heading means Rotation. 

== Syntax ==

<pre>
mp.vehicles.new(model, position,
{
heading: heading,
numberPlate: numberPlate,
alpha: alpha,
color: color,
locked: locked,
engine: engine,
dimension: dimension
});
</pre>

=== Parameters ===
*'''model''': {{RageType|Hash}} (use [[Globals::joaat|mp.joaat]]) or {{RageType|String}}
*'''position''': {{RageType|Vector3}}
*'''heading''': {{RageType|Number}} [-180:180]
*'''numberPlate''': {{RageType|String}}
*'''alpha''': {{RageType|Number}}
*'''color''': {{RageType|[[Number, Number, Number], [Number, Number, Number]]}}
*'''locked''': {{RageType|Boolean}}
*'''engine''': {{RageType|Boolean}}
*'''dimension''': {{RageType|Number}}

== Examples ==

An example of creating a red Turismo with the license plate ADMIN

{{ClientsideCode|
<pre>
mp.vehicles.new(mp.game.joaat("turismor"), new mp.Vector3(-421.88, 1136.86, 326),
{
numberPlate: "ADMIN",
color: [[255, 0, 0],[255,0,0]]
});
</pre>
}}

Same example but creating a blue Turismo and using it server-side
{{ServersideCode|
<pre>
mp.vehicles.new(mp.joaat("turismor"), new mp.Vector3(-441.88, 1156.86, 326),
{
numberPlate: "ADMIN",
color: [[0, 255, 0],[0, 255, 0]]
});
</pre>
}}

Vehicle::Vehicle

2019-01-10T09:50:46Z

CommanderDonkey:

{{sharedFunctionJS}}

Creates a vehicle. 
'''Notes:'''
- Colors don't always work as expected if you use them inside the function. Also plate won't work propperly. Better set those after vehicle is created.
- Heading means Rotation.

== Syntax ==

<pre>
mp.vehicles.new(model, position,
{
heading: heading,
numberPlate: numberPlate,
alpha: alpha,
color: color,
locked: locked,
engine: engine,
dimension: dimension
});
</pre>

=== Parameters ===
*'''model''': {{RageType|Hash}} (use [[Globals::joaat|mp.joaat]]) or {{RageType|String}}
*'''position''': {{RageType|Vector3}}
*'''heading''': {{RageType|Number}} [-180:180]
*'''numberPlate''': {{RageType|String}}
*'''alpha''': {{RageType|Number}}
*'''color''': {{RageType|[[Number, Number, Number], [Number, Number, Number]]}}
*'''locked''': {{RageType|Boolean}}
*'''engine''': {{RageType|Boolean}}
*'''dimension''': {{RageType|Number}}

== Examples ==

An example of creating a red Turismo with the license plate ADMIN

{{ClientsideCode|
<pre>
mp.vehicles.new(mp.game.joaat("turismor"), new mp.Vector3(-421.88, 1136.86, 326),
{
numberPlate: "ADMIN",
color: [[255, 0, 0],[255,0,0]]
});
</pre>
}}

Same example but creating a blue Turismo and using it server-side
{{ServersideCode|
<pre>
mp.vehicles.new(mp.joaat("turismor"), new mp.Vector3(-441.88, 1156.86, 326),
{
numberPlate: "ADMIN",
color: [[0, 255, 0],[0, 255, 0]]
});
</pre>
}}

Player::heading

2019-01-10T08:23:32Z

CommanderDonkey:

This property using for getting or setting player rotation.
== Example ==
<syntaxhighlight lang="javascript">
let playerRotate = player.heading
player.heading = 90
</syntaxhighlight>

==See Also==
{{Player_block}}

Player::heading

2019-01-10T08:23:06Z

CommanderDonkey: /* Example */

This property using for getting or setting player rotation - rotate.
== Example ==
<syntaxhighlight lang="javascript">
let playerRotate = player.heading
player.heading = 90
</syntaxhighlight>

==See Also==
{{Player_block}}

Talk:Player::heading

2019-01-10T08:20:04Z

CommanderDonkey: Blanked the page

Player::heading

2019-01-10T08:19:56Z

CommanderDonkey:

This property using for getting or setting player rotation - rotate.
== Example ==
<syntaxhighlight lang="javascript">
let playerRot = player.heading
player.heading = 90
</syntaxhighlight>

==See Also==
{{Player_block}}

Talk:Player::heading

2019-01-10T08:19:40Z

CommanderDonkey: Created page with "probably any user with have permissions can add "rotate" in the desc. so that anyone who search "rotate" is finding that article..."

probably any user with have permissions can add "rotate" in the desc. so that anyone who search "rotate" is finding that article...