@citizenfx/client 2.0.7596-1 → 2.0.7616-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.
Files changed (2) hide show
  1. package/natives_universal.d.ts +248 -116
  2. package/package.json +1 -1
@@ -296,7 +296,8 @@ declare function AddCoverBlockingArea(playerX: number, playerY: number, playerZ:
296
296
  declare function AddCoverPoint(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number, p7: boolean): number;
297
297
 
298
298
  /**
299
- * decal types:
299
+ * Places a decal into the world
300
+ * ```cs
300
301
  * public enum DecalTypes
301
302
  * {
302
303
  * splatters_blood = 1010,
@@ -352,8 +353,30 @@ declare function AddCoverPoint(p0: number, p1: number, p2: number, p3: number, p
352
353
  * porousPool_water_ped_drip,
353
354
  * liquidTrail_water = 9050
354
355
  * }
355
- */
356
- declare function AddDecal(decalType: number, posX: number, posY: number, posZ: number, p4: number, p5: number, p6: number, p7: number, p8: number, p9: number, width: number, height: number, rCoef: number, gCoef: number, bCoef: number, opacity: number, timeout: number, p17: boolean, p18: boolean, p19: boolean): number;
356
+ * ```
357
+ * @param decalType which type of decal to place, based on the ID, see `DecalTypes` enum.
358
+ * @param posX X position coordinate.
359
+ * @param posY Y position coordinate.
360
+ * @param posZ Z position coordinate.
361
+ * @param dirX X Orientation.
362
+ * @param dirY Y Orientation.
363
+ * @param dirZ Z Orientation.
364
+ * @param sideX Usually set to 0.
365
+ * @param sideY Usually set to 1.
366
+ * @param sideZ Usually set to 0.
367
+ * @param width Width of the decal.
368
+ * @param height Height of the decal.
369
+ * @param rCoef Red Color.
370
+ * @param gCoef Green Color.
371
+ * @param bCoef Blue Color.
372
+ * @param opacity Alpha Color.
373
+ * @param timeout The lifetime of the decal.
374
+ * @param isLongRange toggle further LOD draw distance.
375
+ * @param isDynamic toggle dynamics.
376
+ * @param useComplexColn use complex coloring.
377
+ * @return An integer value representing the added decal index, will return `0` if the decal cannot be added.
378
+ */
379
+ declare function AddDecal(decalType: number, posX: number, posY: number, posZ: number, dirX: number, dirY: number, dirZ: number, sideX: number, sideY: number, sideZ: number, width: number, height: number, rCoef: number, gCoef: number, bCoef: number, opacity: number, timeout: number, isLongRange: boolean, isDynamic: boolean, useComplexColn: boolean): number;
357
380
 
358
381
  /**
359
382
  * To remove, see: [`REMOVE_DISPATCH_SPAWN_BLOCKING_AREA`](#\_0x264AC28B01B353A5).
@@ -607,7 +630,16 @@ declare function N_0x0bc3144deb678666(modelHash: string | number): boolean;
607
630
 
608
631
  /**
609
632
  * Creates a navmesh blocking object, vehicles will avoid driving through this area.
610
- * Only 32 blocking objects may exist at a given time and must be manually managed. See [`REMOVE_NAVMESH_BLOCKING_OBJECT`](#\_0x46399A7895957C0E) and [onResourceStop](https://docs.fivem.net/docs/scripting-reference/events/list/onResourceStop/)
633
+ * Only 32 blocking objects may exist at a given time and must be manually managed. See [`REMOVE_NAVMESH_BLOCKING_OBJECT`](#\_0x46399A7895957C0E) and [`onResourceStop`](https://docs.fivem.net/docs/scripting-reference/events/list/onResourceStop/)
634
+ * ```
635
+ * enum eBlockingObjectFlags {
636
+ * BLOCKING_OBJECT_DEFAULT = 0, // Default Flag
637
+ * BLOCKING_OBJECT_WANDERPATH = 1, // Blocking object will block wander paths
638
+ * BLOCKING_OBJECT_SHORTESTPATH = 2, // Blocking object will block (regular) shortest-paths
639
+ * BLOCKING_OBJECT_FLEEPATH = 4, // Blocking object will block flee paths
640
+ * BLOCKING_OBJECT_ALLPATHS = 7, // Blocking object will block all paths
641
+ * }
642
+ * ```
611
643
  * @param x The x coordinate to create the block on.
612
644
  * @param y The y coordinate.
613
645
  * @param z The z coordinate.
@@ -615,10 +647,10 @@ declare function N_0x0bc3144deb678666(modelHash: string | number): boolean;
615
647
  * @param length The length of the block.
616
648
  * @param height The height of the block.
617
649
  * @param heading The heading of object in degrees.
618
- * @param p7 Usually false.
619
- * @param p8 A bitfield; usually 7.
650
+ * @param bPermanent A boolean indicating if the blocking object is permanent (`true`/`false`).
651
+ * @param flags Flag for the blocking object, refer to `eBlockingObjectFlags`.
620
652
  */
621
- declare function AddNavmeshBlockingObject(x: number, y: number, z: number, width: number, length: number, height: number, heading: number, p7: boolean, p8: number): number;
653
+ declare function AddNavmeshBlockingObject(x: number, y: number, z: number, width: number, length: number, height: number, heading: number, bPermanent: boolean, flags: number): number;
622
654
 
623
655
  /**
624
656
  * ADD_NAVMESH_REQUIRED_REGION
@@ -878,9 +910,19 @@ declare function AddSpeedZoneForCoord(x: number, y: number, z: number, radius: n
878
910
  declare function AddRope(x: number, y: number, z: number, rotX: number, rotY: number, rotZ: number, maxLength: number, ropeType: number, initLength: number, minLength: number, lengthChangeRate: number, onlyPPU: boolean, collisionOn: boolean, lockFromFront: boolean, timeMultiplier: number, breakable: boolean, unkPtr?: number): [number, number];
879
911
 
880
912
  /**
881
- * ADD_SCENARIO_BLOCKING_AREA
913
+ * Sets an area where scenarios are blocked
914
+ * @param posMinX Min X Coordinate.
915
+ * @param posMinY Min Y Coordinate.
916
+ * @param posMinZ Min Z Coordinate.
917
+ * @param posMaxX Max X Coordinate.
918
+ * @param posMaxY Max Y Coordinate.
919
+ * @param posMaxZ Max Z Coordinate.
920
+ * @param network Optionally networked to all other players
921
+ * @param cancelActive Should this cause peds already in active scenario points in the area specified to leave
922
+ * @param blockPeds if this area effects scenarios with peds
923
+ * @param blockVehicles if this area effects scenarios with vehicles
882
924
  */
883
- declare function AddScenarioBlockingArea(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, p6: boolean, p7: boolean, p8: boolean, p9: boolean): number;
925
+ declare function AddScenarioBlockingArea(posMinX: number, posMinY: number, posMinZ: number, posMaxX: number, posMaxY: number, posMaxZ: number, network: boolean, cancelActive: boolean, blockPeds: boolean, blockVehicles: boolean): number;
884
926
 
885
927
  /**
886
928
  * BRAIN::ADD_SCRIPT_TO_RANDOM_PED("pb_prostitute", ${s_f_y_hooker_01}, 100, 0);
@@ -6056,9 +6098,17 @@ declare function DisableMultiplayerChat(disable: boolean): void;
6056
6098
  declare function SetTextChatUnk(disable: boolean): void;
6057
6099
 
6058
6100
  /**
6059
- * DISABLE_NAVMESH_IN_AREA
6101
+ * Use this if you want to completely disable a large area of navmesh.
6102
+ * For smaller areas, use [`ADD_NAVMESH_BLOCKING_OBJECT`](#\_0xFCD5C8E06E502F5A) instead.
6103
+ * @param posMinX X Min Coordinate.
6104
+ * @param posMinY Y Min Coordinate.
6105
+ * @param posMinZ Z Min Coordinate.
6106
+ * @param posMaxX X Max Coordinate.
6107
+ * @param posMaxY Y Max Coordinate.
6108
+ * @param posMaxZ Z Max Coordinate.
6109
+ * @param bDisable Whether to disable the navmesh or not.
6060
6110
  */
6061
- declare function DisableNavmeshInArea(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number): void;
6111
+ declare function DisableNavmeshInArea(posMinX: number, posMinY: number, posMinZ: number, posMaxX: number, posMaxY: number, posMaxZ: number, bDisable: boolean): void;
6062
6112
 
6063
6113
  /**
6064
6114
  * DISABLE_OCCLUSION_THIS_FRAME
@@ -13559,12 +13609,26 @@ declare function GetNumModKits(vehicle: number): number;
13559
13609
 
13560
13610
  /**
13561
13611
  * GET_NUM_NAVMESHES_EXISTING_IN_AREA
13612
+ * @param posMinX Min X Coordinate.
13613
+ * @param posMinY Min Y Coordinate.
13614
+ * @param posMinZ Min Z Coordinate.
13615
+ * @param posMaxX Max X Coordinate.
13616
+ * @param posMaxY Max Y Coordinate.
13617
+ * @param posMaxZ Max Z Coordinate.
13618
+ * @return Returns the number of navmeshes which exist in the given area (irrespective of whether they are currently loaded or not)
13562
13619
  */
13563
- declare function GetNumNavmeshesExistingInArea(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number): number;
13620
+ declare function GetNumNavmeshesExistingInArea(posMinX: number, posMinY: number, posMinZ: number, posMaxX: number, posMaxY: number, posMaxZ: number): number;
13564
13621
  /**
13565
13622
  * GET_NUM_NAVMESHES_EXISTING_IN_AREA
13623
+ * @param posMinX Min X Coordinate.
13624
+ * @param posMinY Min Y Coordinate.
13625
+ * @param posMinZ Min Z Coordinate.
13626
+ * @param posMaxX Max X Coordinate.
13627
+ * @param posMaxY Max Y Coordinate.
13628
+ * @param posMaxZ Max Z Coordinate.
13629
+ * @return Returns the number of navmeshes which exist in the given area (irrespective of whether they are currently loaded or not)
13566
13630
  */
13567
- declare function N_0x01708e8dd3ff8c65(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number): number;
13631
+ declare function N_0x01708e8dd3ff8c65(posMinX: number, posMinY: number, posMinZ: number, posMaxX: number, posMaxY: number, posMaxZ: number): number;
13568
13632
 
13569
13633
  /**
13570
13634
  * p0 appears to be for MP
@@ -18962,18 +19026,30 @@ declare function N_0x08f96ca6c551ad51(pickupHash: string | number): number;
18962
19026
  declare function GetWeaponHashFromPickup(pickupHash: string | number): number;
18963
19027
 
18964
19028
  /**
18965
- * GET_WEAPONTYPE_GROUP
18966
- * @param weaponHash The hash of the Weapon.
18967
- * @return * **Melee**: 2685387236
18968
- * **Handgun**: 416676503
18969
- * **Submachine Gun**: -957766203
18970
- * **Shotgun**: 860033945
18971
- * **Assault Rifle**: 970310034
18972
- * **Light Machine Gun**: 1159398588
18973
- * **Sniper**: 3082541095
18974
- * **Heavy Weapon**: 2725924767
18975
- * **Throwables**: 1548507267
18976
- * **Misc**: 4257178988
19029
+ * Gets and returns the hash of the group of the specified weapon (group names can be found/changed under "Group" in the weapons' meta file).
19030
+ * Note that the group is **not** the same as the location on the weapon wheel.
19031
+ * @param weaponHash The hash of the weapon.
19032
+ * @return Returns the hash of the group of the weapon. Hashes:| Group | Unsigned | Signed | Example |
19033
+ |:----------------------:|:----------:|:-----------:|:-----------------------:|
19034
+ | GROUP_DIGISCANNER | 3539449195 | -755518101 | WEAPON_DIGISCANNER |
19035
+ | GROUP_FIREEXTINGUISHER | 4257178988 | -37788308 | WEAPON_FIREEXTINGUISHER |
19036
+ | GROUP_HACKINGDEVICE | 1175761940 | 1175761940 | WEAPON_HACKINGDEVICE |
19037
+ | GROUP_HEAVY | 2725924767 | -1569042529 | WEAPON_RPG |
19038
+ | GROUP_MELEE | 3566412244 | -728555052 | WEAPON_BAT |
19039
+ | GROUP_METALDETECTOR | 3759491383 | -535475913 | WEAPON_METALDETECTOR |
19040
+ | GROUP_MG | 1159398588 | 1159398588 | WEAPON_COMBATMG |
19041
+ | GROUP_NIGHTVISION | 3493187224 | -801780072 | GADGET_NIGHTVISION |
19042
+ | GROUP_PARACHUTE | 431593103 | 431593103 | GADGET_PARACHUTE |
19043
+ | GROUP_PETROLCAN | 1595662460 | 1595662460 | WEAPON_PETROLCAN |
19044
+ | GROUP_PISTOL | 416676503 | 416676503 | WEAPON_PISTOL |
19045
+ | GROUP_RIFLE | 970310034 | 970310034 | WEAPON_ASSAULTRIFLE |
19046
+ | GROUP_SHOTGUN | 860033945 | 860033945 | WEAPON_PUMPSHOTGUN |
19047
+ | GROUP_SMG | 3337201093 | -957766203 | WEAPON_MICROSMG |
19048
+ | GROUP_SNIPER | 3082541095 | -1212426201 | WEAPON_SNIPERRIFLE |
19049
+ | GROUP_STUNGUN | 690389602 | 690389602 | WEAPON_STUNGUN |
19050
+ | GROUP_THROWN | 1548507267 | 1548507267 | WEAPON_SNOWBALL |
19051
+ | GROUP_TRANQILIZER | 75159441 | 75159441 | WEAPON_TRANQUILIZER |
19052
+ | GROUP_UNARMED | 2685387236 | -1609580060 | WEAPON_UNARMED |
18977
19053
  */
18978
19054
  declare function GetWeapontypeGroup(weaponHash: string | number): number;
18979
19055
 
@@ -20185,6 +20261,28 @@ declare function InitShopPedComponent(outComponent: number): void;
20185
20261
  */
20186
20262
  declare function InitShopPedProp(outProp: number): void;
20187
20263
 
20264
+ /**
20265
+ * INIT_SYNCH_SCENE_AUDIO_WITH_ENTITY
20266
+ */
20267
+ declare function InitSynchSceneAudioWithEntity(audioName: string, entity: number): void;
20268
+ /**
20269
+ * INIT_SYNCH_SCENE_AUDIO_WITH_ENTITY
20270
+ */
20271
+ declare function N_0x950a154b8dab6185(audioName: string, entity: number): void;
20272
+ /**
20273
+ * INIT_SYNCH_SCENE_AUDIO_WITH_ENTITY
20274
+ */
20275
+ declare function SetSynchronizedAudioEventPositionThisFrame(audioName: string, entity: number): void;
20276
+
20277
+ /**
20278
+ * INIT_SYNCH_SCENE_AUDIO_WITH_POSITION
20279
+ */
20280
+ declare function InitSynchSceneAudioWithPosition(audioName: string, x: number, y: number, z: number): void;
20281
+ /**
20282
+ * INIT_SYNCH_SCENE_AUDIO_WITH_POSITION
20283
+ */
20284
+ declare function N_0xc8ede9bdbccba6d4(audioName: string, x: number, y: number, z: number): void;
20285
+
20188
20286
  /**
20189
20287
  * INSTANTLY_FILL_PED_POPULATION
20190
20288
  */
@@ -20216,20 +20314,27 @@ declare function IntToParticipantindex(value: number): number;
20216
20314
  declare function IntToPlayerindex(value: number): number;
20217
20315
 
20218
20316
  /**
20219
- * INTERRUPT_CONVERSATION
20317
+ * Handles conversation interrupts, using the code-side system for improved timing and to minimize unfriendly logic interactions.
20318
+ * @param interrupterPed the ped speaking
20319
+ * @param context the line to use
20320
+ * @param voiceName the voicename for the audio asset
20220
20321
  */
20221
- declare function InterruptConversation(p0: number): [number, number];
20322
+ declare function InterruptConversation(interrupterPed: number, context: string, voiceName: string): void;
20222
20323
 
20223
20324
  /**
20224
- * One call found in the b617d scripts:
20225
- * AUDIO::_8A694D7A68F8DC38(NETWORK::NET_TO_PED(l_3989._f26F[0 -- [[1]] ]), "CONV_INTERRUPT_QUIT_IT", "LESTER");
20325
+ * Handles conversation interrupts and pauses, using the code-side system for improved timing and to minimize unfriendly logic interactions.
20326
+ * @param interrupterPed the ped speaking
20327
+ * @param context the line to use
20328
+ * @param voiceName the voicename for the audio asset
20226
20329
  */
20227
- declare function InterruptConversationAndPause(ped: number, p1: string, p2: string): void;
20330
+ declare function InterruptConversationAndPause(interrupterPed: number, context: string, voiceName: string): void;
20228
20331
  /**
20229
- * One call found in the b617d scripts:
20230
- * AUDIO::_8A694D7A68F8DC38(NETWORK::NET_TO_PED(l_3989._f26F[0 -- [[1]] ]), "CONV_INTERRUPT_QUIT_IT", "LESTER");
20332
+ * Handles conversation interrupts and pauses, using the code-side system for improved timing and to minimize unfriendly logic interactions.
20333
+ * @param interrupterPed the ped speaking
20334
+ * @param context the line to use
20335
+ * @param voiceName the voicename for the audio asset
20231
20336
  */
20232
- declare function N_0x8a694d7a68f8dc38(ped: number, p1: string, p2: string): void;
20337
+ declare function N_0x8a694d7a68f8dc38(interrupterPed: number, context: string, voiceName: string): void;
20233
20338
 
20234
20339
  /**
20235
20340
  * Resets the idle camera timer. Calling that in a loop once every few seconds is enough to disable the idle cinematic camera.
@@ -20274,24 +20379,26 @@ declare function IsAimCamThirdPersonActive(): boolean;
20274
20379
  declare function N_0x74bd83ea840f6bc9(): boolean;
20275
20380
 
20276
20381
  /**
20277
- * Example:
20278
- * bool playing = AUDIO::IS_ALARM_PLAYING("PORT_OF_LS_HEIST_FORT_ZANCUDO_ALARMS");
20382
+ * IS_ALARM_PLAYING
20383
+ * @return Returns true if an alarm is currently playing with the specified name
20279
20384
  */
20280
20385
  declare function IsAlarmPlaying(alarmName: string): boolean;
20281
20386
 
20282
20387
  /**
20283
- * Common in the scripts:
20284
- * AUDIO::IS_AMBIENT_SPEECH_DISABLED(PLAYER::PLAYER_PED_ID());
20388
+ * IS_AMBIENT_SPEECH_DISABLED
20389
+ * @return Returns true if ambient speech for the ped has been disabled
20285
20390
  */
20286
20391
  declare function IsAmbientSpeechDisabled(ped: number): boolean;
20287
20392
 
20288
20393
  /**
20289
20394
  * IS_AMBIENT_SPEECH_PLAYING
20395
+ * @return Returns true if the ped is currently playing ambient speech
20290
20396
  */
20291
20397
  declare function IsAmbientSpeechPlaying(ped: number): boolean;
20292
20398
 
20293
20399
  /**
20294
20400
  * IS_AMBIENT_ZONE_ENABLED
20401
+ * @return Returns true if the given ambient zone is allowed to be active
20295
20402
  */
20296
20403
  declare function IsAmbientZoneEnabled(ambientZone: string): boolean;
20297
20404
 
@@ -20302,10 +20409,12 @@ declare function IsAnEntity(handle: number): boolean;
20302
20409
 
20303
20410
  /**
20304
20411
  * IS_ANIMAL_VOCALIZATION_PLAYING
20412
+ * @return Returns true of the ped is currently playing animal sounds
20305
20413
  */
20306
20414
  declare function IsAnimalVocalizationPlaying(pedHandle: number): boolean;
20307
20415
  /**
20308
20416
  * IS_ANIMAL_VOCALIZATION_PLAYING
20417
+ * @return Returns true of the ped is currently playing animal sounds
20309
20418
  */
20310
20419
  declare function N_0xc265df9fb44a9fbd(pedHandle: number): boolean;
20311
20420
 
@@ -20381,6 +20490,17 @@ declare function IsAnyPassengerRappelingFromVehicle(vehicle: number): boolean;
20381
20490
  */
20382
20491
  declare function IsAnyPedShootingInArea(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, p6: boolean, p7: boolean): boolean;
20383
20492
 
20493
+ /**
20494
+ * NativeDB Introduced: v2189
20495
+ * @return Returns true if any ped-independent positional scripted speech (ie. triggered using [PLAY_AMBIENT_SPEECH_FROM_POSITION_NATIVE](#\_0xED640017ED337E45)) is currently playing
20496
+ */
20497
+ declare function IsAnyPositionalSpeechPlaying(): boolean;
20498
+ /**
20499
+ * NativeDB Introduced: v2189
20500
+ * @return Returns true if any ped-independent positional scripted speech (ie. triggered using [PLAY_AMBIENT_SPEECH_FROM_POSITION_NATIVE](#\_0xED640017ED337E45)) is currently playing
20501
+ */
20502
+ declare function N_0x30ca2ef91d15adf8(): boolean;
20503
+
20384
20504
  /**
20385
20505
  * IS_ANY_SPEECH_PLAYING
20386
20506
  * @return Returns true if the specified ped is playing any speech
@@ -25705,11 +25825,6 @@ declare function N_0x30432a0118736e00(): number;
25705
25825
  */
25706
25826
  declare function N_0x3044240d2e0fa842(): boolean;
25707
25827
 
25708
- /**
25709
- * NativeDB Introduced: v2189
25710
- */
25711
- declare function N_0x30ca2ef91d15adf8(): number;
25712
-
25713
25828
  /**
25714
25829
  * **This native does absolutely nothing, just a nullsub**
25715
25830
  */
@@ -29246,11 +29361,6 @@ declare function N_0xc8b5c4a79cc18b94(cam: number): void;
29246
29361
  */
29247
29362
  declare function N_0xc8e1071177a23be5(): [boolean, number, number, number];
29248
29363
 
29249
- /**
29250
- * 0xC8EDE9BDBCCBA6D4
29251
- */
29252
- declare function N_0xc8ede9bdbccba6d4(p1: number, p2: number, p3: number): number;
29253
-
29254
29364
  /**
29255
29365
  * 0xCA465D9CC0D231BA
29256
29366
  */
@@ -39456,8 +39566,10 @@ declare function N_0xf44a5456ac3f4f97(hudComponent: number): void;
39456
39566
 
39457
39567
  /**
39458
39568
  * REMOVE_SCENARIO_BLOCKING_AREA
39569
+ * @param scenarioBlockingIndex the index of the Scenario blocking area
39570
+ * @param bNetwork Optionally networked to all other players
39459
39571
  */
39460
- declare function RemoveScenarioBlockingArea(p0: number, p1: boolean): void;
39572
+ declare function RemoveScenarioBlockingArea(scenarioBlockingIndex: number, bNetwork: boolean): void;
39461
39573
 
39462
39574
  /**
39463
39575
  * REMOVE_SCENARIO_BLOCKING_AREAS
@@ -48739,13 +48851,29 @@ declare function SetPedShootRate(ped: number, shootRate: number): void;
48739
48851
  declare function SetPedShootsAtCoord(ped: number, x: number, y: number, z: number, toggle: boolean): void;
48740
48852
 
48741
48853
  /**
48742
- * _SET_PED_SHOULD_PLAY_DIRECTED_SCENARIO_EXIT
48854
+ * When this ped receives its next script task, they will exit from their scenario using the normal scenario exit.
48855
+ * Exiting the scenario may take several frames while the ped is playing the exit animation.
48856
+ * If the ped is not currently using a scenario at the time of the command or 0,0,0 is specified as the reaction position,
48857
+ * then the ped will by default attempt to direct their exit forwards.
48858
+ * @param ped the ped who should play a normal (unhurried) exit the next time they are given a script command.
48859
+ * @param x X Coordinate.
48860
+ * @param y Y Coordinate.
48861
+ * @param z Z Coordinate.
48862
+ * @return Returns true if the position was successfully set.
48743
48863
  */
48744
- declare function SetPedShouldPlayDirectedScenarioExit(p0: number, p1: number, p2: number, p3: number): number;
48864
+ declare function SetPedShouldPlayDirectedScenarioExit(ped: number, x: number, y: number, z: number): boolean;
48745
48865
  /**
48746
- * _SET_PED_SHOULD_PLAY_DIRECTED_SCENARIO_EXIT
48866
+ * When this ped receives its next script task, they will exit from their scenario using the normal scenario exit.
48867
+ * Exiting the scenario may take several frames while the ped is playing the exit animation.
48868
+ * If the ped is not currently using a scenario at the time of the command or 0,0,0 is specified as the reaction position,
48869
+ * then the ped will by default attempt to direct their exit forwards.
48870
+ * @param ped the ped who should play a normal (unhurried) exit the next time they are given a script command.
48871
+ * @param x X Coordinate.
48872
+ * @param y Y Coordinate.
48873
+ * @param z Z Coordinate.
48874
+ * @return Returns true if the position was successfully set.
48747
48875
  */
48748
- declare function N_0xec6935ebe0847b90(p0: number, p1: number, p2: number, p3: number): number;
48876
+ declare function N_0xec6935ebe0847b90(ped: number, x: number, y: number, z: number): boolean;
48749
48877
 
48750
48878
  /**
48751
48879
  * SET_PED_SHOULD_PLAY_FLEE_SCENARIO_EXIT
@@ -50344,9 +50472,11 @@ declare function SetScaleformMovieToUseSystemTime(scaleform: number, toggle: boo
50344
50472
  declare function SetScenarioGroupEnabled(scenarioGroup: string, p1: boolean): void;
50345
50473
 
50346
50474
  /**
50347
- * SET_SCENARIO_PED_DENSITY_MULTIPLIER_THIS_FRAME
50475
+ * Set the number of scenario peds on the entire map
50476
+ * @param interiorMult Multiplier for ped scenarios inside interiors.
50477
+ * @param exteriorMult Multiplier for ped scenarios outside interiors.
50348
50478
  */
50349
- declare function SetScenarioPedDensityMultiplierThisFrame(p0: number, p1: number): void;
50479
+ declare function SetScenarioPedDensityMultiplierThisFrame(interiorMult: number, exteriorMult: number): void;
50350
50480
 
50351
50481
  /**
50352
50482
  * SET_SCENARIO_PEDS_SPAWN_IN_SPHERE_AREA
@@ -50869,53 +50999,6 @@ declare function SetSuperJumpThisFrame(player: number): void;
50869
50999
  */
50870
51000
  declare function SetSwimMultiplierForPlayer(player: number, multiplier: number): void;
50871
51001
 
50872
- /**
50873
- * Sets the position of the audio event to the entity's position for one frame(?)
50874
- * if (l_8C3 == 0) {
50875
- * sub_27fd1(0, -1, 1);
50876
- * if (PED::IS_SYNCHRONIZED_SCENE_RUNNING(l_87D)) {
50877
- * AUDIO::STOP_SYNCHRONIZED_AUDIO_EVENT(l_87D);
50878
- * }
50879
- * if (sub_7dd(l_A00)) {
50880
- * AUDIO::_950A154B8DAB6185("PAP2_IG1_POPPYSEX", l_A00);
50881
- * }
50882
- * sub_91c("TK************ SETTING SYNCH SCENE AUDIO POSITION THIS FRAME ************TK");
50883
- * l_8C3 = 1;
50884
- * }
50885
- * --
50886
- * Found in the b617d scripts, duplicates removed:
50887
- * AUDIO::_950A154B8DAB6185("CAR_5_IG_6", l_7FE[1 -- [[1]] ]);
50888
- * AUDIO::_950A154B8DAB6185("EX03_TRAIN_BIKE_LAND", PLAYER::PLAYER_PED_ID());
50889
- * AUDIO::_950A154B8DAB6185("FBI_2_MCS_1_LeadIn", l_40[2 -- [[1]] ]);
50890
- * AUDIO::_950A154B8DAB6185("FIN_C2_MCS_1", l_24C[0 -- [[1]] ]);
50891
- * AUDIO::_950A154B8DAB6185("MNT_DNC", l_5F);
50892
- * AUDIO::_950A154B8DAB6185("PAP2_IG1_POPPYSEX", l_A00);
50893
- */
50894
- declare function SetSynchronizedAudioEventPositionThisFrame(p0: string, p1: number): void;
50895
- /**
50896
- * Sets the position of the audio event to the entity's position for one frame(?)
50897
- * if (l_8C3 == 0) {
50898
- * sub_27fd1(0, -1, 1);
50899
- * if (PED::IS_SYNCHRONIZED_SCENE_RUNNING(l_87D)) {
50900
- * AUDIO::STOP_SYNCHRONIZED_AUDIO_EVENT(l_87D);
50901
- * }
50902
- * if (sub_7dd(l_A00)) {
50903
- * AUDIO::_950A154B8DAB6185("PAP2_IG1_POPPYSEX", l_A00);
50904
- * }
50905
- * sub_91c("TK************ SETTING SYNCH SCENE AUDIO POSITION THIS FRAME ************TK");
50906
- * l_8C3 = 1;
50907
- * }
50908
- * --
50909
- * Found in the b617d scripts, duplicates removed:
50910
- * AUDIO::_950A154B8DAB6185("CAR_5_IG_6", l_7FE[1 -- [[1]] ]);
50911
- * AUDIO::_950A154B8DAB6185("EX03_TRAIN_BIKE_LAND", PLAYER::PLAYER_PED_ID());
50912
- * AUDIO::_950A154B8DAB6185("FBI_2_MCS_1_LeadIn", l_40[2 -- [[1]] ]);
50913
- * AUDIO::_950A154B8DAB6185("FIN_C2_MCS_1", l_24C[0 -- [[1]] ]);
50914
- * AUDIO::_950A154B8DAB6185("MNT_DNC", l_5F);
50915
- * AUDIO::_950A154B8DAB6185("PAP2_IG1_POPPYSEX", l_A00);
50916
- */
50917
- declare function N_0x950a154b8dab6185(p0: string, p1: number): void;
50918
-
50919
51002
  /**
50920
51003
  * SET_SYNCHRONIZED_SCENE_HOLD_LAST_FRAME
50921
51004
  */
@@ -52109,18 +52192,27 @@ declare function SetVehicleDoorOpen(vehicle: number, doorIndex: number, loose: b
52109
52192
  declare function SetVehicleDoorShut(vehicle: number, doorIndex: number, closeInstantly: boolean): void;
52110
52193
 
52111
52194
  /**
52112
- * // Source GTA VC miss2 leak, matching constants for 0/2/4, testing
52113
- * // They use 10 in am_mp_property_int, don't know what it does atm.
52114
- * enum eCarLock {
52115
- * CARLOCK_NONE = 0,
52116
- * CARLOCK_UNLOCKED = 1,
52117
- * CARLOCK_LOCKED = 2,
52118
- * CARLOCK_LOCKOUT_PLAYER_ONLY = 3,
52119
- * CARLOCK_LOCKED_PLAYER_INSIDE = 4,
52120
- * CARLOCK_LOCKED_INITIALLY = 5,
52121
- * CARLOCK_FORCE_SHUT_DOORS = 6,
52122
- * CARLOCK_LOCKED_BUT_CAN_BE_DAMAGED = 7
52195
+ * Locks the doors of a specified vehicle to a defined lock state, affecting how players and NPCs can interact with the vehicle.
52196
+ * ```
52197
+ * NativeDB Introduced: v323
52198
+ * ```
52199
+ * ```cpp
52200
+ * enum eVehicleLockState {
52201
+ * VEHICLELOCK_NONE = 0, // No specific lock state, vehicle behaves according to the game's default settings.
52202
+ * VEHICLELOCK_UNLOCKED = 1, // Vehicle is fully unlocked, allowing free entry by players and NPCs.
52203
+ * VEHICLELOCK_LOCKED = 2, // Vehicle is locked, preventing entry by players and NPCs.
52204
+ * VEHICLELOCK_LOCKOUT_PLAYER_ONLY = 3, // Vehicle locks out only players, allowing NPCs to enter.
52205
+ * VEHICLELOCK_LOCKED_PLAYER_INSIDE = 4, // Vehicle is locked once a player enters, preventing others from entering.
52206
+ * VEHICLELOCK_LOCKED_INITIALLY = 5, // Vehicle starts in a locked state, but may be unlocked through game events.
52207
+ * VEHICLELOCK_FORCE_SHUT_DOORS = 6, // Forces the vehicle's doors to shut and lock.
52208
+ * VEHICLELOCK_LOCKED_BUT_CAN_BE_DAMAGED = 7, // Vehicle is locked but can still be damaged.
52209
+ * VEHICLELOCK_LOCKED_BUT_BOOT_UNLOCKED = 8, // Vehicle is locked, but its trunk/boot remains unlocked.
52210
+ * VEHICLELOCK_LOCKED_NO_PASSENGERS = 9, // Vehicle is locked and does not allow passengers, except for the driver.
52211
+ * VEHICLELOCK_CANNOT_ENTER = 10 // Vehicle is completely locked, preventing entry entirely, even if previously inside.
52123
52212
  * };
52213
+ * ```
52214
+ * @param vehicle The vehicle whose doors are to be locked.
52215
+ * @param doorLockStatus The lock state to apply to the vehicle's doors, see `eVehicleLockState`.
52124
52216
  */
52125
52217
  declare function SetVehicleDoorsLocked(vehicle: number, doorLockStatus: number): void;
52126
52218
 
@@ -56957,9 +57049,40 @@ declare function TaskExtendRoute(x: number, y: number, z: number): void;
56957
57049
  declare function TaskFlushRoute(): void;
56958
57050
 
56959
57051
  /**
56960
- * If no timeout, set timeout to -1.
57052
+ * Sometimes a path may not be able to be found. This could happen because there simply isn't any way to get there, or maybe a bunch of dynamic objects have blocked the way,
57053
+ * or maybe the destination is too far away. In this case the ped will simply stand still.
57054
+ * To identify when this has happened, you can use GET_NAVMESH_ROUTE_RESULT. This will help you find situations where peds cannot get to their target.
57055
+ * ```cpp
57056
+ * enum eNavScriptFlags {
57057
+ * ENAV_DEFAULT = 0, // Default flag
57058
+ * ENAV_NO_STOPPING = 1, // Will ensure the ped continues to move whilst waiting for the path to be found, and will not slow down at the end of their route.
57059
+ * ENAV_ADV_SLIDE_TO_COORD_AND_ACHIEVE_HEADING_AT_END = 2, // Performs a slide-to-coord at the end of the task. This requires that the accompanying NAVDATA structure has the 'SlideToCoordHeading' member set correctly.
57060
+ * ENAV_GO_FAR_AS_POSSIBLE_IF_TARGET_NAVMESH_NOT_LOADED = 4, // If the navmesh is not loaded in under the target position, then this will cause the ped to get as close as is possible on whatever navmesh is loaded. The navmesh must still be loaded at the path start.
57061
+ * ENAV_ALLOW_SWIMMING_UNDERWATER = 8, // Will allow navigation underwater - by default this is not allowed.
57062
+ * ENAV_KEEP_TO_PAVEMENTS = 16, // Will only allow navigation on pavements. If the path starts or ends off the pavement, the command will fail. Likewise if no pavement-only route can be found even although the start and end are on pavement.
57063
+ * ENAV_NEVER_ENTER_WATER = 32, // Prevents the path from entering water at all.
57064
+ * ENAV_DONT_AVOID_OBJECTS = 64, // Disables object-avoidance for this path. The ped may still make minor steering adjustments to avoid objects, but will not pathfind around them.
57065
+ * ENAV_ADVANCED_USE_MAX_SLOPE_NAVIGABLE = 128, // Specifies that the navmesh route will only be able to traverse up slopes which are under the angle specified, in the MaxSlopeNavigable member of the accompanying NAVDATA structure.
57066
+ * ENAV_STOP_EXACTLY = 512, // Unused.
57067
+ * ENAV_ACCURATE_WALKRUN_START = 1024, // The entity will look ahead in its path for a longer distance to make the walk/run start go more in the right direction.
57068
+ * ENAV_DONT_AVOID_PEDS = 2048, // Disables ped-avoidance for this path while we move.
57069
+ * ENAV_DONT_ADJUST_TARGET_POSITION = 4096, // If target pos is inside the boundingbox of an object it will otherwise be pushed out.
57070
+ * ENAV_SUPPRESS_EXACT_STOP = 8192, // Turns off the default behaviour, which is to stop exactly at the target position. Occasionally this can cause footsliding/skating problems.
57071
+ * ENAV_ADVANCED_USE_CLAMP_MAX_SEARCH_DISTANCE = 16384, // Prevents the path-search from finding paths outside of this search distance. This can be used to prevent peds from finding long undesired routes.
57072
+ * ENAV_PULL_FROM_EDGE_EXTRA = 32768 // Pulls out the paths from edges at corners for a longer distance, to prevent peds walking into stuff.
57073
+ * };
57074
+ * ```
57075
+ * @param ped Ped Index.
57076
+ * @param x X Position Coordinate.
57077
+ * @param y Y Position Coordinate.
57078
+ * @param z Z Position Coordinate
57079
+ * @param moveBlendRatio Ratio for ped movement (0 to 3.0 in the following order: still, walk, run and sprint)
57080
+ * @param time INT value in milliseconds.
57081
+ * @param radius distance from the final coordinates that the pedestrian should be to consider itself at the target.
57082
+ * @param flags Navigation Flags for the ped (see `eNavScriptFlags`).
57083
+ * @param finalHeading Peds heading when finished.
56961
57084
  */
56962
- declare function TaskFollowNavMeshToCoord(ped: number, x: number, y: number, z: number, speed: number, timeout: number, stoppingRange: number, persistFollowing: boolean, unk: number): void;
57085
+ declare function TaskFollowNavMeshToCoord(ped: number, x: number, y: number, z: number, moveBlendRatio: number, time: number, radius: number, flags: number, finalHeading: number): void;
56963
57086
 
56964
57087
  /**
56965
57088
  * TASK_FOLLOW_NAV_MESH_TO_COORD_ADVANCED
@@ -59655,8 +59778,17 @@ declare function UpdateMapdataEntity(mapdata: number, entity: number, entityDef:
59655
59778
 
59656
59779
  /**
59657
59780
  * UPDATE_NAVMESH_BLOCKING_OBJECT
59658
- */
59659
- declare function UpdateNavmeshBlockingObject(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number, p7: number, p8: number): void;
59781
+ * @param object Navmesh Blocking Object by ID. must be returned by [`ADD_NAVMESH_BLOCKING_OBJECT`](#\_0xFCD5C8E06E502F5A).
59782
+ * @param posX X position coordinate.
59783
+ * @param posY Y position coordinate.
59784
+ * @param posZ Z position coordinate.
59785
+ * @param scaleX X Scale.
59786
+ * @param scaleY Y Scale.
59787
+ * @param scaleZ Z Scale.
59788
+ * @param heading Heading of the blocking object.
59789
+ * @param flags Flags for the blocking object, see [`ADD_NAVMESH_BLOCKING_OBJECT`](#\_0xFCD5C8E06E502F5A) for list of blocking object flags.
59790
+ */
59791
+ declare function UpdateNavmeshBlockingObject(object: number, posX: number, posY: number, posZ: number, scaleX: number, scaleY: number, scaleZ: number, heading: number, flags: number): void;
59660
59792
 
59661
59793
  /**
59662
59794
  * Returns the current status of the onscreen keyboard, and updates the output.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@citizenfx/client",
3
- "version": "2.0.7596-1",
3
+ "version": "2.0.7616-1",
4
4
  "description": "Typings for the CitizenFX client JS API.",
5
5
  "main": "index.js",
6
6
  "scripts": {