@citizenfx/client 2.0.7114-1 → 2.0.7129-1

package/natives_universal.d.ts

@@ -3956,6 +3956,17 @@ declare function N_0xdbbc7a2432524127(vehicle: number): void;
  */
 declare function ClearVehicleXenonLightsCustomColor(vehicle: number): void;
 
+/**
+ * Clears the active weather type after a specific amount of time determined by `transitionTimeInMs`.
+ * @param transitionTimeInMs Transition time in milliseconds.
+ */
+declare function ClearWeatherTypeNowPersistNetwork(transitionTimeInMs: number): void;
+/**
+ * Clears the active weather type after a specific amount of time determined by `transitionTimeInMs`.
+ * @param transitionTimeInMs Transition time in milliseconds.
+ */
+declare function N_0x0cf97f497fe7d048(transitionTimeInMs: number): void;
+
 /**
  * CLEAR_WEATHER_TYPE_PERSIST
  */
@@ -5556,7 +5567,8 @@ declare function DeleteCheckpoint(checkpoint: number): void;
 declare function DeleteChildRope(ropeId: number): void;
 
 /**
- * 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](#\_0x7239B21A38F536BA).
  * @param entity The entity to delete.
  */
 declare function DeleteEntity(entity: number): void;
@@ -16924,17 +16936,6 @@ declare function GetVehicleDirtLevel(vehicle: number): number;
  */
 declare function GetVehicleDoorAngleRatio(vehicle: number, doorIndex: number): number;
 
-/**
- * See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
- * Returns vehicle door destroy type previously set with \_SET_VEHICLE_DOOR_DESTROY_TYPE
- */
-declare function GetVehicleDoorDestroyType(vehicle: number, doorIndex: number): number;
-/**
- * See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
- * Returns vehicle door destroy type previously set with \_SET_VEHICLE_DOOR_DESTROY_TYPE
- */
-declare function N_0xca4ac3eaae46ec7b(vehicle: number, doorIndex: number): number;
-
 /**
  * enum VehicleLockStatus = {
  * None = 0,
@@ -17162,6 +17163,22 @@ declare function GetVehicleIndexFromEntityIndex(entity: number): number;
  */
 declare function GetVehicleIndicatorLights(vehicle: number): number;
 
+/**
+ * See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
+ * @return Returns vehicle door lock state previously set with [`SET_VEHICLE_INDIVIDUAL_DOORS_LOCKED`](#\_0xBE70724027F85BCD)
+ */
+declare function GetVehicleIndividualDoorLockStatus(vehicle: number, doorIndex: number): number;
+/**
+ * See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
+ * @return Returns vehicle door lock state previously set with [`SET_VEHICLE_INDIVIDUAL_DOORS_LOCKED`](#\_0xBE70724027F85BCD)
+ */
+declare function N_0xca4ac3eaae46ec7b(vehicle: number, doorIndex: number): number;
+/**
+ * See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
+ * @return Returns vehicle door lock state previously set with [`SET_VEHICLE_INDIVIDUAL_DOORS_LOCKED`](#\_0xBE70724027F85BCD)
+ */
+declare function GetVehicleDoorDestroyType(vehicle: number, doorIndex: number): number;
+
 /**
  * _GET_VEHICLE_INTERIOR_COLOR
  */
@@ -24134,14 +24151,6 @@ declare function N_0x0cf54f20de43879c(p0: number): void;
  */
 declare function N_0x0cf6cc51aa18f0f8(p0: number, p1: number, p2: number): number;
 
-/**
- * 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
- */
-declare function N_0x0cf97f497fe7d048(p0: number): void;
-
 /**
  * 0x0D01D20616FC73FB
  */
@@ -41919,7 +41928,9 @@ declare function N_0x2c654b4943bddf7c(camera: number, p1: number): void;
 declare function SetCamDofPlanes(cam: number, p1: number, p2: number, p3: number, p4: number): void;
 
 /**
- * SET_CAM_DOF_STRENGTH
+ * Specifies how much the DoF effect should be applied (Set using [`SET_CAM_NEAR_DOF`](#\_0x3FA4BF0A7AB7DE2C), [`SET_CAM_FAR_DOF`](#\_0xEDD91296CD01AEE0), etc.)
+ * @param cam The camera handle
+ * @param dofStrength Depth of Field strength (between 0.0 and 1.0)
  */
 declare function SetCamDofStrength(cam: number, dofStrength: number): void;
 
@@ -41936,7 +41947,11 @@ declare function SetCamEffect(p0: number): void;
 declare function SetCamFarClip(cam: number, farClip: number): void;
 
 /**
- * SET_CAM_FAR_DOF
+ * Specifies when the camera should stop being in focus. Can be used together with [`SET_USE_HI_DOF`](#\_0xA13B0222F3D94A94), [`SET_CAM_NEAR_DOF`](#\_0x3FA4BF0A7AB7DE2C), [`SET_CAM_USE_SHALLOW_DOF_MODE`](#\_0x16A96863A17552BB), [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897) and other DoF related natives.
+ * ### Usage Example
+ * A usage example for this native can be found in the following native documentation: [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897).
+ * @param cam The camera handle
+ * @param farDOF Distance in in standard units
  */
 declare function SetCamFarDof(cam: number, farDOF: number): void;
 
@@ -41967,7 +41982,11 @@ declare function SetCamMotionBlurStrength(cam: number, strength: number): void;
 declare function SetCamNearClip(cam: number, nearClip: number): void;
 
 /**
- * SET_CAM_NEAR_DOF
+ * Specifies when the camera should start being in focus. Can be used together with [`SET_USE_HI_DOF`](#\_0xA13B0222F3D94A94), [`SET_CAM_FAR_DOF`](#\_0xEDD91296CD01AEE0), [`SET_CAM_USE_SHALLOW_DOF_MODE`](#\_0x16A96863A17552BB), [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897) and other DoF related natives.
+ * ### Usage Example
+ * A usage example for this native can be found in the following native documentation: [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897).
+ * @param cam The camera handle
+ * @param nearDOF Distance in in standard units
  */
 declare function SetCamNearDof(cam: number, nearDOF: number): void;
 
@@ -42118,7 +42137,11 @@ declare function SetCamSplineSmoothingStyle(cam: number, smoothingStyle: number)
 declare function N_0xd1b0f412f109ea5d(cam: number, smoothingStyle: number): void;
 
 /**
- * SET_CAM_USE_SHALLOW_DOF_MODE
+ * Enables or disables the usage of a shallow DOF. Needs to be set to true to use [`SET_CAM_NEAR_DOF`](#\_0x3FA4BF0A7AB7DE2C), [`SET_CAM_FAR_DOF`](#\_0xEDD91296CD01AEE0), etc. Doesn't need to be called every tick.
+ * ### Usage Example
+ * A usage example for this native can be found in the following native documentation: [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897).
+ * @param cam The camera handle
+ * @param toggle Boolean if the camera should use a shallow depth of field or not
  */
 declare function SetCamUseShallowDofMode(cam: number, toggle: boolean): void;
 
@@ -44891,17 +44914,26 @@ declare function SetMinimapBlockWaypoint(toggle: boolean): void;
 declare function SetMinimapClipType(_type: number): void;
 
 /**
- * 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
  * @param componentID The component ID to change.
- * @param toggle True to enable the color, false to disable the effect.
- * @param hudColor The hudcolor index.
+ * @param toggle True to enable/colorize, false to disable.
+ * @param hudColor The hudcolor index, the list of hud colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/).
+ * @return Hardcoded to always return 1 (int)
  */
 declare function SetMinimapComponent(componentID: number, toggle: boolean, hudColor: number): number;
 
@@ -50646,7 +50678,10 @@ declare function SetUnkFloatN_0x104ForSubmarineVehicleTask(vehicle: number, valu
 declare function SetUnkGlobalBoolRelatedToDamage(value: boolean): void;
 
 /**
- * SET_USE_HI_DOF
+ * Needs to be called every tick to make the active camera use a high depth of field.\
+ * The DoF can be customized using [`SET_CAM_NEAR_DOF`](#\_0x3FA4BF0A7AB7DE2C), [`SET_CAM_FAR_DOF`](#\_0xEDD91296CD01AEE0), [`SET_CAM_USE_SHALLOW_DOF_MODE`](#\_0x16A96863A17552BB), [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897) and other DoF related natives.
+ * ### Usage Example
+ * A usage example for this native can be found in the following native documentation: [`SET_CAM_DOF_STRENGTH`](#\_0x5EE29B4D7D5DF897).
  */
 declare function SetUseHiDof(): void;
 

package/package.json

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