RAGE Multiplayer Wiki - User contributions [en]

Events::delayInitialization

2019-11-21T08:49:41Z

Jengas:

{{ServersideJsFunction}}

__TOC__

This function delays server's initialization of packages to run early functions.

==Setter==
* {{RageType|Boolean}}

==Example==
{{ServersideCode|
<pre>
mp.events.delayInitialization = true;
let asyncDone = false;

(async () => {
// async calls done, now let it invoke "packagesLoaded"
await someAsyncFunction();
mp.events.delayInitialization = false;
asyncDone = true;
})();

mp.events.add('packagesLoaded', () => {
console.log(`async done: ${asyncDone}`); // Doesn't get triggered till mp.events.delayInitialization is true.
});
</pre>
}}

==See Also==
{{Event_functions}}

Blip::Blip

2019-11-10T19:43:00Z

Jengas:

{{SharedFunctionJS}}

Creates a blip to display on your map & minimap.

== Syntax ==

<pre>
mp.blips.new(sprite, position,
{
name: name,
scale: scale,
color: color,
alpha: alpha,
drawDistance: drawDistance,
shortRange: shortRange,
rotation: rotation,
dimension: dimension,
radius: radius,
});
</pre>

=== Parameters ===
*'''<span style="font-weight:bold; color:red;">*</span>sprite''': {{RageType|Int}} ([[Blips#Blip_model|Blip sprites]])
*'''<span style="font-weight:bold; color:red;">*</span>position''': {{RageType|Vector3}}
*'''name''': {{RageType|String}}
*'''scale''': {{RageType|Float}}
*'''color''': {{RageType|Color ID}} ([[Blips#Blip_colors|Blip colors]])
*'''alpha''': {{RageType|Int}} [0:255]
*'''drawDistance''': {{RageType|Float}}
*'''shortRange''': {{RageType|Boolean}}: Auto-hide on the minimap
*'''rotation''': {{RageType|Float}}
*'''dimension''': {{RageType|Int}}

<span style="font-weight:bold; color:red;">*</span> = Required

== Examples ==

This creates a blip at the police station. The blip is assigned to the variable '''policeBlip'''.

<div class="header" style="background-color: #00baad; color: #FFFFFF; border: 2px solid #00baad;">
<div style="margin: 10px 10px 10px 10px;"><b>Shared</b></div>
<pre>
let policeBlip = mp.blips.new(60, new mp.Vector3(427.95, -981.05, 0),
{
name: 'Los Santos Police Station',
color: 3,
shortRange: true,
});
</pre>
</div>

== See Also ==
{{Blip_definition}}

[[Category:Blip API]]
[[Category:Shared Function]]

Colshapes::newCuboid

2019-07-20T16:50:46Z

Jengas:

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

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

==See Also==
{{Colshapes_function}}

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

Streaming::requestModel

2019-05-27T17:17:10Z

Jengas: /* Example */

Request a model to be loaded into memory<br><br>Looking it the disassembly, it seems like it actually returns the model if it's already loaded.<br>
==Syntax==
<syntaxhighlight lang="javascript">mp.game.streaming.requestModel(modelHash);</syntaxhighlight>
=== Required Arguments ===
*'''model:''' Model hash
===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="javascript">
mp.game.streaming.requestModel(mp.game.joaat('a_f_y_juggalo_01'));
</syntaxhighlight>

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

Streaming::requestModel

2019-05-27T17:15:41Z

Jengas: /* Syntax */

Request a model to be loaded into memory<br><br>Looking it the disassembly, it seems like it actually returns the model if it's already loaded.<br>
==Syntax==
<syntaxhighlight lang="javascript">mp.game.streaming.requestModel(modelHash);</syntaxhighlight>
=== Required Arguments ===
*'''model:''' Model hash
===Return value===
*'''Undefined'''

==Example==
<syntaxhighlight lang="javascript">
mp.game.streaming.requestModel("infernus", () =>
{
mp.gui.outputChatBox(`${mp.game.streaming.hasModelLoaded("infernus")} is true`);
});
</syntaxhighlight>
==See also==
{{Streaming_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

PlayerLeaveVehicle

2018-12-27T20:04:27Z

Jengas: Fixed typo

Triggers when the player exits the vehicle
{{ServersideCsJsEvent}}
{{JSContainer|
{{Example}}
To do
}}
{{ClientsideCsJsEvent}}
{{CSharpContainer|
<syntaxhighlight lang="c#">
public delegate void OnPlayerLeaveVehicleDelegate();
</syntaxhighlight>
{{Parameters}}
* This event has no parameters

{{Example}}
The example below send a chat message to the player when they exit a vehicle.

<syntaxhighlight lang="c#">
Events.OnPlayerLeaveVehicle += OnPlayerLeaveVehicle();
</syntaxhighlight>
<syntaxhighlight lang="c#">
public void OnPlayerLeaveVehicle()
{
RAGE.Chat.Output("You exited a vehicle");
}
</syntaxhighlight>
}}

{{JSContainer|
{{Example}}
This example outputs chat message, when player start leave from the car.
<pre>
mp.events.add("playerLeaveVehicle", () => {
mp.gui.chat.push("Player start leave the vehicle");
})
</pre>
}}
==See Also==
{{Player_events}}