@citizenfx/client 2.0.5658-1 → 2.0.5668-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5434,6 +5434,7 @@ declare function EnableControlAction(padIndex: number, control: number, enable:
5434
5434
  declare function EnableCrosshairThisFrame(): void;
5435
5435
 
5436
5436
  /**
5437
+ * Enables or disables the specified 'dispatch service' type. 'Dispatch services' are used for spawning AI response peds/vehicles for events such as a fire in the street (type 3 - DT_FireDepartment), or gunfire in a gang area (type 11 - DT_Gangs).
5437
5438
  * List of dispatch services:
5438
5439
  * ```cpp
5439
5440
  * enum DispatchType
@@ -5456,9 +5457,13 @@ declare function EnableCrosshairThisFrame(): void;
5456
5457
  * DT_BikerBackup = 15
5457
5458
  * };
5458
5459
  * ```
5460
+ * Note that 'dispatch service' has nothing to do with the police scanner (audio), to toggle that, use [SET_AUDIO_FLAG](#\_0xB9EFD5C25018725A) with `'PoliceScannerDisabled'`.
5461
+ * @param dispatchService The ID of the dispatch service to toggle.
5462
+ * @param toggle True to enable the dispatch service, false to disable the dispatch service.
5459
5463
  */
5460
5464
  declare function EnableDispatchService(dispatchService: number, toggle: boolean): void;
5461
5465
  /**
5466
+ * Enables or disables the specified 'dispatch service' type. 'Dispatch services' are used for spawning AI response peds/vehicles for events such as a fire in the street (type 3 - DT_FireDepartment), or gunfire in a gang area (type 11 - DT_Gangs).
5462
5467
  * List of dispatch services:
5463
5468
  * ```cpp
5464
5469
  * enum DispatchType
@@ -5481,6 +5486,9 @@ declare function EnableDispatchService(dispatchService: number, toggle: boolean)
5481
5486
  * DT_BikerBackup = 15
5482
5487
  * };
5483
5488
  * ```
5489
+ * Note that 'dispatch service' has nothing to do with the police scanner (audio), to toggle that, use [SET_AUDIO_FLAG](#\_0xB9EFD5C25018725A) with `'PoliceScannerDisabled'`.
5490
+ * @param dispatchService The ID of the dispatch service to toggle.
5491
+ * @param toggle True to enable the dispatch service, false to disable the dispatch service.
5484
5492
  */
5485
5493
  declare function N_0xdc0f817884cdd856(dispatchService: number, toggle: boolean): void;
5486
5494
 
@@ -8394,18 +8402,20 @@ declare function GetGameBuildNumber(): number;
8394
8402
  declare function GetGameName(): string;
8395
8403
 
8396
8404
  /**
8397
- * Returns all pool handles for the given pool name; the data returned adheres to the following layout:
8398
- * ```
8405
+ * Returns a list of entity handles (script GUID) for all entities in the specified pool - the data returned is an array as
8406
+ * follows:
8407
+ * ```json
8399
8408
  * [ 770, 1026, 1282, 1538, 1794, 2050, 2306, 2562, 2818, 3074, 3330, 3586, 3842, 4098, 4354, 4610, ...]
8400
8409
  * ```
8401
- * ### Supported Pools
8402
- * **1**: CPed\
8403
- * **2**: CObject\
8404
- * **3**: CVehicle\
8405
- * **4**: CPickup
8406
- * @return An object containing a list of all pool handles
8410
+ * ### Supported pools
8411
+ * * `CPed`: Peds (including animals) and players.
8412
+ * * `CObject`: Objects (props), doors, and projectiles.
8413
+ * * `CVehicle`: Vehicles.
8414
+ * * `CPickup`: Pickups.
8415
+ * @param poolName The pool name to get a list of entities from.
8416
+ * @return An array containing entity handles for each entity in the named pool.
8407
8417
  */
8408
- declare function GetGamePool(poolname: string): any;
8418
+ declare function GetGamePool(poolName: string): any;
8409
8419
 
8410
8420
  declare function GetGameTimer(): number;
8411
8421
 
@@ -11350,21 +11360,21 @@ declare function GetResourceByFindIndex(findIndex: number): string;
11350
11360
  /**
11351
11361
  * A getter for [SET_RESOURCE_KVP_FLOAT](#\_0x9ADD2938).
11352
11362
  * @param key The key to fetch
11353
- * @return A float that contains the value stored in the Kvp or nil/null if none.
11363
+ * @return The floating-point value stored under the specified key, or 0.0 if not found.
11354
11364
  */
11355
11365
  declare function GetResourceKvpFloat(key: string): number;
11356
11366
 
11357
11367
  /**
11358
11368
  * A getter for [SET_RESOURCE_KVP_INT](#\_0x6A2B1E8).
11359
11369
  * @param key The key to fetch
11360
- * @return A int that contains the value stored in the Kvp or nil/null if none.
11370
+ * @return The integer value stored under the specified key, or 0 if not found.
11361
11371
  */
11362
11372
  declare function GetResourceKvpInt(key: string): number;
11363
11373
 
11364
11374
  /**
11365
11375
  * A getter for [SET_RESOURCE_KVP](#\_0x21C7A35B).
11366
11376
  * @param key The key to fetch
11367
- * @return A string that contains the value stored in the Kvp or nil/null if none.
11377
+ * @return The string value stored under the specified key, or nil/null if not found.
11368
11378
  */
11369
11379
  declare function GetResourceKvpString(key: string): string;
11370
11380
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@citizenfx/client",
3
- "version": "2.0.5658-1",
3
+ "version": "2.0.5668-1",
4
4
  "description": "Typings for the CitizenFX client JS API.",
5
5
  "main": "index.js",
6
6
  "scripts": {