@citizenfx/client 2.0.5834-1 → 2.0.5837-1

package/natives_universal.d.ts

@@ -144,7 +144,8 @@ declare function N_0xce5d0e5e315db238(x: number, y: number, z: number, width: nu
 declare function AddBlipForCoord(x: number, y: number, z: number): number;
 
 /**
- * Create a blip that for default is red (enemy), you can use the [SET_BLIP_AS_FRIENDLY](#\_0xC6F43D0E) to make it blue (friend)
+ * Create a blip that by default is red (enemy), you can use [SET_BLIP_AS_FRIENDLY](#\_0xC6F43D0E) to make it blue (friend).\
+ * Can be used for objects, vehicles and peds.
  * Example of enemy:
  * ![enemy](https://i.imgur.com/fl78svv.png)
  * Example of friend:
@@ -3143,18 +3144,20 @@ declare function CreateAmbientPickup(pickupHash: string | number, posX: number,
 declare function CreateAudioSubmix(name: string): number;
 
 /**
- * Create a camera with the specified cam name, You can use `SET_CAM_` natives to manipulate the camera.
- * Cam names:
- * ```
- * "DEFAULT_SCRIPTED_CAMERA"
- * "DEFAULT_ANIMATED_CAMERA"
- * "DEFAULT_SPLINE_CAMERA"
- * "DEFAULT_SCRIPTED_FLY_CAMERA"
- * "TIMED_SPLINE_CAMERA"
- * ```
- * @param camName Is the type of the camera, is always setted to `DEFAULT_SCRIPTED_CAMERA` in Rockstar scripts and in Fivem Forum Posts
- * @param active Unkown, is always setted to `true` in Rockstar scripts and in Fivem Forum Posts
- * @return A camera handle.
+ * Creates a camera with the specified cam name, You can use `SET_CAM_` natives to manipulate the camera.\
+ * Make sure to call [RENDER_SCRIPT_CAMS](#\_0x07E5B515DB0636FC) once the camera is created, or this won't have any visible effect.
+ * ### Camera names:
+ * *   DEFAULT_SCRIPTED_CAMERA
+ * *   DEFAULT_ANIMATED_CAMERA
+ * *   DEFAULT_SPLINE_CAMERA
+ * *   DEFAULT_SCRIPTED_FLY_CAMERA
+ * *   TIMED_SPLINE_CAMERA
+ * *   CUSTOM_TIMED_SPLINE_CAMERA
+ * *   ROUNDED_SPLINE_CAMERA
+ * *   SMOOTHED_SPLINE_CAMERA
+ * @param camName A string representing the camera type, the game will convert the string into a joaat hash upon native execution.
+ * @param active Set to true if you wish to make this new camera the active camera.
+ * @return A camera handle referencing the camera that was created.
  */
 declare function CreateCam(camName: string, active: boolean): number;
 
@@ -3513,7 +3516,7 @@ declare function CreatePortablePickup_2(pickupHash: string | number, x: number,
  * @param isNetwork Whether to create a network object for the object. If false, the object exists only locally.
  * @param netMissionEntity Whether to register the object as pinned to the script host in the R\* network model.
  * @param doorFlag False to create a door archetype (archetype flag bit 26 set) as a door. Required to be set to true to create door models in network mode.
- * @return A script handle for the object, or `0` if the object failed to be created.
+ * @return A script handle (fwScriptGuid index) for the object, or `0` if the object failed to be created.
  */
 declare function CreateObject(modelHash: string | number, x: number, y: number, z: number, isNetwork: boolean, netMissionEntity: boolean, doorFlag: boolean): number;
 
@@ -10502,24 +10505,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). 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;
-
 /**
  * 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_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 N_0x76bba2cee66d47e9(ped: number): number;
+declare function GetPedEyeColor(ped: number): number;
 
 /**
  * A getter for [\_SET_PED_FACE_FEATURE](#\_0x71A5C1DBA060049E). Returns 0.0 if fails to get.
@@ -22876,8 +22879,8 @@ declare function NetworkGetNumParticipantsHost(): number;
 
 /**
  * Get the network id of the given entity
- * An entity network id is representing a given entity for other clients, is like a handle that every client recognize, can be reconverted to a client entity handle.
- * These can and will be reused, the network id will not change.
+ * An entity network id represents a given entity for other clients, it's a handle shared between clients, can be reconverted to a client entity handle.\
+ * These (entity network IDs) can and will be reused, the network id will not change.
  * If you need to refer to an entity across machines (clients, or the server), you should use its network id.
  * Read more at [Network and local IDs](https://docs.fivem.net/docs/scripting-manual/networking/ids/)
  * @param entity the handle of the entity from which the network id should be taken
@@ -28892,8 +28895,9 @@ declare function SetBitsInRange(rangeStart: number, rangeEnd: number, p3: number
 declare function SetBlipAlpha(blip: number, alpha: number): void;
 
 /**
- * false for enemy
- * true for friendly
+ * Allows the user to set a blip as friendly or enemy based on the toggle.
+ * @param blip The blip handle
+ * @param toggle True for friendly, false for enemy
  */
 declare function SetBlipAsFriendly(blip: number, toggle: boolean): void;
 

package/package.json

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