@citizenfx/client 2.0.7616-1 → 2.0.7628-1

package/natives_universal.d.ts

@@ -9540,11 +9540,6 @@ declare function N_0x920d853f3e17f1da(interiorID: number, roomHashKey: string |
  */
 declare function ForceSnowPass(enabled: boolean): void;
 
-/**
- * Exits the game and downloads a fresh social club update on next restart.
- */
-declare function ForceSocialClubUpdate(): void;
-
 /**
  * Doesn't actually return anything.
  */
@@ -22926,7 +22921,13 @@ declare function N_0x0626a247d2405330(): boolean;
 declare function IsRadioRetuning(): boolean;
 
 /**
- * NativeDB Introduced: v2699
+ * IS_RADIO_STATION_FAVOURITED
+ * @return Returns whether a radio station is a favourite.
+ */
+declare function IsRadioStationFavourited(radioStation: string): boolean;
+/**
+ * IS_RADIO_STATION_FAVOURITED
+ * @return Returns whether a radio station is a favourite.
  */
 declare function IsRadioStationVisible(radioStation: string): boolean;
 
@@ -23074,6 +23075,7 @@ declare function N_0xc912af078af19212(): boolean;
 
 /**
  * IS_SCRIPTED_CONVERSATION_LOADED
+ * @return Returns true if the first batch of lines for the currently requested conversation have loaded successfully.
  */
 declare function IsScriptedConversationLoaded(): boolean;
 
@@ -23103,8 +23105,9 @@ declare function IsScriptedScenarioPedUsingConditionalAnim(ped: number, animDict
 
 /**
  * IS_SCRIPTED_SPEECH_PLAYING
+ * @return Returns true if scripted speech is currently playing from the given ped.
  */
-declare function IsScriptedSpeechPlaying(p0: number): boolean;
+declare function IsScriptedSpeechPlaying(ped: number): boolean;
 
 /**
  * NativeDB Introduced: v1493
@@ -23200,6 +23203,7 @@ declare function N_0x883d79c4071e18b3(): boolean;
 
 /**
  * IS_STREAM_PLAYING
+ * @return Returns true if the script is currently playing a stream.
  */
 declare function IsStreamPlaying(): boolean;
 
@@ -23558,10 +23562,12 @@ declare function IsVehicleAttachedToTrailer(vehicle: number): boolean;
 
 /**
  * IS_VEHICLE_AUDIBLY_DAMAGED
+ * @return Returns true if the vehicle has any audible damage effects applied to it.
  */
 declare function IsVehicleAudiblyDamaged(vehicle: number): boolean;
 /**
  * IS_VEHICLE_AUDIBLY_DAMAGED
+ * @return Returns true if the vehicle has any audible damage effects applied to it.
  */
 declare function N_0x5db8010ee71fdef2(vehicle: number): boolean;
 
@@ -23737,17 +23743,23 @@ declare function N_0x3de51e9c80b116cf(vehicle: number): boolean;
 declare function IsVehiclePreviouslyOwnedByPlayer(vehicle: number): boolean;
 
 /**
- * IS_VEHICLE_*
+ * IS_VEHICLE_RADIO_ON
  * @param vehicle The vehicle to check
- * @return Is the given vehicle's radio enabled
+ * @return Returns true if the given vehicle's radio on
  */
-declare function IsVehicleRadioEnabled(vehicle: number): boolean;
+declare function IsVehicleRadioOn(vehicle: number): boolean;
 /**
- * IS_VEHICLE_*
+ * IS_VEHICLE_RADIO_ON
  * @param vehicle The vehicle to check
- * @return Is the given vehicle's radio enabled
+ * @return Returns true if the given vehicle's radio on
  */
 declare function N_0x0be4be946463f917(vehicle: number): boolean;
+/**
+ * IS_VEHICLE_RADIO_ON
+ * @param vehicle The vehicle to check
+ * @return Returns true if the given vehicle's radio on
+ */
+declare function IsVehicleRadioEnabled(vehicle: number): boolean;
 
 /**
  * _IS_VEHICLE_ROCKET_BOOST_ACTIVE
@@ -24172,13 +24184,17 @@ declare function LeaveCursorMode(): void;
 declare function LinkNamedRendertarget(modelHash: string | number): void;
 
 /**
- * L* (LINK_*?)
+ * Links a static emitter to the given entity
  */
 declare function LinkStaticEmitterToEntity(emitterName: string, entity: number): void;
 /**
- * L* (LINK_*?)
+ * Links a static emitter to the given entity
  */
 declare function N_0x651d3228960d08af(emitterName: string, entity: number): void;
+/**
+ * Links a static emitter to the given entity
+ */
+declare function LinkStaticEmitterToEntity(emitterName: string, entity: number): void;
 
 /**
  * LOAD_ALL_OBJECTS_NOW
@@ -24292,18 +24308,14 @@ declare function LoadRopeData(ropeId: number, rope_preset: string): void;
 declare function LoadScene(x: number, y: number, z: number): void;
 
 /**
- * Example:
- * AUDIO::LOAD_STREAM("CAR_STEAL_1_PASSBY", "CAR_STEAL_1_SOUNDSET");
- * All found occurrences in the b678d decompiled scripts: pastebin.com/3rma6w5w
- * Stream names often ends with "_MASTER", "_SMALL" or "_STREAM". Also "_IN", "_OUT" and numbers.
- * soundSet is often set to 0 in the scripts. These are common to end the soundSets: "_SOUNDS", "_SOUNDSET" and numbers.
+ * Load in named stream. Optionally can specify a sound set which contains the sound specified by name.
+ * Names for the streams can be found [here](https://gist.github.com/4mmonium/2bd2c9c54d6ca5cbdb7b156a82a3a85a), the list will be updated as more are found.
+ * @param soundSet an optional sound set, default is null
  */
 declare function LoadStream(streamName: string, soundSet: string): boolean;
 
 /**
- * Example:
- * AUDIO::LOAD_STREAM_WITH_START_OFFSET("STASH_TOXIN_STREAM", 2400, "FBI_05_SOUNDS");
- * Only called a few times in the scripts.
+ * Load in named stream. Optionally can specify a sound set which contains the sound specified by name.
  */
 declare function LoadStreamWithStartOffset(streamName: string, startOffset: number, soundSet: string): boolean;
 
@@ -24420,23 +24432,36 @@ declare function LockMinimapAngle(angle: number): void;
 declare function LockMinimapPosition(x: number, y: number): void;
 
 /**
- * Disables the radio station (hides it from the radio wheel).
+ * This disables the radio station completely - it won't be selectable on the radio wheel or ever be heard coming from a vehicle/ambient emitter
+ * ```
  * NativeDB Introduced: v1493
+ * ```
  */
 declare function LockRadioStation(radioStationName: string, toggle: boolean): void;
 /**
- * Disables the radio station (hides it from the radio wheel).
+ * This disables the radio station completely - it won't be selectable on the radio wheel or ever be heard coming from a vehicle/ambient emitter
+ * ```
  * NativeDB Introduced: v1493
+ * ```
  */
 declare function N_0x94f2e83ead7e6b82(radioStationName: string, toggle: boolean): void;
 /**
- * Disables the radio station (hides it from the radio wheel).
+ * This disables the radio station completely - it won't be selectable on the radio wheel or ever be heard coming from a vehicle/ambient emitter
+ * ```
  * NativeDB Introduced: v1493
+ * ```
  */
 declare function SetRadioStationDisabled(radioStationName: string, toggle: boolean): void;
+/**
+ * This disables the radio station completely - it won't be selectable on the radio wheel or ever be heard coming from a vehicle/ambient emitter
+ * ```
+ * NativeDB Introduced: v1493
+ * ```
+ */
+declare function LockRadioStation(radioStationName: string, toggle: boolean): void;
 
 /**
- * NativeDB Introduced: v2372
+ * LOCK_RADIO_STATION_TRACK_LIST
  */
 declare function LockRadioStationTrackList(radioStation: string, trackListName: string): void;
 
@@ -26232,11 +26257,6 @@ declare function N_0x44aca259d67651db(p1: number): number;
  */
 declare function N_0x450819d8cf90c416(): boolean;
 
-/**
- * 0x45A83257ED02D9BC
- */
-declare function N_0x45a83257ed02d9bc(): void;
-
 /**
  * 0x45E816772E93A9DB
  */
@@ -27301,11 +27321,6 @@ declare function N_0x705a276ebff3133d(): boolean;
  */
 declare function N_0x70a382adec069dd3(coordX: number, coordY: number, coordZ: number): void;
 
-/**
- * 0x70B8EC8FC108A634
- */
-declare function N_0x70b8ec8fc108a634(p0: boolean, p1: number): void;
-
 /**
  * NativeDB Added Parameter 1: char* p0
  * NativeDB Added Parameter 2: int* p1
@@ -27625,11 +27640,6 @@ declare function N_0x7e2bd3ef6c205f09(p0: string, p1: boolean): void;
  */
 declare function N_0x7e6946f68a38b74f(p0: number): boolean;
 
-/**
- * 0x7EC3C679D0E7E46B
- */
-declare function N_0x7ec3c679d0e7e46b(p0: number, p1: number, p2: number, p3: number): void;
-
 /**
  * Possibly used to clear scenario points.
  * CLEAR_*
@@ -29103,11 +29113,6 @@ declare function N_0xbf22e0f32968e967(player: number, p1: boolean): void;
  */
 declare function N_0xbf371cd2b64212fd(p0: number): void;
 
-/**
- * 0xBF4DC1784BE94DFA
- */
-declare function N_0xbf4dc1784be94dfa(ped: number, p1: boolean, hash: string | number): void;
-
 /**
  * 0xBF4F34A85CA2970C
  */
@@ -29522,11 +29527,6 @@ declare function N_0xd2049635deb9c375(): void;
  */
 declare function N_0xd29334ed1a256dbf(p0: number, p1: number, p2: number, p3: number, p4: number): void;
 
-/**
- * 0xD2DCCD8E16E20997
- */
-declare function N_0xd2dccd8e16e20997(p0: number): void;
-
 /**
  * NETWORK_SESSION_IS_*
  */
@@ -34797,6 +34797,17 @@ declare function N_0x85a0ef54a500882c(p0: number): [boolean, number];
  */
 declare function NetworkGetGamerStatus(p0: number): [boolean, number];
 
+/**
+ * Forces the "Are you sure you want to quit Grand Theft Auto V?" warning message (Same as when you Alt+F4) to show.
+ * Doesn't work in singleplayer.
+ */
+declare function NetworkQuitMpToDesktop(): void;
+/**
+ * Forces the "Are you sure you want to quit Grand Theft Auto V?" warning message (Same as when you Alt+F4) to show.
+ * Doesn't work in singleplayer.
+ */
+declare function N_0x45a83257ed02d9bc(): void;
+
 /**
  * NETWORK_RECEIVE_PLAYER_JOBSHARE_CASH
  */
@@ -36935,12 +36946,19 @@ declare function N_0xa76359fc80b2438e(scaling: number): void;
 
 /**
  * Sets audio flag "OverrideMicrophoneSettings"
+ * Allows the script to ovverride the current microphone settings
  */
 declare function OverrideMicrophoneSettings(hash: string | number, toggle: boolean): void;
 /**
  * Sets audio flag "OverrideMicrophoneSettings"
+ * Allows the script to ovverride the current microphone settings
  */
 declare function N_0x75773e11ba459e90(hash: string | number, toggle: boolean): void;
+/**
+ * Sets audio flag "OverrideMicrophoneSettings"
+ * Allows the script to ovverride the current microphone settings
+ */
+declare function OverrideMicrophoneSettings(hash: string | number, toggle: boolean): void;
 
 /**
  * _OVERRIDE_MULTIPLAYER_CHAT_COLOUR
@@ -36984,13 +37002,15 @@ declare function OverridePedsCanStandOnTopFlag(flag: boolean): void;
 declare function OverridePedsUseDefaultDriveByClipset(flag: boolean): void;
 
 /**
- * OVERRIDE_PLAYER_GROUND_MATERIAL
+ * Sets the footstep tuning modes
+ * @param scriptOverrides True to override with the given overridenMaterialHash, false to stop overriding
  */
-declare function OverridePlayerGroundMaterial(hash: string | number, toggle: boolean): void;
+declare function OverridePlayerGroundMaterial(overriddenMaterialHash: string | number, scriptOverrides: boolean): void;
 /**
- * OVERRIDE_PLAYER_GROUND_MATERIAL
+ * Sets the footstep tuning modes
+ * @param scriptOverrides True to override with the given overridenMaterialHash, false to stop overriding
  */
-declare function N_0xd2cc78cd3d0b50f9(hash: string | number, toggle: boolean): void;
+declare function N_0xd2cc78cd3d0b50f9(overriddenMaterialHash: string | number, scriptOverrides: boolean): void;
 
 /**
  * Replaces the `popgroups` (CPopGroupList) meta file with the file in the specified path.
@@ -37016,13 +37036,16 @@ declare function OverrideSaveHouse(p0: boolean, p1: number, p2: number, p3: numb
 
 /**
  * This native enables the audio flag "TrevorRageIsOverridden" and sets the voice effect to `voiceEffect`
+ * To clear the override use [RESET_TREVOR_RAGE](#\_0xE78503B10C4314E0)
  */
 declare function OverrideTrevorRage(voiceEffect: string): void;
 
 /**
- * OVERRIDE_UNDERWATER_STREAM
+ * This native allows a scripter to override the current underwater stream.
+ * It needs to be called before going into the water
+ * It needs to also be called with OVERRIDE_UNDERWATER_STREAM("", false) in order to stop overriding.
  */
-declare function OverrideUnderwaterStream(p1: boolean): number;
+declare function OverrideUnderwaterStream(streamName: string, override: boolean): void;
 
 /**
  * Overrides the vehicle's horn hash.
@@ -37328,9 +37351,9 @@ declare function N_0xcdca26e80faecb8f(): void;
 declare function PausePlaybackRecordedVehicle(vehicle: number): void;
 
 /**
- * PAUSE_SCRIPTED_CONVERSATION
+ * To resume the conversation use [RESTART_SCRIPTED_CONVERSATION](#\_0x9AEB285D1818C9AC)
  */
-declare function PauseScriptedConversation(p0: boolean): void;
+declare function PauseScriptedConversation(finishCurrentLine: boolean): void;
 
 /**
  * PED_HAS_USE_SCENARIO_TASK
@@ -37376,14 +37399,17 @@ declare function N_0xd76eeef746057fd6(object: number): boolean;
 
 /**
  * PLAY_AMBIENT_SPEECH_FROM_POSITION_NATIVE
+ * @param speechParam See [`PLAY_PED_AMBIENT_SPEECH_NATIVE`](#\_0x8E04FEDD28D42462) for params
  */
 declare function PlayAmbientSpeechFromPositionNative(speechName: string, voiceName: string, x: number, y: number, z: number, speechParam: string): void;
 /**
  * PLAY_AMBIENT_SPEECH_FROM_POSITION_NATIVE
+ * @param speechParam See [`PLAY_PED_AMBIENT_SPEECH_NATIVE`](#\_0x8E04FEDD28D42462) for params
  */
 declare function N_0xed640017ed337e45(speechName: string, voiceName: string, x: number, y: number, z: number, speechParam: string): void;
 /**
  * PLAY_AMBIENT_SPEECH_FROM_POSITION_NATIVE
+ * @param speechParam See [`PLAY_PED_AMBIENT_SPEECH_NATIVE`](#\_0x8E04FEDD28D42462) for params
  */
 declare function PlayAmbientSpeechAtCoords(speechName: string, voiceName: string, x: number, y: number, z: number, speechParam: string): void;
 
@@ -37393,17 +37419,31 @@ declare function PlayAmbientSpeechAtCoords(speechName: string, voiceName: string
 declare function PlayAnimOnRunningScenario(ped: number, animDict: string, animName: string): void;
 
 /**
- * Plays sounds from a ped with chop model. For example it used to play bark or sniff sounds. p1 is always 3 or 4294967295 in decompiled scripts. By a quick disassembling I can assume that this arg is unused.
- * This native is works only when you call it on the ped with right model (ac_chop only ?)
- * Speech Name can be: CHOP_SNIFF_SEQ CHOP_WHINE CHOP_LICKS_MOUTH CHOP_PANT bark GROWL SNARL BARK_SEQ
+ * cpp
+ * enum eAudAnimalType {
+ * AUD_ANIMAL_NONE = -1,
+ * AUD_ANIMAL_BOAR,
+ * AUD_ANIMAL_CHICKEN,
+ * AUD_ANIMAL_DOG,
+ * AUD_ANIMAL_DOG_ROTTWEILER,
+ * AUD_ANIMAL_HORSE,
+ * AUD_NUM_ANIMALS
+ * }
  */
-declare function PlayAnimalVocalization(pedHandle: number, p1: number, speechName: string): void;
+declare function PlayAnimalVocalization(pedHandle: number, animalType: number, speechName: string): void;
 /**
- * Plays sounds from a ped with chop model. For example it used to play bark or sniff sounds. p1 is always 3 or 4294967295 in decompiled scripts. By a quick disassembling I can assume that this arg is unused.
- * This native is works only when you call it on the ped with right model (ac_chop only ?)
- * Speech Name can be: CHOP_SNIFF_SEQ CHOP_WHINE CHOP_LICKS_MOUTH CHOP_PANT bark GROWL SNARL BARK_SEQ
+ * cpp
+ * enum eAudAnimalType {
+ * AUD_ANIMAL_NONE = -1,
+ * AUD_ANIMAL_BOAR,
+ * AUD_ANIMAL_CHICKEN,
+ * AUD_ANIMAL_DOG,
+ * AUD_ANIMAL_DOG_ROTTWEILER,
+ * AUD_ANIMAL_HORSE,
+ * AUD_NUM_ANIMALS
+ * }
  */
-declare function N_0xee066c7006c49c0a(pedHandle: number, p1: number, speechName: string): void;
+declare function N_0xee066c7006c49c0a(pedHandle: number, animalType: number, speechName: string): void;
 
 /**
  * NativeDB Introduced: v1290
@@ -37421,20 +37461,18 @@ declare function PlayBinkMovie(binkMovie: number): void;
 declare function PlayCamAnim(cam: number, animName: string, animDictionary: string, x: number, y: number, z: number, xRot: number, yRot: number, zRot: number, p9: boolean, p10: number): boolean;
 
 /**
- * Only call found in the b617d scripts:
- * AUDIO::PLAY_DEFERRED_SOUND_FRONTEND("BACK", "HUD_FREEMODE_SOUNDSET");
+ * PLAY_DEFERRED_SOUND_FRONTEND
  */
 declare function PlayDeferredSoundFrontend(soundName: string, soundsetName: string): void;
 /**
- * Only call found in the b617d scripts:
- * AUDIO::PLAY_DEFERRED_SOUND_FRONTEND("BACK", "HUD_FREEMODE_SOUNDSET");
+ * PLAY_DEFERRED_SOUND_FRONTEND
  */
 declare function N_0xcada5a0d0702381e(soundName: string, soundsetName: string): void;
 
 /**
  * PLAY_END_CREDITS_MUSIC
  */
-declare function PlayEndCreditsMusic(play: boolean): void;
+declare function PlayEndCreditsMusic(bActive: boolean): void;
 
 /**
  * ```
@@ -37466,54 +37504,51 @@ declare function PlayFacialAnim(ped: number, animName: string, animDict: string)
 declare function PlayMissionCompleteAudio(audioName: string): void;
 
 /**
- * **Warning**:
- * Parameters are wrong after painID. To preserve C-Sharp backwards compatibility, we can't add or remove parameters.
- * Correct parameters should be:\
- * `PLAY_PAIN(Ped ped, int painID, float p3, bool createNetEvent)`
- * Check the *examples* section for the correct usage of this native.
- * **Description:**
- * Plays a pain sound. A maximum of 33 pain IDs are allowed.\
- * `createNetEvent` creates a `CPedPlayPainEvent` when set to true.
- * Below is a list of all the pain IDs (Asterisks indicate that sounds can play in a Low, Medium or High fashion), for example: `PAIN_LOW_GENERIC`. The corresponding pain strings belong to the game exe.
- * **Pain IDs:**
- * *   0: PAIN_\*\_GENERIC (Low, Medium, High)
- * *   1: UNUSED
- * *   2: UNUSED
- * *   3: SCREAM_PANIC (Nothing can be heard)
- * *   4: SCREAM_PANIC_SHORT
- * *   5: SCREAM_SCARED
- * *   6: SCREAM_SHOCKED
- * *   7: SCREAM_TERROR
- * *   8: ON_FIRE
- * *   9: UNUSED
- * *   10: UNUSED
- * *   11: INHALE (Nothing can be heard)
- * *   12: EXHALE (Nothing can be heard)
- * *   13: DEATH_HIGH_SHORT
- * *   14: UNUSED
- * *   15: PAIN_HIGH_GENERIC
- * *   16: PAIN_\*\_GENERIC (Low, Medium, High)
- * *   17: PAIN_SHOVE
- * *   18: PAIN_WHEEZE
- * *   19: COUGH
- * *   20: PAIN_TAZER
- * *   21: UNUSED
- * *   22: CLIMB_LARGE (Nothing can be heard)
- * *   23: CLIMB_SMALL (Nothing can be heard)
- * *   24: JUMP (Nothing can be heard)
- * *   25: COWER
- * *   26: WHIMPER
- * *   27: DYING_MOAN
- * *   28: EXHALE_CYCLING (Nothing can be heard)
- * *   29: PAIN_RAPIDS (Nothing can be heard)
- * *   30: SNEEZE
- * *   31: MELEE_SMALL_GRUNT (Nothing can be heard)
- * *   32: MELEE_LARGE_GRUNT (Nothing can be heard)
- * *   33: PAIN_\*\_GENERIC (Low, Medium, High)
+ * This native had a 4th parameter added in newer game builds
+ * `syncOverNetwork` creates a `CPedPlayPainEvent` when set to true, by default this variable is false.
+ * ```cpp
+ * enum eAudDamageReason {
+ * AUD_DAMAGE_REASON_DEFAULT = 0,
+ * AUD_DAMAGE_REASON_FALLING = 1,
+ * AUD_DAMAGE_REASON_SUPER_FALLING = 2,
+ * AUD_DAMAGE_REASON_SCREAM_PANIC = 3,
+ * AUD_DAMAGE_REASON_SCREAM_PANIC_SHORT = 4,
+ * AUD_DAMAGE_REASON_SCREAM_SCARED = 5,
+ * AUD_DAMAGE_REASON_SCREAM_SHOCKED = 6,
+ * AUD_DAMAGE_REASON_SCREAM_TERROR = 7,
+ * AUD_DAMAGE_REASON_ON_FIRE = 8,
+ * AUD_DAMAGE_REASON_DROWNING = 9,
+ * AUD_DAMAGE_REASON_SURFACE_DROWNING = 10,	// drowning on the surface of water, after we time out
+ * AUD_DAMAGE_REASON_INHALE = 11,
+ * AUD_DAMAGE_REASON_EXHALE = 12,
+ * AUD_DAMAGE_REASON_POST_FALL_GRUNT = 13,
+ * AUD_DAMAGE_REASON_ENTERING_RAGDOLL_DEATH = 14,
+ * AUD_DAMAGE_REASON_EXPLOSION = 15,
+ * AUD_DAMAGE_REASON_MELEE = 16,
+ * AUD_DAMAGE_REASON_SHOVE = 17,
+ * AUD_DAMAGE_REASON_WHEEZE = 18,
+ * AUD_DAMAGE_REASON_COUGH = 19,
+ * AUD_DAMAGE_REASON_TAZER = 20,
+ * AUD_DAMAGE_REASON_EXHAUSTION = 21,
+ * AUD_DAMAGE_REASON_CLIMB_LARGE = 22,
+ * AUD_DAMAGE_REASON_CLIMB_SMALL = 23,
+ * AUD_DAMAGE_REASON_JUMP = 24,
+ * AUD_DAMAGE_REASON_COWER = 25,
+ * AUD_DAMAGE_REASON_WHIMPER = 26,
+ * AUD_DAMAGE_REASON_DYING_MOAN = 27,
+ * AUD_DAMAGE_REASON_CYCLING_EXHALE = 28,
+ * AUD_DAMAGE_REASON_PAIN_RAPIDS = 29,
+ * AUD_DAMAGE_REASON_SNEEZE = 30,
+ * AUD_DAMAGE_REASON_MELEE_SMALL_GRUNT = 31,
+ * AUD_DAMAGE_REASON_MELEE_LARGE_GRUNT = 32,
+ * AUD_DAMAGE_REASON_POST_FALL_GRUNT_LOW = 33
+ * }
+ * ```
  * @param ped The ped entity.
- * @param painID The pain id, max allowed id is 33.
+ * @param damageReason The damage reason/type, refer to eAudDamageReason
+ * @param rawDamage Damage value, defaults to 0.0
  */
-declare function PlayPain(ped: number, painID: number, p1: number): void;
+declare function PlayPain(ped: number, damageReason: number, rawDamage: number): void;
 
 /**
  * See [`PLAY_PED_AMBIENT_SPEECH_NATIVE`](#\_0x8E04FEDD28D42462) for parameter specifications.
@@ -37684,39 +37719,30 @@ declare function PlaySoundFromEntity(soundId: number, audioName: string, entity:
 declare function PlaySoundFrontend(soundId: number, audioName: string, audioRef: string, p3: boolean): void;
 
 /**
- * Used with AUDIO::LOAD_STREAM
- * Example from finale_heist2b.c4:
- * TASK::TASK_SYNCHRONIZED_SCENE(l_4C8[2 -- [[14]] ], l_4C8[2 -- [[14]] ]._f7, l_30A, "push_out_vault_l", 4.0, -1.5, 5, 713, 4.0, 0);
- * PED::SET_SYNCHRONIZED_SCENE_PHASE(l_4C8[2 -- [[14]] ]._f7, 0.0);
- * PED::_2208438012482A1A(l_4C8[2 -- [[14]] ], 0, 0);
- * PED::SET_PED_COMBAT_ATTRIBUTES(l_4C8[2 -- [[14]] ], 38, 1);
- * PED::SET_BLOCKING_OF_NON_TEMPORARY_EVENTS(l_4C8[2 -- [[14]] ], 1);
- * if (AUDIO::LOAD_STREAM("Gold_Cart_Push_Anim_01", "BIG_SCORE_3B_SOUNDS")) {
- * AUDIO::PLAY_STREAM_FROM_OBJECT(l_36F[0 -- [[1]] ]);
- * }
+ * Plays a preloaded stream back from the specified object.
  */
 declare function PlayStreamFromObject(object: number): void;
 
 /**
- * PLAY_STREAM_FROM_PED
+ * Plays a preloaded stream back from the specified ped.
  */
 declare function PlayStreamFromPed(ped: number): void;
 /**
- * PLAY_STREAM_FROM_PED
+ * Plays a preloaded stream back from the specified ped.
  */
 declare function N_0x89049dd63c08b5d1(ped: number): void;
 
 /**
- * PLAY_STREAM_FROM_POSITION
+ * Plays a preloaded stream back from the specified Vector3.
  */
 declare function PlayStreamFromPosition(x: number, y: number, z: number): void;
 /**
- * PLAY_STREAM_FROM_POSITION
+ * Plays a preloaded stream back from the specified Vector3.
  */
 declare function SpecialFrontendEqual(x: number, y: number, z: number): void;
 
 /**
- * PLAY_STREAM_FROM_VEHICLE
+ * Plays a preloaded stream back from the specified ped vehicle
  */
 declare function PlayStreamFromVehicle(vehicle: number): void;
 
@@ -37728,7 +37754,7 @@ declare function PlayStreamFrontend(): void;
 /**
  * PLAY_SYNCHRONIZED_AUDIO_EVENT
  */
-declare function PlaySynchronizedAudioEvent(p0: number): boolean;
+declare function PlaySynchronizedAudioEvent(sceneId: number): boolean;
 
 /**
  * ```
@@ -38517,23 +38543,42 @@ declare function PreloadCloudHat(name: string): void;
 declare function N_0x11b56fbbf7224868(name: string): void;
 
 /**
- * PRELOAD_SCRIPT_CONVERSATION
+ * Similar to [START_SCRIPT_CONVERSATION](#\_0x6B17C62C9635D2DC), except that is starts the conversation off paused.
+ * A scripter can then kick off the conversation by calling [START_PRELOADED_CONVERSATION](#\_0x23641AFE870AF385).
+ * If they want to check that the conversation is done preloading, they can use [GET_IS_PRELOADED_CONVERSATION_READY](#\_0xE73364DB90778FFA)
+ * @param addToBriefScreen Defaults to true
+ * @param cloneConversation Defaults to false
+ * @param interruptible Defaults to true
  */
-declare function PreloadScriptConversation(p0: boolean, p1: boolean, p2: boolean, p3: boolean): void;
+declare function PreloadScriptConversation(displaySubtitles: boolean, addToBriefScreen: boolean, cloneConversation: boolean, interruptible: boolean): void;
 
 /**
  * PRELOAD_SCRIPT_PHONE_CONVERSATION
+ * @param addToBriefScreen Defaults to true
  */
-declare function PreloadScriptPhoneConversation(p0: boolean, p1: boolean): void;
+declare function PreloadScriptPhoneConversation(displaySubtitles: boolean, addToBriefScreen: boolean): void;
 
 /**
+ * Request that we preload the required audio bank for a given vehicle model.
+ * ```
  * NativeDB Introduced: v1180
+ * ```
  */
-declare function PreloadVehicleAudio(model: string | number): void;
+declare function PreloadVehicleAudioBank(model: string | number): void;
 /**
+ * Request that we preload the required audio bank for a given vehicle model.
+ * ```
  * NativeDB Introduced: v1180
+ * ```
  */
 declare function N_0xca4cea6ae0000a7e(model: string | number): void;
+/**
+ * Request that we preload the required audio bank for a given vehicle model.
+ * ```
+ * NativeDB Introduced: v1180
+ * ```
+ */
+declare function PreloadVehicleAudio(model: string | number): void;
 
 /**
  * PRELOAD_VEHICLE_MOD
@@ -38542,20 +38587,23 @@ declare function N_0xca4cea6ae0000a7e(model: string | number): void;
 declare function PreloadVehicleMod(p0: number, modType: number, p2: number): void;
 
 /**
- * Example:
- * bool prepareAlarm = AUDIO::PREPARE_ALARM("PORT_OF_LS_HEIST_FORT_ZANCUDO_ALARMS");
+ * Prepares any banks required to play the given alarm
+ * @return Returns true if the alarm was successfully prepared
  */
 declare function PrepareAlarm(alarmName: string): boolean;
 
 /**
- * All music event names found in the b617d scripts: pastebin.com/GnYt0R3P
+ * Prepares the specified music event. Preparing it in advance will preload any required data so that it's ready to play immediately.
+ * @return Returns true if the event is prepared, false otherwise
  */
 declare function PrepareMusicEvent(eventName: string): boolean;
 
 /**
  * PREPARE_SYNCHRONIZED_AUDIO_EVENT
+ * @param audioEvent The audio event name.
+ * @param startOffsetMs Unused parameter (since v323)
  */
-declare function PrepareSynchronizedAudioEvent(p0: string, p1: number): number;
+declare function PrepareSynchronizedAudioEvent(audioEvent: string, startOffsetMs: number): boolean;
 
 /**
  * PREPARE_SYNCHRONIZED_AUDIO_EVENT_FOR_SCENE
@@ -38684,6 +38732,19 @@ declare function QueueMissionRepeatSave(): boolean;
  */
 declare function N_0x44a0bdc559b35f6e(): boolean;
 
+/**
+ * Quits the game.
+ */
+declare function QuitGame(): void;
+/**
+ * Quits the game.
+ */
+declare function N_0xeb6891f03362fb12(): void;
+/**
+ * Quits the game.
+ */
+declare function ForceSocialClubUpdate(): void;
+
 /**
  * Add a BLIP_GALLERY at the specific coordinate. Used in fm_maintain_transition_players to display race track points.
  */
@@ -39317,13 +39378,15 @@ declare function RemoveDoorFromSystem(doorHash: string | number): void;
 declare function RemoveDryVolume(handle: number): void;
 
 /**
- * REMOVE_ENTITY_FROM_AUDIO_MIX_GROUP
+ * Removes an entity from its current mix group.
+ * @param fadeOut Defaults to 0.0
  */
-declare function RemoveEntityFromAudioMixGroup(entity: number, p1: number): void;
+declare function RemoveEntityFromAudioMixGroup(entity: number, fadeOut: number): void;
 /**
- * REMOVE_ENTITY_FROM_AUDIO_MIX_GROUP
+ * Removes an entity from its current mix group.
+ * @param fadeOut Defaults to 0.0
  */
-declare function N_0x18eb48cfc41f2ea0(entity: number, p1: number): void;
+declare function N_0x18eb48cfc41f2ea0(entity: number, fadeOut: number): void;
 
 /**
  * REMOVE_FORCED_OBJECT
@@ -39509,23 +39572,29 @@ declare function RemovePopMultiplierSphere(id: number, p1: boolean): void;
 declare function N_0xe6869becdd8f2403(id: number, p1: boolean): void;
 
 /**
+ * ```
  * Found in the b617d scripts, duplicates removed:
  * AUDIO::_B4BBFD9CD8B3922B("V_CARSHOWROOM_PS_WINDOW_UNBROKEN");
  * AUDIO::_B4BBFD9CD8B3922B("V_CIA_PS_WINDOW_UNBROKEN");
  * AUDIO::_B4BBFD9CD8B3922B("V_DLC_HEIST_APARTMENT_DOOR_CLOSED");
  * AUDIO::_B4BBFD9CD8B3922B("V_FINALEBANK_PS_VAULT_INTACT");
  * AUDIO::_B4BBFD9CD8B3922B("V_MICHAEL_PS_BATHROOM_WITH_WINDOW");
+ * ```
+ * For events like cars driving through windows, allows script to unocclude that window
  */
-declare function RemovePortalSettingsOverride(p0: string): void;
+declare function RemovePortalSettingsOverride(portalSettingsName: string): void;
 /**
+ * ```
  * Found in the b617d scripts, duplicates removed:
  * AUDIO::_B4BBFD9CD8B3922B("V_CARSHOWROOM_PS_WINDOW_UNBROKEN");
  * AUDIO::_B4BBFD9CD8B3922B("V_CIA_PS_WINDOW_UNBROKEN");
  * AUDIO::_B4BBFD9CD8B3922B("V_DLC_HEIST_APARTMENT_DOOR_CLOSED");
  * AUDIO::_B4BBFD9CD8B3922B("V_FINALEBANK_PS_VAULT_INTACT");
  * AUDIO::_B4BBFD9CD8B3922B("V_MICHAEL_PS_BATHROOM_WITH_WINDOW");
+ * ```
+ * For events like cars driving through windows, allows script to unocclude that window
  */
-declare function N_0xb4bbfd9cd8b3922b(p0: string): void;
+declare function N_0xb4bbfd9cd8b3922b(portalSettingsName: string): void;
 
 /**
  * REMOVE_PTFX_ASSET
@@ -39918,12 +39987,11 @@ declare function RequestAdditionalTextForDlc(gxt: string, slot: number): void;
 declare function RequestAdditionalText_2(gxt: string, slot: number): void;
 
 /**
- * All occurrences and usages found in b617d, sorted alphabetically and identical lines removed: pastebin.com/XZ1tmGEz
- * ```
- * ```
- * NativeDB Added Parameter 3: Any p2
+ * This native is marked as deprecated internally, please use [REQUEST_SCRIPT_AUDIO_BANK](#\_0x2F844A8B08D76685)
+ * This native has a new argument on newer game builds:
+ * *   **playerBits**:
  */
-declare function RequestAmbientAudioBank(p0: string, p1: boolean): boolean;
+declare function RequestAmbientAudioBank(bankName: string, bOverNetwork: boolean): boolean;
 
 /**
  * REQUEST_ANIM_DICT
@@ -40009,12 +40077,11 @@ declare function RequestMenuPedModel(model: string | number): void;
 declare function N_0xa0261aef7acfc51e(model: string | number): void;
 
 /**
- * All occurrences and usages found in b617d: pastebin.com/NzZZ2Tmm
- * ```
- * ```
- * NativeDB Added Parameter 3: Any p2
+ * This native is marked as deprecated internally, please use [REQUEST_SCRIPT_AUDIO_BANK](#\_0x2F844A8B08D76685)
+ * This native has a new argument on newer game builds:
+ * *   **playerBits**:
  */
-declare function RequestMissionAudioBank(p0: string, p1: boolean): boolean;
+declare function RequestMissionAudioBank(bankName: string, bOverNetwork: boolean): boolean;
 
 /**
  * Request a model (archetype) to be loaded for use by the current script. Use SET_MODEL_AS_NO_LONGER_NEEDED when done using the model in script.
@@ -40185,12 +40252,11 @@ declare function RequestHudScaleform(hudComponent: number): void;
 declare function RequestScript(scriptName: string): void;
 
 /**
- * All occurrences and usages found in b617d, sorted alphabetically and identical lines removed: pastebin.com/AkmDAVn6
- * ```
- * ```
- * NativeDB Added Parameter 3: int p2
+ * This native has a new argument on newer game builds:
+ * *   **playerBits**:
+ * @return Requests and returns true/false if the script audio bank has laoded
  */
-declare function RequestScriptAudioBank(p0: string, p1: boolean): boolean;
+declare function RequestScriptAudioBank(bankName: string, bOverNetwork: boolean): boolean;
 
 /**
  * formerly _REQUEST_STREAMED_SCRIPT
@@ -40231,6 +40297,19 @@ declare function RequestTaskMoveNetworkStateTransition(ped: number, name: string
  */
 declare function N_0xd01015c7316ae176(ped: number, name: string): boolean;
 
+/**
+ * Loads the tennis vocalization banks into a couple animal slots.
+ */
+declare function RequestTennisBanks(opponentPed: number): void;
+/**
+ * Loads the tennis vocalization banks into a couple animal slots.
+ */
+declare function N_0x4ada3f19be4a6047(opponentPed: number): void;
+/**
+ * Loads the tennis vocalization banks into a couple animal slots.
+ */
+declare function SetPedTalk(opponentPed: number): void;
+
 /**
  * REQUEST_VEHICLE_ASSET(GET_HASH_KEY(cargobob3), 3);
  * vehicle found that have asset's:
@@ -40582,7 +40661,7 @@ declare function N_0xe3a3db414a373dab(): void;
 declare function ScreenDrawPositionEnd(): void;
 
 /**
- * RESET_TREVOR_RAGE
+ * Clears the override set by [OVERRIDE_TREVOR_RAGE](#\_0x13AD665062541A7E)
  */
 declare function ResetTrevorRage(): void;
 
@@ -40593,6 +40672,15 @@ declare function ResetTrevorRage(): void;
  */
 declare function ResetVehiclePedsCanStandOnTopFlag(vehicle: number): void;
 
+/**
+ * Resets the override for [SET_VEHICLE_STARTUP_REV_SOUND](#\_0xF1F8157B8C3F171C)
+ */
+declare function ResetVehicleStartupRevSound(vehicle: number): void;
+/**
+ * Resets the override for [SET_VEHICLE_STARTUP_REV_SOUND](#\_0xF1F8157B8C3F171C)
+ */
+declare function N_0xd2dccd8e16e20997(vehicle: number): void;
+
 /**
  * The inner function has a switch on the second parameter. It's the stuck timer index.
  * Here's some pseudo code I wrote for the inner function:
@@ -40652,16 +40740,23 @@ declare function ResetWorldBoundaryForPlayer(): void;
 declare function RestartFrontendMenu(menuHash: string | number, p1: number): void;
 
 /**
- * In singleplayer it does exactly what the name implies. In FiveM / GTA:Online it shows `Disconnecting from GTA Online` HUD and then quits the game.
+ * In singleplayer it does exactly what the name implies. In FiveM / GTA:Online it shows the `Disconnecting from GTA Online` warning screen message and quits the game.
+ * After quitting, the game process is started again (as the name implies).
  */
 declare function RestartGame(): void;
 /**
- * In singleplayer it does exactly what the name implies. In FiveM / GTA:Online it shows `Disconnecting from GTA Online` HUD and then quits the game.
+ * In singleplayer it does exactly what the name implies. In FiveM / GTA:Online it shows the `Disconnecting from GTA Online` warning screen message and quits the game.
+ * After quitting, the game process is started again (as the name implies).
  */
 declare function N_0xe574a662acaefbb1(): void;
+/**
+ * In singleplayer it does exactly what the name implies. In FiveM / GTA:Online it shows the `Disconnecting from GTA Online` warning screen message and quits the game.
+ * After quitting, the game process is started again (as the name implies).
+ */
+declare function RestartGame(): void;
 
 /**
- * RESTART_SCRIPTED_CONVERSATION
+ * Restarts a conversation that was previously paused with [PAUSE_SCRIPTED_CONVERSATION](#\_0x8530AD776CD72B12)
  */
 declare function RestartScriptedConversation(): void;
 
@@ -41320,6 +41415,15 @@ declare function PushScaleformMovieMethodParameterString_2(_string: string): voi
  */
 declare function ScriptIsMovingMobilePhoneOffscreen(toggle: boolean): void;
 
+/**
+ * Overrides wind elevation sounds
+ */
+declare function ScriptOverridesWindElevation(override: boolean, windElevationHashName: string | number): void;
+/**
+ * Overrides wind elevation sounds
+ */
+declare function N_0x70b8ec8fc108a634(override: boolean, windElevationHashName: string | number): void;
+
 /**
  * SCRIPT_RACE_GET_PLAYER_SPLIT_TIME
  */
@@ -48948,15 +49052,6 @@ declare function SetPedSuffersCriticalHits(ped: number, toggle: boolean): void;
  */
 declare function SetPedSweat(ped: number, sweat: number): void;
 
-/**
- * Speech related.
- */
-declare function SetPedTalk(ped: number): void;
-/**
- * Speech related.
- */
-declare function N_0x4ada3f19be4a6047(ped: number): void;
-
 /**
  * Only 1 and 2 appear in the scripts. combatbehaviour.meta seems to only have TLR_SearchForTarget for all peds, but we don't know if that's 1 or 2.
  */
@@ -59762,11 +59857,6 @@ declare function N_0xdeadc0dedeadc0de(entity: number): void;
  */
 declare function EntityDescriptionText(entity: number): void;
 
-/**
- * NativeDB Introduced: v1493
- */
-declare function UpdateLsur(enableMixes: boolean): void;
-
 /**
  * Transiently updates the entity with the specified mapdata index and entity index.
  * This function supports SDK infrastructure and is not intended to be used directly from your code.
@@ -59818,6 +59908,15 @@ declare function N_0xe23d5873c2394c61(player: number): boolean;
  */
 declare function HasPlayerTeleportFinished(player: number): boolean;
 
+/**
+ * Updates a playing sounds absolute position.
+ */
+declare function UpdateSoundCoord(soundId: number, x: number, y: number, z: number): void;
+/**
+ * Updates a playing sounds absolute position.
+ */
+declare function N_0x7ec3c679d0e7e46b(soundId: number, x: number, y: number, z: number): void;
+
 /**
  * UPDATE_TASK_AIM_GUN_SCRIPTED_TARGET
  */
@@ -59838,6 +59937,21 @@ declare function UpdateTaskSweepAimEntity(ped: number, entity: number): void;
  */
 declare function UpdateTaskSweepAimPosition(p0: number, p1: number, p2: number, p3: number): void;
 
+/**
+ * Unlocks any available DJ radio tracks based on the tuneable status
+ * ```
+ * NativeDB Introduced: v1493
+ * ```
+ */
+declare function UpdateUnlockableDjRadioTracks(allowTrackReprioritization: boolean): void;
+/**
+ * Unlocks any available DJ radio tracks based on the tuneable status
+ * ```
+ * NativeDB Introduced: v1493
+ * ```
+ */
+declare function UpdateLsur(allowTrackReprioritization: boolean): void;
+
 /**
  * Related to displaying cash on the HUD
  * Always called before HUD::CHANGE_FAKE_MP_CASH in decompiled scripts
@@ -59849,6 +59963,15 @@ declare function UseFakeMpCash(p0: boolean): void;
  */
 declare function N_0x170f541e1cadd1de(p0: boolean): void;
 
+/**
+ * Allows script to trigger a sweetener footstep sound
+ */
+declare function UseFootstepScriptSweeteners(ped: number, useSweetner: boolean, soundSetHash: string | number): void;
+/**
+ * Allows script to trigger a sweetener footstep sound
+ */
+declare function N_0xbf4dc1784be94dfa(ped: number, useSweetner: boolean, soundSetHash: string | number): void;
+
 /**
  * From the b678d decompiled scripts:
  * GRAPHICS::_SET_PTFX_ASSET_NEXT_CALL("FM_Mission_Controler");
@@ -59891,7 +60014,7 @@ declare function UsePlayerColourInsteadOfTeamColour(toggle: boolean): void;
 /**
  * USE_SIREN_AS_HORN
  */
-declare function UseSirenAsHorn(vehicle: number, toggle: boolean): void;
+declare function UseSirenAsHorn(vehicle: number, sirenAsHorn: boolean): void;
 
 /**
  * Applies a predefined set of vehicle camera settings optimized for capturing stunts, effective for the current game update/frame.

package/package.json

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