@citizenfx/client 2.0.7654-1 → 2.0.7660-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.
@@ -1748,6 +1748,21 @@ declare function AreOutriggerLegsDeployed(vehicle: number): boolean;
1748
1748
  */
1749
1749
  declare function N_0x3a9128352eac9e85(vehicle: number): boolean;
1750
1750
 
1751
+ /**
1752
+ * Queries whether the control panels of a plane are intact. This native is used to determine the operational status of a plane's cockpit controls, which can affect the plane's flyability.
1753
+ * @param vehicle The vehicle to check. This should be a plane.
1754
+ * @param checkForZeroHealth If set to `true`, the native also checks if the plane's health is zero, indicating it is completely destroyed. If `false`, only the state of the control panels is considered.
1755
+ * @return Returns `true` if the plane's control panels are intact, and, depending on the `checkForZeroHealth` parameter, the plane is not completely destroyed. Returns `false` if the control panels are damaged or the plane is destroyed (when `checkForZeroHealth` is `true`).
1756
+ */
1757
+ declare function ArePlaneControlPanelsIntact(vehicle: number, checkForZeroHealth: boolean): boolean;
1758
+ /**
1759
+ * Queries whether the control panels of a plane are intact. This native is used to determine the operational status of a plane's cockpit controls, which can affect the plane's flyability.
1760
+ * @param vehicle The vehicle to check. This should be a plane.
1761
+ * @param checkForZeroHealth If set to `true`, the native also checks if the plane's health is zero, indicating it is completely destroyed. If `false`, only the state of the control panels is considered.
1762
+ * @return Returns `true` if the plane's control panels are intact, and, depending on the `checkForZeroHealth` parameter, the plane is not completely destroyed. Returns `false` if the control panels are damaged or the plane is destroyed (when `checkForZeroHealth` is `true`).
1763
+ */
1764
+ declare function N_0xf78f94d60248c737(vehicle: number, checkForZeroHealth: boolean): boolean;
1765
+
1751
1766
  /**
1752
1767
  * ARE_PLANE_PROPELLERS_INTACT
1753
1768
  */
@@ -25496,11 +25511,6 @@ declare function N_0x265635150fb0d82e(): void;
25496
25511
  */
25497
25512
  declare function N_0x26d7399b9587fe89(p0: number): void;
25498
25513
 
25499
- /**
25500
- * 0x26D99D5A82FD18E8
25501
- */
25502
- declare function N_0x26d99d5a82fd18e8(p0: number): void;
25503
-
25504
25514
  /**
25505
25515
  * 0x26F07DD83A5F7F98
25506
25516
  */
@@ -30236,11 +30246,6 @@ declare function N_0xf6f4383b7c92f11a(p0: number): void;
30236
30246
  */
30237
30247
  declare function N_0xf78b803082d4386f(p0: number): void;
30238
30248
 
30239
- /**
30240
- * 0xF78F94D60248C737
30241
- */
30242
- declare function N_0xf78f94d60248c737(vehicle: number, p1: boolean): boolean;
30243
-
30244
30249
  /**
30245
30250
  * 0xF814FEC6A19FD6E0
30246
30251
  */
@@ -43623,6 +43628,23 @@ declare function N_0x2632482fd6b9ab87(): void;
43623
43628
  */
43624
43629
  declare function SetDisableAmbientMeleeMove(player: number, toggle: boolean): void;
43625
43630
 
43631
+ /**
43632
+ * Disables the additional physics forces applied to BMX bikes that enable them to perform tricks.
43633
+ * ```
43634
+ * NativeDB Introduced: v463
43635
+ * ```
43636
+ * @param disableExtraTrickForces Set to `true` to disable the extra forces applied for tricks on BMX bicycles, making the bike behave more like a regular bicycle without trick capabilities. Set to `false` to allow BMX bikes to perform tricks normally.
43637
+ */
43638
+ declare function SetDisableBmxExtraTrickForces(disableExtraTrickForces: boolean): void;
43639
+ /**
43640
+ * Disables the additional physics forces applied to BMX bikes that enable them to perform tricks.
43641
+ * ```
43642
+ * NativeDB Introduced: v463
43643
+ * ```
43644
+ * @param disableExtraTrickForces Set to `true` to disable the extra forces applied for tricks on BMX bicycles, making the bike behave more like a regular bicycle without trick capabilities. Set to `false` to allow BMX bikes to perform tricks normally.
43645
+ */
43646
+ declare function N_0x26d99d5a82fd18e8(disableExtraTrickForces: boolean): void;
43647
+
43626
43648
  /**
43627
43649
  * SET_DISABLE_BREAKING
43628
43650
  */
@@ -47095,21 +47117,6 @@ declare function SetPedAudioFootstepLoud(ped: number, toggle: boolean): void;
47095
47117
  */
47096
47118
  declare function N_0x0653b735bfbdfe87(ped: number, toggle: boolean): void;
47097
47119
 
47098
- /**
47099
- * Enables/disables ped's "quiet" footstep sound.
47100
- * ```
47101
- * ```
47102
- * NativeDB Introduced: v1493
47103
- */
47104
- declare function SetPedAudioFootstepQuiet(ped: number, toggle: boolean): void;
47105
- /**
47106
- * Enables/disables ped's "quiet" footstep sound.
47107
- * ```
47108
- * ```
47109
- * NativeDB Introduced: v1493
47110
- */
47111
- declare function N_0x29da3ca8d8b2692d(ped: number, toggle: boolean): void;
47112
-
47113
47120
  /**
47114
47121
  * _SET_PED_AUDIO_GENDER
47115
47122
  */
@@ -47336,6 +47343,19 @@ declare function SetPedCapsule(ped: number, value: number): void;
47336
47343
  */
47337
47344
  declare function SetPedChanceOfFiringBlanks(ped: number, xBias: number, yBias: number): void;
47338
47345
 
47346
+ /**
47347
+ * NativeDB Introduced: v1493
47348
+ */
47349
+ declare function SetPedClothEventsEnabled(ped: number, enabled: boolean): void;
47350
+ /**
47351
+ * NativeDB Introduced: v1493
47352
+ */
47353
+ declare function N_0x29da3ca8d8b2692d(ped: number, enabled: boolean): void;
47354
+ /**
47355
+ * NativeDB Introduced: v1493
47356
+ */
47357
+ declare function SetPedAudioFootstepQuiet(ped: number, enabled: boolean): void;
47358
+
47339
47359
  /**
47340
47360
  * SET_PED_CLOTH_PACKAGE_INDEX
47341
47361
  */
@@ -53163,7 +53183,7 @@ declare function SetVehicleRadioEnabled(vehicle: number, toggle: boolean): void;
53163
53183
  /**
53164
53184
  * SET_VEHICLE_RADIO_LOUD
53165
53185
  */
53166
- declare function SetVehicleRadioLoud(vehicle: number, toggle: boolean): void;
53186
+ declare function SetVehicleRadioLoud(vehicle: number, loud: boolean): void;
53167
53187
 
53168
53188
  /**
53169
53189
  * _SET_VEHICLE_RAMP_LAUNCH_MODIFIER
@@ -53334,22 +53354,14 @@ declare function N_0x1cf38d529d7441d9(vehicle: number, toggle: boolean): void;
53334
53354
 
53335
53355
  /**
53336
53356
  * Overrides the vehicle's startup engine rev sound.
53337
- * 2 calls found in the b617d scripts:
53338
- * ```cpp
53339
- * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_A42, "Franklin_Bike_Rev", "BIG_SCORE_3A_SOUNDS");
53340
- * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_166, "Trevor_Revs_Off", "PALETO_SCORE_SETUP_SOUNDS");
53341
- * ```
53357
+ * You can reset this with [RESET_VEHICLE_STARTUP_REV_SOUND](#\_0xD2DCCD8E16E20997)
53342
53358
  */
53343
- declare function SetVehicleStartupRevSound(vehicle: number, p1: string, p2: string): void;
53359
+ declare function SetVehicleStartupRevSound(vehicle: number, soundName: string, setName: string): void;
53344
53360
  /**
53345
53361
  * Overrides the vehicle's startup engine rev sound.
53346
- * 2 calls found in the b617d scripts:
53347
- * ```cpp
53348
- * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_A42, "Franklin_Bike_Rev", "BIG_SCORE_3A_SOUNDS");
53349
- * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_166, "Trevor_Revs_Off", "PALETO_SCORE_SETUP_SOUNDS");
53350
- * ```
53362
+ * You can reset this with [RESET_VEHICLE_STARTUP_REV_SOUND](#\_0xD2DCCD8E16E20997)
53351
53363
  */
53352
- declare function N_0xf1f8157b8c3f171c(vehicle: number, p1: string, p2: string): void;
53364
+ declare function N_0xf1f8157b8c3f171c(vehicle: number, soundName: string, setName: string): void;
53353
53365
 
53354
53366
  /**
53355
53367
  * Locks the vehicle's steering to the desired angle, explained below.
@@ -55157,30 +55169,9 @@ declare function StabiliseEntityAttachedToHeli(vehicle: number, entity: number,
55157
55169
  declare function N_0x374706271354cb18(vehicle: number, entity: number, p2: number): void;
55158
55170
 
55159
55171
  /**
55160
- * Example:
55161
- * This will start the alarm at Fort Zancudo.
55162
- * AUDIO::START_ALARM("PORT_OF_LS_HEIST_FORT_ZANCUDO_ALARMS", 1);
55163
- * First parameter (char) is the name of the alarm.
55164
- * Second parameter (bool) is unknown, it does not seem to make a difference if this one is 0 or 1.
55165
- * ----------
55166
- * It DOES make a difference but it has to do with the duration or something I dunno yet
55167
- * ----------
55168
- * Found in the b617d scripts:
55169
- * AUDIO::START_ALARM("AGENCY_HEIST_FIB_TOWER_ALARMS", 0);
55170
- * AUDIO::START_ALARM("AGENCY_HEIST_FIB_TOWER_ALARMS_UPPER", 1);
55171
- * AUDIO::START_ALARM("AGENCY_HEIST_FIB_TOWER_ALARMS_UPPER_B", 0);
55172
- * AUDIO::START_ALARM("BIG_SCORE_HEIST_VAULT_ALARMS", a_0);
55173
- * AUDIO::START_ALARM("FBI_01_MORGUE_ALARMS", 1);
55174
- * AUDIO::START_ALARM("FIB_05_BIOTECH_LAB_ALARMS", 0);
55175
- * AUDIO::START_ALARM("JEWEL_STORE_HEIST_ALARMS", 0);
55176
- * AUDIO::START_ALARM("PALETO_BAY_SCORE_ALARM", 1);
55177
- * AUDIO::START_ALARM("PALETO_BAY_SCORE_CHICKEN_FACTORY_ALARM", 0);
55178
- * AUDIO::START_ALARM("PORT_OF_LS_HEIST_FORT_ZANCUDO_ALARMS", 1);
55179
- * AUDIO::START_ALARM("PORT_OF_LS_HEIST_SHIP_ALARMS", 0);
55180
- * AUDIO::START_ALARM("PRISON_ALARMS", 0);
55181
- * AUDIO::START_ALARM("PROLOGUE_VAULT_ALARMS", 0);
55182
- */
55183
- declare function StartAlarm(alarmName: string, p2: boolean): void;
55172
+ * You should call [PREPARE_ALARM](#\_0x9D74AE343DB65533) and wait for its value to be true before using this
55173
+ */
55174
+ declare function StartAlarm(alarmName: string, skipStartup: boolean): void;
55184
55175
 
55185
55176
  /**
55186
55177
  * Used to prepare a scene where the surrounding sound is muted or a bit changed. This does not play any sound.
@@ -55603,7 +55594,7 @@ declare function StartPlayerSwitch(_from: number, to: number, flags: number, swi
55603
55594
  declare function StartPlayerTeleport(player: number, x: number, y: number, z: number, heading: number, teleportWithVehicle: boolean, findCollisionLand: boolean, p7: boolean): void;
55604
55595
 
55605
55596
  /**
55606
- * START_PRELOADED_CONVERSATION
55597
+ * For use with [PRELOAD_SCRIPT_CONVERSATION](#\_0x3B3CAD6166916D87) and [GET_IS_PRELOADED_CONVERSATION_READY](#\_0xE73364DB90778FFA)
55607
55598
  */
55608
55599
  declare function StartPreloadedConversation(): void;
55609
55600
 
@@ -55657,8 +55648,11 @@ declare function StartSaveStruct(size: number, structName: string): number;
55657
55648
 
55658
55649
  /**
55659
55650
  * START_SCRIPT_CONVERSATION
55651
+ * @param addToBriefScreen Defaults to true
55652
+ * @param cloneConversation Defaults to false
55653
+ * @param interruptible Defaults to true
55660
55654
  */
55661
- declare function StartScriptConversation(p0: boolean, p1: boolean, p2: boolean, p3: boolean): void;
55655
+ declare function StartScriptConversation(displaySubtitles: boolean, addToBriefScreen: boolean, cloneConversation: boolean, interruptible: boolean): void;
55662
55656
 
55663
55657
  /**
55664
55658
  * Starts a fire:
@@ -55670,8 +55664,9 @@ declare function StartScriptFire(X: number, Y: number, Z: number, maxChildren: n
55670
55664
 
55671
55665
  /**
55672
55666
  * START_SCRIPT_PHONE_CONVERSATION
55667
+ * @param addToBriefScreen Defaults to true
55673
55668
  */
55674
- declare function StartScriptPhoneConversation(p0: boolean, p1: boolean): void;
55669
+ declare function StartScriptPhoneConversation(displaySubtitles: boolean, addToBriefScreen: boolean): void;
55675
55670
 
55676
55671
  /**
55677
55672
  * See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
@@ -56267,18 +56262,16 @@ declare function StatSetUserId(statName: string | number, value: string, save: b
56267
56262
  declare function StatSlotIsLoaded(p0: number): boolean;
56268
56263
 
56269
56264
  /**
56270
- * Example:
56271
- * This will stop the alarm at Fort Zancudo.
56272
- * AUDIO::STOP_ALARM("PORT_OF_LS_HEIST_FORT_ZANCUDO_ALARMS", 1);
56273
- * First parameter (char) is the name of the alarm.
56274
- * Second parameter (bool) has to be true (1) to have any effect.
56265
+ * STOP_ALARM
56266
+ * @param instantStop Whether to kill the alarm instantly, or to let the audio system turn it off when it becomes inaudible
56275
56267
  */
56276
- declare function StopAlarm(alarmName: string, toggle: boolean): void;
56268
+ declare function StopAlarm(alarmName: string, instantStop: boolean): void;
56277
56269
 
56278
56270
  /**
56279
56271
  * STOP_ALL_ALARMS
56272
+ * @param instantStop Whether to kill the alarm instantly, or to let the audio system turn it off when it becomes inaudible
56280
56273
  */
56281
- declare function StopAllAlarms(stop: boolean): void;
56274
+ declare function StopAllAlarms(instantStop: boolean): void;
56282
56275
 
56283
56276
  /**
56284
56277
  * STOP_ALL_GARAGE_ACTIVITY
@@ -56302,9 +56295,9 @@ declare function StopAnimTask(ped: number, animDictionary: string, animationName
56302
56295
  declare function StopAnyPedModelBeingSuppressed(): void;
56303
56296
 
56304
56297
  /**
56305
- * STOP_AUDIO_SCENE
56298
+ * Stops the named mixing scene (which was previously started by this script)
56306
56299
  */
56307
- declare function StopAudioScene(scene: string): void;
56300
+ declare function StopAudioScene(sceneName: string): void;
56308
56301
 
56309
56302
  /**
56310
56303
  * Stops all mixed scenes which were previously started by this script
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@citizenfx/client",
3
- "version": "2.0.7654-1",
3
+ "version": "2.0.7660-1",
4
4
  "description": "Typings for the CitizenFX client JS API.",
5
5
  "main": "index.js",
6
6
  "scripts": {