@citizenfx/client 2.0.7436-1 → 2.0.7466-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.
@@ -1504,13 +1504,37 @@ declare function ApplyPedBloodDamageByZone(ped: number, p1: number, p2: number,
1504
1504
  declare function N_0x816f6981c60bf53b(ped: number, p1: number, p2: number, p3: number, p4: number): void;
1505
1505
 
1506
1506
  /**
1507
- * APPLY_PED_BLOOD_SPECIFIC
1507
+ * Applies blood damage to a ped with specific parameters for zone, UV offsets, rotation, scale, and initial aging.
1508
+ * ```
1509
+ * NativeDB Introduced: v323
1510
+ * ```
1511
+ * @param ped The Ped to which blood damage is applied.
1512
+ * @param component Specific component or body part.
1513
+ * @param u UV texture coordinates for placing the decal in the specified zone.
1514
+ * @param v UV texture coordinates for placing the decal in the specified zone.
1515
+ * @param rotation Angle in degrees for the rotation of the blood decal.
1516
+ * @param scale Scale factor for the damage, ranging from 0.0 to 1.0.
1517
+ * @param forcedFrame Allows a specific frame of damage to be chosen (-1 for random selection).
1518
+ * @param preAge Number of seconds to pre-age the damage for an "old wound" effect (0.0 for fresh wound).
1519
+ * @param bloodName Name of the blood type, matching an entry in peddamage.xml.
1508
1520
  */
1509
- declare function ApplyPedBloodSpecific(ped: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number, p7: number, p8?: number): number;
1521
+ declare function ApplyPedBloodSpecific(ped: number, component: number, u: number, v: number, rotation: number, scale: number, forcedFrame: number, preAge: number, bloodName: string): void;
1510
1522
  /**
1511
- * APPLY_PED_BLOOD_SPECIFIC
1523
+ * Applies blood damage to a ped with specific parameters for zone, UV offsets, rotation, scale, and initial aging.
1524
+ * ```
1525
+ * NativeDB Introduced: v323
1526
+ * ```
1527
+ * @param ped The Ped to which blood damage is applied.
1528
+ * @param component Specific component or body part.
1529
+ * @param u UV texture coordinates for placing the decal in the specified zone.
1530
+ * @param v UV texture coordinates for placing the decal in the specified zone.
1531
+ * @param rotation Angle in degrees for the rotation of the blood decal.
1532
+ * @param scale Scale factor for the damage, ranging from 0.0 to 1.0.
1533
+ * @param forcedFrame Allows a specific frame of damage to be chosen (-1 for random selection).
1534
+ * @param preAge Number of seconds to pre-age the damage for an "old wound" effect (0.0 for fresh wound).
1535
+ * @param bloodName Name of the blood type, matching an entry in peddamage.xml.
1512
1536
  */
1513
- declare function N_0xef0d582cbf2d9b0f(ped: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number, p7: number, p8?: number): number;
1537
+ declare function N_0xef0d582cbf2d9b0f(ped: number, component: number, u: number, v: number, rotation: number, scale: number, forcedFrame: number, preAge: number, bloodName: string): void;
1514
1538
 
1515
1539
  /**
1516
1540
  * enum eDamageZone
@@ -3948,6 +3972,17 @@ declare function ClearVehicleCustomPrimaryColour(vehicle: number): void;
3948
3972
  */
3949
3973
  declare function ClearVehicleCustomSecondaryColour(vehicle: number): void;
3950
3974
 
3975
+ /**
3976
+ * Removes the cargen area of interest and resumes normal cargen spawning.
3977
+ * You can set the area of interest with [`SET_VEHICLE_GENERATOR_AREA_OF_INTEREST`](#\_0x9A75585FB2E54FAD)
3978
+ */
3979
+ declare function ClearVehicleGeneratorAreaOfInterest(): void;
3980
+ /**
3981
+ * Removes the cargen area of interest and resumes normal cargen spawning.
3982
+ * You can set the area of interest with [`SET_VEHICLE_GENERATOR_AREA_OF_INTEREST`](#\_0x9A75585FB2E54FAD)
3983
+ */
3984
+ declare function N_0x0a436b8643716d14(): void;
3985
+
3951
3986
  /**
3952
3987
  * _CLEAR_VEHICLE_PHONE_EXPLOSIVE_DEVICE
3953
3988
  */
@@ -14273,24 +14308,24 @@ declare function GetPedEventData(ped: number, eventType: number, outData?: numbe
14273
14308
  declare function GetPedExtractedDisplacement(ped: number, worldSpace: boolean): number[];
14274
14309
 
14275
14310
  /**
14276
- * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
14311
+ * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
14277
14312
  * @param ped The target ped
14278
14313
  * @return Returns ped's eye colour, or -1 if fails to get.
14279
14314
  */
14280
14315
  declare function GetPedEyeColor(ped: number): number;
14281
-
14282
14316
  /**
14283
14317
  * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
14284
14318
  * @param ped The target ped
14285
14319
  * @return Returns ped's eye colour, or -1 if fails to get.
14286
14320
  */
14287
- declare function GetPedEyeColor(ped: number): number;
14321
+ declare function N_0x76bba2cee66d47e9(ped: number): number;
14322
+
14288
14323
  /**
14289
- * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
14324
+ * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
14290
14325
  * @param ped The target ped
14291
14326
  * @return Returns ped's eye colour, or -1 if fails to get.
14292
14327
  */
14293
- declare function N_0x76bba2cee66d47e9(ped: number): number;
14328
+ declare function GetPedEyeColor(ped: number): number;
14294
14329
 
14295
14330
  /**
14296
14331
  * A getter for [\_SET_PED_FACE_FEATURE](#\_0x71A5C1DBA060049E). Returns 0.0 if fails to get.
@@ -18385,7 +18420,7 @@ declare function GetBlipInfoIdIterator(): number;
18385
18420
  declare function GetWaypointDistanceAlongRoute(p0: string, p1: number): number;
18386
18421
 
18387
18422
  /**
18388
- * A getter for [SET_WEAPON_ANIMATION_OVERRIDE](\_0x1055AC3A667F09D9).
18423
+ * A getter for [SET_WEAPON_ANIMATION_OVERRIDE](#\_0x1055AC3A667F09D9).
18389
18424
  * @param ped The target ped.
18390
18425
  * @return The weapon animation override.
18391
18426
  */
@@ -24335,11 +24370,6 @@ declare function N_0x0811381ef5062fec(p0: number): void;
24335
24370
  */
24336
24371
  declare function N_0x08e8eeadfd0dc4a0(amount: number): boolean;
24337
24372
 
24338
- /**
24339
- * CLEAR_VEHICLE_*
24340
- */
24341
- declare function N_0x0a436b8643716d14(): void;
24342
-
24343
24373
  /**
24344
24374
  * 0x0A9C7F36E5D7B683
24345
24375
  */
@@ -27818,13 +27848,6 @@ declare function N_0x99cad8e7afdb60fa(vehicle: number, p1: number, p2: number):
27818
27848
  */
27819
27849
  declare function N_0x9a62ec95ae10e011(): number;
27820
27850
 
27821
- /**
27822
- * Related to car generators & CPlayerSwitchMgrLong
27823
- * SET_VEHICLE_*
27824
- * SET_VEHICLE_GENERATORS_EXPECTED_GAMEPLAY_PT ?
27825
- */
27826
- declare function N_0x9a75585fb2e54fad(x: number, y: number, z: number, radius: number): void;
27827
-
27828
27851
  /**
27829
27852
  * 0x9A77DFD295E29B09
27830
27853
  */
@@ -36619,6 +36642,13 @@ declare function N_0x95eb5e34f821babe(ped: number, txd: string, txn: string): bo
36619
36642
  */
36620
36643
  declare function OverridePedsCanStandOnTopFlag(flag: boolean): void;
36621
36644
 
36645
+ /**
36646
+ * Allows the bypassing of default game behavior that prevents the use of [SET_PED_DRIVE_BY_CLIPSET_OVERRIDE](#\_0xED34AB6C5CB36520) in certain scenarios to avoid clipping issues (e.g., when there is more than one Ped in a vehicle).
36647
+ * Note: This flag and the overridden clipset are not replicated values and require synchronization through user scripts. Additionally, current game behavior also restricts applying this clipset locally when in first-person mode and will require a temporary workaround.
36648
+ * @param flag true to override, false to use default game behavior.
36649
+ */
36650
+ declare function OverridePedsUseDefaultDriveByClipset(flag: boolean): void;
36651
+
36622
36652
  /**
36623
36653
  * OVERRIDE_PLAYER_GROUND_MATERIAL
36624
36654
  */
@@ -51869,6 +51899,25 @@ declare function SetVehicleGeneratesEngineShockingEvents(vehicle: number, toggle
51869
51899
  */
51870
51900
  declare function N_0x279d50de5652d935(vehicle: number, toggle: boolean): void;
51871
51901
 
51902
+ /**
51903
+ * Specifies an area of interest where cargens will focus on spawning vehicles
51904
+ * You can clear the area of interest with [`CLEAR_VEHICLE_GENERATOR_AREA_OF_INTEREST`](#\_0x0A436B8643716D14)
51905
+ * @param x The X coordinate of the central point of the area of interest.
51906
+ * @param y The Y coordinate of the central point of the area of interest.
51907
+ * @param z The Z coordinate of the central point of the area of interest.
51908
+ * @param radius The radius around the central point, defining the size of the area of interest
51909
+ */
51910
+ declare function SetVehicleGeneratorAreaOfInterest(x: number, y: number, z: number, radius: number): void;
51911
+ /**
51912
+ * Specifies an area of interest where cargens will focus on spawning vehicles
51913
+ * You can clear the area of interest with [`CLEAR_VEHICLE_GENERATOR_AREA_OF_INTEREST`](#\_0x0A436B8643716D14)
51914
+ * @param x The X coordinate of the central point of the area of interest.
51915
+ * @param y The Y coordinate of the central point of the area of interest.
51916
+ * @param z The Z coordinate of the central point of the area of interest.
51917
+ * @param radius The radius around the central point, defining the size of the area of interest
51918
+ */
51919
+ declare function N_0x9a75585fb2e54fad(x: number, y: number, z: number, radius: number): void;
51920
+
51872
51921
  /**
51873
51922
  * SET_VEHICLE_GRAVITY
51874
51923
  */
@@ -52082,13 +52131,23 @@ declare function SetVehicleIsStolen(vehicle: number, isStolen: boolean): void;
52082
52131
  declare function SetVehicleIsWanted(vehicle: number, state: boolean): void;
52083
52132
 
52084
52133
  /**
52085
- * _SET_VEHICLE_JET_ENGINE_ON
52134
+ * Calling this native will keep a vehicle's engine running after exiting.
52135
+ * @param vehicle The vehicle handle.
52136
+ * @param toggle `true` to keep the engine on, otherwise `false`.
52086
52137
  */
52087
- declare function SetVehicleJetEngineOn(vehicle: number, toggle: boolean): void;
52138
+ declare function SetVehicleKeepEngineOnWhenAbandoned(vehicle: number, toggle: boolean): void;
52088
52139
  /**
52089
- * _SET_VEHICLE_JET_ENGINE_ON
52140
+ * Calling this native will keep a vehicle's engine running after exiting.
52141
+ * @param vehicle The vehicle handle.
52142
+ * @param toggle `true` to keep the engine on, otherwise `false`.
52090
52143
  */
52091
52144
  declare function N_0xb8fbc8b1330ca9b4(vehicle: number, toggle: boolean): void;
52145
+ /**
52146
+ * Calling this native will keep a vehicle's engine running after exiting.
52147
+ * @param vehicle The vehicle handle.
52148
+ * @param toggle `true` to keep the engine on, otherwise `false`.
52149
+ */
52150
+ declare function SetVehicleJetEngineOn(vehicle: number, toggle: boolean): void;
52092
52151
 
52093
52152
  /**
52094
52153
  * SET_VEHICLE_KERS_ALLOWED
@@ -55886,6 +55945,28 @@ declare function StringToInt(_string: string, outInteger?: number): [boolean, nu
55886
55945
  */
55887
55946
  declare function SuppressAgitationEventsNextFrame(): void;
55888
55947
 
55948
+ /**
55949
+ * Suppresses a crime for a given player for this frame only.
55950
+ * **Note:** This native needs to be executed inside a thread if a crime is meant to be suppressed for a given amount of time.
55951
+ * @param player The player we are suppressing the crime for.
55952
+ * @param crimeType The crime to suppress, see [`REPORT_CRIME`](#\_0xE9B09589827545E7) for available types.
55953
+ */
55954
+ declare function SuppressCrimeThisFrame(player: number, crimeType: number): void;
55955
+ /**
55956
+ * Suppresses a crime for a given player for this frame only.
55957
+ * **Note:** This native needs to be executed inside a thread if a crime is meant to be suppressed for a given amount of time.
55958
+ * @param player The player we are suppressing the crime for.
55959
+ * @param crimeType The crime to suppress, see [`REPORT_CRIME`](#\_0xE9B09589827545E7) for available types.
55960
+ */
55961
+ declare function N_0x9a987297ed8bd838(player: number, crimeType: number): void;
55962
+ /**
55963
+ * Suppresses a crime for a given player for this frame only.
55964
+ * **Note:** This native needs to be executed inside a thread if a crime is meant to be suppressed for a given amount of time.
55965
+ * @param player The player we are suppressing the crime for.
55966
+ * @param crimeType The crime to suppress, see [`REPORT_CRIME`](#\_0xE9B09589827545E7) for available types.
55967
+ */
55968
+ declare function SwitchCrimeType(player: number, crimeType: number): void;
55969
+
55889
55970
  /**
55890
55971
  * SUPPRESS_FRONTEND_RENDERING_THIS_FRAME
55891
55972
  */
@@ -55905,21 +55986,6 @@ declare function SuppressShockingEventTypeNextFrame(eventType: number): void;
55905
55986
  */
55906
55987
  declare function SuppressShockingEventsNextFrame(): void;
55907
55988
 
55908
- /**
55909
- * This was previously named as "RESERVE_ENTITY_EXPLODES_ON_HIGH_EXPLOSION_COMBO"
55910
- * which is obviously incorrect.
55911
- * Seems to only appear in scripts used in Singleplayer. p1 ranges from 2 - 46.
55912
- * I assume this switches the crime type
55913
- */
55914
- declare function SwitchCrimeType(player: number, p1: number): void;
55915
- /**
55916
- * This was previously named as "RESERVE_ENTITY_EXPLODES_ON_HIGH_EXPLOSION_COMBO"
55917
- * which is obviously incorrect.
55918
- * Seems to only appear in scripts used in Singleplayer. p1 ranges from 2 - 46.
55919
- * I assume this switches the crime type
55920
- */
55921
- declare function N_0x9a987297ed8bd838(player: number, p1: number): void;
55922
-
55923
55989
  /**
55924
55990
  * Used in carsteal3 script with p0 = "Carsteal4_spycar".
55925
55991
  * S*
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@citizenfx/client",
3
- "version": "2.0.7436-1",
3
+ "version": "2.0.7466-1",
4
4
  "description": "Typings for the CitizenFX client JS API.",
5
5
  "main": "index.js",
6
6
  "scripts": {