@citizenfx/client 2.0.14033-1 → 2.0.14157-1

package/natives_universal.d.ts

@@ -6001,13 +6001,17 @@ declare function DeleteStuntJump(p0: number): void;
 declare function DeleteVehicle(vehicle: number): void;
 
 /**
- * _DELETE_WAYPOINT
+ * Same as [`SET_WAYPOINT_OFF`](#\_0xA7E4E2D361C2627F), except it checks if the local player is the owner of the waypoint.
  */
-declare function DeleteWaypoint(): void;
+declare function DeleteWaypointsFromThisPlayer(): void;
 /**
- * _DELETE_WAYPOINT
+ * Same as [`SET_WAYPOINT_OFF`](#\_0xA7E4E2D361C2627F), except it checks if the local player is the owner of the waypoint.
  */
 declare function N_0xd8e694757bcea8e9(): void;
+/**
+ * Same as [`SET_WAYPOINT_OFF`](#\_0xA7E4E2D361C2627F), except it checks if the local player is the owner of the waypoint.
+ */
+declare function DeleteWaypoint(): void;
 
 /**
  * Does nothing and always returns false.
@@ -7445,6 +7449,15 @@ declare function DrawGizmo(matrixPtr: number, id: string): boolean;
  */
 declare function DrawGlowSphere(posX: number, posY: number, posZ: number, radius: number, colorR: number, colorG: number, colorB: number, intensity: number, invert: boolean, marker: boolean): void;
 
+/**
+ * Allows HUD to be drawn over screen fade every frame this function is called.
+ */
+declare function DrawHudOverFadeThisFrame(): void;
+/**
+ * Allows HUD to be drawn over screen fade every frame this function is called.
+ */
+declare function N_0xbf4f34a85ca2970c(): void;
+
 /**
  * Similar to [\_DRAW_SPRITE](#\_0xE7FFAE5EBF23D890), but seems to be some kind of "interactive" sprite, at least used by render targets.
  * These seem to be the only dicts ever requested by this native:
@@ -9330,7 +9343,7 @@ declare function EnsureEntityStateBag(entity: number): void;
 declare function EnterCursorMode(): void;
 
 /**
- * EXECUTE_COMMAND
+ * Depending on your use case you may need to use `add_acl resource.<your_resource_name> command.<command_name> allow` to use this native in your resource.
  */
 declare function ExecuteCommand(commandString: string): void;
 
@@ -9967,6 +9980,11 @@ declare function ForceVehicleEngineAudio(vehicle: number, gameObjectName: string
  */
 declare function ForceVehicleEngineSynth(vehicle: number, force: boolean): void;
 
+/**
+ * An internal function for converting a stack trace object to a string.
+ */
+declare function FormatStackTrace(traceData: any): string;
+
 /**
  * FREE_MEMORY_FOR_HIGH_QUALITY_PHOTO
  */
@@ -11514,6 +11532,38 @@ declare function GetDriftTyresEnabled(vehicle: number): boolean;
  */
 declare function GetDuiHandle(duiObject: number): string;
 
+/**
+ * ### Supported types
+ * *   \[1] : Peds (including animals) and players.
+ * *   \[2] : Vehicles.
+ * *   \[3] : Objects (props), doors, and projectiles.
+ * ### Coordinates need to be send unpacked (x,y,z)
+ * ```lua
+ * -- Define the allowed model hashes
+ * local allowedModelHashes = { GetHashKey("p_crate03x"), GetHashKey("p_crate22x") }
+ * -- Get the player's current coordinates
+ * local playerCoords = GetEntityCoords(PlayerPedId())
+ * -- Retrieve all entities of type Object (type 3) within a radius of 10.0 units
+ * -- that match the allowed model hashes
+ * -- and sort output entities by distance
+ * local entities = GetEntitiesInRadius(playerCoords.x, playerCoords.y, playerCoords.z, 10.0, 3, true, allowedModelHashes)
+ * -- Iterate through the list of entities and print their ids
+ * for i = 1, #entities do
+ * local entity = entities[i]
+ * print(entity)
+ * end
+ * ```
+ * @param x The X coordinate.
+ * @param y The Y coordinate.
+ * @param z The Z coordinate.
+ * @param radius Max distance from coordinate to entity
+ * @param entityType Entity types see list below
+ * @param sortByDistance Sort output entites by distance from nearest to farthest
+ * @param models List of allowed models its also optional
+ * @return An array containing entity handles for each entity.
+ */
+declare function GetEntitiesInRadius(x: number, y: number, z: number, radius: number, entityType: number, sortByDistance: boolean, models: any): any;
+
 /**
  * **Experimental**: This native may be altered or removed in future versions of CitizenFX without warning.
  * Returns the memory address of an entity.
@@ -13702,6 +13752,103 @@ declare function GetModelDimensions(modelHash: string | number): [number[], numb
  */
 declare function GetMount(ped: number): number;
 
+/**
+ * Gets mouse event data from scaleforms with mouse support. Must be checked every frame.
+ * Returns item index if using the COLOUR_SWITCHER\_02 scaleform.
+ * Selection types, found in MOUSE_EVENTS.as:
+ * MOUSE_DRAG_OUT = 0;
+ * MOUSE_DRAG_OVER = 1;
+ * MOUSE_DOWN = 2;
+ * MOUSE_MOVE = 3;
+ * MOUSE_UP = 4;
+ * MOUSE_PRESS = 5;
+ * MOUSE_RELEASE = 6;
+ * MOUSE_RELEASE_OUTSIDE = 7;
+ * MOUSE_ROLL_OUT = 8;
+ * MOUSE_ROLL_OVER = 9;
+ * MOUSE_WHEEL_UP = 10;
+ * MOUSE_WHEEL_DOWN = 11;
+ * Scaleforms that this works with:
+ * *   COLOUR_SWITCHER\_02
+ * *   MP_RESULTS_PANEL
+ * *   MP_NEXT_JOB_SELECTION
+ * *   SC_LEADERBOARD
+ * Probably works with other scaleforms, needs more research.
+ * In order to use this Native you MUST have controls 239, 240, 237, 238 enabled!
+ * This native, due to its erroneous redundancy of the returned boolean value, works differently in C#: shifting the parameters (where `received` becomes `selectionType` and so on making the fourth parameter unused and always 0).
+ * @param scaleformHandle Handle of the scaleform
+ * @param received Returns a boolean indicating if the data was received successfully (in Lua).
+ * @param selectionType The type of MouseEvent specified above.
+ * @param context Context of the slot the mouse is hovering on.
+ * @param slotIndex Index of the slot the mouse is hovering on.
+ * @return *   **retVal** Returns true if MOUSE_EVENT callback from Scaleforms has been called.
+ */
+declare function GetMouseEvent(scaleformHandle: number): [boolean, any /* actually bool */, number, number, number];
+/**
+ * Gets mouse event data from scaleforms with mouse support. Must be checked every frame.
+ * Returns item index if using the COLOUR_SWITCHER\_02 scaleform.
+ * Selection types, found in MOUSE_EVENTS.as:
+ * MOUSE_DRAG_OUT = 0;
+ * MOUSE_DRAG_OVER = 1;
+ * MOUSE_DOWN = 2;
+ * MOUSE_MOVE = 3;
+ * MOUSE_UP = 4;
+ * MOUSE_PRESS = 5;
+ * MOUSE_RELEASE = 6;
+ * MOUSE_RELEASE_OUTSIDE = 7;
+ * MOUSE_ROLL_OUT = 8;
+ * MOUSE_ROLL_OVER = 9;
+ * MOUSE_WHEEL_UP = 10;
+ * MOUSE_WHEEL_DOWN = 11;
+ * Scaleforms that this works with:
+ * *   COLOUR_SWITCHER\_02
+ * *   MP_RESULTS_PANEL
+ * *   MP_NEXT_JOB_SELECTION
+ * *   SC_LEADERBOARD
+ * Probably works with other scaleforms, needs more research.
+ * In order to use this Native you MUST have controls 239, 240, 237, 238 enabled!
+ * This native, due to its erroneous redundancy of the returned boolean value, works differently in C#: shifting the parameters (where `received` becomes `selectionType` and so on making the fourth parameter unused and always 0).
+ * @param scaleformHandle Handle of the scaleform
+ * @param received Returns a boolean indicating if the data was received successfully (in Lua).
+ * @param selectionType The type of MouseEvent specified above.
+ * @param context Context of the slot the mouse is hovering on.
+ * @param slotIndex Index of the slot the mouse is hovering on.
+ * @return *   **retVal** Returns true if MOUSE_EVENT callback from Scaleforms has been called.
+ */
+declare function N_0x632b2940c67f4ea9(scaleformHandle: number): [boolean, any /* actually bool */, number, number, number];
+/**
+ * Gets mouse event data from scaleforms with mouse support. Must be checked every frame.
+ * Returns item index if using the COLOUR_SWITCHER\_02 scaleform.
+ * Selection types, found in MOUSE_EVENTS.as:
+ * MOUSE_DRAG_OUT = 0;
+ * MOUSE_DRAG_OVER = 1;
+ * MOUSE_DOWN = 2;
+ * MOUSE_MOVE = 3;
+ * MOUSE_UP = 4;
+ * MOUSE_PRESS = 5;
+ * MOUSE_RELEASE = 6;
+ * MOUSE_RELEASE_OUTSIDE = 7;
+ * MOUSE_ROLL_OUT = 8;
+ * MOUSE_ROLL_OVER = 9;
+ * MOUSE_WHEEL_UP = 10;
+ * MOUSE_WHEEL_DOWN = 11;
+ * Scaleforms that this works with:
+ * *   COLOUR_SWITCHER\_02
+ * *   MP_RESULTS_PANEL
+ * *   MP_NEXT_JOB_SELECTION
+ * *   SC_LEADERBOARD
+ * Probably works with other scaleforms, needs more research.
+ * In order to use this Native you MUST have controls 239, 240, 237, 238 enabled!
+ * This native, due to its erroneous redundancy of the returned boolean value, works differently in C#: shifting the parameters (where `received` becomes `selectionType` and so on making the fourth parameter unused and always 0).
+ * @param scaleformHandle Handle of the scaleform
+ * @param received Returns a boolean indicating if the data was received successfully (in Lua).
+ * @param selectionType The type of MouseEvent specified above.
+ * @param context Context of the slot the mouse is hovering on.
+ * @param slotIndex Index of the slot the mouse is hovering on.
+ * @return *   **retVal** Returns true if MOUSE_EVENT callback from Scaleforms has been called.
+ */
+declare function GetScaleformMovieCursorSelection(scaleformHandle: number): [boolean, any /* actually bool */, number, number, number];
+
 /**
  * GET_MUSIC_PLAYTIME
  * @return Returns the play time in milliseconds of the current score track.
@@ -16989,71 +17136,6 @@ declare function GetSafePickupCoords(x: number, y: number, z: number, p3: number
  */
 declare function GetSafeZoneSize(): number;
 
-/**
- * Gets mouse selection data from scaleforms with mouse support. Must be checked every frame.
- * Returns item index if using the COLOUR_SWITCHER\_02 scaleform.
- * Selection types, found in MOUSE_EVENTS.as:
- * MOUSE_DRAG_OUT = 0;
- * MOUSE_DRAG_OVER = 1;
- * MOUSE_DOWN = 2;
- * MOUSE_MOVE = 3;
- * MOUSE_UP = 4;
- * MOUSE_PRESS = 5;
- * MOUSE_RELEASE = 6;
- * MOUSE_RELEASE_OUTSIDE = 7;
- * MOUSE_ROLL_OUT = 8;
- * MOUSE_ROLL_OVER = 9;
- * MOUSE_WHEEL_UP = 10;
- * MOUSE_WHEEL_DOWN = 11;
- * Scaleforms that this works with:
- * *   COLOUR_SWITCHER\_02
- * *   MP_RESULTS_PANEL
- * *   MP_NEXT_JOB_SELECTION
- * *   SC_LEADERBOARD
- * Probably works with other scaleforms, needs more research.
- * In order to use this Native you MUST have controls 239, 240, 237, 238 enabled!
- * This native, due to its erroneous redundancy of the returned boolean value, works differently in C#: shifting the parameters (where `received` becomes `selectionType` and so on making the fourth parameter unused and always 0).
- * @param scaleformHandle Handle of the scaleform
- * @param received Returns a boolean indicating if the data was received successfully (in Lua).
- * @param selectionType The type of MouseEvent specified above.
- * @param context Context of the slot the mouse is hovering on.
- * @param slotIndex Index of the slot the mouse is hovering on.
- * @return *   **retVal** Returns true if MOUSE_EVENT callback from Scaleforms has been called.
- */
-declare function GetScaleformMovieCursorSelection(scaleformHandle: number): [boolean, any /* actually bool */, number, number, number];
-/**
- * Gets mouse selection data from scaleforms with mouse support. Must be checked every frame.
- * Returns item index if using the COLOUR_SWITCHER\_02 scaleform.
- * Selection types, found in MOUSE_EVENTS.as:
- * MOUSE_DRAG_OUT = 0;
- * MOUSE_DRAG_OVER = 1;
- * MOUSE_DOWN = 2;
- * MOUSE_MOVE = 3;
- * MOUSE_UP = 4;
- * MOUSE_PRESS = 5;
- * MOUSE_RELEASE = 6;
- * MOUSE_RELEASE_OUTSIDE = 7;
- * MOUSE_ROLL_OUT = 8;
- * MOUSE_ROLL_OVER = 9;
- * MOUSE_WHEEL_UP = 10;
- * MOUSE_WHEEL_DOWN = 11;
- * Scaleforms that this works with:
- * *   COLOUR_SWITCHER\_02
- * *   MP_RESULTS_PANEL
- * *   MP_NEXT_JOB_SELECTION
- * *   SC_LEADERBOARD
- * Probably works with other scaleforms, needs more research.
- * In order to use this Native you MUST have controls 239, 240, 237, 238 enabled!
- * This native, due to its erroneous redundancy of the returned boolean value, works differently in C#: shifting the parameters (where `received` becomes `selectionType` and so on making the fourth parameter unused and always 0).
- * @param scaleformHandle Handle of the scaleform
- * @param received Returns a boolean indicating if the data was received successfully (in Lua).
- * @param selectionType The type of MouseEvent specified above.
- * @param context Context of the slot the mouse is hovering on.
- * @param slotIndex Index of the slot the mouse is hovering on.
- * @return *   **retVal** Returns true if MOUSE_EVENT callback from Scaleforms has been called.
- */
-declare function N_0x632b2940c67f4ea9(scaleformHandle: number): [boolean, any /* actually bool */, number, number, number];
-
 /**
  * GET_SCALEFORM_MOVIE_METHOD_RETURN_VALUE_BOOL
  * @param methodReturn Operation handle returned by [`END_SCALEFORM_MOVIE_METHOD_RETURN_VALUE`](#\_0xC50AA39A577AF886)
@@ -30816,11 +30898,6 @@ declare function N_0xbf22e0f32968e967(player: number, p1: boolean): void;
  */
 declare function N_0xbf371cd2b64212fd(p0: number): void;
 
-/**
- * 0xBF4F34A85CA2970C
- */
-declare function N_0xbf4f34a85ca2970c(): void;
-
 /**
  * 0xBF72910D0F26F025
  */
@@ -44435,15 +44512,19 @@ declare function SetBlipBright(blip: number, toggle: boolean): void;
  * 7 = "Other Players" category, also shows distance in legend
  * 10 = "Property" category
  * 11 = "Owned Property" category
+ * 12 - 133 = Custom named categories
+ * 134 - 254 = Custom unnamed categories
  * ```
- * Any other value behaves like `index = 1`, `index` wraps around after 255
- * Blips with categories `7`, `10` or `11` will all show under the specific categories listing in the map legend, regardless of sprite or name.
+ * `index` wraps around after 255.
+ * Blips with categories `7`, `10`, `11` or `12 - 254` (custom categories) will all show under the specific categories listing in the map legend, regardless of sprite or name.
  * **Legend entries**
  * | index | Legend entry | Label |
  * | --- | --- | --- |
  * | 7 | Other Players | `BLIP_OTHPLYR` |
  * | 10 | Property | `BLIP_PROPCAT` |
  * | 11 | Owned Property | `BLIP_APARTCAT` |
+ * | 12 - 133 | Custom categories (Named) | `BLIP_CAT_` + `index` |
+ * | 134 - 254 | Custom categories (Unnamed) | `-` |
  * @param blip The blip to change the category index of
  * @param index The category index to change to
  */
@@ -48996,19 +49077,19 @@ declare function SetMpGamerHealthBarDisplay(gamerTagId: number, toggle: boolean)
 
 /**
  * Should be enabled as component (2). Has 0 alpha by default.
- * @param gamerTagId a gamerTagId obtained using  for example: [CREATE_FAKE_MP_GAMER_TAG](https://runtime.fivem.net/doc/natives/?\_0xBFEFE3321A3F5015)
+ * @param gamerTagId a gamerTagId obtained using  for example: [CREATE_FAKE_MP_GAMER_TAG](https://docs.fivem.net/natives/?\_0xBFEFE3321A3F5015)
  * @param hudColorIndex a hud color index, see the full list here: [link](https://docs.fivem.net/docs/game-references/hud-colors/)
  */
 declare function SetMpGamerTagHealthBarColour(gamerTagId: number, hudColorIndex: number): void;
 /**
  * Should be enabled as component (2). Has 0 alpha by default.
- * @param gamerTagId a gamerTagId obtained using  for example: [CREATE_FAKE_MP_GAMER_TAG](https://runtime.fivem.net/doc/natives/?\_0xBFEFE3321A3F5015)
+ * @param gamerTagId a gamerTagId obtained using  for example: [CREATE_FAKE_MP_GAMER_TAG](https://docs.fivem.net/natives/?\_0xBFEFE3321A3F5015)
  * @param hudColorIndex a hud color index, see the full list here: [link](https://docs.fivem.net/docs/game-references/hud-colors/)
  */
 declare function N_0x3158c77a7e888ab4(gamerTagId: number, hudColorIndex: number): void;
 /**
  * Should be enabled as component (2). Has 0 alpha by default.
- * @param gamerTagId a gamerTagId obtained using  for example: [CREATE_FAKE_MP_GAMER_TAG](https://runtime.fivem.net/doc/natives/?\_0xBFEFE3321A3F5015)
+ * @param gamerTagId a gamerTagId obtained using  for example: [CREATE_FAKE_MP_GAMER_TAG](https://docs.fivem.net/natives/?\_0xBFEFE3321A3F5015)
  * @param hudColorIndex a hud color index, see the full list here: [link](https://docs.fivem.net/docs/game-references/hud-colors/)
  */
 declare function SetMpGamerTagHealthBarColor(gamerTagId: number, hudColorIndex: number): void;
@@ -57405,13 +57486,17 @@ declare function SetWantedLevelMultiplier(multiplier: number): void;
 declare function SetWarningMessage(entryLine1: string, instructionalKey: number, entryLine2: string, p3: boolean, p4: number, background: string, p6: string, showBg: boolean, errorCode: number): void;
 
 /**
- * Param names copied from the corresponding scaleform function "SET_LIST_ROW"
+ * SET_WARNING_MESSAGE_OPTION_ITEMS
  */
-declare function SetWarningMessageListRow(index: number, name: string, cash: number, rp: number, lvl: number, colour: number): boolean;
+declare function SetWarningMessageOptionItems(index: number, name: string, cash: number, rp: number, lvl: number, colour: number): boolean;
 /**
- * Param names copied from the corresponding scaleform function "SET_LIST_ROW"
+ * SET_WARNING_MESSAGE_OPTION_ITEMS
  */
 declare function N_0x0c5a80a9e096d529(index: number, name: string, cash: number, rp: number, lvl: number, colour: number): boolean;
+/**
+ * SET_WARNING_MESSAGE_OPTION_ITEMS
+ */
+declare function SetWarningMessageListRow(index: number, name: string, cash: number, rp: number, lvl: number, colour: number): boolean;
 
 /**
  * instructionalKey enum list:
@@ -59365,11 +59450,21 @@ declare function Cast_3dRayPointToPoint(x1: number, y1: number, z1: number, x2:
  * IntersectPeds = 4,
  * IntersectRagdolls = 8,
  * IntersectObjects = 16,
- * IntersectWater = 32,
+ * IntersectPickup = 32,
  * IntersectGlass = 64,
  * IntersectRiver = 128,
  * IntersectFoliage = 256,
- * IntersectEverything = -1
+ * IntersectEverything = 511
+ * }
+ * ```
+ * ```cpp
+ * enum eTraceOptionFlags
+ * {
+ * None = 0,
+ * OptionIgnoreGlass = 1,
+ * OptionIgnoreSeeThrough = 2,
+ * OptionIgnoreNoCollision = 4,
+ * OptionDefault = 7
  * }
  * ```
  * NOTE: Raycasts that intersect with mission_entites (flag = 2) has limited range and will not register for far away entites. The range seems to be about 30 metres.
@@ -59382,10 +59477,10 @@ declare function Cast_3dRayPointToPoint(x1: number, y1: number, z1: number, x2:
  * @param z2 Ending Z coordinate.
  * @param traceFlags Refer to `eTraceFlags`, this defines what the shape test will intersect with
  * @param entity An entity to ignore, or 0.
- * @param options A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
+ * @param optionFlags Refer to `eTraceOptionFlags`, this defines additional options for the shape test
  * @return A shape test handle.
  */
-declare function StartShapeTestLosProbe(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, traceFlags: number, entity: number, options: number): number;
+declare function StartShapeTestLosProbe(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, traceFlags: number, entity: number, optionFlags: number): number;
 /**
  * Asynchronously starts a line-of-sight (raycast) world probe shape test.
  * ```cpp
@@ -59397,11 +59492,21 @@ declare function StartShapeTestLosProbe(x1: number, y1: number, z1: number, x2:
  * IntersectPeds = 4,
  * IntersectRagdolls = 8,
  * IntersectObjects = 16,
- * IntersectWater = 32,
+ * IntersectPickup = 32,
  * IntersectGlass = 64,
  * IntersectRiver = 128,
  * IntersectFoliage = 256,
- * IntersectEverything = -1
+ * IntersectEverything = 511
+ * }
+ * ```
+ * ```cpp
+ * enum eTraceOptionFlags
+ * {
+ * None = 0,
+ * OptionIgnoreGlass = 1,
+ * OptionIgnoreSeeThrough = 2,
+ * OptionIgnoreNoCollision = 4,
+ * OptionDefault = 7
  * }
  * ```
  * NOTE: Raycasts that intersect with mission_entites (flag = 2) has limited range and will not register for far away entites. The range seems to be about 30 metres.
@@ -59414,10 +59519,10 @@ declare function StartShapeTestLosProbe(x1: number, y1: number, z1: number, x2:
  * @param z2 Ending Z coordinate.
  * @param traceFlags Refer to `eTraceFlags`, this defines what the shape test will intersect with
  * @param entity An entity to ignore, or 0.
- * @param options A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
+ * @param optionFlags Refer to `eTraceOptionFlags`, this defines additional options for the shape test
  * @return A shape test handle.
  */
-declare function N_0x7ee9f5d83dd4f90e(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, traceFlags: number, entity: number, options: number): number;
+declare function N_0x7ee9f5d83dd4f90e(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, traceFlags: number, entity: number, optionFlags: number): number;
 
 /**
  * Since it is only used in the PC version, likely some mouse-friendly shape test. Uses **in** vector arguments.

package/package.json

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