RAGE Multiplayer Wiki - User contributions [en]

DummyEntityCreated

2020-10-26T06:59:37Z

Graber: Add dummyEntityCreated

{{ClientsideJsEvent}}

Triggered when a dummy has been created.

{{JSContainer|
=== Parameters ===
*'''dummyType''': {{RageType|Int}} - the type of the dummy entity
*'''dummy''': {{RageType|Object}} - the created dummy entity

== Example ==

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

== See Also ==
{{Player_events_clientside}}

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

DummyEntityDestroyed

2020-10-26T06:58:52Z

Graber: Fix parameter types

{{ClientsideJsEvent}}

Triggered when a dummy has been destroyed.

{{JSContainer|
=== Parameters ===
*'''dummyType''': {{RageType|Int}} - the type of the dummy entity
*'''dummy''': {{RageType|Object}} - the destroyed dummy entity

== Example ==

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

== See Also ==
{{Player_events_clientside}}

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

PlayerSpawn

2020-10-20T20:12:01Z

Graber: Fix syntax error

This event is triggered when a player spawns.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerSpawn on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - player, which has spawned

{{Example}}
This example outputs a console chat message, when a player spawns.
<pre>
function playerSpawn(player) {
console.log(`${player.name} has spawned`);
}

mp.events.add("playerSpawn", playerSpawn);
</pre>
}}

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerSpawnDelegate(CancelEventArgs cancel);
</syntaxhighlight>

{{Parameters}}
* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.

{{Example}}
The example below shows a chat message to the client when they spawn.

<syntaxhighlight lang="csharp">
Events.OnPlayerSpawn += OnPlayerSpawn;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerSpawn(RAGE.Events.CancelEventArgs cancel)
{
RAGE.Chat.Output($"You just spawned");
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - player, which has spawned (always the same as mp.players.local, only works with local player)
{{Example}}
This example outputs a console chat message to the client when they spawns.
<pre>
mp.events.add("playerSpawn", (player) => {
mp.gui.chat.push("Hey " + player.name + ", you just spawned");
});
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

PlayerSpawn

2020-10-20T20:11:35Z

Graber: Add player parameter to clientside variant

This event is triggered when a player spawns.

{{ServersideCsJsEvent}}

{{CSharpContainer|1=
See [https://wiki.gtanet.work/index.php?title=OnPlayerSpawn on GTA Network Wiki].
}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - player, which has spawned

{{Example}}
This example outputs a console chat message, when a player spawns.
<pre>
function playerSpawn(player) {
console.log(`${player.name} has spawned`);
}

mp.events.add("playerSpawn", playerSpawn);
</pre>
}}

{{ClientsideCsJsEvent}}

{{CSharpContainer|
<syntaxhighlight lang="csharp">
public delegate void OnPlayerSpawnDelegate(CancelEventArgs cancel);
</syntaxhighlight>

{{Parameters}}
* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.

{{Example}}
The example below shows a chat message to the client when they spawn.

<syntaxhighlight lang="csharp">
Events.OnPlayerSpawn += OnPlayerSpawn;
</syntaxhighlight>
<syntaxhighlight lang="csharp">
public void OnPlayerSpawn(RAGE.Events.CancelEventArgs cancel)
{
RAGE.Chat.Output($"You just spawned");
}
</syntaxhighlight>
}}

{{JSContainer|
{{Parameters}}
* '''player''': {{RageType|Player}} - player, which has spawned (always the same as mp.players.local, only works with local player)
{{Example}}
This example outputs a console chat message to the client when they spawns.
<pre>
mp.events.add("playerSpawn", (player) => {
mp.gui.chat.push("Hey " + player.name ", you just spawned");
});
</pre>
}}

==See also==
{{Player_events}}

[[Category:Player]]
[[Category:Server-side Event]]
[[Category:Client-side Event]]

Colshapes::newRectangle

2020-10-20T12:58:47Z

Graber: Add missing dimension optional parameter

Creates a rectangle (square) ColShape 2D plane
==Parameters==
* '''x:''' {{RageType|Number}} in float
* '''y:''' {{RageType|Number}} in float
* '''width:''' {{RageType|Number}} in float
* '''height:''' {{RageType|Number}} in float
* '''dimension:''' {{RageType|Number}} (optional)

==Syntax==
{{Shared}}
<syntaxhighlight lang="javascript">
mp.colshapes.newRectangle(x, y, width, height, dimension)
</syntaxhighlight>

==See Also==
{{Colshapes_function}}

[[Category:ColShape API]]
[[Category:Shared Function]]

Colshapes::newTube

2020-10-20T00:23:04Z

Graber: Add missing type

Creates a Colshape into the shape of a Tube.

==Parameters==
* '''x:''' {{RageType|Number}} in float
* '''y:''' {{RageType|Number}} in float
* '''z:''' {{RageType|Number}} in float
* '''height:''' {{RageType|Number}} in float
* '''range:''' {{RageType|Number}} in float
==Syntax==
{{Shared}}
<syntaxhighlight lang="javascript">
mp.colshapes.newTube(x, y, z, height, range)
</syntaxhighlight>

==See Also==
{{Colshapes_function}}

[[Category:ColShape API]]
[[Category:Shared Function]]

Colshapes::newTube

2020-10-20T00:22:45Z

Graber: Fix params (again)

Creates a Colshape into the shape of a Tube.

==Parameters==
* '''x:''' {{RageType|Number}} in float
* '''y:''' {{RageType|Number}} in float
* '''z:''' {{RageType|Number}} in float
* '''height:''' {{RageType|Number}} in float
* '''range:''' {{RageType|Number}}
==Syntax==
{{Shared}}
<syntaxhighlight lang="javascript">
mp.colshapes.newTube(x, y, z, height, range)
</syntaxhighlight>

==See Also==
{{Colshapes_function}}

[[Category:ColShape API]]
[[Category:Shared Function]]

Colshapes::newTube

2020-10-20T00:22:03Z

Graber: Fix params

Creates a Colshape into the shape of a Tube.

==Parameters==
* '''x:''' {{RageType|Number}} in float
* '''y:''' {{RageType|Number}} in float
* '''z:''' {{RageType|Number}} in float
* '''height:''' {{RageType|Number}} in float
* '''range:''' {{RageType|Number}}
==Syntax==
{{Shared}}
<syntaxhighlight lang="javascript">
mp.colshapes.newTube(x, y, z, range, dimensionAndRange)
</syntaxhighlight>

==See Also==
{{Colshapes_function}}

[[Category:ColShape API]]
[[Category:Shared Function]]

Colshapes::newCuboid

2020-10-19T23:32:55Z

Graber: Add missing dimension optional parameter

{{SharedFunctionJS}}

Creates a cuboid ColShape in 3D space
==Parameters==
* '''x:''' {{RageType|Number}} in float
* '''y:''' {{RageType|Number}} in float
* '''z:''' {{RageType|Number}} in float
* '''width:''' {{RageType|Number}} in float
* '''depth:''' {{RageType|Number}} in float
* '''height:''' {{RageType|Number}} in float
* '''dimension:''' {{RageType|Number}} (optional)

==Syntax==
<syntaxhighlight lang="javascript">
mp.colshapes.newCuboid(x, y, z, width, depth, height, dimension)
</syntaxhighlight>

==See Also==
{{Colshapes_function}}

[[Category:ColShape API]]
[[Category:Shared Function]]

Template:PlayerPool functions

2020-10-17T20:47:42Z

Graber: Fix function names

**[[Players::broadcast]]
**[[Players::broadcastInDimension]]
**[[Players::broadcastInRange]]
**[[Players::call]]
**[[Players::callInDimension]]
**[[Players::callInRange]]
**[[Players::callUnreliable]]
**[[Players::callInDimensionUnreliable]]
**[[Players::callInRangeUnreliable]]

Player::callUnreliable

2020-10-17T20:45:23Z

Graber: Add Player::callUnreliable based on Player::callProc layout but with examples similar to Player::call

__TOC__

{{ServersideJsFunction}}

This function triggers a client-side event for the selected player unreliably, which means it will be affected by potential packet loss, but it will be triggered way more faster, useful for when you need frequent triggers.

{{JSContainer|
==Syntax==
<pre>
player.callUnreliable('eventName', [...args]);
</pre>

=== Required Arguments ===
*{{Required}}'''eventName''': {{RageType|String}}
*'''args''': {{RageType|Any}}

==Example==
{{ServersideCode|
<pre>
let player = mp.player.at(1337); //Get player by ID
if (player) {
player.callUnreliable('syncUnreliableData', [123]); // example
}
</pre>
}}

{{ClientsideCode|
<pre>
// may not always be called because of possible packetloss
mp.events.add('syncUnreliableData', (data) => {
mp.gui.chat.push(`we got data: ${data}`);
});
</pre>
}}
}}

==See Also==
{{Player_block}}

Player::callProc

2020-06-23T05:21:32Z

Graber: Add async proc example

__TOC__

{{ServersideJsFunction}}

This function calls the specified player's clientside Remote prodecure call (RPC) event and expects a callback.

{{JSContainer|
==Syntax==
<pre>
player.callProc('eventProcName', [...args]);
</pre>

=== Required Arguments ===
*{{Required}}'''eventProcName''': {{RageType|String}}
*'''args''': {{RageType|Any}}

==Example==
{{ServersideCode|
<pre>
(async () => {
try {
let res = await player.callProc('test_proc', ['ok']);
console.log('succ', res);
} catch(e) {
console.error('Error: ' + e);
}
}();
</pre>
}}

{{ClientsideCode|
<pre>
mp.events.addProc('test_proc', (player, text) => {
return 'hey beast: ' + text;
});

// also supports async functions
mp.events.addProc('test_proc', async (text) => {
await doAsyncJob();
return 'hey beast: ' + text;
});
</pre>
}}
}}

==See Also==
{{Player_block}}

Entity::attachTo

2020-05-30T19:07:13Z

Graber: Remove confusing contradiction

Attaches entity1 to bone (boneIndex) of entity2. boneIndex - this is different to boneID, use GET_Player_BONE_INDEX to get the index from the ID. use the index for attaching to specific bones. entity1 will be attached to entity2's centre if bone index given doesn't correspond to bone indexes for that entity type. useSoftPinning - if set to false attached entity will not detach when fixed collision - controls collision between the two entities (FALSE disables collision). isPed - pitch doesnt work when false and roll will only work on negative numbers (only peds) vertexIndex - position of vertex fixedRot - if false it ignores entity vector 
==Syntax==
<syntaxhighlight lang="javascript">entity.attachTo(entity2, boneIndex, xPosOffset, yPosOffset, zPosOffset, xRot, yRot, zRot, p9, useSoftPinning, collision, isPed, vertexIndex, fixedRot);</syntaxhighlight>
=== Required Arguments ===
*'''entity2:''' Entity handle ( so use for example player.handle )
*'''boneIndex:''' int
*'''xPosOffset:''' float
*'''yPosOffset:''' float
*'''zPosOffset:''' float
*'''xRot:''' float
*'''yRot:''' float
*'''zRot:''' float
*'''p9:''' Boolean
*'''useSoftPinning:''' Boolean
*'''collision:''' Boolean
*'''isPed:''' Boolean
*'''vertexIndex:''' int
*'''fixedRot:''' Boolean

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

==Example==
<syntaxhighlight lang="javascript">

mp.events.add('arrestAttach', (cop, criminal) => {
criminal.attachTo(cop.handle, 0, 0, 0, 0, 0, 0, 0, true, false, false, false, 0, false);
});

</syntaxhighlight>

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