@citizenfx/server 2.0.14033-1 → 2.0.14111-1

package/natives_server.d.ts

@@ -418,7 +418,7 @@ declare function EndFindKvp(handle: number): void;
 declare function EnsureEntityStateBag(entity: number): 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;
 
@@ -536,6 +536,38 @@ declare function GetCurrentPedWeapon(ped: number): number;
  */
 declare function GetCurrentResourceName(): 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;
+
 /**
  * Gets the entity that this entity is attached to.
  * @param entity The entity to check.

package/package.json

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