RAGE Multiplayer Wiki - User contributions [en]

Vehicle::defaultEngineBehaviour

2021-05-23T19:22:16Z

Wdoyle2: Incorrect note for use. Should be using Config Flag as well to ensure Animation is fixed

{{ClientsideJsFunction}}
Lets you disable the default engine behaviour (when you enter a vehicle, the player automatically turns on the engine). Setting this to false will stop the player from turning the engine on. 

Note: 
It is best to set the config flag: [[Player_Config_Flags|PED_FLAG_STOP_ENGINE_TURNING]] - to ensure the player doesn't attempt to turn the engine resulting in a strange animation.
<pre>mp.players.local.setConfigFlag(429, true);</pre>

{{JSContainer|
== Syntax ==

<pre>
mp.game.vehicle.defaultEngineBehaviour = flag;
</pre>

=== Parameters ===
*'''flag''': {{RageType|Boolean}}

== Examples ==
Simply disables people from turning on their engine within the server.

<pre>
mp.game.vehicle.defaultEngineBehaviour = false;
</pre>
}}

==See also==
{{Vehicle_s_function_c}}
[[Category:Clientside API]]

VehicleDamage

2021-05-11T21:26:36Z

Wdoyle2:

Event triggered when a vehicle gets damage.

{{ServersideCsJsEvent}}

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

{{JSContainer|
{{Parameters}}
* '''vehicle''': {{RageType|Vehicle}}
* '''bodyHealthLoss''': {{RageType|Number}}
* '''engineHealthLoss''': {{RageType|Number}}

{{Example}}
<syntaxhighlight lang="javascript">
mp.events.add("vehicleDamage", (vehicle, bodyHealthLoss, engineHealthLoss) => {
// Do what you want.
});
</syntaxhighlight>

====== Notice - currently deprecated on 1.1 as it only triggers on Health Value Changes ======
'' To recreate this event, simply monitor the vehicle health on interval and compare differences over a period of time ''

}}

== See also ==
* [[vehicleDeath]]

[[Category:Vehicle]]
[[Category:Server-side Event]]

Entity::setLights

2021-05-11T21:22:06Z

Wdoyle2: Poor example for setLights when referring to vehicle. (Note: might be worth removing if setLights is only a vehicle function)

==Syntax==
<syntaxhighlight lang="javascript">entity.setLights(toggle);</syntaxhighlight>
=== Required Arguments ===
*'''toggle:''' Boolean
===Return value===
*'''Undefined'''
==Example==

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

Template:Example

2021-05-04T13:59:22Z

Wdoyle2: Replaced content with "===Example==="

===Example===

Raycast Materials

2021-04-06T00:45:55Z

Wdoyle2: Materials from Raycasting

{| class="wikitable sortable" border="1" style="text-align:center;"
! scope="col" style="padding:20px;" |
Material Name
! scope="col" style="padding:20px;" |
ID
|-
|Default||-1775485061
|-
|Concrete||1187676648
|-
|ConcretePothole||359120722
|-
|ConcreteDusty||-1084640111
|-
|Tarmac||282940568
|-
|TarmacPainted||-1301352528
|-
|TarmacPothole||1886546517
|-
|RumbleStrip||-250168275
|-
|BreezeBlock||-954112554
|-
|Rock||-840216541
|-
|RockMossy||-124769592
|-
|Stone||765206029
|-
|Cobblestone||576169331
|-
|Brick||1639053622
|-
|Marble||1945073303
|-
|PavingSlab||1907048430
|-
|SandstoneSolid||592446772
|-
|SandstoneBrittle||1913209870
|-
|SandLoose||-1595148316
|-
|SandCompact||510490462
|-
|SandWet||909950165
|-
|SandTrack||-1907520769
|-
|SandUnderwater||-1136057692
|-
|SandDryDeep||509508168
|-
|SandWetDeep||1288448767
|-
|Ice||-786060715
|-
|IceTarmac||-1931024423
|-
|SnowLoose||-1937569590
|-
|SnowCompact||-878560889
|-
|SnowDeep||1619704960
|-
|SnowTarmac||1550304810
|-
|GravelSmall||951832588
|-
|GravelLarge||2128369009
|-
|GravelDeep||-356706482
|-
|GravelTrainTrack||1925605558
|-
|DirtTrack||-1885547121
|-
|MudHard||-1942898710
|-
|MudPothole||312396330
|-
|MudSoft||1635937914
|-
|MudUnderwater||-273490167
|-
|MudDeep||1109728704
|-
|Marsh||223086562
|-
|MarshDeep||1584636462
|-
|Soil||-700658213
|-
|ClayHard||1144315879
|-
|ClaySoft||560985072
|-
|GrassLong||-461750719
|-
|Grass||1333033863
|-
|GrassShort||-1286696947
|-
|Hay||-1833527165
|-
|Bushes||581794674
|-
|Twigs||-913351839
|-
|Leaves||-2041329971
|-
|Woodchips||-309121453
|-
|TreeBark||-1915425863
|-
|MetalSolidSmall||-1447280105
|-
|MetalSolidMedium||-365631240
|-
|MetalSolidLarge||752131025
|-
|MetalHollowSmall||15972667
|-
|MetalHollowMedium||1849540536
|-
|MetalHollowLarge||-583213831
|-
|MetalChainlinkSmall||762193613
|-
|MetalChainlinkLarge||125958708
|-
|MetalCorrugatedIron||834144982
|-
|MetalGrille||-426118011
|-
|MetalRailing||2100727187
|-
|MetalDuct||1761524221
|-
|MetalGarageDoor||-231260695
|-
|MetalManhole||-754997699
|-
|WoodSolidSmall||-399872228
|-
|WoodSolidMedium||555004797
|-
|WoodSolidLarge||815762359
|-
|WoodSolidPolished||126470059
|-
|WoodFloorDusty||-749452322
|-
|WoodHollowSmall||1993976879
|-
|WoodHollowMedium||-365476163
|-
|WoodHollowLarge||-925419289
|-
|WoodChipboard||1176309403
|-
|WoodOldCreaky||722686013
|-
|WoodHighDensity||-1742843392
|-
|WoodLattice||2011204130
|-
|Ceramic||-1186320715
|-
|RoofTile||1755188853
|-
|RoofFelt||-1417164731
|-
|Fibreglass||1354180827
|-
|Tarpaulin||-642658848
|-
|Plastic||-2073312001
|-
|PlasticHollow||627123000
|-
|PlasticHighDensity||-1625995479
|-
|PlasticClear||-1859721013
|-
|PlasticHollowClear||772722531
|-
|PlasticHighDensityClear||-1338473170
|-
|FibreglassHollow||-766055098
|-
|Rubber||-145735917
|-
|RubberHollow||-783934672
|-
|Linoleum||289630530
|-
|Laminate||1845676458
|-
|CarpetSolid||669292054
|-
|CarpetSolidDusty||158576196
|-
|CarpetFloorboard||-1396484943
|-
|Cloth||122789469
|-
|PlasterSolid||-574122433
|-
|PlasterBrittle||-251888898
|-
|CardboardSheet||236511221
|-
|CardboardBox||-1409054440
|-
|Paper||474149820
|-
|Foam||808719444
|-
|FeatherPillow||1341866303
|-
|Polystyrene||-1756927331
|-
|Leather||-570470900
|-
|Tvscreen||1429989756
|-
|SlattedBlinds||673696729
|-
|GlassShootThrough||937503243
|-
|GlassBulletproof||244521486
|-
|GlassOpaque||1500272081
|-
|Perspex||-1619794068
|-
|CarMetal||-93061983
|-
|CarPlastic||2137197282
|-
|CarSofttop||-979647862
|-
|CarSofttopClear||2130571536
|-
|CarGlassWeak||1247281098
|-
|CarGlassMedium||602884284
|-
|CarGlassStrong||1070994698
|-
|CarGlassBulletproof||-1721915930
|-
|CarGlassOpaque||513061559
|-
|Water||435688960
|-
|Blood||5236042
|-
|Oil||-634481305
|-
|Petrol||-1634184340
|-
|FreshMeat||868733839
|-
|DriedMeat||-1445160429
|-
|EmissiveGlass||1501078253
|-
|EmissivePlastic||1059629996
|-
|VfxMetalElectrified||-309134265
|-
|VfxMetalWaterTower||611561919
|-
|VfxMetalSteam||-691277294
|-
|VfxMetalFlame||332778253
|-
|PhysNoFriction||1666473731
|-
|PhysGolfBall||-1693813558
|-
|PhysTennisBall||-256704763
|-
|PhysCaster||-235302683
|-
|PhysCasterRusty||2016463089
|-
|PhysCarVoid||1345867677
|-
|PhysPedCapsule||-291631035
|-
|PhysElectricFence||-1170043733
|-
|PhysElectricMetal||-2013761145
|-
|PhysBarbedWire||-1543323456
|-
|PhysPooltableSurface||605776921
|-
|PhysPooltableCushion||972939963
|-
|PhysPooltableBall||-748341562
|-
|Buttocks||483400232
|-
|ThighLeft||-460535871
|-
|ShinLeft||652772852
|-
|FootLeft||1926285543
|-
|ThighRight||-236981255
|-
|ShinRight||-446036155
|-
|FootRight||-1369136684
|-
|Spine0||-1922286884
|-
|Spine1||-1140112869
|-
|Spine2||1457572381
|-
|Spine3||32752644
|-
|ClavicleLeft||-1469616465
|-
|UpperArmLeft||-510342358
|-
|LowerArmLeft||1045062756
|-
|HandLeft||113101985
|-
|ClavicleRight||-1557288998
|-
|UpperArmRight||1501153539
|-
|LowerArmRight||1777921590
|-
|HandRight||2000961972
|-
|Neck||1718294164
|-
|Head||-735392753
|-
|AnimalDefault||286224918
|-
|CarEngine||-1916939624
|-
|Puddle||999829011
|-
|ConcretePavement||2015599386
|-
|BrickPavement||-1147361576
|-
|PhysDynamicCoverBound||-2047468855
|-
|VfxWoodBeerBarrel||998201806
|-
|WoodHighFriction||-2140087047
|-
|RockNoinst||127813971
|-
|BushesNoinst||1441114862
|-
|MetalSolidRoadSurface||-729112334
|-
|StuntRampSurface||-2088174996
|-
|Temp01||746881105
|-
|Temp02||-1977970111
|-
|Temp03||1911121241
|-
|Temp04||1923995104
|-
|Temp05||-1393662448
|-
|Temp06||1061250033
|-
|Temp07||-1765523682
|-
|Temp08||1343679702
|-
|Temp09||1026054937
|-
|Temp10||63305994
|-
|Temp11||47470226
|-
|Temp12||702596674
|-
|Temp13||-1637485913
|-
|Temp14||-645955574
|-
|Temp15||-1583997931
|-
|Temp16||-1512735273
|-
|Temp17||1011960114
|-
|Temp18||1354993138
|-
|Temp19||-801804446
|-
|Temp20||-2052880405
|-
|Temp21||-1037756060
|-
|Temp22||-620388353
|-
|Temp23||465002639
|-
|Temp24||1963820161
|-
|Temp25||1952288305
|-
|Temp26||-1116253098
|-
|Temp27||889255498
|-
|Temp28||-1179674098
|-
|Temp29||1078418101
|-
|Temp30||13626292
|}

[[Category:Assets]]

Player Config Flags

2021-01-12T13:29:38Z

Wdoyle2: Includes ability to Disable Stopping of Vehicle Engine and restructured as out of order

__TOC__

This a list of the known player config flags.

== Flags ==

{| class="wikitable sortable" border="1" style="text-align:center;"
! scope="col" style="padding:20px;" |
Flag Name
! scope="col" style="padding:20px;" |
Flag ID
|-
|PED_FLAG_CAN_PUNCH||18
|-
|PED_FLAG_CAN_FLY_THRU_WINDSCREEN||32
|-
|PED_FLAG_DIES_BY_RAGDOLL||33
|-
|PED_FLAG_CAN_PUT_MOTORCYCLE_HELMET||35
|-
|PED_FLAG_NO_COLLISION||52
|-
|PED_FLAG_IS_SHOOTING||58
|-
|PED_FLAG_IS_ON_GROUND||60
|-
|PED_FLAG_NO_COLLIDE||62
|-
|PED_FLAG_DEAD||71
|-
|PED_FLAG_IS_SNIPER_SCOPE_ACTIVE||72
|-
|PED_FLAG_SUPER_DEAD||73
|-
|PED_FLAG_IS_IN_AIR||76
|-
|PED_FLAG_IS_AIMING||78
|-
|PED_FLAG_DRUNK||100
|-
|PED_FLAG_IS_NOT_RAGDOLL_AND_NOT_PLAYING_ANIM||104
|-
|PED_FLAG_NO_PLAYER_MELEE||122
|-
|PED_FLAG_NM_MESSAGE_466||125
|-
|PED_FLAG_ (Removes HELMET DAMAGE REDUCTION)||149
|-
|PED_FLAG_INJURED_LIMP||166
|-
|PED_FLAG_INJURED_LIMP_2||170
|-
|PED_FLAG_AUTOMATIC_SEAT_SHUFFLE||184
|-
|PED_FLAG_INJURED_DOWN||187
|-
|PED_FLAG_SHRINK||223
|-
|PED_FLAG_MELEE_COMBAT||224
|-
|PED_FLAG_DISABLE_STOPPING_VEH_ENGINE||241
|-
|PED_FLAG_IS_ON_STAIRS||253
|-
|PED_FLAG_HAS_ONE_LEG_ON_GROUND||276
|-
|PED_FLAG_NO_WRITHE||281
|-
|PED_FLAG_FREEZE||292
|-
|PED_FLAG_IS_STILL||301
|-
|PED_FLAG_NO_PED_MELEE||314
|-
|PED_SWITCHING_WEAPON||331
|-
|PED_FLAG_ALPHA||410
|-
|PED_FLAG_FLAMING_FOOTPRINTS||421
|-
|PED_FLAG_DISABLE_PROP_KNOCK_OFF||423
|-
|PED_FLAG_STOP_ENGINE_TURNING||429
|-
|PED_FLAG_ (Removes HELMET DAMAGE REDUCTION)||438
|}

== Functions ==
*[[Player::getConfigFlag|Player.getConfigFlag]]
*[[Player::setConfigFlag|Player.setConfigFlag]]

Player::taskPlaneLand

2021-01-11T10:27:22Z

Wdoyle2: /* Example */ Improved examples from XNLRealPlanes resource detailing correct runways

Function.Call(Hash.TASK_PLANE_LAND, pilot, selectedAirplane, runwayStartPoint.X, runwayStartPoint.Y, runwayStartPoint.Z, runwayEndPoint.X, runwayEndPoint.Y, runwayEndPoint.Z);

Using this you can task the ped to land (This will only task the ped to land the plane if already in air)
You need to turn the engines on manually because the ped will not
==Syntax==
<syntaxhighlight lang="javascript">player.taskPlaneLand(plane, runwayStartX, runwayStartY, runwayStartZ, runwayEndX, runwayEndY, runwayEndZ);</syntaxhighlight>
=== Required Arguments ===
*'''plane:''' Vehicle handle or object
*'''runwayStartX:''' float
*'''runwayStartY:''' float
*'''runwayStartZ:''' float
*'''runwayEndX:''' float
*'''runwayEndY:''' float
*'''runwayEndZ:''' float
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
const player = mp.players.local;

// Sandy Shore Airfield
player.taskPlaneLand(player.vehicle.handle, 1060.688232421875, 3077.2314453125, 40.273826599121094, 1667.779541015625, 3240.7724609375, 39.652400970458984);

// Runway 30R Los Santos International
player.taskPlaneLand(player.vehicle.handle, -944.08721923828, -3175.4035644531, 13.951797485352, -1211.2023925781, -3021.1779785156, 13.988622665405);

// Runway 30L Los Santos International
player.taskPlaneLand(player.vehicle.handle, -1015.9371948242, -3328.49609375, 13.987154960632, -1308.6403808594, -3159.6342773438, 13.944442749023);

// Runway 12R Los Santos International
player.taskPlaneLand(player.vehicle.handle, -1621.0546875, -2979.1828613281, 13.987594604492, -1300.5179443359, -3164.3552246094, 13.987669944763);

// Runway 12L Los Santos International
player.taskPlaneLand(player.vehicle.handle, -1553.873046875, -2823.3256835938, 14.001617431641, -1322.3289794922, -2956.9755859375, 13.989463806152);

// Runway 21 Los Santos International
player.taskPlaneLand(player.vehicle.handle, -1357.6005859375, -2247.2133789063, 13.968578338623, -1496.3876953125, -2487.9694824219, 13.97553062439);

// Runway at Zandudo
player.taskPlaneLand(player.vehicle.handle, -2035.1810302734, 2874.1303710938, 32.828636169434, -2425.7612304688, 3099.9943847656, 32.926719665527);
</syntaxhighlight>

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

VoiceChat.getPreprocessingParam

2021-01-11T10:09:55Z

Wdoyle2:

{{ClientsideJsFunction}}
'''Crash warning: It is worth noting some settings will return an array and can crash the game.'''

== Description ==
This function is for getting Audio Pre-Processing on the Voicechat. This function is utilized by the Speexdsp library therefore for any setting you wish to check would be best referred to the documentation.

==Parameters==
* '''setting''' - the int representing the setting you wish to check (For example SPEEX_PREPROCESS_GET_DEREVERB would be 9) [https://github.com/xiph/speexdsp/blob/master/include/speex/speex_preprocess.h#L98-L212 SpeexDSP PreProcess Source].

(The setting you wish to checkcan also be confirmed in the following documentation: [https://www.speex.org/docs/api/speex-api-reference/group__SpeexPreprocessState.html#g55d8537631ed5b7e49ec60b79ca6e98f Speex])

==Example==
This example calling clientside event

<syntaxhighlight lang="javascript">
mp.voiceChat.getPreprocessingParam(9);
</syntaxhighlight>

'''This might require some more examples to show you the benefits of using a Pre Processor on the Voice Chat'''

VoiceChat.getPreprocessingParam

2021-01-11T10:09:03Z

Wdoyle2:

{{ClientsideJsFunction}}
'''Crash warning: It is worth noting some settings will return an array and can crash the game.'''

== Description ==
This function is for getting Audio Pre-Processing on the Voicechat. This function is utilized by the Speexdsp library therefore for any setting you wish to check would be best referred to the documentation.

==Parameters==
* '''setting''' - the int representing the setting you wish to check (For example SPEEX_PREPROCESS_SET_NOISE_SUPPRESS would be 18) [https://github.com/xiph/speexdsp/blob/master/include/speex/speex_preprocess.h#L98-L212 SpeexDSP PreProcess Source].

(The setting you wish to checkcan also be confirmed in the following documentation: [https://www.speex.org/docs/api/speex-api-reference/group__SpeexPreprocessState.html#g55d8537631ed5b7e49ec60b79ca6e98f Speex])

==Example==
This example calling clientside event

<syntaxhighlight lang="javascript">
mp.voiceChat.getPreprocessingParam(10);
</syntaxhighlight>

'''This might require some more examples to show you the benefits of using a Pre Processor on the Voice Chat'''

VoiceChat.getPreprocessingParam

2021-01-11T10:08:49Z

Wdoyle2:

{{ClientsideJsFunction}}

'''Crash warning: It is worth noting some settings will return an array and can crash the game.```

== Description ==
This function is for getting Audio Pre-Processing on the Voicechat. This function is utilized by the Speexdsp library therefore for any setting you wish to check would be best referred to the documentation.

==Parameters==
* '''setting''' - the int representing the setting you wish to check (For example SPEEX_PREPROCESS_SET_NOISE_SUPPRESS would be 18) [https://github.com/xiph/speexdsp/blob/master/include/speex/speex_preprocess.h#L98-L212 SpeexDSP PreProcess Source].

(The setting you wish to checkcan also be confirmed in the following documentation: [https://www.speex.org/docs/api/speex-api-reference/group__SpeexPreprocessState.html#g55d8537631ed5b7e49ec60b79ca6e98f Speex])

==Example==
This example calling clientside event

<syntaxhighlight lang="javascript">
mp.voiceChat.getPreprocessingParam(10);
</syntaxhighlight>

'''This might require some more examples to show you the benefits of using a Pre Processor on the Voice Chat'''

VoiceChat.getPreprocessingParam

2021-01-11T10:01:11Z

Wdoyle2: Created page with "{{ClientsideJsFunction}} == Description == This function is for getting Audio Pre-Processing on the Voicechat. This function is utilized by the Speexdsp library therefore for..."

{{ClientsideJsFunction}}

== Description ==
This function is for getting Audio Pre-Processing on the Voicechat. This function is utilized by the Speexdsp library therefore for any setting you wish to check would be best referred to the documentation.

==Parameters==
* '''setting''' - the int representing the setting you wish to check (For example SPEEX_PREPROCESS_SET_NOISE_SUPPRESS would be 18) [https://github.com/xiph/speexdsp/blob/master/include/speex/speex_preprocess.h#L98-L212 SpeexDSP PreProcess Source].

(The setting you wish to checkcan also be confirmed in the following documentation: [https://www.speex.org/docs/api/speex-api-reference/group__SpeexPreprocessState.html#g55d8537631ed5b7e49ec60b79ca6e98f Speex])

==Example==
This example calling clientside event

<syntaxhighlight lang="javascript">
mp.voiceChat.getPreprocessingParam(10);
</syntaxhighlight>

'''This might require some more examples to show you the benefits of using a Pre Processor on the Voice Chat'''

VoiceChat.setPreprocessingParam

2021-01-11T09:54:15Z

Wdoyle2: Documentation based on xdays comments in Discord previously

{{ClientsideJsFunction}}

== Description ==
This function is for setting Audio Pre-Processing on the Voicechat. This function is utilized by the Speexdsp library therefore for any values and params it would be best to check those.

==Parameters==
* '''setting''' - the int representing the value you wish to change (For example SPEEX_PREPROCESS_SET_NOISE_SUPPRESS would be 18) [https://github.com/xiph/speexdsp/blob/master/include/speex/speex_preprocess.h#L98-L212 SpeexDSP PreProcess Source].
* '''value''' - Based on the value allowed in the Speex documentation

(The setting you wish to change can also be confirmed in the following documentation: [https://www.speex.org/docs/api/speex-api-reference/group__SpeexPreprocessState.html#g55d8537631ed5b7e49ec60b79ca6e98f Speex])

==Example==
This example calling clientside event (You will need to test with another player to fine tune the effects.

<syntaxhighlight lang="javascript">
mp.voiceChat.setPreprocessingParam(10,1);
</syntaxhighlight>

'''This might require some more examples to show you the benefits of using a Pre Processor on the Voice Chat'''

Key::bind

2021-01-07T23:03:12Z

Wdoyle2: Ignore - was missing the keycode

{{ClientsideJsFunction}}

== Description ==
This function binds the key .

==Parameters==
* '''keycode''' - hexadecimal code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key].
* '''keydown/keyup''' - true trigges on keydown, false triggers on keyup (bool)
* '''handler''' - function-handler.

==Example==
This example calling server event.

<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.');
});
</syntaxhighlight>

==See also==
{{Keys_functions_c}}

Key::bind

2021-01-07T23:02:08Z

Wdoyle2: Easy to use Key Finding tool

{{ClientsideJsFunction}}

== Description ==
This function binds the key .

==Parameters==
* '''keycode''' - hexadecimal code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key]. (For an easy to use Key finding tool - try [https://keycode.info/ keycode.info])
* '''keydown/keyup''' - true trigges on keydown, false triggers on keyup (bool)
* '''handler''' - function-handler.

==Example==
This example calling server event.

<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.');
});
</syntaxhighlight>

==See also==
{{Keys_functions_c}}

Vehicle::setLivery

2021-01-07T14:41:58Z

Wdoyle2:

==Syntax==
<syntaxhighlight lang="javascript">vehicle.setLivery(livery);</syntaxhighlight>
=== Required Arguments ===
*'''livery:''' int
===Return value===
*'''Undefined'''
==Example==
<syntaxhighlight lang="javascript">
// todo
</syntaxhighlight>
==See also==
{{Vehicle_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]

System.notify()

2021-01-07T08:51:30Z

Wdoyle2:

Send a Notification direct to the Desktop of the User

{{ClientsideCode|
<pre>
mp.system.notify({ title: string, text: string, attribute: string, duration: int, silent: bool })
</pre>
}}
=== Arguments ===
*'''title:''' String
*'''text:''' String
*'''attribute:''' String
*'''duration:''' Int
*'''silent:''' Boolean
==Example==
<gallery widths=280px heights=190px>
File:System.notify.png
</gallery>

==See also==
{{Gui_definition_c}}
[[Category:Clientside API]]

System.notify()

2021-01-07T08:41:21Z

Wdoyle2: Created page with "Send a Notification direct to the Windows Desktop of the User {{ClientsideCode| <pre> mp.system.notify({ title: string, text: string, attribute: string, duration: int, silent..."

Send a Notification direct to the Windows Desktop of the User

{{ClientsideCode|
<pre>
mp.system.notify({ title: string, text: string, attribute: string, duration: int, silent: bool })
</pre>
}}
=== Arguments ===
*'''title:''' String
*'''text:''' String
*'''attribute:''' String
*'''duration:''' Int
*'''silent:''' Boolean
==Example==
<gallery widths=280px heights=190px>
File:System.notify.png
</gallery>

==See also==
{{Gui_definition_c}}
[[Category:Clientside API]]

File:System.notify.png

2021-01-07T08:40:36Z

Wdoyle2:

Clientside JS Snippets

2020-12-01T10:02:00Z

Wdoyle2: Created page with "= Client-side Javascript - Helpful Code Snippets/Examples = === These should not be limited to one existing function. If they are, simply propose the edit on the function as a..."

= Client-side Javascript - Helpful Code Snippets/Examples =
=== These should not be limited to one existing function. If they are, simply propose the edit on the function as an example ===

'''Rotate Recentangle'''
The rotate rectangle allows you to get the Vehicle size and rotate it to get the correct X and Y from the Game.

<pre>
rotateRect(angle, ox, oy, x, y, w, h) {
const xAx = Math.cos(angle); // x axis x
const xAy = Math.sin(angle); // x axis y
x -= ox; // move rectangle onto origin
y -= oy;
return [[ // return array holding the resulting points
x * xAx - y * xAy + ox, // Get the top left rotated position
x * xAy + y * xAx + oy, // and move it back to the origin
], [
(x + w) * xAx - y * xAy + ox, // Get the top right rotated position
(x + w) * xAy + y * xAx + oy,
], [
(x + w) * xAx - (y + h) * xAy + ox, // Get the bottom right rotated position
(x + w) * xAy + (y + h) * xAx + oy,
], [
x * xAx - (y + h) * xAy + ox, // Get the bottom left rotated position
x * xAy + (y + h) * xAx + oy,
]
];
}</pre>

'''Get Vehicle Layout (Sizings and Location in Game)'''
This function allows you to get the full layout of the vehicle such as front, rear, roof.
<pre>vehicleLayout(Vehicle) {
const sizeofVehicle = mp.game.gameplay.getModelDimensions(Vehicle.model);
const vehicleRotation = Vehicle.getRotation(2);
const Xwidth = (0 - sizeofVehicle.min.x) + (sizeofVehicle.max.x);
const Ywidth = (0 - sizeofVehicle.min.y) + (sizeofVehicle.max.y);
const degree = (vehicleRotation.z + 180) * Math.PI / 180;
const newDegrees = this.rotateRect(degree, Vehicle.position.x, Vehicle.position.y, Vehicle.position.x - sizeofVehicle.max.x, Vehicle.position.y - sizeofVehicle.max.y, Xwidth, Ywidth);
const frontX = newDegrees[0][0] + ((newDegrees[1][0] - newDegrees[0][0]) / 2);
const frontY = newDegrees[0][1] + ((newDegrees[1][1] - newDegrees[0][1]) / 2);
const bottomX = newDegrees[2][0] + ((newDegrees[3][0] - newDegrees[2][0]) / 2);
const bottomY = newDegrees[2][1] + ((newDegrees[3][1] - newDegrees[2][1]) / 2);
return {
front: {x: frontX, y: frontY},
back: {x: bottomX, y: bottomY},
center: {x: Vehicle.position.x, y: Vehicle.position.y},
size: {
lengthX: Xwidth,
lengthY: Ywidth,
min: {x: sizeofVehicle.min.x, y: sizeofVehicle.min.y},
max: {x: sizeofVehicle.max.x, y: sizeofVehicle.max.y},
z: sizeofVehicle.min.z
}
};
}
</pre>

Gameplay::getGroundZFor3dCoord

2019-09-17T19:18:09Z

Wdoyle2: /* Example */

Returns the first surface ''beneath'' the specified elevation (at the given location). 
This can be a roof, an elevated road, or the ground. 
(If no surface can be found beneath, then the returned boolean will be false, and the float will contain 0.) 
For water positions the sea floor will be returned (negative value).

For the function to work reliably, the position tested should have been streamed already (i.e. close to the player); otherwise it might return 0.

==Syntax==
<syntaxhighlight lang="javascript">mp.game.gameplay.getGroundZFor3dCoord(x, y, z, unknowna, unknownb);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' float - X-coordinate of location to test
*'''y:''' float - Y-coordinate of location to test
*'''z:''' float - Z-coordinate, beneath which to test
*'''unknowna:''' float - this is ignored
*'''unknownb:''' boolean - unknown (normally 0)
===Return value===
*'''float''' - Elevation above the ground
==Example==
<syntaxhighlight lang="javascript">
const getGroundZ = mp.game.gameplay.getGroundZFor3dCoord(position.x, position.y, position.z, parseFloat(0), false);

mp.markers.new(1, new mp.Vector3(position.x, position.y,getGroundZ), 1.5,
{
color: [0, 255, 0, 100],
visible: true
});
</syntaxhighlight>

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

Gameplay::getGroundZFor3dCoord

2019-09-17T19:17:50Z

Wdoyle2: Implement client side JS function and correct defintion of the function and response

Returns the first surface ''beneath'' the specified elevation (at the given location). 
This can be a roof, an elevated road, or the ground. 
(If no surface can be found beneath, then the returned boolean will be false, and the float will contain 0.) 
For water positions the sea floor will be returned (negative value).

For the function to work reliably, the position tested should have been streamed already (i.e. close to the player); otherwise it might return 0.

==Syntax==
<syntaxhighlight lang="javascript">mp.game.gameplay.getGroundZFor3dCoord(x, y, z, unknowna, unknownb);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' float - X-coordinate of location to test
*'''y:''' float - Y-coordinate of location to test
*'''z:''' float - Z-coordinate, beneath which to test
*'''unknowna:''' float - this is ignored
*'''unknownb:''' boolean - unknown (normally 0)
===Return value===
*'''float''' - Elevation above the ground
==Example==
<syntaxhighlight lang="javascript">
const getGroundZ = mp.game.gameplay.getGroundZFor3dCoord(position.x, position.y, position.z, parseFloat(0), false);

mp.markers.new(1, new mp.Vector3(position.x, position.y,groundZCords), 1.5,
{
color: [0, 255, 0, 100],
visible: true
});
</syntaxhighlight>
==See also==
{{Gameplay_s_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]