Release 2023-11-27

Author: github-actions[bot]

docs-gen/native-entity.def.lua

@@ -1832,8 +1832,19 @@ function SetEntityAlwaysPrerender(entity, toggle) end
 function SetEntityAsMissionEntity(entity, p1, p2) end
 
 
---- Deletes the specified entity, and invalidates the passed handle (i.e. in/out argument).
----
+--- Delete the specified entity, and invalidate the passed handle (i.e., the in/out argument).
+--- You might want to check if the entity exists before with [DOES_ENTITY_EXIST](https://docs.fivem.net/natives/?_0x7239B21A38F536BA).
+--- @usage -- Retrieve the vehicle the player is currently in. 
+--- local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
+--- 
+--- -- Check if the vehicle exists in the game world.
+--- if not DoesEntityExist(vehicle) then 
+---     -- If the vehicle does not exist, end the execution of the code here.
+---     return 
+--- end
+--- 
+--- -- If the vehicle does exist, delete the vehicle entity from the game world.
+--- DeleteEntity(vehicle
 --- @hash [0xAE3CBE5BF394C9C9](https://docs.fivem.net/natives/?_0xAE3CBE5BF394C9C9)
 --- @param entity Entity (Entity*)
 --- @return void

docs-gen/native-hud.def.lua

@@ -5882,24 +5882,33 @@ function ShowHeightOnBlip(blip, toggle) end
 function N_0x75a16c3da34f1245(blip, toggle) end
 
 
---- This native is used to colorize certain map components like the army base at the top of the map.
---- 
---- An incomplete list of components ID:
---- 
---- 0: Los Santos' air port yellow lift-off markers.
---- 1: Sandy Shore's air port yellow lift-off markers.
---- 2: Trevor's air port yellow lift-off markers.
---- 6: Vespucci Beach lifeguard building.
---- 15: Army base.
---- 
---- [List of hud colors](https://docs.fivem.net/docs/game-references/hud-colors/)
----
+--- This native is used to colorize/toggle certain map components like the army base.
+--- 
+--- Component IDs 6 through 14 are used by the freemode event King of the Castle in GTA Online.
+--- 
+--- ### An incomplete list of component IDs:
+--- 
+--- *   **0**: Los Santos International Airport yellow runway markers
+--- *   **1**: Sandy Shores Airfield yellow runway markers
+--- *   **2**: McKenzie Field yellow runway markers
+--- *   **6**: Vespucci Beach lifeguard building
+--- *   **7**: Top level zone of Alien Camp (Hippy Camp)
+--- *   **8**: Paleto Bay fire station drill tower
+--- *   **9** Land Act Dam tower
+--- *   **10** Pala Springs Aerial Tramway
+--- *   **11** Galileo Observatory power unit
+--- *   **12** Small zone (empty "interior") near Central Los Santos Medical Center
+--- *   **13** Richman Mansion grotto
+--- *   **14** 2 Alien Camp (Hippy Camp) circles
+--- *   **15** Fort Zancudo
+--- @usage -- Enables Fort Zancudo on the map
+--- SetMinimapComponent(15, true, 0
 --- @hash [0x75A9A10948D1DEA6](https://docs.fivem.net/natives/?_0x75A9A10948D1DEA6)
 --- @param componentID number (int)
 --- @param toggle boolean
 --- @param hudColor number (int)
---- @return any
---- @overload fun(componentID: number, toggle: boolean, hudColor: number): any
+--- @return number
+--- @overload fun(componentID: number, toggle: boolean, hudColor: number): number
 function SetMinimapComponent(componentID, toggle, hudColor) end
 
 

docs-gen/native-interior.def.lua

@@ -805,8 +805,6 @@ function UnkGetInteriorAtCoords(x, y, z, typeHash) end
 
 
 --- ```
---- GET_INTERIOR_*
---- 
 --- NativeDB Introduced: v1493
 --- ```
 ---
@@ -816,4 +814,17 @@ function UnkGetInteriorAtCoords(x, y, z, typeHash) end
 --- @overload fun(interior: number): number
 function GetInteriorHeading(interior) end
 
+    
+--- # New Name: GetInteriorHeading
+--- ```
+--- NativeDB Introduced: v1493
+--- ```
+---
+--- @hash [0xF49B58631D9E22D9](https://docs.fivem.net/natives/?_0xF49B58631D9E22D9)
+--- @param interior number (int)
+--- @return number
+--- @overload fun(interior: number): number
+--- @deprecated
+function GetInteriorHeading(interior) end
+
 

docs-gen/native-misc.def.lua

@@ -274,18 +274,40 @@ function AreStringsEqual(string1, string2) end
 function UpdateOnscreenKeyboard() end
 
 
---- ```
---- 0 as param = weird black and green screen
---- 0.1 - 0.99 = Prevent rain effect from falling (still sound and effects on puddles) and prevent puddles from increase/decrease, seems than it prevent any weather change too
---- 1 and more = "Unfreeze" rain puddles but clear weather too
---- When 'freezing' is enabled, it seem to also freeze value getted with GetRainLevel
---- ```
----
+--- Clears the active weather type after a specific amount of time determined by `transitionTimeInMs`.
+--- @usage RegisterCommand('weathertransition', function(source, args)
+---     -- Set the weather type to foggy so we can see the change
+---     SetWeatherTypeNowPersist("FOGGY")
+---     -- Clear the weather and run the transition
+---     local transitionTimeInMs = tonumber(args[1]) or 5000
+---     if transitionTimeInMs > 0 then
+---         ClearWeatherTypeNowPersistNetwork(transitionTimeInMs)
+---     end
+--- end, false
 --- @hash [0x0CF97F497FE7D048](https://docs.fivem.net/natives/?_0x0CF97F497FE7D048)
---- @param p0 number (float)
+--- @param transitionTimeInMs number (int)
 --- @return void
---- @overload fun(p0: number): void
-function N_0x0cf97f497fe7d048(p0) end
+--- @overload fun(transitionTimeInMs: number): void
+function ClearWeatherTypeNowPersistNetwork(transitionTimeInMs) end
+
+    
+--- # New Name: ClearWeatherTypeNowPersistNetwork
+--- Clears the active weather type after a specific amount of time determined by `transitionTimeInMs`.
+--- @usage RegisterCommand('weathertransition', function(source, args)
+---     -- Set the weather type to foggy so we can see the change
+---     SetWeatherTypeNowPersist("FOGGY")
+---     -- Clear the weather and run the transition
+---     local transitionTimeInMs = tonumber(args[1]) or 5000
+---     if transitionTimeInMs > 0 then
+---         ClearWeatherTypeNowPersistNetwork(transitionTimeInMs)
+---     end
+--- end, false
+--- @hash [0x0CF97F497FE7D048](https://docs.fivem.net/natives/?_0x0CF97F497FE7D048)
+--- @param transitionTimeInMs number (int)
+--- @return void
+--- @overload fun(transitionTimeInMs: number): void
+--- @deprecated
+function N_0x0cf97f497fe7d048(transitionTimeInMs) end
 
 
 --- RegisterEnumToSave
@@ -5573,18 +5595,26 @@ function SlerpNearQuaternion(t, x, y, z, w, x1, y1, z1, w1) end
 function N_0xf2f6a2fa49278625(t, x, y, z, w, x1, y1, z1, w1) end
 
 
---- SetCloudHatOpacity
----
+--- Allows modification of the cloud opacity. It can also be used in other contexts, such as when the player is in a switch state [`IS_PLAYER_SWITCH_IN_PROGRESS`](https://docs.fivem.net/natives/?_0xD9D2CFFF49FAB35F).
+--- @usage -- Check if the player is in a Switch "state"
+--- if IsPlayerSwitchInProgress() then
+---     -- If the player is in a Switch state, set the clouds opacity to 1.0
+---     SetCloudsAlpha(1.0)
+--- en
 --- @hash [0xF36199225D6D8C86](https://docs.fivem.net/natives/?_0xF36199225D6D8C86)
 --- @param opacity number (float)
 --- @return void
 --- @overload fun(opacity: number): void
-function SetCloudHatOpacity(opacity) end
+function SetCloudsAlpha(opacity) end
 
 
---- # New Name: SetCloudHatOpacity
---- SetCloudHatOpacity
----
+--- # New Name: SetCloudsAlpha
+--- Allows modification of the cloud opacity. It can also be used in other contexts, such as when the player is in a switch state [`IS_PLAYER_SWITCH_IN_PROGRESS`](https://docs.fivem.net/natives/?_0xD9D2CFFF49FAB35F).
+--- @usage -- Check if the player is in a Switch "state"
+--- if IsPlayerSwitchInProgress() then
+---     -- If the player is in a Switch state, set the clouds opacity to 1.0
+---     SetCloudsAlpha(1.0)
+--- en
 --- @hash [0xF36199225D6D8C86](https://docs.fivem.net/natives/?_0xF36199225D6D8C86)
 --- @param opacity number (float)
 --- @return void
@@ -5593,6 +5623,21 @@ function SetCloudHatOpacity(opacity) end
 function N_0xf36199225d6d8c86(opacity) end
 
 
+--- # New Name: SetCloudsAlpha
+--- Allows modification of the cloud opacity. It can also be used in other contexts, such as when the player is in a switch state [`IS_PLAYER_SWITCH_IN_PROGRESS`](https://docs.fivem.net/natives/?_0xD9D2CFFF49FAB35F).
+--- @usage -- Check if the player is in a Switch "state"
+--- if IsPlayerSwitchInProgress() then
+---     -- If the player is in a Switch state, set the clouds opacity to 1.0
+---     SetCloudsAlpha(1.0)
+--- en
+--- @hash [0xF36199225D6D8C86](https://docs.fivem.net/natives/?_0xF36199225D6D8C86)
+--- @param opacity number (float)
+--- @return void
+--- @overload fun(opacity: number): void
+--- @deprecated
+function SetCloudHatOpacity(opacity) end
+
+    
 --- Refer to [`SET_WEATHER_TYPE_NOW_PERSIST`](https://docs.fivem.net/natives/?_0xED712CA327900C8A) for weather types.
 ---
 --- @hash [0xF3BBE884A14BB413](https://docs.fivem.net/natives/?_0xF3BBE884A14BB413)

docs-gen/native-player.def.lua

@@ -3263,16 +3263,58 @@ function N_0xefd79fa81dfba9cb(player, distance) end
 function ClearPlayerHasDamagedAtLeastOnePed(player) end
 
 
+--- Violation types:
+--- 
 --- ```
---- Only 1 occurrence. p1 was 2.  
+--- enum eViolationType {
+---   VT_PAVED_PEDESTRIAN_AREAS = 0,
+---   VT_RUNNING_REDS,
+---   VT_AGAINST_TRAFFIC
+--- };
 --- ```
+--- 
+--- Checks if a player is performing a certain type of traffic violation.
+--- 
+--- *   Type 0: Checks if the player is driving outside designated road areas pedestrians would walk on (specifically paved sidewalks).
+--- *   Type 1: Checks if the player is running through reds, takes some time to return true.
+--- *   Type 2: Checks if the player is driving on the wrong side of the road (against traffic).
+--- 
+--- Used solely in "Al Di Napoli" with type 2 for a voiceline.
 ---
 --- @hash [0xF10B44FD479D69F3](https://docs.fivem.net/natives/?_0xF10B44FD479D69F3)
 --- @param player Player
---- @param p1 number (int)
+--- @param type number (int)
 --- @return boolean
---- @overload fun(player: Player, p1: number): boolean
-function N_0xf10b44fd479d69f3(player, p1) end
+--- @overload fun(player: Player, type: number): boolean
+function IsPlayerDrivingDangerously(player, type) end
+
+    
+--- # New Name: IsPlayerDrivingDangerously
+--- Violation types:
+--- 
+--- ```
+--- enum eViolationType {
+---   VT_PAVED_PEDESTRIAN_AREAS = 0,
+---   VT_RUNNING_REDS,
+---   VT_AGAINST_TRAFFIC
+--- };
+--- ```
+--- 
+--- Checks if a player is performing a certain type of traffic violation.
+--- 
+--- *   Type 0: Checks if the player is driving outside designated road areas pedestrians would walk on (specifically paved sidewalks).
+--- *   Type 1: Checks if the player is running through reds, takes some time to return true.
+--- *   Type 2: Checks if the player is driving on the wrong side of the road (against traffic).
+--- 
+--- Used solely in "Al Di Napoli" with type 2 for a voiceline.
+---
+--- @hash [0xF10B44FD479D69F3](https://docs.fivem.net/natives/?_0xF10B44FD479D69F3)
+--- @param player Player
+--- @param type number (int)
+--- @return boolean
+--- @overload fun(player: Player, type: number): boolean
+--- @deprecated
+function N_0xf10b44fd479d69f3(player, type) end
 
 
 --- ```