@citizenfx/client 2.0.20072-1 → 2.0.20150-1

package/natives_universal.d.ts

@@ -6357,11 +6357,11 @@ declare function SetTextChatUnk(disable: boolean): void;
 declare function DisableNavmeshInArea(posMinX: number, posMinY: number, posMinZ: number, posMaxX: number, posMaxY: number, posMaxZ: number, bDisable: boolean): void;
 
 /**
- * DISABLE_OCCLUSION_THIS_FRAME
+ * This disables all occluders that cause the 'flickering' rendering under the map and inside buildings with no interiors, note that this may impact performance on lower end systems.
  */
 declare function DisableOcclusionThisFrame(): void;
 /**
- * DISABLE_OCCLUSION_THIS_FRAME
+ * This disables all occluders that cause the 'flickering' rendering under the map and inside buildings with no interiors, note that this may impact performance on lower end systems.
  */
 declare function N_0x3669f1b198dcaa4f(): void;
 
@@ -9210,13 +9210,19 @@ declare function EndTextCommandThefeedPostMessagetextWithCrewTagAndAdditionalIco
 declare function SetNotificationMessageClanTag_2(picTxd: string, picTxn: string, flash: boolean, iconType1: number, nameStr: string, subtitleStr: string, duration: number, crewPackedStr: string, iconType2: number, textColor: number): number;
 
 /**
- * END_TEXT_COMMAND_THEFEED_POST_MPTICKER
+ * Exactly the same as [`END_TEXT_COMMAND_THEFEED_POST_TICKER`](#\_0x2ED7843F8F801023).
+ * @param isImportant If true, the notification will flash.
+ * @param showInBrief If true, the message will be shown in Pause Menu > Info > Notifications.
+ * @return The notification handle.
  */
-declare function EndTextCommandThefeedPostMpticker(blink: boolean, bHasTokens: boolean): number;
+declare function EndTextCommandThefeedPostMpticker(isImportant: boolean, showInBrief: boolean): number;
 /**
- * END_TEXT_COMMAND_THEFEED_POST_MPTICKER
+ * Exactly the same as [`END_TEXT_COMMAND_THEFEED_POST_TICKER`](#\_0x2ED7843F8F801023).
+ * @param isImportant If true, the notification will flash.
+ * @param showInBrief If true, the message will be shown in Pause Menu > Info > Notifications.
+ * @return The notification handle.
  */
-declare function DrawNotification_4(blink: boolean, bHasTokens: boolean): number;
+declare function DrawNotification_4(isImportant: boolean, showInBrief: boolean): number;
 
 /**
  * returns a notification handle, prints out a notification like below:
@@ -9309,39 +9315,69 @@ declare function N_0x2b7e9a4eaaa93c89(statTitle: string, iconEnum: number, stepV
 declare function SetNotificationMessage_2(statTitle: string, iconEnum: number, stepVal: boolean, barValue: number, isImportant: boolean, picTxd: string, picTxn: string): number;
 
 /**
- * Example output preview:
- * ![](https://i.imgur.com/TJvqkYq.png)
- * @param isImportant Makes the notification flash on the screen.
- * @param bHasTokens Makes the notification appear in the "Pause Menu > Info/Brief > Notifications" section.
- * @return The notification handle.
+ * Posts a generic feed notification:
+ * ![](https://i.ibb.co/GkHcFvf/image.png)
+ * ````
+ * ## Parameters
+ * * **isImportant**: Makes the notification flash on the screen.
+ * * **showInBrief**: Makes the notification appear in the "Pause Menu > Info/Brief > Notifications" section.
+ * ## Return value
+ * The notification handle.
+ * ## Examples
+ * ```lua
+ * AddTextEntry("MyFeedMessage", "Hello " .. GetPlayerName(PlayerId()) .. ".")
+ * BeginTextCommandThefeedPost("MyFeedMessage")
+ * EndTextCommandThefeedPostTicker(true, true)
+ * ````
  */
-declare function EndTextCommandThefeedPostTicker(isImportant: boolean, bHasTokens: boolean): number;
+declare function EndTextCommandThefeedPostTicker(isImportant: boolean, showInBrief: boolean): number;
 /**
- * Example output preview:
- * ![](https://i.imgur.com/TJvqkYq.png)
- * @param isImportant Makes the notification flash on the screen.
- * @param bHasTokens Makes the notification appear in the "Pause Menu > Info/Brief > Notifications" section.
- * @return The notification handle.
+ * Posts a generic feed notification:
+ * ![](https://i.ibb.co/GkHcFvf/image.png)
+ * ````
+ * ## Parameters
+ * * **isImportant**: Makes the notification flash on the screen.
+ * * **showInBrief**: Makes the notification appear in the "Pause Menu > Info/Brief > Notifications" section.
+ * ## Return value
+ * The notification handle.
+ * ## Examples
+ * ```lua
+ * AddTextEntry("MyFeedMessage", "Hello " .. GetPlayerName(PlayerId()) .. ".")
+ * BeginTextCommandThefeedPost("MyFeedMessage")
+ * EndTextCommandThefeedPostTicker(true, true)
+ * ````
  */
-declare function DrawNotification(isImportant: boolean, bHasTokens: boolean): number;
+declare function DrawNotification(isImportant: boolean, showInBrief: boolean): number;
 
 /**
- * END_TEXT_COMMAND_THEFEED_POST_TICKER_FORCED
+ * Posts an above minimap feed notification that is forced (Previous messages will be cleared).
+ * @param isImportant If true, the notification will flash.
+ * @param showInBrief If true, shows in Pause Menu > Info > Notifications.
+ * @return The notification handle.
  */
-declare function EndTextCommandThefeedPostTickerForced(blink: boolean, bHasTokens: boolean): number;
+declare function EndTextCommandThefeedPostTickerForced(isImportant: boolean, showInBrief: boolean): number;
 /**
- * END_TEXT_COMMAND_THEFEED_POST_TICKER_FORCED
+ * Posts an above minimap feed notification that is forced (Previous messages will be cleared).
+ * @param isImportant If true, the notification will flash.
+ * @param showInBrief If true, shows in Pause Menu > Info > Notifications.
+ * @return The notification handle.
  */
-declare function DrawNotification_2(blink: boolean, bHasTokens: boolean): number;
+declare function DrawNotification_2(isImportant: boolean, showInBrief: boolean): number;
 
 /**
- * END_TEXT_COMMAND_THEFEED_POST_TICKER_WITH_TOKENS
+ * Posts an above minimap feed message with tokens support (blips, input keys, etc...)
+ * @param isImportant Makes the notification flash.
+ * @param showInBrief Shows in Pause Menu > Info > Notifications.
+ * @return Notification handle.
  */
-declare function EndTextCommandThefeedPostTickerWithTokens(isImportant: boolean, bHasTokens: boolean): number;
+declare function EndTextCommandThefeedPostTickerWithTokens(isImportant: boolean, showInBrief: boolean): number;
 /**
- * END_TEXT_COMMAND_THEFEED_POST_TICKER_WITH_TOKENS
+ * Posts an above minimap feed message with tokens support (blips, input keys, etc...)
+ * @param isImportant Makes the notification flash.
+ * @param showInBrief Shows in Pause Menu > Info > Notifications.
+ * @return Notification handle.
  */
-declare function DrawNotification_3(isImportant: boolean, bHasTokens: boolean): number;
+declare function DrawNotification_3(isImportant: boolean, showInBrief: boolean): number;
 
 /**
  * END_TEXT_COMMAND_THEFEED_POST_UNLOCK
@@ -14015,6 +14051,7 @@ declare function GetThreadName(threadId: number): string;
  * ARMYB = Fort Zancudo
  * BANHAMC = Banham Canyon Dr
  * BANNING = Banning
+ * BAYTRE = Baytree Canyon
  * BEACH = Vespucci Beach
  * BHAMCA = Banham Canyon
  * BRADP = Braddock Pass
@@ -14040,6 +14077,7 @@ declare function GetThreadName(threadId: number): string;
  * ELGORL = El Gordo Lighthouse
  * ELYSIAN = Elysian Island
  * GALFISH = Galilee
+ * GALLI = Galileo Park
  * GOLF = GWC and Golfing Society
  * GRAPES = Grapeseed
  * GREATC = Great Chaparral
@@ -14064,6 +14102,7 @@ declare function GetThreadName(threadId: number): string;
  * MURRI = Murrieta Heights
  * NCHU = North Chumash
  * NOOSE = N.O.O.S.E
+ * OBSERV = Galileo Observatory
  * OCEANA = Pacific Ocean
  * PALCOV = Paleto Cove
  * PALETO = Paleto Bay
@@ -15712,24 +15751,24 @@ declare function GetPedEventData(ped: number, eventType: number, outData?: numbe
 declare function GetPedExtractedDisplacement(ped: number, worldSpace: boolean): number[];
 
 /**
- * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
+ * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
  * @param ped The target ped
  * @return Returns ped's eye colour, or -1 if fails to get.
  */
 declare function GetPedEyeColor(ped: number): number;
+
 /**
  * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
  * @param ped The target ped
  * @return Returns ped's eye colour, or -1 if fails to get.
  */
-declare function N_0x76bba2cee66d47e9(ped: number): number;
-
+declare function GetPedEyeColor(ped: number): number;
 /**
- * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
+ * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
  * @param ped The target ped
  * @return Returns ped's eye colour, or -1 if fails to get.
  */
-declare function GetPedEyeColor(ped: number): number;
+declare function N_0x76bba2cee66d47e9(ped: number): number;
 
 /**
  * A getter for [\_SET_PED_FACE_FEATURE](#\_0x71A5C1DBA060049E). Returns 0.0 if fails to get.
@@ -20614,96 +20653,9 @@ declare function GetWorldPositionOfEntityBone(entity: number, boneIndex: number)
 declare function GetZoneAtCoords(x: number, y: number, z: number): number;
 
 /**
- * 'zoneName' corresponds to an entry in 'popzone.ipl'.
- * AIRP = Los Santos International Airport
- * ALAMO = Alamo Sea
- * ALTA = Alta
- * ARMYB = Fort Zancudo
- * BANHAMC = Banham Canyon Dr
- * BANNING = Banning
- * BEACH = Vespucci Beach
- * BHAMCA = Banham Canyon
- * BRADP = Braddock Pass
- * BRADT = Braddock Tunnel
- * BURTON = Burton
- * CALAFB = Calafia Bridge
- * CANNY = Raton Canyon
- * CCREAK = Cassidy Creek
- * CHAMH = Chamberlain Hills
- * CHIL = Vinewood Hills
- * CHU = Chumash
- * CMSW = Chiliad Mountain State Wilderness
- * CYPRE = Cypress Flats
- * DAVIS = Davis
- * DELBE = Del Perro Beach
- * DELPE = Del Perro
- * DELSOL = La Puerta
- * DESRT = Grand Senora Desert
- * DOWNT = Downtown
- * DTVINE = Downtown Vinewood
- * EAST_V = East Vinewood
- * EBURO = El Burro Heights
- * ELGORL = El Gordo Lighthouse
- * ELYSIAN = Elysian Island
- * GALFISH = Galilee
- * GOLF = GWC and Golfing Society
- * GRAPES = Grapeseed
- * GREATC = Great Chaparral
- * HARMO = Harmony
- * HAWICK = Hawick
- * HORS = Vinewood Racetrack
- * HUMLAB = Humane Labs and Research
- * JAIL = Bolingbroke Penitentiary
- * KOREAT = Little Seoul
- * LACT = Land Act Reservoir
- * LAGO = Lago Zancudo
- * LDAM = Land Act Dam
- * LEGSQU = Legion Square
- * LMESA = La Mesa
- * LOSPUER = La Puerta
- * MIRR = Mirror Park
- * MORN = Morningwood
- * MOVIE = Richards Majestic
- * MTCHIL = Mount Chiliad
- * MTGORDO = Mount Gordo
- * MTJOSE = Mount Josiah
- * MURRI = Murrieta Heights
- * NCHU = North Chumash
- * NOOSE = N.O.O.S.E
- * OCEANA = Pacific Ocean
- * PALCOV = Paleto Cove
- * PALETO = Paleto Bay
- * PALFOR = Paleto Forest
- * PALHIGH = Palomino Highlands
- * PALMPOW = Palmer-Taylor Power Station
- * PBLUFF = Pacific Bluffs
- * PBOX = Pillbox Hill
- * PROCOB = Procopio Beach
- * RANCHO = Rancho
- * RGLEN = Richman Glen
- * RICHM = Richman
- * ROCKF = Rockford Hills
- * RTRAK = Redwood Lights Track
- * SANAND = San Andreas
- * SANCHIA = San Chianski Mountain Range
- * SANDY = Sandy Shores
- * SKID = Mission Row
- * SLAB = Stab City
- * STAD = Maze Bank Arena
- * STRAW = Strawberry
- * TATAMO = Tataviam Mountains
- * TERMINA = Terminal
- * TEXTI = Textile City
- * TONGVAH = Tongva Hills
- * TONGVAV = Tongva Valley
- * VCANA = Vespucci Canals
- * VESP = Vespucci
- * VINE = Vinewood
- * WINDF = Ron Alternates Wind Farm
- * WVINE = West Vinewood
- * ZANCUDO = Zancudo River
- * ZP_ORT = Port of South Los Santos
- * ZQ_UAR = Davis Quartz
+ * Refer to https://docs.fivem.net/docs/game-references/zones/ for a list of all zones including their integer ID, string ID, short name and full name
+ * @param zoneName The zone name like "Z_RMAN2", most-left column of popzone.ipl
+ * @return The zone ID, index in the popzone.ipl file starting with 1
  */
 declare function GetZoneFromNameId(zoneName: string): number;
 
@@ -21192,12 +21144,12 @@ declare function HasBulletImpactedInArea(x: number, y: number, z: number, p3: nu
 declare function HasBulletImpactedInBox(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: boolean, p7: boolean): boolean;
 
 /**
- * This native appears on the cheat_controller script and tracks a combination of buttons, which may be used to toggle cheats in-game. Credits to ThreeSocks for the info. The hash contains the combination, while the "amount" represents the amount of buttons used in a combination. The following page can be used to make a button combination: gta5offset.com/ts/hash/
+ * This native appears on the cheat_controller script and tracks a combination of buttons, which may be used to toggle cheats in-game. Credits to ThreeSocks for the info. The hash contains the combination, while the "amount" represents the amount of buttons used in a combination.
  * INT_SCORES_SCORTED was a hash collision
  */
 declare function HasButtonCombinationJustBeenEntered(hash: string | number, amount: number): boolean;
 /**
- * This native appears on the cheat_controller script and tracks a combination of buttons, which may be used to toggle cheats in-game. Credits to ThreeSocks for the info. The hash contains the combination, while the "amount" represents the amount of buttons used in a combination. The following page can be used to make a button combination: gta5offset.com/ts/hash/
+ * This native appears on the cheat_controller script and tracks a combination of buttons, which may be used to toggle cheats in-game. Credits to ThreeSocks for the info. The hash contains the combination, while the "amount" represents the amount of buttons used in a combination.
  * INT_SCORES_SCORTED was a hash collision
  */
 declare function N_0x071e2a839de82d90(hash: string | number, amount: number): boolean;
@@ -39748,103 +39700,101 @@ declare function PlayPedAmbientSpeechAndCloneNative(ped: number, speechName: str
 declare function PlayAmbientSpeech2(ped: number, speechName: string, speechParam: string): void;
 
 /**
- * Plays ambient speech; see also [`PLAY_PED_AMBIENT_SPEECH_AND_CLONE_NATIVE`](#\_0xC6941B4A3A8FBBB9).
- * ```
- * speechParam: Can be one of the following:
- * SPEECH_PARAMS_STANDARD
- * SPEECH_PARAMS_ALLOW_REPEAT
- * SPEECH_PARAMS_BEAT
- * SPEECH_PARAMS_FORCE
- * SPEECH_PARAMS_FORCE_FRONTEND
- * SPEECH_PARAMS_FORCE_NO_REPEAT_FRONTEND
- * SPEECH_PARAMS_FORCE_NORMAL
- * SPEECH_PARAMS_FORCE_NORMAL_CLEAR
- * SPEECH_PARAMS_FORCE_NORMAL_CRITICAL
- * SPEECH_PARAMS_FORCE_SHOUTED
- * SPEECH_PARAMS_FORCE_SHOUTED_CLEAR
- * SPEECH_PARAMS_FORCE_SHOUTED_CRITICAL
- * SPEECH_PARAMS_FORCE_PRELOAD_ONLY
- * SPEECH_PARAMS_MEGAPHONE
- * SPEECH_PARAMS_HELI
- * SPEECH_PARAMS_FORCE_MEGAPHONE
- * SPEECH_PARAMS_FORCE_HELI
- * SPEECH_PARAMS_INTERRUPT
- * SPEECH_PARAMS_INTERRUPT_SHOUTED
- * SPEECH_PARAMS_INTERRUPT_SHOUTED_CLEAR
- * SPEECH_PARAMS_INTERRUPT_SHOUTED_CRITICAL
- * SPEECH_PARAMS_INTERRUPT_NO_FORCE
- * SPEECH_PARAMS_INTERRUPT_FRONTEND
- * SPEECH_PARAMS_INTERRUPT_NO_FORCE_FRONTEND
- * SPEECH_PARAMS_ADD_BLIP
- * SPEECH_PARAMS_ADD_BLIP_ALLOW_REPEAT
- * SPEECH_PARAMS_ADD_BLIP_FORCE
- * SPEECH_PARAMS_ADD_BLIP_SHOUTED
- * SPEECH_PARAMS_ADD_BLIP_SHOUTED_FORCE
- * SPEECH_PARAMS_ADD_BLIP_INTERRUPT
- * SPEECH_PARAMS_ADD_BLIP_INTERRUPT_FORCE
- * SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED
- * SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED_CLEAR
- * SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED_CRITICAL
- * SPEECH_PARAMS_SHOUTED
- * SPEECH_PARAMS_SHOUTED_CLEAR
- * SPEECH_PARAMS_SHOUTED_CRITICAL
- * Note: A list of Name and Parameters can be found here pastebin.com/1GZS5dCL
- * ```
- * ```
- * NativeDB Added Parameter 4: Any p3
+ * Plays ambient speech; see also [`PLAY_PED_AMBIENT_SPEECH_AND_CLONE_NATIVE`](#\_0xC6941B4A3A8FBBB9). Some speeches only play on certain ped models.
+ * A full list of speech names can be found [here](https://docs.fivem.net/docs/game-references/speeches/).
+ * ```cpp
+ * static const char *SpeechParams[] = {
+ * "SPEECH_PARAMS_ADD_BLIP",
+ * "SPEECH_PARAMS_ADD_BLIP_ALLOW_REPEAT",
+ * "SPEECH_PARAMS_ADD_BLIP_FORCE",
+ * "SPEECH_PARAMS_ADD_BLIP_INTERRUPT",
+ * "SPEECH_PARAMS_ADD_BLIP_INTERRUPT_FORCE",
+ * "SPEECH_PARAMS_ADD_BLIP_SHOUTED",
+ * "SPEECH_PARAMS_ADD_BLIP_SHOUTED_FORCE",
+ * "SPEECH_PARAMS_ALLOW_REPEAT",
+ * "SPEECH_PARAMS_BEAT",
+ * "SPEECH_PARAMS_FORCE",
+ * "SPEECH_PARAMS_FORCE_FRONTEND",
+ * "SPEECH_PARAMS_FORCE_HELI",
+ * "SPEECH_PARAMS_FORCE_MEGAPHONE",
+ * "SPEECH_PARAMS_FORCE_NO_REPEAT_FRONTEND",
+ * "SPEECH_PARAMS_FORCE_NORMAL",
+ * "SPEECH_PARAMS_FORCE_NORMAL_CLEAR",
+ * "SPEECH_PARAMS_FORCE_NORMAL_CRITICAL",
+ * "SPEECH_PARAMS_FORCE_PRELOAD_ONLY",
+ * "SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED",
+ * "SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED_CLEAR",
+ * "SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED_CRITICAL",
+ * "SPEECH_PARAMS_FORCE_SHOUTED",
+ * "SPEECH_PARAMS_FORCE_SHOUTED_CLEAR",
+ * "SPEECH_PARAMS_FORCE_SHOUTED_CRITICAL",
+ * "SPEECH_PARAMS_HELI",
+ * "SPEECH_PARAMS_INTERRUPT",
+ * "SPEECH_PARAMS_INTERRUPT_FRONTEND",
+ * "SPEECH_PARAMS_INTERRUPT_NO_FORCE",
+ * "SPEECH_PARAMS_INTERRUPT_NO_FORCE_FRONTEND",
+ * "SPEECH_PARAMS_INTERRUPT_SHOUTED",
+ * "SPEECH_PARAMS_INTERRUPT_SHOUTED_CLEAR",
+ * "SPEECH_PARAMS_INTERRUPT_SHOUTED_CRITICAL",
+ * "SPEECH_PARAMS_MEGAPHONE",
+ * "SPEECH_PARAMS_SHOUTED",
+ * "SPEECH_PARAMS_SHOUTED_CLEAR",
+ * "SPEECH_PARAMS_SHOUTED_CRITICAL",
+ * "SPEECH_PARAMS_STANDARD"
+ * }
  * ```
  * @param ped The ped to play the ambient speech.
  * @param speechName Name of the speech to play, eg. "GENERIC_HI".
+ * @param speechParam Name of the speechParam rage game object to look to for various details on how the speech should be played.
  */
 declare function PlayPedAmbientSpeechNative(ped: number, speechName: string, speechParam: string): void;
 /**
- * Plays ambient speech; see also [`PLAY_PED_AMBIENT_SPEECH_AND_CLONE_NATIVE`](#\_0xC6941B4A3A8FBBB9).
- * ```
- * speechParam: Can be one of the following:
- * SPEECH_PARAMS_STANDARD
- * SPEECH_PARAMS_ALLOW_REPEAT
- * SPEECH_PARAMS_BEAT
- * SPEECH_PARAMS_FORCE
- * SPEECH_PARAMS_FORCE_FRONTEND
- * SPEECH_PARAMS_FORCE_NO_REPEAT_FRONTEND
- * SPEECH_PARAMS_FORCE_NORMAL
- * SPEECH_PARAMS_FORCE_NORMAL_CLEAR
- * SPEECH_PARAMS_FORCE_NORMAL_CRITICAL
- * SPEECH_PARAMS_FORCE_SHOUTED
- * SPEECH_PARAMS_FORCE_SHOUTED_CLEAR
- * SPEECH_PARAMS_FORCE_SHOUTED_CRITICAL
- * SPEECH_PARAMS_FORCE_PRELOAD_ONLY
- * SPEECH_PARAMS_MEGAPHONE
- * SPEECH_PARAMS_HELI
- * SPEECH_PARAMS_FORCE_MEGAPHONE
- * SPEECH_PARAMS_FORCE_HELI
- * SPEECH_PARAMS_INTERRUPT
- * SPEECH_PARAMS_INTERRUPT_SHOUTED
- * SPEECH_PARAMS_INTERRUPT_SHOUTED_CLEAR
- * SPEECH_PARAMS_INTERRUPT_SHOUTED_CRITICAL
- * SPEECH_PARAMS_INTERRUPT_NO_FORCE
- * SPEECH_PARAMS_INTERRUPT_FRONTEND
- * SPEECH_PARAMS_INTERRUPT_NO_FORCE_FRONTEND
- * SPEECH_PARAMS_ADD_BLIP
- * SPEECH_PARAMS_ADD_BLIP_ALLOW_REPEAT
- * SPEECH_PARAMS_ADD_BLIP_FORCE
- * SPEECH_PARAMS_ADD_BLIP_SHOUTED
- * SPEECH_PARAMS_ADD_BLIP_SHOUTED_FORCE
- * SPEECH_PARAMS_ADD_BLIP_INTERRUPT
- * SPEECH_PARAMS_ADD_BLIP_INTERRUPT_FORCE
- * SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED
- * SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED_CLEAR
- * SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED_CRITICAL
- * SPEECH_PARAMS_SHOUTED
- * SPEECH_PARAMS_SHOUTED_CLEAR
- * SPEECH_PARAMS_SHOUTED_CRITICAL
- * Note: A list of Name and Parameters can be found here pastebin.com/1GZS5dCL
- * ```
- * ```
- * NativeDB Added Parameter 4: Any p3
+ * Plays ambient speech; see also [`PLAY_PED_AMBIENT_SPEECH_AND_CLONE_NATIVE`](#\_0xC6941B4A3A8FBBB9). Some speeches only play on certain ped models.
+ * A full list of speech names can be found [here](https://docs.fivem.net/docs/game-references/speeches/).
+ * ```cpp
+ * static const char *SpeechParams[] = {
+ * "SPEECH_PARAMS_ADD_BLIP",
+ * "SPEECH_PARAMS_ADD_BLIP_ALLOW_REPEAT",
+ * "SPEECH_PARAMS_ADD_BLIP_FORCE",
+ * "SPEECH_PARAMS_ADD_BLIP_INTERRUPT",
+ * "SPEECH_PARAMS_ADD_BLIP_INTERRUPT_FORCE",
+ * "SPEECH_PARAMS_ADD_BLIP_SHOUTED",
+ * "SPEECH_PARAMS_ADD_BLIP_SHOUTED_FORCE",
+ * "SPEECH_PARAMS_ALLOW_REPEAT",
+ * "SPEECH_PARAMS_BEAT",
+ * "SPEECH_PARAMS_FORCE",
+ * "SPEECH_PARAMS_FORCE_FRONTEND",
+ * "SPEECH_PARAMS_FORCE_HELI",
+ * "SPEECH_PARAMS_FORCE_MEGAPHONE",
+ * "SPEECH_PARAMS_FORCE_NO_REPEAT_FRONTEND",
+ * "SPEECH_PARAMS_FORCE_NORMAL",
+ * "SPEECH_PARAMS_FORCE_NORMAL_CLEAR",
+ * "SPEECH_PARAMS_FORCE_NORMAL_CRITICAL",
+ * "SPEECH_PARAMS_FORCE_PRELOAD_ONLY",
+ * "SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED",
+ * "SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED_CLEAR",
+ * "SPEECH_PARAMS_FORCE_PRELOAD_ONLY_SHOUTED_CRITICAL",
+ * "SPEECH_PARAMS_FORCE_SHOUTED",
+ * "SPEECH_PARAMS_FORCE_SHOUTED_CLEAR",
+ * "SPEECH_PARAMS_FORCE_SHOUTED_CRITICAL",
+ * "SPEECH_PARAMS_HELI",
+ * "SPEECH_PARAMS_INTERRUPT",
+ * "SPEECH_PARAMS_INTERRUPT_FRONTEND",
+ * "SPEECH_PARAMS_INTERRUPT_NO_FORCE",
+ * "SPEECH_PARAMS_INTERRUPT_NO_FORCE_FRONTEND",
+ * "SPEECH_PARAMS_INTERRUPT_SHOUTED",
+ * "SPEECH_PARAMS_INTERRUPT_SHOUTED_CLEAR",
+ * "SPEECH_PARAMS_INTERRUPT_SHOUTED_CRITICAL",
+ * "SPEECH_PARAMS_MEGAPHONE",
+ * "SPEECH_PARAMS_SHOUTED",
+ * "SPEECH_PARAMS_SHOUTED_CLEAR",
+ * "SPEECH_PARAMS_SHOUTED_CRITICAL",
+ * "SPEECH_PARAMS_STANDARD"
+ * }
  * ```
  * @param ped The ped to play the ambient speech.
  * @param speechName Name of the speech to play, eg. "GENERIC_HI".
+ * @param speechParam Name of the speechParam rage game object to look to for various details on how the speech should be played.
  */
 declare function PlayAmbientSpeech1(ped: number, speechName: string, speechParam: string): void;
 
@@ -41586,7 +41536,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).
+ * **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`](#\_0xB98236CAAECEF897).
  * @param blip Blip handle to remove.
  */
 declare function RemoveBlip(blip: number): void;
@@ -45896,11 +45846,19 @@ declare function SetCurrentPlayerTcmodifier(modifierName: string): void;
 declare function N_0xbbf327ded94e4deb(modifierName: string): void;
 
 /**
- * _SET_CURSOR_LOCATION
+ * Sets the position of the mouse cursor within the current UI context (e.g., NUI menu or pause menu).\
+ * Coordinates must be in the range 0.0 to 1.0, where (0.5, 0.5) represents the center of the screen.
+ * @param x Horizontal position (0.0 = left, 1.0 = right)
+ * @param y Vertical position (0.0 = top, 1.0 = bottom)
+ * @return Returns `true` if the cursor position was successfully set, otherwise `false`.
  */
 declare function SetCursorLocation(x: number, y: number): boolean;
 /**
- * _SET_CURSOR_LOCATION
+ * Sets the position of the mouse cursor within the current UI context (e.g., NUI menu or pause menu).\
+ * Coordinates must be in the range 0.0 to 1.0, where (0.5, 0.5) represents the center of the screen.
+ * @param x Horizontal position (0.0 = left, 1.0 = right)
+ * @param y Vertical position (0.0 = top, 1.0 = bottom)
+ * @return Returns `true` if the cursor position was successfully set, otherwise `false`.
  */
 declare function N_0xfc695459d4d0e219(x: number, y: number): boolean;
 
@@ -52024,9 +51982,9 @@ declare function SetPedHasAiBlipWithColor(ped: number, hasCone: boolean, color:
 declare function N_0xb13dcb4c6faad238(ped: number, hasCone: boolean, color: number): void;
 
 /**
- * For more info please refer to [this](https://gtaforums.com/topic/858970-all-gtao-face-ids-pedset-ped-head-blend-data-explained) topic.
+ * For more info and the list of faceIDs please refer to [this](https://gtaforums.com/topic/858970-all-gtao-face-ids-pedset-ped-head-blend-data-explained) topic. Note that the Skin and Shape IDs are shared. This native will use this same list for both Skin and Shape IDs.
  * **Other information:**
- * IDs start at zero and go Male Non-DLC, Female Non-DLC, Male DLC, and Female DLC.</br>
+ * IDs start at zero and go Male Non-DLC, Female Non-DLC, Male DLC, and Female DLC.
  * This native function is often called prior to calling natives such as:
  * *   [`SetPedHairColor`](#\_0xA23FE32C)
  * *   [`SetPedHeadOverlayColor`](#\_0x78935A27)
@@ -59280,7 +59238,7 @@ declare function N_0xf2f6a2fa49278625(t: number, x: number, y: number, z: number
 /**
  * Returns true if the object has finished moving.
  * If false, moves the object towards the specified X, Y and Z coordinates with the specified X, Y and Z speed.
- * See also: https://gtagmodding.com/opcode-database/opcode/034E/
+ * See also: https://gtag.sannybuilder.com/opcode-database/opcode/034E/
  * Has to be looped until it returns true.
  */
 declare function SlideObject(object: number, toX: number, toY: number, toZ: number, speedX: number, speedY: number, speedZ: number, collision: boolean): boolean;
@@ -59746,7 +59704,7 @@ declare function StartParticleFxLoopedOnEntityBone_2(effectName: string, entity:
 
 /**
  * NOTE: the [USE_PARTICLE_FX_ASSET](#\_0x6C38AF3693A69A91) needs to be called before EVERY StartNetworkedParticleFxNonLoopedAtCoord(....) call!
- * List with lots of particle effects: https://vespura.com/fivem/particle-list/
+ * List with lots of particle effects: https://gist.githubusercontent.com/alexguirre/af70f0122957f005a5c12bef2618a786/raw/899e93c5611ba58138c56873bb6f56664a776af4/Particles%2520Effects%2520Dump.txt
  * Note: Not all particles on this list are for non looped and vice versa, neither are all of them suited/meant to have SetParticleFxNonLoopedColour(....) called on them.
  * ```
  * NativeDB Added Parameter 12: BOOL p11
@@ -59755,7 +59713,7 @@ declare function StartParticleFxLoopedOnEntityBone_2(effectName: string, entity:
 declare function StartNetworkedParticleFxNonLoopedAtCoord(effectName: string, xPos: number, yPos: number, zPos: number, xRot: number, yRot: number, zRot: number, scale: number, xAxis: boolean, yAxis: boolean, zAxis: boolean): boolean;
 /**
  * NOTE: the [USE_PARTICLE_FX_ASSET](#\_0x6C38AF3693A69A91) needs to be called before EVERY StartNetworkedParticleFxNonLoopedAtCoord(....) call!
- * List with lots of particle effects: https://vespura.com/fivem/particle-list/
+ * List with lots of particle effects: https://gist.githubusercontent.com/alexguirre/af70f0122957f005a5c12bef2618a786/raw/899e93c5611ba58138c56873bb6f56664a776af4/Particles%2520Effects%2520Dump.txt
  * Note: Not all particles on this list are for non looped and vice versa, neither are all of them suited/meant to have SetParticleFxNonLoopedColour(....) called on them.
  * ```
  * NativeDB Added Parameter 12: BOOL p11
@@ -63299,39 +63257,50 @@ declare function TextureDownloadRelease(p0: number): void;
 declare function TextureDownloadRequest(FilePath: string, Name: string, p3: boolean): [number, number];
 
 /**
- * THEFEED_CLEAR_FROZEN_POST
+ * Disables tip notifications enabled by [`THEFEED_AUTO_POST_GAMETIPS_ON`](#\_0x56C8B608CFD49854)
  */
-declare function ThefeedClearFrozenPost(): void;
+declare function ThefeedAutoPostGametipsOff(): void;
 /**
- * THEFEED_CLEAR_FROZEN_POST
+ * Disables tip notifications enabled by [`THEFEED_AUTO_POST_GAMETIPS_ON`](#\_0x56C8B608CFD49854)
  */
-declare function N_0x80fe4f3ab4e1b62a(): void;
+declare function N_0xaded7f5748acafe6(): void;
 /**
- * THEFEED_CLEAR_FROZEN_POST
+ * Disables tip notifications enabled by [`THEFEED_AUTO_POST_GAMETIPS_ON`](#\_0x56C8B608CFD49854)
  */
-declare function ThefeedFlushPersistent(): void;
-
+declare function ThefeedShowGtaoTooltips(): void;
 /**
- * Displays "normal" notifications again after calling `_0x56C8B608CFD49854` (those that were drawn before calling this native too), though those will have a weird offset and stay on screen forever (tested with notifications created from same script).
+ * Disables tip notifications enabled by [`THEFEED_AUTO_POST_GAMETIPS_ON`](#\_0x56C8B608CFD49854)
  */
 declare function ThefeedCommentTeleportPoolOff(): void;
+
 /**
- * Displays "normal" notifications again after calling `_0x56C8B608CFD49854` (those that were drawn before calling this native too), though those will have a weird offset and stay on screen forever (tested with notifications created from same script).
+ * Enables loading screen tips to be be shown, blocks other kinds of notifications from being displayed.
+ * Call [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#\_0xADED7F5748ACAFE6) to undo this.
  */
-declare function N_0xaded7f5748acafe6(): void;
+declare function ThefeedAutoPostGametipsOn(): void;
 /**
- * Displays "normal" notifications again after calling `_0x56C8B608CFD49854` (those that were drawn before calling this native too), though those will have a weird offset and stay on screen forever (tested with notifications created from same script).
+ * Enables loading screen tips to be be shown, blocks other kinds of notifications from being displayed.
+ * Call [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#\_0xADED7F5748ACAFE6) to undo this.
  */
-declare function ThefeedShowGtaoTooltips(): void;
-
+declare function N_0x56c8b608cfd49854(): void;
 /**
- * Enables loading screen tips to be be shown (`_0x15CFA549788D35EF` and `_0x488043841BBE156F`), blocks other kinds of notifications from being displayed (at least from current script). Call `0xADED7F5748ACAFE6` to display those again.
+ * Enables loading screen tips to be be shown, blocks other kinds of notifications from being displayed.
+ * Call [`THEFEED_AUTO_POST_GAMETIPS_OFF`](#\_0xADED7F5748ACAFE6) to undo this.
  */
 declare function ThefeedCommentTeleportPoolOn(): void;
+
 /**
- * Enables loading screen tips to be be shown (`_0x15CFA549788D35EF` and `_0x488043841BBE156F`), blocks other kinds of notifications from being displayed (at least from current script). Call `0xADED7F5748ACAFE6` to display those again.
+ * THEFEED_CLEAR_FROZEN_POST
  */
-declare function N_0x56c8b608cfd49854(): void;
+declare function ThefeedClearFrozenPost(): void;
+/**
+ * THEFEED_CLEAR_FROZEN_POST
+ */
+declare function N_0x80fe4f3ab4e1b62a(): void;
+/**
+ * THEFEED_CLEAR_FROZEN_POST
+ */
+declare function ThefeedFlushPersistent(): void;
 
 /**
  * Stops loading screen tips shown by invoking either `0x488043841BBE156F` or `0x15CFA549788D35EF`

package/package.json

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