RAGE Multiplayer Wiki - User contributions [en]

Cam::getGameplayCamRelativeHeading

2019-06-27T19:38:36Z

Sudodude: /* Syntax */

==Syntax==
<syntaxhighlight lang="javascript">
var heading = mp.game.getGameplayCamRelativeHeading();
</syntaxhighlight>

===Returned value===
*'''heading''': {{RageType|number}}

==Example==
<syntaxhighlight lang="javascript">
// PLEASE MAKE ME
</syntaxhighlight>

PlayerWeaponShot

2019-05-16T19:14:33Z

Sudodude: Readability, parameter definitions and syntax/grammar fixes/updates.

This event is called every time a player shoots a weapon.
{{ClientsideCsJsEvent}}
{{CSharpContainer|
<syntaxhighlight lang="c#">
public delegate void OnPlayerWeaponShotDelegate(Vector3 targetPos, Player target, CancelEventArgs cancel);
</syntaxhighlight>
{{Parameters}}
* '''targetPos''' - the position of the target, expects '''RAGE.Vector3'''
* '''target''' - the target player, expects '''RAGE.Elements.Player'''
* '''cancel''' - cancel, expects '''RAGE.Events.CancelEventArgs'''

{{Example}}
The example below shows a chat message to the client when they shoot a weapon

<syntaxhighlight lang="c#">
Events.OnPlayerWeaponShot += OnPlayerWeaponShot;
</syntaxhighlight>
<syntaxhighlight lang="c#">
public void OnPlayerWeaponShot(RAGE.Vector3 targetPos, RAGE.Elements.Player target, RAGE.Events.CancelEventArgs cancel)
{
RAGE.Chat.Output($"You shot a weapon");
}
</syntaxhighlight>
}}

{{JSContainer|
<syntaxhighlight lang="javascript">
mp.events.add('playerWeaponShot', (targetPosition, targetEntity) => {});
</syntaxhighlight>

{{Parameters}}
* '''targetPosition''': Target's position, output expects a '''[[Vector3::Vector3|Vector3]]''' type.
* '''targetEntity''': Target's entity, output expects '''any''' type. Returns undefined if no target entity.

{{Example}}
The example below prints a message to the player's chat every time the player fires a weapon.

<syntaxhighlight lang="javascript">
mp.events.add('playerWeaponShot', (targetPosition, targetEntity) => {
mp.gui.chat.push('You fired a weapon!');
});
</syntaxhighlight>
}}

[[Category:Client-side Event]]

Player::getsJacker

2019-05-16T19:01:01Z

Sudodude: /* Example */ added js tag

==Syntax==
<syntaxhighlight lang="javascript">player.getsJacker();</syntaxhighlight>
=== Required Arguments ===
===Return value===
*'''Ped handle or object'''
==Example==
This example will use the returned value from Player::getsJacker to add 25 armour to the specified entity (client-side). - 2019-5-16

<div class="header" style="background-color: #00FF00; color: #FFFFFF; border: 2px solid #00FF00;">
<div style="margin: 10px;"><b>Client-Side JS</b></div>
<syntaxhighlight lang="javascript">
/* Player::getsJacker */
let localPlayerJacker = mp.players.local.getsJacker();

/* CLIENT-SIDE ADDARMOURTO localPlayerJacker ADDS 25 ARMOUR TO PLAYER. */
mp.players.at(localPlayerJacker).addArmourTo(25);
</syntaxhighlight>
</div>

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

Player::getsJacker

2019-05-16T18:39:46Z

Sudodude: /* Example */ removed unnecessary white space.

==Syntax==
<syntaxhighlight lang="javascript">player.getsJacker();</syntaxhighlight>
=== Required Arguments ===
===Return value===
*'''Ped handle or object'''
==Example==
This example will use the returned value from Player::getsJacker to add 25 armour to the specified entity (client-side). - 2019-5-16

<div class="header" style="background-color: #00FF00; color: #FFFFFF; border: 2px solid #00FF00;">
<div style="margin: 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">
/* Player::getsJacker */
let localPlayerJacker = mp.players.local.getsJacker();

/* CLIENT-SIDE ADDARMOURTO localPlayerJacker ADDS 25 ARMOUR TO PLAYER. */
mp.players.at(localPlayerJacker).addArmourTo(25);
</syntaxhighlight>
</div>

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

Player::getsJacker

2019-05-16T18:37:54Z

Sudodude: /* Example */ Simple example for use of Player::getsJacker because I was confused with the use of this method and tested it out.

==Syntax==
<syntaxhighlight lang="javascript">player.getsJacker();</syntaxhighlight>
=== Required Arguments ===
===Return value===
*'''Ped handle or object'''
==Example==
This example will use the returned value from Player::getsJacker to add 25 armour to the specified entity (client-side). - 2019-5-16

<div class="header" style="background-color: #00FF00; color: #FFFFFF; border: 2px solid #00FF00;">
<div style="margin: 10px;"><b>Client-Side</b></div>
<syntaxhighlight lang="javascript">

/* Player::getsJacker */
let localPlayerJacker = mp.players.local.getsJacker();

/* CLIENT-SIDE ADDARMOURTO localPlayerJacker ADD
* ADDS 25 ARMOUR TO PLAYER.
*/
mp.players.at(localPlayerJacker).addArmourTo(25);

</syntaxhighlight>
</div>

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

Player::startPlayerTeleport

2019-05-16T18:17:03Z

Sudodude: Readability update to function argument list. Added commas and spaces between argument list.

==Syntax==
<syntaxhighlight lang="javascript">mp.game.player.startPlayerTeleport(x, y, z, heading, p5, p6, p7);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' float
*'''y:''' float
*'''z:''' float
*'''heading:''' float
*'''p5:''' Boolean
*'''p6:''' Boolean
*'''p7:''' Boolean
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Player_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]