@citizenfx/client 2.0.6243-1 → 2.0.6246-1

package/natives_universal.d.ts

@@ -4104,7 +4104,7 @@ declare function DeleteCheckpoint(checkpoint: number): void;
 declare function DeleteChildRope(ropeId: number): void;
 
 /**
- * Deletes the specified entity, then sets the handle pointed to by the pointer to NULL.
+ * Deletes the specified entity, and invalidates the passed handle (i.e. in/out argument).
  * @param entity The entity to delete.
  */
 declare function DeleteEntity(entity: number): void;
@@ -7806,12 +7806,9 @@ declare function GetDisabledControlUnboundNormal(padIndex: number, control: numb
 declare function N_0x4f8a26a890fd62fb(padIndex: number, control: number): number;
 
 /**
- * Returns model name of vehicle in all caps. Needs to be displayed through localizing text natives to get proper display name.
- * -----------------------------------------------------------------------------------------------------------------------------------------
- * While often the case, this does not simply return the model name of the vehicle (which could be hashed to return the model hash). Variations of the same vehicle may also use the same display name.
- * -----------------------------------------------------------------------------------------------------------------------------------------
- * Returns "CARNOTFOUND" if the hash doesn't match a vehicle hash.
- * Using HUD::_GET_LABEL_TEXT, you can get the localized name.
+ * Returns the display name/text label (`gameName` in `vehicles.meta`) for the specified vehicle model.
+ * @param modelHash A vehicle model to check.
+ * @return The display name for the vehicle, or `'CARNOTFOUND'` if invalid.
  */
 declare function GetDisplayNameFromVehicleModel(modelHash: string | number): string;
 
@@ -8188,9 +8185,9 @@ declare function GetEntityMatrix(entity: number): [number[], number[], number[],
 declare function GetEntityMaxHealth(entity: number): number;
 
 /**
- * Returns the model hash from the entity
+ * Returns the model hash from an entity.
  * @param entity The entity to get the model for.
- * @return The model hash from the entity.
+ * @return The model hash of the entity.
  */
 declare function GetEntityModel(entity: number): number;
 
@@ -14174,7 +14171,10 @@ declare function HasForceCleanupOccurred(cleanupFlags: number): boolean;
 declare function HasMinimapOverlayLoaded(id: number): boolean;
 
 /**
- * Checks if the specified model has loaded into memory.
+ * Returns whether the specified model (archetype) is currently loaded.
+ * Note that this will return 'true' even if the model has been requested and loaded by something other than the current script, if you're intending to actually use the model in a later frame, you should call REQUEST_MODEL anyway.
+ * @param model The model hash to check for.
+ * @return A boolean indicating whether the archetype is loaded (true) or not (false).
  */
 declare function HasModelLoaded(model: string | number): boolean;
 
@@ -26000,13 +26000,14 @@ declare function PlayerAttachVirtualBound(p0: number, p1: number, p2: number, p3
 declare function PlayerDetachVirtualBound(): void;
 
 /**
- * This returns YOUR 'identity' as a Player type.
- * Always returns 0 in story mode.
+ * Returns the player index for the local player.
+ * @return The local player's player index.
  */
 declare function PlayerId(): number;
 
 /**
- * Returns current player ped
+ * Returns the entity handle for the local player ped. Note that this entity handle will change after using commands such as SET_PLAYER_MODEL.
+ * @return The local player ped's entity handle.
  */
 declare function PlayerPedId(): number;
 
@@ -27479,7 +27480,8 @@ declare function N_0xa0261aef7acfc51e(model: string | number): void;
 declare function RequestMissionAudioBank(p0: string, p1: boolean): boolean;
 
 /**
- * Request a model to be loaded into memory.
+ * Request a model (archetype) to be loaded for use by the current script. Use SET_MODEL_AS_NO_LONGER_NEEDED when done using the model in script.
+ * @param model The model to request.
  */
 declare function RequestModel(model: string | number): void;
 
@@ -30159,11 +30161,9 @@ declare function SetEntityAnimCurrentTime(entity: number, animDictionary: string
 declare function SetEntityAnimSpeed(entity: number, animDictionary: string, animName: string, speedMultiplier: number): void;
 
 /**
- * Makes the specified entity (ped, vehicle or object) persistent. Persistent entities will not automatically be removed by the engine.
- * p1 has no effect when either its on or off
- * maybe a quick disassembly will tell us what it does
- * p2 has no effect when either its on or off
- * maybe a quick disassembly will tell us what it does
+ * Assigns an existing entity to be owned by the current script. If the entity was not owned by a script yet, this also means the entity will remain persistent until released.
+ * Note that this is not needed right after creating an entity as a script-created entity will automatically be assigned.
+ * @param entity An entity handle.
  */
 declare function SetEntityAsMissionEntity(entity: number, p1: boolean, p2: boolean): void;
 
@@ -31433,7 +31433,8 @@ declare function N_0x375a706a5c2fd084(toggle: boolean): void;
 declare function SetMobileRadioEnabledDuringGameplay(toggle: boolean): void;
 
 /**
- * Unloads model from memory
+ * Releases the script ownership assigned by REQUEST_MODEL. This command should be used when done using a specific model hash in script.
+ * @param model The model to release ownership of.
  */
 declare function SetModelAsNoLongerNeeded(model: string | number): void;
 
@@ -34186,10 +34187,10 @@ declare function SetPlayerMeleeWeaponDamageModifier(player: number, modifier: nu
 declare function SetPlayerMeleeWeaponDefenseModifier(player: number, modifier: number): void;
 
 /**
- * Set the model for a specific Player. Be aware that this will destroy the current Ped for the Player and create a new one, any reference to the old ped should be reset
- * Make sure to request the model first and wait until it has loaded.
+ * Set the model for a specific Player. Note that this will destroy the current Ped for the Player and create a new one, any reference to the old ped will be invalid after calling this.
+ * As per usual, make sure to request the model first and wait until it has loaded.
  * @param player The player to set the model for
- * @param model The hash of the model to use
+ * @param model The model to use
  */
 declare function SetPlayerModel(player: number, model: string | number): void;
 

package/package.json

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