RAGE Multiplayer Wiki - User contributions [en]

Vehicle::engineHealth

2018-03-18T16:35:19Z

GreenFanta:

This functions using for getting engine health.

'''Note: this property is read-only. For edit health use [[Vehicle::repair]]'''
== Example ==
<source lang="javascript">
let engineHealth = vehicle.engineHealth
</source>

Entity::getVariable

2018-03-11T13:11:36Z

GreenFanta: /* Syntax */

__NOTOC__

'''Function''': Gets a custom data from an entity.

==Syntax==
<syntaxhighlight lang="javascript">
value entity.getVariable(name); // Returns null if key 'name' does not exist.
</syntaxhighlight>

==Example==
{{ServerSide}}
<syntaxhighlight lang="javascript">
// Supposed you want to get a vehicle you bound with a player
let veh = player.getVariable('veh');
</syntaxhighlight>

Entity::setAlpha

2018-03-04T13:37:05Z

GreenFanta: /* Example */

skin - everything alpha except skin<br>Set entity alpha level. Ranging from 0 to 255 but chnages occur after every 20 percent (after every 51).
==Syntax==
<syntaxhighlight lang="javascript">entity.setAlpha(alphaLevel);</syntaxhighlight>
=== Required Arguments ===
*'''alphaLevel:''' int

=== Old Arguments ===
*'''alphaLevel:''' int
*'''skin:''' Boolean
** The "skin" parameter is not used and will cause argument count exceptions if used.

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

==Example==
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
mp.events.add('enableCollisions', () => {
mp.players.forEach(player => {
mp.players.local.vehicle.setNoCollision(player.vehicle.handle, true);
player.vehicle.setAlpha(255);
player.setAlpha(255);
});
});
mp.events.add('disableCollisions', () => {
mp.players.forEach(player => {
mp.players.local.vehicle.setNoCollision(player.vehicle.handle, false);
player.vehicle.setAlpha(102);
player.setAlpha(255);
});
});
</syntaxhighlight>
</div>
</div>

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

Key::bind

2018-03-04T13:31:06Z

GreenFanta: /* Parameters */

This function binds the key .

==Parameters==
* '''keycode''' - hexadecimal code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key].
* '''keyhold''' - call function as long as key is held pressed? (Bool)
* '''handler''' - function-handler.

==Example==
This example calling server event.
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
// 0x71 is the F2 key code
mp.keys.bind(0x71, true, function() {
mp.events.callRemote('keypress:F2'); // Calling server event "keypress:F2"
mp.gui.chat.push('F2 key is pressed. This message will be shown until you release the key, because "keyhold" is true.');
});
</syntaxhighlight>
</div>

==See also==
{{KeyBinding_function_c}}

Key::bind

2018-03-04T13:30:51Z

GreenFanta: /* Parameters */

This function binds the key .

==Parameters==
* '''keycode''' - code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key] (Hexadecimal).
* '''keyhold''' - call function as long as key is held pressed? (Bool)
* '''handler''' - function-handler.

==Example==
This example calling server event.
<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #408DAE;">
<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
// 0x71 is the F2 key code
mp.keys.bind(0x71, true, function() {
mp.events.callRemote('keypress:F2'); // Calling server event "keypress:F2"
mp.gui.chat.push('F2 key is pressed. This message will be shown until you release the key, because "keyhold" is true.');
});
</syntaxhighlight>
</div>

==See also==
{{KeyBinding_function_c}}

Entity::setAlpha

2018-03-04T13:29:26Z

GreenFanta: /* Old Arguments */

skin - everything alpha except skin<br>Set entity alpha level. Ranging from 0 to 255 but chnages occur after every 20 percent (after every 51).
==Syntax==
<syntaxhighlight lang="javascript">entity.setAlpha(alphaLevel);</syntaxhighlight>
=== Required Arguments ===
*'''alphaLevel:''' int

=== Old Arguments ===
*'''alphaLevel:''' int
*'''skin:''' Boolean
** The "skin" parameter is not used and will cause argument count exceptions if used.

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

==Example==
<syntaxhighlight lang="javascript">
mp.events.add('enableCollisions', () => {
mp.players.forEach(player => {
mp.players.local.vehicle.setNoCollision(player.vehicle.handle, true);
player.vehicle.setAlpha(255);
player.setAlpha(255);
});
});
mp.events.add('disableCollisions', () => {
mp.players.forEach(player => {
mp.players.local.vehicle.setNoCollision(player.vehicle.handle, false);
player.vehicle.setAlpha(102);
player.setAlpha(255);
});
});
</syntaxhighlight>

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

Entity::setAlpha

2018-03-04T13:26:46Z

GreenFanta: /* Example */

skin - everything alpha except skin<br>Set entity alpha level. Ranging from 0 to 255 but chnages occur after every 20 percent (after every 51).
==Syntax==
<syntaxhighlight lang="javascript">entity.setAlpha(alphaLevel);</syntaxhighlight>
=== Required Arguments ===
*'''alphaLevel:''' int

=== Old Arguments ===
*'''alphaLevel:''' int
*'''skin:''' Boolean
** The "skin" parameter is not used will cause argument count exceptions if used.

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

==Example==
<syntaxhighlight lang="javascript">
mp.events.add('enableCollisions', () => {
mp.players.forEach(player => {
mp.players.local.vehicle.setNoCollision(player.vehicle.handle, true);
player.vehicle.setAlpha(255);
player.setAlpha(255);
});
});
mp.events.add('disableCollisions', () => {
mp.players.forEach(player => {
mp.players.local.vehicle.setNoCollision(player.vehicle.handle, false);
player.vehicle.setAlpha(102);
player.setAlpha(255);
});
});
</syntaxhighlight>

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

Entity::setAlpha

2018-03-04T13:25:21Z

GreenFanta:

Entity::setAlpha

2018-03-04T13:08:48Z

GreenFanta: /* Syntax */

Entity::setNoCollision

2018-03-01T20:16:03Z

GreenFanta:

Calling this function, regardless of the 'unknown' value, disabled collision between two entities.<br><br>Importance of entity1 and 2 order is unclear.
==Syntax==
<syntaxhighlight lang="javascript">entity.setNoCollision(entity2, collision);</syntaxhighlight>
=== Required Arguments ===
*'''entity2:''' Entity handle
*'''collision:''' Boolean
** False = no collison, true = enabled collisions
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Entity_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Causes of death

2018-03-01T17:24:04Z

GreenFanta:

__TOC__

'''Causes of death by weapons can be seen here:''' [[Weapons]]

{| class="wikitable" style="text-align:center;"
! scope="col" style="padding:10px 100px;"| Cause
! scope="col" style="padding:10px 50px;"| Hash
! scope="col" style="padding:10px 50px;"| Hex
! scope="col" style="padding:10px 50px;"| Notes
|-
|weapon_electric_fence||style="color:blue;"|2461879995||style="color:blue;"|0x92BD4EBB||
|-
|weapon_hit_by_water_cannon||style="color:blue;"|3425972830||style="color:blue;"|0xCC34325E||
|-
|weapon_rammed_by_car||style="color:blue;"|133987706||style="color:blue;"|0x7FC7D7A||Death from world after exiting (or being exited from) vehicle (high speed exit/flying out of windscreen)
|-
|weapon_run_over_by_car||style="color:blue;"|2741846334||style="color:blue;"|0xA36D413E||
|-
|weapon_fall||style="color:blue;"|3452007600||style="color:blue;"|0xCDC174B0||
|-
|weapon_animal||style="color:blue;"|4194021054||style="color:blue;"|0xF9FBAEBE||
|-
|weapon_airstrike_rocket||style="color:blue;"|324506233||style="color:blue;"|0x13579279||
|-
|weapon_bleeding||style="color:blue;"|2339582971||style="color:blue;"|0x8B7333FB||
|-
|weapon_briefcase||style="color:blue;"|2294779575||style="color:blue;"|0x88C78EB7||
|-
|weapon_briefcase_02||style="color:blue;"|28811031||style="color:blue;"|0x1B79F17||
|-
|weapon_cougar||style="color:blue;"|148160082||style="color:blue;"|0x8D4BE52||
|-
|weapon_barbed_wire||style="color:blue;"|1223143800||style="color:blue;"|0x48E7B178||
|-
|weapon_drowning||style="color:blue;"|4284007675||style="color:blue;"|0xFF58C4FB||
|-
|weapon_drowning_in_vehicle||style="color:blue;"|1936677264||style="color:blue;"|0x736F5990||
|-
|weapon_explosion||style="color:blue;"|539292904||style="color:blue;"|0x2024F4E8||
|-
|weapon_exhaustion||style="color:blue;"|910830060||style="color:blue;"|0x364A29EC||
|-
|weapon_fire||style="color:blue;"|3750660587||style="color:blue;"|0xDF8E89EB||
|-
|weapon_heli_crash||style="color:blue;"|341774354||style="color:blue;"|0x145F1012||
|-
|weapon_vehicle_rocket||style="color:blue;"|3204302209||style="color:blue;"|0xBEFDC581||
|}

PlayerDeath

2018-03-01T17:06:17Z

GreenFanta:

This event is triggered when a player dies.

==Parameters==
* '''player''' - player, which died.
* '''reason ''' - cause hash of death ('''list causes:''' [[Causes of death| Causes]]).
* '''killer''' - who killed the player.

==Example==
This example outputs chat message, when player dies.
{{ServerSide}}
<syntaxhighlight lang="javascript" style="width: 98%; background-color: #E4F1FE;">
function playerDeathHandler(player, reason, killer) {
const deathName = player.name;
const killerName = killer.name;
if(reason == 341774354) {
mp.players.broadcast(`${deathName} died in a chopper!`);
return;
}
mp.players.broadcast(`${killerName} killed ${deathName}. Reason: ${reason}`);
}

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

==See also==
{{Player_events}}

PlayerDeath

2018-03-01T17:05:10Z

GreenFanta:

This event is triggered when a player dies.

==Parameters==
* '''player''' - player, which died.
* '''reason ''' - cause hash of death ('''list causes:''' [[Causes of death| Causes]]).
* '''killer''' - who killed the player.

==Example==
This example outputs chat message, when player dies.
{{ServerSide}}
<syntaxhighlight lang="javascript" style="width: 98%; background-color: #E4F1FE;">
function playerDeathHandler(player, reason, killer) {
const deathName = player.name;
const killerName = killer.name;

mp.players.broadcast(`${killerName} killed ${deathName}. Reason: ${reason}`);
}

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

==See also==
{{Player_events}}

Trigger

2018-03-01T16:54:15Z

GreenFanta:

__NOTOC__

Sends data/trigger events from html to your clientside JS file.

== Syntax ==

<syntaxhighlight lang="typescript">
mp.trigger('event', params)
</syntaxhighlight>

=== '''Required Arguments''' ===

*'''event''': '''<font color='green'>String</font>'''
*'''params''': '''<font color = 'red'>int</font>''' or '''<font color = 'green'>String</font>'''

=== '''Return Value''' ===

*'''Unknown'''

== Example ==
<div class="header" style="background-color: #40aeae; color: #FFFFFF; border: 2px solid #40aeae;">
<div style="margin: 10px 10px 10px 10px;"><b>CEF</b></div>
<syntaxhighlight lang="html">
<script>
mp.trigger('CEFDoneUsingBrowser');
</script>
</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 activeBrowser = null;
mp.events.add('guiReady', () => {
activeBrowser = mp.browsers.new('package://menu/modes/race.html');
});

mp.events.add('CEFDoneUsingBrowser', () => {
activeBrowser.destroy();
});
</syntaxhighlight>
</div>

Entity::setCollision

2018-02-25T11:46:03Z

GreenFanta:

==Syntax==
<syntaxhighlight lang="javascript">entity.setCollision(toggle, keepPhysics);</syntaxhighlight>
=== Required Arguments ===
*'''toggle:''' Boolean
** Setting 'toggle' to false will disable all collisions and you will fall through the world.
*'''keepPhysics:''' Boolean
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Entity_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Entity::setCollision

2018-02-25T11:45:39Z

GreenFanta:

==Syntax==
<syntaxhighlight lang="javascript">entity.setCollision(toggle, keepPhysics);</syntaxhighlight>
=== Required Arguments ===
*'''toggle:''' Boolean
*'''keepPhysics:''' Boolean
* Setting 'toggle' to false will disable all collisions and you will fall through the world.
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Entity_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

Entity::setCollision

2018-02-25T11:45:28Z

GreenFanta:

==Syntax==
<syntaxhighlight lang="javascript">entity.setCollision(toggle, keepPhysics);</syntaxhighlight>
* Setting 'toggle' to false will disable all collisions and you will fall through the world.
=== Required Arguments ===
*'''toggle:''' Boolean
*'''keepPhysics:''' Boolean
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Entity_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]