@citizenfx/client 2.0.6947-1 → 2.0.7031-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -609,23 +609,27 @@ declare function AddOilDecal(x: number, y: number, z: number, groundLvl: number,
609
609
  declare function AddOwnedExplosion(ped: number, x: number, y: number, z: number, explosionType: number, damageScale: number, isAudible: boolean, isInvisible: boolean, cameraShake: number): void;
610
610
 
611
611
  /**
612
- * ADD_PATROL_ROUTE_LINK
612
+ * connects/links 2 [route nodes](#\_0x8EDF950167586B7C)\
613
+ * image representing the cyclic example below:\
614
+ * ![image](https://user-images.githubusercontent.com/55803068/188470866-c32c6a9f-a25d-4772-9b18-5be46e2c14a1.png)
615
+ * @param id1 the id representing the first route node
616
+ * @param id2 the id representing the second route node
613
617
  */
614
- declare function AddPatrolRouteLink(p0: number, p1: number): void;
618
+ declare function AddPatrolRouteLink(id1: number, id2: number): void;
615
619
 
616
620
  /**
617
- * Example:
618
- * TASK::ADD_PATROL_ROUTE_NODE(2, "WORLD_HUMAN_GUARD_STAND", -193.4915, -2378.864990234375, 10.9719, -193.4915, -2378.864990234375, 10.9719, 3000);
619
- * p0 is between 0 and 4 in the scripts.
620
- * p1 is "WORLD_HUMAN_GUARD_STAND" or "StandGuard".
621
- * p2, p3 and p4 is only one parameter sometimes in the scripts. Most likely a Vector3 hence p2, p3 and p4 are coordinates.
622
- * Examples:
623
- * TASK::ADD_PATROL_ROUTE_NODE(1, "WORLD_HUMAN_GUARD_STAND", l_739[7 -- [[3]] ], 0.0, 0.0, 0.0, 0);
624
- * TASK::ADD_PATROL_ROUTE_NODE(1, "WORLD_HUMAN_GUARD_STAND", l_B0[17 -- [[44]] ]._f3, l_B0[17 -- [[44]] ]._f3, 2000);
625
- * p5, p6 and p7 are for example set to: 1599.0406494140625, 2713.392578125, 44.4309.
626
- * p8 is an int, often random set to for example: MISC::GET_RANDOM_INT_IN_RANGE(5000, 10000).
621
+ * x2,y2 and z2 are the coordinates to which the ped should look at
622
+ * @param id is an integer that "identifies" the route node for linking to the route with ADD_PATROL_ROUTE_LINK.
623
+ * @param guardScenario can be "WORLD_HUMAN_GUARD_STAND" or "StandGuard"
624
+ * @param x1 destination
625
+ * @param y1 destination
626
+ * @param z1 destination
627
+ * @param x2 coordinates to which the ped should look
628
+ * @param y2 coordinates to which the ped should look
629
+ * @param z2 coordinates to which the ped should look
630
+ * @param waitTime written in ms
627
631
  */
628
- declare function AddPatrolRouteNode(p0: number, p1: string, x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, p8: number): void;
632
+ declare function AddPatrolRouteNode(id: number, guardScenario: string, x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, waitTime: number): void;
629
633
 
630
634
  /**
631
635
  * Applies an Item from a PedDecorationCollection to a ped. These include tattoos and shirt decals.
@@ -1743,11 +1747,24 @@ declare function Atan2(p0: number, p1: number): number;
1743
1747
 
1744
1748
  /**
1745
1749
  * Last param determines if its relative to the Entity
1750
+ * @param cam The camera handle.
1751
+ * @param entity The entity handle.
1752
+ * @param xOffset X-axis offset
1753
+ * @param yOffset Y-axis offset
1754
+ * @param zOffset Z-axis offset
1755
+ * @param isRelative Whether or not the camera will be relative to the entity
1746
1756
  */
1747
1757
  declare function AttachCamToEntity(cam: number, entity: number, xOffset: number, yOffset: number, zOffset: number, isRelative: boolean): void;
1748
1758
 
1749
1759
  /**
1750
- * ATTACH_CAM_TO_PED_BONE
1760
+ * This native works with peds only.
1761
+ * @param cam The camera handle.
1762
+ * @param ped The ped handle.
1763
+ * @param boneIndex This is different to boneID, use ['GET_PED_BONE_INDEX'](#\_0x3F428D08BE5AAE31) to get the index from the ID. use the index for attaching to specific bones. `cam` will be attached to the center of `ped` if bone index given doesn't correspond to bone indexes for that entity type.
1764
+ * @param xOffset X-axis offset
1765
+ * @param yOffset Y-axis offset
1766
+ * @param zOffset Z-axis offset
1767
+ * @param isRelative Whether or not the camera will be relative to the bone
1751
1768
  */
1752
1769
  declare function AttachCamToPedBone(cam: number, ped: number, boneIndex: number, xOffset: number, yOffset: number, zOffset: number, isRelative: boolean): void;
1753
1770
 
@@ -1912,11 +1929,15 @@ declare function AttachVehicleOnToTrailer(vehicle: number, trailer: number, offs
1912
1929
  declare function N_0x16b5e274bde402f8(vehicle: number, trailer: number, offsetX: number, offsetY: number, offsetZ: number, coordsX: number, coordsY: number, coordsZ: number, rotationX: number, rotationY: number, rotationZ: number, disableColls: number): void;
1913
1930
 
1914
1931
  /**
1915
- * p2 is unknown and is always -1 in the script natives.
1916
- * @param vehicle The vehicle which should be attached
1932
+ * ATTACH_VEHICLE_TO_CARGOBOB
1917
1933
  * @param cargobob The cargobob
1934
+ * @param vehicle The vehicle that will be attached
1935
+ * @param vehicleBoneIndex A Vehicle bone the hook/magnet should attach to or -1 for none/default [GET_ENTITY_BONE_INDEX_BY_NAME](#\_0xFB71170B7E76ACBA)
1936
+ * @param x x hook/magnet Offset
1937
+ * @param y y hook/magnet Offset
1938
+ * @param z z hook/magnet Offset
1918
1939
  */
1919
- declare function AttachVehicleToCargobob(vehicle: number, cargobob: number, p2: number, x: number, y: number, z: number): void;
1940
+ declare function AttachVehicleToCargobob(cargobob: number, vehicle: number, vehicleBoneIndex: number, x: number, y: number, z: number): void;
1920
1941
 
1921
1942
  /**
1922
1943
  * HookOffset defines where the hook is attached. leave at 0 for default attachment.
@@ -3490,11 +3511,11 @@ declare function ClearGpsDisabledZoneAtIndex(index: number): void;
3490
3511
  declare function ClearGpsFlags(): void;
3491
3512
 
3492
3513
  /**
3493
- * Does the same as [`SET_GPS_MULTI_ROUTE_RENDER(false)`](https://runtime.fivem.net/doc/reference.html#\_0x3DDA37128DD1ACA8)
3514
+ * Does the same as [`SET_GPS_MULTI_ROUTE_RENDER(false)`](#\_0x3DDA37128DD1ACA8)
3494
3515
  */
3495
3516
  declare function ClearGpsMultiRoute(): void;
3496
3517
  /**
3497
- * Does the same as [`SET_GPS_MULTI_ROUTE_RENDER(false)`](https://runtime.fivem.net/doc/reference.html#\_0x3DDA37128DD1ACA8)
3518
+ * Does the same as [`SET_GPS_MULTI_ROUTE_RENDER(false)`](#\_0x3DDA37128DD1ACA8)
3498
3519
  */
3499
3520
  declare function N_0x67eedea1b9bafd94(): void;
3500
3521
 
@@ -4494,8 +4515,8 @@ declare function CreateItemset(distri: boolean): number;
4494
4515
  * ### Some train variations (default from trains.xml as of build 2372)
4495
4516
  * * 17. Very long train and freight variation.
4496
4517
  * * 18. Freight train only.
4497
- * * 25. Double metro train (with both models flipped opposite to each other). This used to be `24` before the 2372 build.
4498
- * @param variation The variation id, these can range from 0 to 25 as of build 2372.
4518
+ * * 26. Double metro train (with both models flipped opposite to each other). This used to be `25` before the 2802 build, it also used to be `24` before the 2372 build.
4519
+ * @param variation The variation id, these can range from 0 to 26 as of build 2802 (previously `0-25` in build 2372 and `0-24` before that).
4499
4520
  * @param x Spawn coordinate X component.
4500
4521
  * @param y Spawn coordinate Y component.
4501
4522
  * @param z Spawn coordinate Z component.
@@ -5716,7 +5737,7 @@ declare function DetachVehicleFromAnyTowTruck(vehicle: number): boolean;
5716
5737
  /**
5717
5738
  * DETACH_VEHICLE_FROM_CARGOBOB
5718
5739
  */
5719
- declare function DetachVehicleFromCargobob(vehicle: number, cargobob: number): void;
5740
+ declare function DetachVehicleFromCargobob(cargobob: number, vehicle: number): void;
5720
5741
 
5721
5742
  /**
5722
5743
  * First two parameters swapped. Scripts verify that towTruck is the first parameter, not the second.
@@ -5892,8 +5913,10 @@ declare function DisablePedPainAudio(ped: number, toggle: boolean): void;
5892
5913
  declare function DisablePlaneAileron(vehicle: number, p1: boolean, p2: boolean): void;
5893
5914
 
5894
5915
  /**
5895
- * Inhibits the player from using any method of combat including melee and firearms.
5916
+ * Inhibits the player from using any method of combat including melee and firearms.\
5896
5917
  * NOTE: Only disables the firing for one frame
5918
+ * @param player The player for which to disable combat methods.
5919
+ * @param toggle Unused, as this native will disable combat regardless of the value of this parameter.
5897
5920
  */
5898
5921
  declare function DisablePlayerFiring(player: number, toggle: boolean): void;
5899
5922
 
@@ -7344,13 +7367,13 @@ declare function EnableAircraftObstacleAvoidance(vehicle: number, avoidObstacles
7344
7367
  declare function N_0x8aa9180de2fedd45(vehicle: number, avoidObstacles: boolean): void;
7345
7368
 
7346
7369
  /**
7347
- * Creates a motion-blur sort of effect, this native does not seem to work, however by using the [`START_SCREEN_EFFECT`](#\_0x2206BF9A37B7F724) native with `"DrugsMichaelAliensFight"` as the effect parameter, you should be able to get the effect.
7348
- * This native does not seem to work, however by using the [START_SCREEN_EFFECT](https://runtime.fivem.net/doc/natives/#\_0x2206BF9A37B7F724) native with "DrugsMichaelAliensFight" as the effect parameter, you should be able to get the effect.
7370
+ * Creates a motion-blur sort of effect, this native does not seem to work, however by using the [`ANIMPOSTFX_PLAY`](#\_0x2206BF9A37B7F724) native with `"DrugsMichaelAliensFight"` as the effect parameter, you should be able to get the effect.
7371
+ * This native does not seem to work, however by using the [ANIMPOSTFX_PLAY](#\_0x2206BF9A37B7F724) native with "DrugsMichaelAliensFight" as the effect parameter, you should be able to get the effect.
7349
7372
  */
7350
7373
  declare function EnableAlienBloodVfx(toggle: boolean): void;
7351
7374
  /**
7352
- * Creates a motion-blur sort of effect, this native does not seem to work, however by using the [`START_SCREEN_EFFECT`](#\_0x2206BF9A37B7F724) native with `"DrugsMichaelAliensFight"` as the effect parameter, you should be able to get the effect.
7353
- * This native does not seem to work, however by using the [START_SCREEN_EFFECT](https://runtime.fivem.net/doc/natives/#\_0x2206BF9A37B7F724) native with "DrugsMichaelAliensFight" as the effect parameter, you should be able to get the effect.
7375
+ * Creates a motion-blur sort of effect, this native does not seem to work, however by using the [`ANIMPOSTFX_PLAY`](#\_0x2206BF9A37B7F724) native with `"DrugsMichaelAliensFight"` as the effect parameter, you should be able to get the effect.
7376
+ * This native does not seem to work, however by using the [ANIMPOSTFX_PLAY](#\_0x2206BF9A37B7F724) native with "DrugsMichaelAliensFight" as the effect parameter, you should be able to get the effect.
7354
7377
  */
7355
7378
  declare function N_0x9dce1f0f78260875(toggle: boolean): void;
7356
7379
 
@@ -14031,24 +14054,24 @@ declare function GetPedEventData(ped: number, eventType: number, outData?: numbe
14031
14054
  declare function GetPedExtractedDisplacement(ped: number, worldSpace: boolean): number[];
14032
14055
 
14033
14056
  /**
14034
- * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
14057
+ * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
14035
14058
  * @param ped The target ped
14036
14059
  * @return Returns ped's eye colour, or -1 if fails to get.
14037
14060
  */
14038
14061
  declare function GetPedEyeColor(ped: number): number;
14062
+
14039
14063
  /**
14040
14064
  * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
14041
14065
  * @param ped The target ped
14042
14066
  * @return Returns ped's eye colour, or -1 if fails to get.
14043
14067
  */
14044
- declare function N_0x76bba2cee66d47e9(ped: number): number;
14045
-
14068
+ declare function GetPedEyeColor(ped: number): number;
14046
14069
  /**
14047
- * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
14070
+ * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
14048
14071
  * @param ped The target ped
14049
14072
  * @return Returns ped's eye colour, or -1 if fails to get.
14050
14073
  */
14051
- declare function GetPedEyeColor(ped: number): number;
14074
+ declare function N_0x76bba2cee66d47e9(ped: number): number;
14052
14075
 
14053
14076
  /**
14054
14077
  * A getter for [\_SET_PED_FACE_FEATURE](#\_0x71A5C1DBA060049E). Returns 0.0 if fails to get.
@@ -18578,7 +18601,7 @@ declare function GivePedNmMessage(ped: number): void;
18578
18601
  * ```
18579
18602
  * p1 is either 1 or 2 in the PC scripts.
18580
18603
  * ```
18581
- * This native is used to "give"/duplicate a player ped to a frontend menu as configured via the `ACTIVATE_FRONTEND_MENU` native, you first must utilize the `CLONE_PED` ( https://runtime.fivem.net/doc/natives/#\_0xEF29A16337FACADB ) to clone said ped.
18604
+ * This native is used to "give"/duplicate a player ped to a frontend menu as configured via the `ACTIVATE_FRONTEND_MENU` native, you first must utilize the [CLONE_PED](#\_0xEF29A16337FACADB) to clone said ped.
18582
18605
  */
18583
18606
  declare function GivePedToPauseMenu(ped: number, p1: number): void;
18584
18607
 
@@ -41558,20 +41581,21 @@ declare function SetBlipColour(blip: number, color: number): void;
41558
41581
  declare function SetBlipCoords(blip: number, posX: number, posY: number, posZ: number): void;
41559
41582
 
41560
41583
  /**
41561
- * **displayId Behaviour** <br>
41562
- * 0 = Doesn't show up, ever, anywhere. <br>
41563
- * 1 = Doesn't show up, ever, anywhere. <br>
41564
- * 2 = Shows on both main map and minimap. (Selectable on map) <br>
41565
- * 3 = Shows on main map only. (Selectable on map) <br>
41566
- * 4 = Shows on main map only. (Selectable on map) <br>
41567
- * 5 = Shows on minimap only. <br>
41568
- * 6 = Shows on both main map and minimap. (Selectable on map) <br>
41569
- * 7 = Doesn't show up, ever, anywhere. <br>
41570
- * 8 = Shows on both main map and minimap. (Not selectable on map) <br>
41571
- * 9 = Shows on minimap only. <br>
41572
- * 10 = Shows on both main map and minimap. (Not selectable on map) <br>
41573
- * Anything higher than 10 seems to be exactly the same as 10. <br>
41574
- * <br>
41584
+ * **displayId Behaviour**
41585
+ * | display ID | Behaviour |
41586
+ * |------------ |------------------------------------------------------------- |
41587
+ * | 0 | Doesn't show up, ever, anywhere. |
41588
+ * | 1 | Doesn't show up, ever, anywhere. |
41589
+ * | 2 | Shows on both main map and minimap. (Selectable on map) |
41590
+ * | 3 | Shows on main map only. (Selectable on map) |
41591
+ * | 4 | Shows on main map only. (Selectable on map) |
41592
+ * | 5 | Shows on minimap only. |
41593
+ * | 6 | Shows on both main map and minimap. (Selectable on map) |
41594
+ * | 7 | Doesn't show up, ever, anywhere. |
41595
+ * | 8 | Shows on both main map and minimap. (Not selectable on map) |
41596
+ * | 9 | Shows on minimap only. |
41597
+ * | 10 | Shows on both main map and minimap. (Not selectable on map) |
41598
+ * Anything higher than 10 seems to be exactly the same as 10.
41575
41599
  * Rockstar seem to only use 0, 2, 3, 4, 5 and 8 in the decompiled scripts.
41576
41600
  */
41577
41601
  declare function SetBlipDisplay(blip: number, displayId: number): void;
@@ -41693,9 +41717,6 @@ declare function SetBlipShrink(blip: number, toggle: boolean): void;
41693
41717
  declare function N_0x2b6d467dab714e8d(blip: number, toggle: boolean): void;
41694
41718
 
41695
41719
  /**
41696
- * <!--
41697
- * _loc1_.map((name, idx) => `| ${idx} | ${name} | ![${name}](https://runtime.fivem.net/blips/${name}.svg) |`).join('\n')
41698
- * -->
41699
41720
  * Sets the displayed sprite for a specific blip.
41700
41721
  * There's a [list of sprites](https://docs.fivem.net/game-references/blips/) on the FiveM documentation site.
41701
41722
  * @param blip The blip to change.
@@ -42148,11 +42169,11 @@ declare function SetCanClimbOnEntity(entity: number, toggle: boolean): void;
42148
42169
  declare function N_0xa80ae305e0a3044f(entity: number, toggle: boolean): void;
42149
42170
 
42150
42171
  /**
42151
- * Does the same as [`_SET_CAN_PED_SELECT_WEAPON`](https://runtime.fivem.net/doc/natives/#\_0xB4771B9AAF4E68E4) except for all weapons.
42172
+ * Does the same as [`_SET_CAN_PED_SELECT_WEAPON`](#\_0xB4771B9AAF4E68E4) except for all weapons.
42152
42173
  */
42153
42174
  declare function SetCanPedEquipAllWeapons(ped: number, toggle: boolean): void;
42154
42175
  /**
42155
- * Does the same as [`_SET_CAN_PED_SELECT_WEAPON`](https://runtime.fivem.net/doc/natives/#\_0xB4771B9AAF4E68E4) except for all weapons.
42176
+ * Does the same as [`_SET_CAN_PED_SELECT_WEAPON`](#\_0xB4771B9AAF4E68E4) except for all weapons.
42156
42177
  */
42157
42178
  declare function N_0xeff296097ff1e509(ped: number, toggle: boolean): void;
42158
42179
 
@@ -43625,13 +43646,45 @@ declare function SetFloatingHelpTextScreenPosition(hudIndex: number, x: number,
43625
43646
  declare function N_0x7679cc1bcebe3d4c(hudIndex: number, x: number, y: number): void;
43626
43647
 
43627
43648
  /**
43628
- * SET_FLOATING_HELP_TEXT_STYLE
43629
- */
43630
- declare function SetFloatingHelpTextStyle(hudIndex: number, p1: number, p2: number, p3: number, p4: number, p5: number): void;
43631
- /**
43632
- * SET_FLOATING_HELP_TEXT_STYLE
43633
- */
43634
- declare function N_0x788e7fd431bd67f1(hudIndex: number, p1: number, p2: number, p3: number, p4: number, p5: number): void;
43649
+ * ### Arrow Positions
43650
+ * * 0 = Off / No arrow
43651
+ * * 1 = Top
43652
+ * * 2 = Left
43653
+ * * 3 = Bottom
43654
+ * * 4 = Right
43655
+ * ### Note
43656
+ * Any numeric value greater than 4 will result in a right arrow (Index 4)
43657
+ * ### Important
43658
+ * Needs to be called every frame
43659
+ * ![Preview of the provided example code](https://forum.cfx.re/uploads/default/original/4X/7/f/3/7f319bc93c3a00b8829bd4ac8dddc235fbf3a9ef.png)
43660
+ * @param hudIndex The hud index for the floating help message
43661
+ * @param style Value 0 won't show an arrow at all. Values 1, 2 and -2 will display an arrow.
43662
+ * @param hudColor https://docs.fivem.net/docs/game-references/hud-colors/
43663
+ * @param alpha Value for the help box opacity, from 0-255. Anything greater will simply ignore the alpha value. Always 191 in R\* scripts.
43664
+ * @param arrowPosition Used to set the arrow positon. No value will hide the arrow
43665
+ * @param boxOffset Offset for the floating help box. Note: Arrow stays fixed
43666
+ */
43667
+ declare function SetFloatingHelpTextStyle(hudIndex: number, style: number, hudColor: number, alpha: number, arrowPosition: number, boxOffset: number): void;
43668
+ /**
43669
+ * ### Arrow Positions
43670
+ * * 0 = Off / No arrow
43671
+ * * 1 = Top
43672
+ * * 2 = Left
43673
+ * * 3 = Bottom
43674
+ * * 4 = Right
43675
+ * ### Note
43676
+ * Any numeric value greater than 4 will result in a right arrow (Index 4)
43677
+ * ### Important
43678
+ * Needs to be called every frame
43679
+ * ![Preview of the provided example code](https://forum.cfx.re/uploads/default/original/4X/7/f/3/7f319bc93c3a00b8829bd4ac8dddc235fbf3a9ef.png)
43680
+ * @param hudIndex The hud index for the floating help message
43681
+ * @param style Value 0 won't show an arrow at all. Values 1, 2 and -2 will display an arrow.
43682
+ * @param hudColor https://docs.fivem.net/docs/game-references/hud-colors/
43683
+ * @param alpha Value for the help box opacity, from 0-255. Anything greater will simply ignore the alpha value. Always 191 in R\* scripts.
43684
+ * @param arrowPosition Used to set the arrow positon. No value will hide the arrow
43685
+ * @param boxOffset Offset for the floating help box. Note: Arrow stays fixed
43686
+ */
43687
+ declare function N_0x788e7fd431bd67f1(hudIndex: number, style: number, hudColor: number, alpha: number, arrowPosition: number, boxOffset: number): void;
43635
43688
 
43636
43689
  /**
43637
43690
  * SET_FLOATING_HELP_TEXT_TO_ENTITY
@@ -44839,7 +44892,7 @@ declare function N_0x0923dbf87dff735e(x: number, y: number, z: number): void;
44839
44892
  * All I know for sure is that it draws the specified hole ID on the pause menu map as well as on the mini-map/radar. This native also seems to change some other things related to the pause menu map's behaviour, for example: you can no longer set waypoints, the pause menu map starts up in a 'zoomed in' state. This native does not need to be executed every tick.
44840
44893
  * You need to center the minimap manually as well as change/lock it's zoom and angle in order for it to appear correctly on the minimap.
44841
44894
  * You'll also need to use the `GOLF` scaleform in order to get the correct minmap border to show up.
44842
- * Use [`N_0x35edd5b2e3ff01c0()`](https://runtime.fivem.net/doc/reference.html#\_0x35EDD5B2E3FF01C0) to reset the map when you no longer want to display any golf holes (you still need to unlock zoom, position and angle of the radar manually after calling this).
44895
+ * Use [`SET_MINIMAP_GOLF_COURSE_OFF()`](#\_0x35EDD5B2E3FF01C0) to reset the map when you no longer want to display any golf holes (you still need to unlock zoom, position and angle of the radar manually after calling this).
44843
44896
  * @param hole The ID of the hole to draw on the map. ID starts with 1 for hole 1, 2 for hole 2, etc. 0 disables the golf map behaviour.
44844
44897
  */
44845
44898
  declare function SetMinimapGolfCourse(hole: number): void;
@@ -44848,7 +44901,7 @@ declare function SetMinimapGolfCourse(hole: number): void;
44848
44901
  * All I know for sure is that it draws the specified hole ID on the pause menu map as well as on the mini-map/radar. This native also seems to change some other things related to the pause menu map's behaviour, for example: you can no longer set waypoints, the pause menu map starts up in a 'zoomed in' state. This native does not need to be executed every tick.
44849
44902
  * You need to center the minimap manually as well as change/lock it's zoom and angle in order for it to appear correctly on the minimap.
44850
44903
  * You'll also need to use the `GOLF` scaleform in order to get the correct minmap border to show up.
44851
- * Use [`N_0x35edd5b2e3ff01c0()`](https://runtime.fivem.net/doc/reference.html#\_0x35EDD5B2E3FF01C0) to reset the map when you no longer want to display any golf holes (you still need to unlock zoom, position and angle of the radar manually after calling this).
44904
+ * Use [`SET_MINIMAP_GOLF_COURSE_OFF()`](#\_0x35EDD5B2E3FF01C0) to reset the map when you no longer want to display any golf holes (you still need to unlock zoom, position and angle of the radar manually after calling this).
44852
44905
  * @param hole The ID of the hole to draw on the map. ID starts with 1 for hole 1, 2 for hole 2, etc. 0 disables the golf map behaviour.
44853
44906
  */
44854
44907
  declare function N_0x71bdb63dbaf8da59(hole: number): void;
@@ -47125,7 +47178,7 @@ declare function SetPedEyeColor(ped: number, index: number): void;
47125
47178
  * * **18**: Chin Hole (Chin Bum)
47126
47179
  * * **19**: Neck Thickness (Thin/Thick)
47127
47180
  * **Note:**
47128
- * You may need to call [`SetPedHeadBlendData`](#0x9414E18B9434C2FE) prior to calling this native in order for it to work.
47181
+ * You may need to call [`SetPedHeadBlendData`](#\_0x9414E18B9434C2FE) prior to calling this native in order for it to work.
47129
47182
  * @param ped The ped entity
47130
47183
  * @param index An integer ranging from 0 to 19
47131
47184
  * @param scale A float ranging from -1.0 to 1.0
@@ -47238,10 +47291,10 @@ declare function N_0xb13dcb4c6faad238(ped: number, hasCone: boolean, color: numb
47238
47291
  * **Other information:**
47239
47292
  * IDs start at zero and go Male Non-DLC, Female Non-DLC, Male DLC, and Female DLC.</br>
47240
47293
  * This native function is often called prior to calling natives such as:
47241
- * * [`SetPedHairColor`](#0xBB43F090)
47242
- * * [`SetPedHeadOverlayColor`](#0x78935A27)
47243
- * * [`SetPedHeadOverlay`](#0xD28DBA90)
47244
- * * [`SetPedFaceFeature`](#0x6C8D4458)
47294
+ * * [`SetPedHairColor`](#\_0xBB43F090)
47295
+ * * [`SetPedHeadOverlayColor`](#\_0x78935A27)
47296
+ * * [`SetPedHeadOverlay`](#\_0xD28DBA90)
47297
+ * * [`SetPedFaceFeature`](#\_0x6C8D4458)
47245
47298
  * @param ped The ped entity
47246
47299
  * @param shapeFirstID Controls the shape of the first ped's face
47247
47300
  * @param shapeSecondID Controls the shape of the second ped's face
@@ -47275,7 +47328,7 @@ declare function SetPedHeadBlendData(ped: number, shapeFirstID: number, shapeSec
47275
47328
  * 12 Add Body Blemishes 0 - 1, 255
47276
47329
  * ```
47277
47330
  * **Note:**
47278
- * You may need to call [`SetPedHeadBlendData`](#0x9414E18B9434C2FE) prior to calling this native in order for it to work.
47331
+ * You may need to call [`SetPedHeadBlendData`](#\_0x9414E18B9434C2FE) prior to calling this native in order for it to work.
47279
47332
  * @param ped The ped entity
47280
47333
  * @param overlayID The overlay id displayed up above.
47281
47334
  * @param index An integer representing the index (from 0 to `_GET_NUM_OVERLAY_VALUES(overlayID)-1`)
@@ -47289,7 +47342,7 @@ declare function SetPedHeadOverlay(ped: number, overlayID: number, index: number
47289
47342
  * Called after SET_PED_HEAD_OVERLAY().
47290
47343
  * ```
47291
47344
  * **Note:**
47292
- * You may need to call [`SetPedHeadBlendData`](#0x9414E18B9434C2FE) prior to calling this native in order for it to work.
47345
+ * You may need to call [`SetPedHeadBlendData`](#\_0x9414E18B9434C2FE) prior to calling this native in order for it to work.
47293
47346
  * @param ped The ped entity
47294
47347
  * @param overlayID An integer representing the overlay id
47295
47348
  * @param colorType 1 for eyebrows, beards, and chest hair; 2 for blush and lipstick; and 0 otherwise, though not called in those cases.
@@ -48727,16 +48780,20 @@ declare function SetPlayerVisibleLocally(player: number, toggle: boolean): void;
48727
48780
  declare function SetPlayerWantedCentrePosition(player: number, p2: boolean, p3: boolean): number[];
48728
48781
 
48729
48782
  /**
48730
- * Call SET_PLAYER_WANTED_LEVEL_NOW for immediate effect
48731
- * wantedLevel is an integer value representing 0 to 5 stars even though the game supports the 6th wanted level but no police will appear since no definitions are present for it in the game files
48732
- * disableNoMission- Disables When Off Mission- appears to always be false
48783
+ * SET_PLAYER_WANTED_LEVEL
48784
+ * @param player the target player
48785
+ * @param wantedLevel the wanted level 1-5
48786
+ * @param delayedResponse false = 0-10sec police spawn response time, true = 10-20sec police spawn response time
48733
48787
  */
48734
- declare function SetPlayerWantedLevel(player: number, wantedLevel: number, disableNoMission: boolean): void;
48788
+ declare function SetPlayerWantedLevel(player: number, wantedLevel: number, delayedResponse: boolean): void;
48735
48789
 
48736
48790
  /**
48737
- * p2 is always false in R* scripts
48791
+ * SET_PLAYER_WANTED_LEVEL_NO_DROP
48792
+ * @param player the target player
48793
+ * @param wantedLevel the wanted level 1-5
48794
+ * @param delayedResponse false = 0-10sec police spawn response time, true = 10-20sec police spawn response time
48738
48795
  */
48739
- declare function SetPlayerWantedLevelNoDrop(player: number, wantedLevel: number, p2: boolean): void;
48796
+ declare function SetPlayerWantedLevelNoDrop(player: number, wantedLevel: number, delayedResponse: boolean): void;
48740
48797
 
48741
48798
  /**
48742
48799
  * Forces any pending wanted level to be applied to the specified player immediately.
@@ -52957,7 +53014,7 @@ declare function SetWeatherOwnedByNetwork(network: boolean): void;
52957
53014
  declare function SetWeatherTypeNow(weatherType: string): void;
52958
53015
 
52959
53016
  /**
52960
- * Refer to [`SET_WEATHER_TYPE_NOW`](#0x29B487C359E19889) for weather types.
53017
+ * Refer to [`SET_WEATHER_TYPE_NOW`](#\_0x29B487C359E19889) for weather types.
52961
53018
  */
52962
53019
  declare function SetWeatherTypeNowPersist(weatherType: string): void;
52963
53020
 
@@ -56744,19 +56801,19 @@ declare function TerminateThread(threadId: number): void;
56744
56801
 
56745
56802
  /**
56746
56803
  * This native enables/disables the gold putting grid display (https://i.imgur.com/TC6cku6.png).
56747
- * This requires these two natives to be called as well to configure the grid: [`0x1c4fc5752bcd8e48`](https://runtime.fivem.net/doc/reference.html#\_0x1C4FC5752BCD8E48) and [`0x5ce62918f8d703c7`](https://runtime.fivem.net/doc/reference.html#\_0x5CE62918F8D703C7).
56804
+ * This requires these two natives to be called as well to configure the grid: [`TERRAINGRID_SET_PARAMS`](#\_0x1C4FC5752BCD8E48) and [`TERRAINGRID_SET_COLOURS`](#\_0x5CE62918F8D703C7).
56748
56805
  * @param toggle Enables or disables the golf putting grid display.
56749
56806
  */
56750
56807
  declare function TerraingridActivate(toggle: boolean): void;
56751
56808
  /**
56752
56809
  * This native enables/disables the gold putting grid display (https://i.imgur.com/TC6cku6.png).
56753
- * This requires these two natives to be called as well to configure the grid: [`0x1c4fc5752bcd8e48`](https://runtime.fivem.net/doc/reference.html#\_0x1C4FC5752BCD8E48) and [`0x5ce62918f8d703c7`](https://runtime.fivem.net/doc/reference.html#\_0x5CE62918F8D703C7).
56810
+ * This requires these two natives to be called as well to configure the grid: [`TERRAINGRID_SET_PARAMS`](#\_0x1C4FC5752BCD8E48) and [`TERRAINGRID_SET_COLOURS`](#\_0x5CE62918F8D703C7).
56754
56811
  * @param toggle Enables or disables the golf putting grid display.
56755
56812
  */
56756
56813
  declare function N_0xa356990e161c9e65(toggle: boolean): void;
56757
56814
 
56758
56815
  /**
56759
- * This native is used along with these two natives: [`0xa356990e161c9e65`](https://runtime.fivem.net/doc/reference.html#\_0xA356990E161C9E65) and [`0x1c4fc5752bcd8e48`](https://runtime.fivem.net/doc/reference.html#\_0x1C4FC5752BCD8E48).
56816
+ * This native is used along with these two natives: [`TERRAINGRID_ACTIVATE`](#\_0xA356990E161C9E65) and [`TERRAINGRID_SET_PARAMS`](#\_0x1C4FC5752BCD8E48).
56760
56817
  * This native sets the colors for the golf putting grid. the 'min...' values are for the lower areas that the grid covers, the 'max...' values are for the higher areas that the grid covers, all remaining values are for the 'normal' ground height.
56761
56818
  * All those natives combined they will output something like this: https://i.imgur.com/TC6cku6.png
56762
56819
  * Old description:
@@ -56778,7 +56835,7 @@ declare function N_0xa356990e161c9e65(toggle: boolean): void;
56778
56835
  */
56779
56836
  declare function TerraingridSetColours(lowR: number, lowG: number, lowB: number, lowAlpha: number, R: number, G: number, B: number, Alpha: number, highR: number, highG: number, highB: number, highAlpha: number): void;
56780
56837
  /**
56781
- * This native is used along with these two natives: [`0xa356990e161c9e65`](https://runtime.fivem.net/doc/reference.html#\_0xA356990E161C9E65) and [`0x1c4fc5752bcd8e48`](https://runtime.fivem.net/doc/reference.html#\_0x1C4FC5752BCD8E48).
56838
+ * This native is used along with these two natives: [`TERRAINGRID_ACTIVATE`](#\_0xA356990E161C9E65) and [`TERRAINGRID_SET_PARAMS`](#\_0x1C4FC5752BCD8E48).
56782
56839
  * This native sets the colors for the golf putting grid. the 'min...' values are for the lower areas that the grid covers, the 'max...' values are for the higher areas that the grid covers, all remaining values are for the 'normal' ground height.
56783
56840
  * All those natives combined they will output something like this: https://i.imgur.com/TC6cku6.png
56784
56841
  * Old description:
@@ -56801,7 +56858,7 @@ declare function TerraingridSetColours(lowR: number, lowG: number, lowB: number,
56801
56858
  declare function N_0x5ce62918f8d703c7(lowR: number, lowG: number, lowB: number, lowAlpha: number, R: number, G: number, B: number, Alpha: number, highR: number, highG: number, highB: number, highAlpha: number): void;
56802
56859
 
56803
56860
  /**
56804
- * This native is used along with these two natives: [`0xa356990e161c9e65`](https://runtime.fivem.net/doc/reference.html#\_0xA356990E161C9E65) and [`0x5ce62918f8d703c7`](https://runtime.fivem.net/doc/reference.html#\_0x5CE62918F8D703C7).
56861
+ * This native is used along with these two natives: [`TERRAINGRID_ACTIVATE`](#\_0xA356990E161C9E65) and [`TERRAINGRID_SET_COLOURS`](#\_0x5CE62918F8D703C7).
56805
56862
  * This native configures the location, size, rotation, normal height, and the difference ratio between min, normal and max.
56806
56863
  * All those natives combined they will output something like this: https://i.imgur.com/TC6cku6.png
56807
56864
  * @param x Grid center x coord.
@@ -56820,7 +56877,7 @@ declare function N_0x5ce62918f8d703c7(lowR: number, lowG: number, lowB: number,
56820
56877
  */
56821
56878
  declare function TerraingridSetParams(x: number, y: number, z: number, p3: number, rotation: number, p5: number, width: number, height: number, p8: number, scale: number, glowIntensity: number, normalHeight: number, heightDiff: number): void;
56822
56879
  /**
56823
- * This native is used along with these two natives: [`0xa356990e161c9e65`](https://runtime.fivem.net/doc/reference.html#\_0xA356990E161C9E65) and [`0x5ce62918f8d703c7`](https://runtime.fivem.net/doc/reference.html#\_0x5CE62918F8D703C7).
56880
+ * This native is used along with these two natives: [`TERRAINGRID_ACTIVATE`](#\_0xA356990E161C9E65) and [`TERRAINGRID_SET_COLOURS`](#\_0x5CE62918F8D703C7).
56824
56881
  * This native configures the location, size, rotation, normal height, and the difference ratio between min, normal and max.
56825
56882
  * All those natives combined they will output something like this: https://i.imgur.com/TC6cku6.png
56826
56883
  * @param x Grid center x coord.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@citizenfx/client",
3
- "version": "2.0.6947-1",
3
+ "version": "2.0.7031-1",
4
4
  "description": "Typings for the CitizenFX client JS API.",
5
5
  "main": "index.js",
6
6
  "scripts": {