@citizenfx/client 2.0.7630-1 → 2.0.7660-1

package/natives_universal.d.ts

@@ -1748,6 +1748,21 @@ declare function AreOutriggerLegsDeployed(vehicle: number): boolean;
  */
 declare function N_0x3a9128352eac9e85(vehicle: number): boolean;
 
+/**
+ * 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.
+ * @param vehicle The vehicle to check. This should be a plane.
+ * @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.
+ * @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`).
+ */
+declare function ArePlaneControlPanelsIntact(vehicle: number, checkForZeroHealth: boolean): boolean;
+/**
+ * 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.
+ * @param vehicle The vehicle to check. This should be a plane.
+ * @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.
+ * @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`).
+ */
+declare function N_0xf78f94d60248c737(vehicle: number, checkForZeroHealth: boolean): boolean;
+
 /**
  * ARE_PLANE_PROPELLERS_INTACT
  */
@@ -25496,16 +25511,6 @@ declare function N_0x265635150fb0d82e(): void;
  */
 declare function N_0x26d7399b9587fe89(p0: number): void;
 
-/**
- * 0x26D99D5A82FD18E8
- */
-declare function N_0x26d99d5a82fd18e8(p0: number): void;
-
-/**
- * NativeDB Introduced: v1290
- */
-declare function N_0x26e13d440e7f6064(vehicle: number, value: number): void;
-
 /**
  * 0x26F07DD83A5F7F98
  */
@@ -30064,11 +30069,6 @@ declare function N_0xed5fd7af10f5e262(p0: number, p1: number, p2: number, p3: nu
  */
 declare function N_0xed76d195e6e3bf7f(p0: number, p1: number, p2: number, p3: number): void;
 
-/**
- * 0xEDBC8405B3895CC9
- */
-declare function N_0xedbc8405b3895cc9(p0: number, p1: number): void;
-
 /**
  * 0xEDBF6C9B0D2C65C8
  */
@@ -30246,11 +30246,6 @@ declare function N_0xf6f4383b7c92f11a(p0: number): void;
  */
 declare function N_0xf78b803082d4386f(p0: number): void;
 
-/**
- * 0xF78F94D60248C737
- */
-declare function N_0xf78f94d60248c737(vehicle: number, p1: boolean): boolean;
-
 /**
  * 0xF814FEC6A19FD6E0
  */
@@ -39297,6 +39292,7 @@ declare function RemoveAnimSet(animSet: string): void;
 
 /**
  * Removes the blip from your map.
+ * **Note:** This function only works on the script that created the blip, if you wish to remove blips created by other scripts, see [`SET_THIS_SCRIPT_CAN_REMOVE_BLIPS_CREATED_BY_ANY_SCRIPT`](#\_0x86A652570E5F25DD).
  * @param blip Blip handle to remove.
  */
 declare function RemoveBlip(blip: number): void;
@@ -43632,6 +43628,23 @@ declare function N_0x2632482fd6b9ab87(): void;
  */
 declare function SetDisableAmbientMeleeMove(player: number, toggle: boolean): void;
 
+/**
+ * Disables the additional physics forces applied to BMX bikes that enable them to perform tricks.
+ * ```
+ * NativeDB Introduced: v463
+ * ```
+ * @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.
+ */
+declare function SetDisableBmxExtraTrickForces(disableExtraTrickForces: boolean): void;
+/**
+ * Disables the additional physics forces applied to BMX bikes that enable them to perform tricks.
+ * ```
+ * NativeDB Introduced: v463
+ * ```
+ * @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.
+ */
+declare function N_0x26d99d5a82fd18e8(disableExtraTrickForces: boolean): void;
+
 /**
  * SET_DISABLE_BREAKING
  */
@@ -43646,11 +43659,51 @@ declare function SetDisableDecalRenderingThisFrame(): void;
  */
 declare function N_0x4b5cfc83122df602(): void;
 
+/**
+ * Prevents a vehicle from exploding upon sustaining body damage from physical collisions. This can be used to increase the durability of vehicles in high-impact scenarios, such as races or combat situations, by preventing them from being destroyed due to collision-induced body damage.
+ * For helicopters, you might want to check [`SET_DISABLE_HELI_EXPLODE_FROM_BODY_DAMAGE`](#\_0xEDBC8405B3895CC9) instead.
+ * ```
+ * NativeDB Introduced: v1290
+ * ```
+ * @param vehicle The vehicle to apply this setting to.
+ * @param disableExplode `true` to disable explosion from body damage on collision; `false` to allow explosions as normal.
+ */
+declare function SetDisableExplodeFromBodyDamageOnCollision(vehicle: number, disableExplode: boolean): void;
+/**
+ * Prevents a vehicle from exploding upon sustaining body damage from physical collisions. This can be used to increase the durability of vehicles in high-impact scenarios, such as races or combat situations, by preventing them from being destroyed due to collision-induced body damage.
+ * For helicopters, you might want to check [`SET_DISABLE_HELI_EXPLODE_FROM_BODY_DAMAGE`](#\_0xEDBC8405B3895CC9) instead.
+ * ```
+ * NativeDB Introduced: v1290
+ * ```
+ * @param vehicle The vehicle to apply this setting to.
+ * @param disableExplode `true` to disable explosion from body damage on collision; `false` to allow explosions as normal.
+ */
+declare function N_0x26e13d440e7f6064(vehicle: number, disableExplode: boolean): void;
+
 /**
  * SET_DISABLE_FRAG_DAMAGE
  */
 declare function SetDisableFragDamage(object: number, toggle: boolean): void;
 
+/**
+ * Prevents a helicopter from exploding due to relatively minor body damage. This native can be particularly useful in gameplay scenarios or missions where helicopters are subject to damage that would not realistically cause an explosion, ensuring they remain operational unless subjected to more significant damage.
+ * ```
+ * NativeDB Introduced: v1103
+ * ```
+ * @param helicopter The helicopter to apply this setting to.
+ * @param disableExplode `true` to disable explosion from body damage on collision; `false` to allow explosions as normal.
+ */
+declare function SetDisableHeliExplodeFromBodyDamage(helicopter: number, disableExplode: boolean): void;
+/**
+ * Prevents a helicopter from exploding due to relatively minor body damage. This native can be particularly useful in gameplay scenarios or missions where helicopters are subject to damage that would not realistically cause an explosion, ensuring they remain operational unless subjected to more significant damage.
+ * ```
+ * NativeDB Introduced: v1103
+ * ```
+ * @param helicopter The helicopter to apply this setting to.
+ * @param disableExplode `true` to disable explosion from body damage on collision; `false` to allow explosions as normal.
+ */
+declare function N_0xedbc8405b3895cc9(helicopter: number, disableExplode: boolean): void;
+
 /**
  * Disables wings for `Deluxo` and `Oppressor MK II`. For the Deluxo, it retracts the wings immediately, preventing flight. For the Oppressor Mk II, the wings retract after landing and take-off is not possible, though it can still glide if launched into the air.
  * @param vehicle The vehicle to which the toggle will be applied.
@@ -47064,21 +47117,6 @@ declare function SetPedAudioFootstepLoud(ped: number, toggle: boolean): void;
  */
 declare function N_0x0653b735bfbdfe87(ped: number, toggle: boolean): void;
 
-/**
- * Enables/disables ped's "quiet" footstep sound.
- * ```
- * ```
- * NativeDB Introduced: v1493
- */
-declare function SetPedAudioFootstepQuiet(ped: number, toggle: boolean): void;
-/**
- * Enables/disables ped's "quiet" footstep sound.
- * ```
- * ```
- * NativeDB Introduced: v1493
- */
-declare function N_0x29da3ca8d8b2692d(ped: number, toggle: boolean): void;
-
 /**
  * _SET_PED_AUDIO_GENDER
  */
@@ -47305,6 +47343,19 @@ declare function SetPedCapsule(ped: number, value: number): void;
  */
 declare function SetPedChanceOfFiringBlanks(ped: number, xBias: number, yBias: number): void;
 
+/**
+ * NativeDB Introduced: v1493
+ */
+declare function SetPedClothEventsEnabled(ped: number, enabled: boolean): void;
+/**
+ * NativeDB Introduced: v1493
+ */
+declare function N_0x29da3ca8d8b2692d(ped: number, enabled: boolean): void;
+/**
+ * NativeDB Introduced: v1493
+ */
+declare function SetPedAudioFootstepQuiet(ped: number, enabled: boolean): void;
+
 /**
  * SET_PED_CLOTH_PACKAGE_INDEX
  */
@@ -51393,7 +51444,8 @@ declare function SetThirdPersonAimCamNearClip(distance: number): void;
 declare function SetThisScriptCanBePaused(toggle: boolean): void;
 
 /**
- * SET_THIS_SCRIPT_CAN_REMOVE_BLIPS_CREATED_BY_ANY_SCRIPT
+ * Normally, blips can only be removed by the script or resource that created them. However, this native function allows a script to bypass this logic and remove blips from any script.
+ * @param toggle Bool indicating if the script that called this native can remove blips created by other scripts.
  */
 declare function SetThisScriptCanRemoveBlipsCreatedByAnyScript(toggle: boolean): void;
 
@@ -53131,7 +53183,7 @@ declare function SetVehicleRadioEnabled(vehicle: number, toggle: boolean): void;
 /**
  * SET_VEHICLE_RADIO_LOUD
  */
-declare function SetVehicleRadioLoud(vehicle: number, toggle: boolean): void;
+declare function SetVehicleRadioLoud(vehicle: number, loud: boolean): void;
 
 /**
  * _SET_VEHICLE_RAMP_LAUNCH_MODIFIER
@@ -53302,22 +53354,14 @@ declare function N_0x1cf38d529d7441d9(vehicle: number, toggle: boolean): void;
 
 /**
  * Overrides the vehicle's startup engine rev sound.
- * 2 calls found in the b617d scripts:
- * ```cpp
- * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_A42, "Franklin_Bike_Rev", "BIG_SCORE_3A_SOUNDS");
- * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_166, "Trevor_Revs_Off", "PALETO_SCORE_SETUP_SOUNDS");
- * ```
+ * You can reset this with [RESET_VEHICLE_STARTUP_REV_SOUND](#\_0xD2DCCD8E16E20997)
  */
-declare function SetVehicleStartupRevSound(vehicle: number, p1: string, p2: string): void;
+declare function SetVehicleStartupRevSound(vehicle: number, soundName: string, setName: string): void;
 /**
  * Overrides the vehicle's startup engine rev sound.
- * 2 calls found in the b617d scripts:
- * ```cpp
- * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_A42, "Franklin_Bike_Rev", "BIG_SCORE_3A_SOUNDS");
- * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_166, "Trevor_Revs_Off", "PALETO_SCORE_SETUP_SOUNDS");
- * ```
+ * You can reset this with [RESET_VEHICLE_STARTUP_REV_SOUND](#\_0xD2DCCD8E16E20997)
  */
-declare function N_0xf1f8157b8c3f171c(vehicle: number, p1: string, p2: string): void;
+declare function N_0xf1f8157b8c3f171c(vehicle: number, soundName: string, setName: string): void;
 
 /**
  * Locks the vehicle's steering to the desired angle, explained below.
@@ -55125,30 +55169,9 @@ declare function StabiliseEntityAttachedToHeli(vehicle: number, entity: number,
 declare function N_0x374706271354cb18(vehicle: number, entity: number, p2: number): void;
 
 /**
- * Example:
- * This will start the alarm at Fort Zancudo.
- * AUDIO::START_ALARM("PORT_OF_LS_HEIST_FORT_ZANCUDO_ALARMS", 1);
- * First parameter (char) is the name of the alarm.
- * Second parameter (bool) is unknown, it does not seem to make a difference if this one is 0 or 1.
- * ----------
- * It DOES make a difference but it has to do with the duration or something I dunno yet
- * ----------
- * Found in the b617d scripts:
- * AUDIO::START_ALARM("AGENCY_HEIST_FIB_TOWER_ALARMS", 0);
- * AUDIO::START_ALARM("AGENCY_HEIST_FIB_TOWER_ALARMS_UPPER", 1);
- * AUDIO::START_ALARM("AGENCY_HEIST_FIB_TOWER_ALARMS_UPPER_B", 0);
- * AUDIO::START_ALARM("BIG_SCORE_HEIST_VAULT_ALARMS", a_0);
- * AUDIO::START_ALARM("FBI_01_MORGUE_ALARMS", 1);
- * AUDIO::START_ALARM("FIB_05_BIOTECH_LAB_ALARMS", 0);
- * AUDIO::START_ALARM("JEWEL_STORE_HEIST_ALARMS", 0);
- * AUDIO::START_ALARM("PALETO_BAY_SCORE_ALARM", 1);
- * AUDIO::START_ALARM("PALETO_BAY_SCORE_CHICKEN_FACTORY_ALARM", 0);
- * AUDIO::START_ALARM("PORT_OF_LS_HEIST_FORT_ZANCUDO_ALARMS", 1);
- * AUDIO::START_ALARM("PORT_OF_LS_HEIST_SHIP_ALARMS", 0);
- * AUDIO::START_ALARM("PRISON_ALARMS", 0);
- * AUDIO::START_ALARM("PROLOGUE_VAULT_ALARMS", 0);
- */
-declare function StartAlarm(alarmName: string, p2: boolean): void;
+ * You should call [PREPARE_ALARM](#\_0x9D74AE343DB65533) and wait for its value to be true before using this
+ */
+declare function StartAlarm(alarmName: string, skipStartup: boolean): void;
 
 /**
  * Used to prepare a scene where the surrounding sound is muted or a bit changed. This does not play any sound.
@@ -55571,7 +55594,7 @@ declare function StartPlayerSwitch(_from: number, to: number, flags: number, swi
 declare function StartPlayerTeleport(player: number, x: number, y: number, z: number, heading: number, teleportWithVehicle: boolean, findCollisionLand: boolean, p7: boolean): void;
 
 /**
- * START_PRELOADED_CONVERSATION
+ * For use with [PRELOAD_SCRIPT_CONVERSATION](#\_0x3B3CAD6166916D87) and [GET_IS_PRELOADED_CONVERSATION_READY](#\_0xE73364DB90778FFA)
  */
 declare function StartPreloadedConversation(): void;
 
@@ -55625,8 +55648,11 @@ declare function StartSaveStruct(size: number, structName: string): number;
 
 /**
  * START_SCRIPT_CONVERSATION
+ * @param addToBriefScreen Defaults to true
+ * @param cloneConversation Defaults to false
+ * @param interruptible Defaults to true
  */
-declare function StartScriptConversation(p0: boolean, p1: boolean, p2: boolean, p3: boolean): void;
+declare function StartScriptConversation(displaySubtitles: boolean, addToBriefScreen: boolean, cloneConversation: boolean, interruptible: boolean): void;
 
 /**
  * Starts a fire:
@@ -55638,8 +55664,9 @@ declare function StartScriptFire(X: number, Y: number, Z: number, maxChildren: n
 
 /**
  * START_SCRIPT_PHONE_CONVERSATION
+ * @param addToBriefScreen Defaults to true
  */
-declare function StartScriptPhoneConversation(p0: boolean, p1: boolean): void;
+declare function StartScriptPhoneConversation(displaySubtitles: boolean, addToBriefScreen: boolean): void;
 
 /**
  * See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
@@ -56235,18 +56262,16 @@ declare function StatSetUserId(statName: string | number, value: string, save: b
 declare function StatSlotIsLoaded(p0: number): boolean;
 
 /**
- * Example:
- * This will stop the alarm at Fort Zancudo.
- * AUDIO::STOP_ALARM("PORT_OF_LS_HEIST_FORT_ZANCUDO_ALARMS", 1);
- * First parameter (char) is the name of the alarm.
- * Second parameter (bool) has to be true (1) to have any effect.
+ * STOP_ALARM
+ * @param instantStop Whether to kill the alarm instantly, or to let the audio system turn it off when it becomes inaudible
  */
-declare function StopAlarm(alarmName: string, toggle: boolean): void;
+declare function StopAlarm(alarmName: string, instantStop: boolean): void;
 
 /**
  * STOP_ALL_ALARMS
+ * @param instantStop Whether to kill the alarm instantly, or to let the audio system turn it off when it becomes inaudible
  */
-declare function StopAllAlarms(stop: boolean): void;
+declare function StopAllAlarms(instantStop: boolean): void;
 
 /**
  * STOP_ALL_GARAGE_ACTIVITY
@@ -56270,9 +56295,9 @@ declare function StopAnimTask(ped: number, animDictionary: string, animationName
 declare function StopAnyPedModelBeingSuppressed(): void;
 
 /**
- * STOP_AUDIO_SCENE
+ * Stops the named mixing scene (which was previously started by this script)
  */
-declare function StopAudioScene(scene: string): void;
+declare function StopAudioScene(sceneName: string): void;
 
 /**
  * Stops all mixed scenes which were previously started by this script

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citizenfx/client",
-  "version": "2.0.7630-1",
+  "version": "2.0.7660-1",
   "description": "Typings for the CitizenFX client JS API.",
   "main": "index.js",
   "scripts": {