@citizenfx/client 2.0.12746-1 → 2.0.12781-1

package/natives_universal.d.ts

@@ -7316,6 +7316,28 @@ declare function DrawBinkMovie(binkMovie: number, posX: number, posY: number, sc
  */
 declare function DrawBox(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, red: number, green: number, blue: number, alpha: number): void;
 
+/**
+ * Allows drawing advanced light effects, known as coronas, which support flares, volumetric lighting, and customizable glow properties.
+ * @param posX The X position of the corona origin.
+ * @param posY The Y position of the corona origin.
+ * @param posZ The Z position of the corona origin.
+ * @param size The size of the corona.
+ * @param red The red component of the marker color, on a scale from 0-255.
+ * @param green The green component of the marker color, on a scale from 0-255.
+ * @param blue The blue component of the marker color, on a scale from 0-255.
+ * @param alpha The alpha component of the marker color, on a scale from 0-255.
+ * @param intensity The intensity of the corona.
+ * @param zBias zBias slightly shifts the depth of surfaces to make sure they don’t overlap or cause visual glitches when they are very close together. The zBias value are usually in the range of 0.0 to 1.0.
+ * @param dirX The X direction of the corona.
+ * @param dirY The Y direction of the corona.
+ * @param dirZ The Z direction of the corona.
+ * @param viewThreshold The view threshold is to determine the fading of the corona based on the distance.
+ * @param innerAngle The inner angle of the corona.
+ * @param outerAngle The outer angle of the corona.
+ * @param flags The corona flags.
+ */
+declare function DrawCorona(posX: number, posY: number, posZ: number, size: number, red: number, green: number, blue: number, alpha: number, intensity: number, zBias: number, dirX: number, dirY: number, dirZ: number, viewThreshold: number, innerAngle: number, outerAngle: number, flags: number): void;
+
 /**
  * NOTE: Debugging functions are not present in the retail version of the game.
  */
@@ -15304,24 +15326,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.
@@ -18640,6 +18662,57 @@ declare function GetVehicleHandlingInt(vehicle: number, class_: string, fieldNam
  */
 declare function GetVehicleHandlingVector(vehicle: number, class_: string, fieldName: string): number[];
 
+/**
+ * **Note**: Flags are not the same based on your `gamebuild`. Please see [here](https://docs.fivem.net/docs/game-references/vehicle-references/vehicle-flags) to see a complete list of all vehicle flags.
+ * Get vehicle.meta flag by index. Useful examples include `FLAG_LAW_ENFORCEMENT` (31), `FLAG_RICH_CAR` (36), `FLAG_IS_ELECTRIC` (43), `FLAG_IS_OFFROAD_VEHICLE` (48).
+ * @param vehicle The vehicle to obtain flags for.
+ * @param flagIndex Flag index.
+ * @return A boolean for whether the flag is set.### Example```lua
+local vehicleFlags = {
+    FLAG_SMALL_WORKER = 0,
+    FLAG_BIG = 1,
+    FLAG_NO_BOOT = 2,
+    FLAG_ONLY_DURING_OFFICE_HOURS = 3
+    -- This is just a example, see fivem-docs to see all flags.
+}
+
+local function getAllVehicleFlags(vehicle)
+    local flags = {}
+    for i = 0, 256 do
+        if GetVehicleHasFlag(vehicle, i) then
+            flags[#flags+1] = i
+        end
+    end
+    return flags
+end
+
+local flagsVehicle = GetVehiclePedIsIn(PlayerPedId(), false)
+print(getAllVehicleFlags)
+``````javascript
+const VEHICLE_FLAGS = {
+    FLAG_SMALL_WORKER: 0,
+    FLAG_BIG: 1,
+    FLAG_NO_BOOT: 2,
+    FLAG_ONLY_DURING_OFFICE_HOURS: 3
+    // This is just a example, see fivem-docs to see all flags.
+};
+
+function getAllVehicleFlags(mVehicle = GetVehiclePedIsIn(PlayerPedId(), false)) {
+    const flags = [];
+    for (let i = 0; i < 204; i++) {
+        if (GetVehicleHasFlag(mVehicle, i)) {
+            flags.push(i);
+        }
+    }
+    return flags;
+}
+
+let flagsVehicle = GetVehiclePedIsIn(PlayerPedId(), false);
+console.log(getAllVehicleFlags);
+```
+ */
+declare function GetVehicleHasFlag(vehicle: number, flagIndex: number): boolean;
+
 /**
  * GET_VEHICLE_HAS_KERS
  * @param vehicle The vehicle handle.
@@ -40636,6 +40709,14 @@ declare function RegisterRawNuiCallback(callbackType: string, callback: Function
  */
 declare function RegisterResourceAsEventHandler(eventName: string): void;
 
+/**
+ * Registers a custom rope data with the game. For guidance on what these values should be use common:/data/ropedata.xml as a reference.
+ * Returns a rope type which can be passed into [ADD_ROPE](?\_0xE832D760399EB220) to use a custom rope design.
+ * Once a rope data is registered it can be used indefinitely and you should take caution not too register too many as to exceed the games limit.
+ * @return Returns a non-negative value on success, or -1 if the rope data could not be registered or an invalid argument is passed.
+ */
+declare function RegisterRopeData(numSections: number, radius: number, diffuseTextureName: string, normalMapName: string, distanceMappingScale: number, uvScaleX: number, uvScaleY: number, specularFresnel: number, specularFalloff: number, specularIntensity: number, bumpiness: number, color: number): number;
+
 /**
  * REGISTER_SAVE_HOUSE
  */
@@ -55325,6 +55406,14 @@ declare function SetVehicleExtraColours(vehicle: number, pearlescentColor: numbe
  */
 declare function SetVehicleFixed(vehicle: number): void;
 
+/**
+ * This native is a setter for [`GET_VEHICLE_HAS_FLAG`](#\_0xD85C9F57).
+ * @param vehicle The vehicle to set flag for.
+ * @param flagIndex Flag index.
+ * @param value `true` to enable the flag, `false` to disable it.
+ */
+declare function SetVehicleFlag(vehicle: number, flagIndex: number, value: boolean): boolean;
+
 /**
  * SET_VEHICLE_FLIGHT_NOZZLE_POSITION
  */

package/package.json

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