RAGE Multiplayer Wiki - User contributions [en]

Vehicle::Vehicle

2019-09-23T15:55:11Z

Cygwin255: numberPlate is bugged

{{sharedFunctionJS}}

Creates a vehicle. 
'''Notes:''' 
- Colors don't always work as expected if you use them inside the function. Also number plate won't work properly. Better set those after vehicle is created. 
- Heading means Z Rotation. 
- in 0.3.7 numberPlate property is bugged, so set the numberPlate after vehicle creation with vehicle.numberPlate = 'plate';
== 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::Vector3|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>
}}

==See also==
{{Vehicle_definition_c}}

[[Category:Vehicle API]]
[[Category:Clientside API]]
[[Category:Client-side Function]]
[[Category:Shared Function]]

Vehicle::setDamage

2019-09-13T17:11:28Z

Cygwin255:

Apply damage to vehicle at a location. Location is relative to vehicle model (not world). Radius of effect damage applied in a sphere at impact location
It is enough to use x,y,z values from -1 to 1.
p6 should be true, with false it does not taking in account offset values and all damage is applied to rear left part of the vehicle.
Good values for radius could be from 25 to 200, for damage 50-200.
You need to apply delay if you want to call setDamage couple times in a row. Typically 10ms is enough.
==Syntax==
<syntaxhighlight lang="javascript">vehicle.setDamage(xOffset, yOffset, zOffset, damage, radius, p6);</syntaxhighlight>
=== Required Arguments ===
*'''xOffset:''' float
*'''yOffset:''' float
*'''zOffset:''' float
*'''damage:''' float
*'''radius:''' float
*'''p6:''' Boolean
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>

[[Category:Clientside API]]
[[Category:TODO: Example]]

Storage.data

2019-09-10T11:51:50Z

Cygwin255: Created page for storage.data

Used to set some client-related data. Saved on the client, see [[storage.flush()]] for more details.
 Data is saved in <path to RAGEMP>/client_resources/<server ip>/.storage
 Thus it is wiped when player deletes client folder.
==Syntax==
<syntaxhighlight lang="javascript">
storage.data.someKey = obj;
</syntaxhighlight>
==Example==
<syntaxhighlight lang="javascript">
mp.storage.data.auth = { token: "abcd" };
mp.storage.flush();
</syntaxhighlight>
==Known bugs==
There is a bug with ragemp 0.3.7 when if server restarts while player is connected the data property gets nested into a new data field, so mp.storage.data becomes mp.storage.data.data and so on.
 Fix:
<syntaxhighlight lang="javascript">
// author: Shonz1 from ragemp's discord
// region: Fix RAGE:MP storage error (recursive data:...)
let storage = mp.storage.data;
while (storage.hasOwnProperty('data'))
storage = storage.data;

delete mp.storage.data.data;

Object.getOwnPropertyNames(storage).forEach(key => {
mp.storage.data[key] = storage[key];
});

mp.storage.flush();
// endregion
</syntaxhighlight>
==See also==
[[Category:Clientside API]]

Client-side functions

2019-09-10T11:38:35Z

Cygwin255: /* Storage */

==Classes==
===Blip===
{{Blip_functions_c}}

===Browser===
{{Browser_definition_c}}

===Camera===
{{Camera_definition_c}}

===Checkpoint===
*[[Checkpoint::Checkpoint]]

===Cursor===
{{Cursor_definition_c}}

===Voice chat===
*Properties:
**voiceChat.muted
*Functions:
**voiceChat.getPreprocessingParam
**voiceChat.setPreprocessingParam

===Entity===
{{Entity_functions_c}}

===Entity pool===
*[[Pool::atHandle]]
*[[Pool::atRemoteId]]
{{EntityPool_Client_functions}}
*[[Pool::remoteId]]

===Event===
{{Event_functions_c}}

===Global===
{{Global_properties_c}}

===Gui===
{{Gui_definition_c}}

===Keys===
{{Keys_functions_c}}

===Label===
{{Label_definition_c}}

===Marker===
{{Marker_definition_c}}

===Nametags===
*Functions:
**mp.nametags.update
**[[nametags.set|mp.nametags.set]]
*Properties:
**mp.nametags.enabled

===Object===
{{Object_definition_c}}

===Peds===
*[[Peds::new|mp.peds.new]]

===Pickup===
*[[Pickup::Pickup]]

===Player===
{{Player_definition_c}}

===Vector3===
{{Vector3_definition}}

===Vehicle===
{{Vehicle_definition_c}}

==Static Objects==

===App===
{{App_functions_c}}

===Audio===
{{Audio_functions_c}}

===Brain===
{{Brain_functions_c}}

===Cam===
{{Cam_functions_c}}

===Controls===
{{Controls_functions_c}}

===Cutscene===
{{Cutscene_functions_c}}

===Datafile===
{{Datafile_functions_c}}

===Decisionevent===
{{Decisionevent_functions_c}}

===Decorator===
*[[Decorator::decorIsRegisteredAsType|mp.game.decorator.decorIsRegisteredAsType]]
*[[Decorator::decorRegister|mp.game.decorator.decorRegister]]

===Discord===
*[[Discord::update|mp.discord.update]]

===DLC===
{{Dlc1_functions_c}}

===DLC2===
*[[Dlc2::nullify|mp.game.dlc2.nullify]]
*[[Dlc2::isDlcPresent|mp.game.dlc2.isDlcPresent]]

===Fire===
{{Fire_functions_c}}

===Gameplay===
{{Gameplay_functions_c}}

===Game Globals===
*Functions:
**[[Globals::joaat|mp.game.joaat]]
**[[Globals::invoke|mp.game.invoke]]
*Properies:
**[[Client-side_functions#App|mp.game.app]]
**[[Client-side_functions#Audio|mp.game.audio]]
**[[Client-side_functions#Brain|mp.game.brain]]
**[[Client-side_functions#Cam|mp.game.cam]]
**[[Client-side_functions#Controls|mp.game.controls]]
**[[Client-side_functions#Cutscene|mp.game.cutscene]]
**[[Client-side_functions#Datafile|mp.game.datafile]]
**[[Client-side_functions#Decisionevent|mp.game.decisionevent]]
**[[Client-side_functions#Decorator|mp.game.decorator]]
**[[Client-side_functions#Dlc1|mp.game.dlc1]]
**[[Client-side_functions#Dlc2|mp.game.dlc2]]
**[[Client-side_functions#Entity|mp.game.entity]]
**[[Client-side_functions#Fire|mp.game.fire]]
**[[Client-side_functions#Gameplay|mp.game.gameplay]]
**[[Client-side_functions#Graphics|mp.game.graphics]]
**[[Client-side_functions#Interior|mp.game.interior]]
**[[Client-side_functions#Itemset|mp.game.itemset]]
**[[Client-side_functions#Mobile|mp.game.mobile]]
**[[Client-side_functions#Object|mp.game.object]]
**[[Client-side_functions#Pathfind|mp.game.pathfind]]
**[[Client-side_functions#Ped|mp.game.ped]]
**[[Client-side_functions#Player|mp.game.player]]
**[[Client-side_functions#Rope|mp.game.rope]]
**[[Client-side_functions#Script|mp.game.script]]
**[[Client-side_functions#Stats|mp.game.stats]]
**[[Client-side_functions#Streaming|mp.game.streaming]]
**[[Client-side_functions#System|mp.game.system]]
**[[Client-side_functions#Time|mp.game.time]]
**[[Client-side_functions#Ui|mp.game.ui]]
**[[Client-side_functions#Unk|mp.game.unk]]
**[[Client-side_functions#Recorder|mp.game.recorder]]
**[[Client-side_functions#Vehicle|mp.game.vehicle]]
**[[Client-side_functions#Water|mp.game.water]]
**[[Client-side_functions#Weapon|mp.game.weapon]]
**[[Client-side_functions#Worldprobe|mp.game.worldprobe]]
**[[Client-side_functions#Zone|mp.game.zone]]

===Graphics===
{{Graphics_functions_c}}

===Interior===
{{Interior_functions_c}}

===Itemset===
{{Itemset_functions_c}}

===Mobile===
{{Mobile_functions_c}}

===Object===
{{Object_functions_c}}

===Pathfind===
{{Path_functions_c}}

===Ped===
{{Ped_functions_c}}

===Player===
{{Player_functions_c}}

===Raycasting===
**[[Raycasting::testPointToPoint|mp.raycasting.testPointToPoint]]
**[[Raycasting::testCapsule|mp.raycasting.testCapsule]]

===Recorder===
*[[Recorder::start|mp.game.recorder.start]]
*[[Recorder::stop|mp.game.recorder.stop]]
*[[Recorder::isRecording|mp.game.recorder.isRecording]]

===Rope===
{{Rope_functions_c}}

===Script===
{{Script_functions_c}}

===Stats===
{{Stats_functions_c}}

===Storage===
*Functions:
**[[storage.flush()|mp.storage.flush]]
*Properties:
**[[storage.data|mp.storage.data]]

===Streaming===
{{Streaming_functions_c}}

===System===
{{System_functions_c}}

===Time===
{{Time_functions_c}}

===Ui===
{{Ui_functions_c}}

===Unk===
*[[Unk::getBroadcastFinishedLosSound|mp.game.unk.getBroadcastFinishedLosSound]]

===Vehicle===
{{Vehicle_functions_c}}

===Water===
{{Water_functions_c}}

===Weapon===
{{Weapon_functions_c}}

===Worldprobe===
{{Worldprobe_functions_c}}

===Zone===
{{Zone_functions_c}}

World::setWeatherTransition

2019-09-10T11:35:38Z

Cygwin255: /* Example */

__NOTOC__
This function start a weather transition to the weather specified and sync it to all clients.

==Example==
<syntaxhighlight lang="javascript">
mp.world.setWeatherTransition("CLEARING"); // Set's the server's weather to 'CLEARING' immediately
</syntaxhighlight>
<syntaxhighlight lang="javascript">
mp.world.setWeatherTransition("CLEARING", 600000); // Set's the server's weather to 'CLEARING' with 10 minutes transition
</syntaxhighlight>
Note: the second use with duration field seems to be buggy, it has graphical issues with transition from SMOG to FOGGY weather (and probably with some other weather), so right now the best choise would be to do weather transition on client side and sync it manually.

==See Also==
[[Weather]]
{{World_definition}}

World::setWeatherTransition

2019-09-07T19:20:43Z

Cygwin255: Added example