@citizenfx/client 2.0.6550-1 → 2.0.6552-1

package/natives_universal.d.ts

@@ -1749,7 +1749,7 @@ declare function AttachCamToEntity(cam: number, entity: number, xOffset: number,
 /**
  * ATTACH_CAM_TO_PED_BONE
  */
-declare function AttachCamToPedBone(cam: number, ped: number, boneIndex: number, x: number, y: number, z: number, heading: boolean): void;
+declare function AttachCamToPedBone(cam: number, ped: number, boneIndex: number, xOffset: number, yOffset: number, zOffset: number, isRelative: boolean): void;
 
 /**
  * NativeDB Introduced: v1180
@@ -1844,9 +1844,9 @@ declare function AttachEntityToCargobob(vehicle: number, entity: number, p2: num
  * @param collision Controls collision between the two entities (FALSE disables collision).
  * @param isPed Pitch doesnt work when false and roll will only work on negative numbers (only peds)
  * @param rotationOrder The order in which the rotation is applied. See [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
- * @param fixedRot If false it ignores entity vector.
+ * @param syncRot If false it ignores entity rotation.
  */
-declare function AttachEntityToEntity(entity1: number, entity2: number, boneIndex: number, xPos: number, yPos: number, zPos: number, xRot: number, yRot: number, zRot: number, p9: boolean, useSoftPinning: boolean, collision: boolean, isPed: boolean, rotationOrder: number, fixedRot: boolean): void;
+declare function AttachEntityToEntity(entity1: number, entity2: number, boneIndex: number, xPos: number, yPos: number, zPos: number, xRot: number, yRot: number, zRot: number, p9: boolean, useSoftPinning: boolean, collision: boolean, isPed: boolean, rotationOrder: number, syncRot: boolean): void;
 
 /**
  * breakForce is the amount of force required to break the bond.
@@ -2283,19 +2283,13 @@ declare function BeginTextCommandIsMessageDisplayed(text: string): void;
 declare function N_0x853648fd1063a213(text: string): void;
 
 /**
- * BOOL IsContextActive(char *ctx)
- * {
- * BEGIN_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED(ctx);
- * return END_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED(0);
- * }
+ * BEGIN_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED
+ * @param labelName Text entry name. This can be created using [`AddTextEntry`](#\_0x32CA01C3).
  */
 declare function BeginTextCommandIsThisHelpMessageBeingDisplayed(labelName: string): void;
 /**
- * BOOL IsContextActive(char *ctx)
- * {
- * BEGIN_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED(ctx);
- * return END_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED(0);
- * }
+ * BEGIN_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED
+ * @param labelName Text entry name. This can be created using [`AddTextEntry`](#\_0x32CA01C3).
  */
 declare function N_0x0a24da3a41b718f5(labelName: string): void;
 
@@ -3257,8 +3251,8 @@ declare function ClearAllBrokenGlass(): void;
 declare function ClearAllHelpMessages(): void;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * CLEAR_ALL_PED_PROPS
+ * @param ped The ped handle.
  */
 declare function ClearAllPedProps(ped: number): void;
 
@@ -3313,9 +3307,14 @@ declare function N_0x957838aaf91bd12d(x: number, y: number, z: number, radius: n
 declare function ClearAreaOfEverything(x: number, y: number, z: number, radius: number, p4: boolean, p5: boolean, p6: boolean, p7: boolean): void;
 
 /**
- * flags appears to always be 0
+ * Clears an area of cops at the given coordinates and radius.
+ * @param x The x coordinate of where to clear cops.
+ * @param y The y coordinate of where to clear cops.
+ * @param z The z coordinate of where to clear cops.
+ * @param radius The area radius to clear cops.
+ * @param createNetEvent specifies whether a `CClearAreaEvent` event of should be created for online use.
  */
-declare function ClearAreaOfCops(x: number, y: number, z: number, radius: number, flags: number): void;
+declare function ClearAreaOfCops(x: number, y: number, z: number, radius: number, createNetEvent: boolean): void;
 
 /**
  * I looked through the PC scripts that this site provides you with a link to find. It shows the last param mainly uses, (0, 2, 6, 16, and 17) so I am going to assume it is a type of flag.
@@ -3323,14 +3322,24 @@ declare function ClearAreaOfCops(x: number, y: number, z: number, radius: number
 declare function ClearAreaOfObjects(x: number, y: number, z: number, radius: number, flags: number): void;
 
 /**
- * Example:       CLEAR_AREA_OF_PEDS(0, 0, 0, 10000, 1);
+ * Clears an area of peds at the given coordinates and radius.
+ * @param x The x coordinate of where to clear peds.
+ * @param y The y coordinate of where to clear peds.
+ * @param z The z coordinate of where to clear peds.
+ * @param radius The area radius to clear peds.
+ * @param createNetEvent specifies whether a `CClearAreaEvent` event of should be created for online use.
  */
-declare function ClearAreaOfPeds(x: number, y: number, z: number, radius: number, flags: number): void;
+declare function ClearAreaOfPeds(x: number, y: number, z: number, radius: number, createNetEvent: boolean): void;
 
 /**
- * CLEAR_AREA_OF_PROJECTILES
+ * Clears an area of projectiles at the given coordinates and radius.
+ * @param x The x coordinate of where to clear projectiles.
+ * @param y The y coordinate of where to clear projectiles.
+ * @param z The z coordinate of where to clear projectiles.
+ * @param radius The area radius to clear projectiles.
+ * @param createNetEvent specifies whether a `CClearAreaEvent` event of should be created for online use.
  */
-declare function ClearAreaOfProjectiles(x: number, y: number, z: number, radius: number, flags: number): void;
+declare function ClearAreaOfProjectiles(x: number, y: number, z: number, radius: number, createNetEvent: boolean): void;
 
 /**
  * Example: 		CLEAR_AREA_OF_VEHICLES(0, 0, 0, 10000, false, false, false, false, false);
@@ -3656,8 +3665,9 @@ declare function ClearPedParachutePackVariation(ped: number): void;
 declare function N_0x1280804f7cfd2d6c(ped: number): void;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * CLEAR_PED_PROP
+ * @param ped The ped handle.
+ * @param propId The prop id you want to clear from the ped. Refer to [SET_PED_PROP_INDEX](#\_0x93376B65A266EB5F).
  */
 declare function ClearPedProp(ped: number, propId: number): void;
 
@@ -4228,8 +4238,7 @@ declare function CreateAirDefenseSphere(x: number, y: number, z: number, radius:
 declare function N_0x91ef34584710be99(x: number, y: number, z: number, radius: number, p4: number, p5: number, p6: number, weaponHash: string | number): number;
 
 /**
- * Used for doing money drop
- * Pickup hashes: pastebin.com/8EuSv2r1
+ * Creates an ambient pickup given the hash. Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
  */
 declare function CreateAmbientPickup(pickupHash: string | number, posX: number, posY: number, posZ: number, flags: number, value: number, modelHash: string | number, returnHandle: boolean, p8: boolean): number;
 
@@ -4260,14 +4269,8 @@ declare function CreateCam(camName: string, active: boolean): number;
 
 /**
  * Create a camera with the specified cam name/type, You can use `SET_CAM_` natives to manipulate the camera.
- * Camera names found in the b617d scripts:
- * ```
- * "DEFAULT_ANIMATED_CAMERA"
- * "DEFAULT_SCRIPTED_CAMERA"
- * "DEFAULT_SCRIPTED_FLY_CAMERA"
- * "DEFAULT_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
+ * Take a look at [CREATE_CAM](#\_0xC3981DCE61D9E13F) if you would like to see the available camera names.
+ * @param camName A string representing the camera type, the game will convert the string into a joaat hash upon native execution.
  * @param posX The x position of the camera (you can also send a vector3 instead of the bulk coordinates)
  * @param posY The y position of the camera (you can also send a vector3 instead of the bulk coordinates)
  * @param posZ The z position of the camera (you can also send a vector3 instead of the bulk coordinates)
@@ -4275,6 +4278,8 @@ declare function CreateCam(camName: string, active: boolean): number;
  * @param rotY The y rotation of the camera
  * @param rotZ The z rotation of the camera
  * @param fov The Field Of View of the camera, is the observable world that is seen
+ * @param active Set to true if you wish to make this new camera the active camera.
+ * @param rotationOrder The order of rotation, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
  * @return A camera handle.
  */
 declare function CreateCamWithParams(camName: string, posX: number, posY: number, posZ: number, rotX: number, rotY: number, rotZ: number, fov: number, active: boolean, rotationOrder: number): number;
@@ -4287,7 +4292,7 @@ declare function CreateCamera(camHash: string | number, active: boolean): number
 /**
  * CAM::\_GET_GAMEPLAY_CAM_COORDS can be used instead of posX,Y,Z\
  * CAM::\_GET_GAMEPLAY_CAM_ROT can be used instead of rotX,Y,Z\
- * CAM::\_80EC114669DAEFF4() can be used instead of p7 (Possible p7 is FOV parameter. )\
+ * CAM::\_GET_FINAL_RENDERED_CAM_FOV can be used instead of p7 (Possible p7 is FOV parameter. )\
  * rotationOrder is 2 usually
  */
 declare function CreateCameraWithParams(camHash: string | number, posX: number, posY: number, posZ: number, rotX: number, rotY: number, rotZ: number, fov: number, active: boolean, rotationOrder: number): number;
@@ -4466,13 +4471,19 @@ declare function CreateIncidentWithEntity(dispatchService: number, ped: number,
 declare function CreateItemset(distri: boolean): number;
 
 /**
- * Train models must be [requested](#\_0x963D27A58DF860AC) before use. See trains.xml for freight and metro variations.
+ * Train models must be [requested](#\_0x963D27A58DF860AC) before use. See trains.xml (located in `Grand Theft Auto V\update\update.rpf\common\data\levels\gta5\trains.xml`) for freight and metro variations.
+ * Model names to request can be found by searching `model_name` in the file.
+ * The `Lua` usage example provided down below has been provided in such way so users can test each and every train variation.
+ * ### Newly added parameters (seen in 2372 build)
  * ```
- * NativeDB Added Parameter 6: Any p5
- * NativeDB Added Parameter 7: Any p6
+ * NativeDB Added Parameter 6: BOOL isNetwork
+ * NativeDB Added Parameter 7: BOOL netMissionEntity
  * ```
+ * *   **isNetwork**: Whether to create a network object for the train. If false, the train exists only locally.
+ * *   **netMissionEntity**: Whether to register the train as pinned to the script host in the R\* network model.
  * ### Train Models:
  * *   freight
+ * ### Carriage Models:
  * *   freightcar
  * *   freightcar2 (Added v2372)
  * *   freightcont1
@@ -4480,6 +4491,16 @@ declare function CreateItemset(distri: boolean): number;
  * *   freightgrain
  * *   metrotrain
  * *   tankercar
+ * ### Some train variations (default from trains.xml as of build 2372)
+ * *   17. Very long train and freight variation.
+ * *   18. Freight train only.
+ * *   25. Double metro train (with both models flipped opposite to each other). This used to be `24` before the 2372 build.
+ * @param variation The variation id, these can range from 0 to 25 as of build 2372.
+ * @param x Spawn coordinate X component.
+ * @param y Spawn coordinate Y component.
+ * @param z Spawn coordinate Z component.
+ * @param direction The direction in which the train will go (true or false)
+ * @return A script handle (fwScriptGuid index) for the train, or 0 if the train failed to be created.
  */
 declare function CreateMissionTrain(variation: number, x: number, y: number, z: number, direction: boolean): number;
 
@@ -4734,7 +4755,7 @@ declare function CreatePickUpRopeForCargobob(cargobob: number, state: number): v
 declare function EnableCargobobHook(cargobob: number, state: number): void;
 
 /**
- * Pickup hashes: pastebin.com/8EuSv2r1
+ * Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
  */
 declare function CreatePickup(pickupHash: string | number, posX: number, posY: number, posZ: number, p4: number, value: number, p6: boolean, modelHash: string | number): number;
 
@@ -4747,7 +4768,7 @@ declare function CreatePickup(pickupHash: string | number, posX: number, posY: n
 declare function CreatePickupRotate(pickupHash: string | number, posX: number, posY: number, posZ: number, rotX: number, rotY: number, rotZ: number, flag: number, amount: number, p9: number, p10: boolean, modelHash: string | number): number;
 
 /**
- * Pickup hashes: pastebin.com/8EuSv2r1
+ * Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
  */
 declare function CreatePortablePickup(pickupHash: string | number, x: number, y: number, z: number, placeOnGround: boolean, modelHash: string | number): number;
 
@@ -5535,7 +5556,7 @@ declare function DeleteFunctionReference(referenceIdentity: string): void;
 declare function DeleteIncident(incidentId: number): void;
 
 /**
- * DELETE_MISSION_TRAIN
+ * Used to delete mission trains created with [`CREATE_MISSION_TRAIN`](#\_0x63C6CCA8E68AE8C8).
  */
 declare function DeleteMissionTrain(train: number): void;
 
@@ -5877,7 +5898,8 @@ declare function DisablePlaneAileron(vehicle: number, p1: boolean, p2: boolean):
 declare function DisablePlayerFiring(player: number, toggle: boolean): void;
 
 /**
- * DISABLE_PLAYER_VEHICLE_REWARDS
+ * Disables vehicle rewards for the current frame.
+ * @param player The player to disable rewards
  */
 declare function DisablePlayerVehicleRewards(player: number): void;
 
@@ -6205,7 +6227,9 @@ declare function DoesBlipHaveGpsRoute(blip: number): boolean;
 declare function N_0xdd2238f57b977751(blip: number): boolean;
 
 /**
- * Returns whether or not the passed camera handle exists.
+ * Looks up a camera handle in the current camera pool and returns `true` if the handle is found, otherwise it returns `false`.
+ * @param cam The camera handle to look for.
+ * @return A boolean value representing whether the camera exists or not.
  */
 declare function DoesCamExist(cam: number): boolean;
 
@@ -6333,11 +6357,11 @@ declare function DoesPickupExist(pickup: number): boolean;
 declare function DoesPickupObjectExist(pickupObject: number): boolean;
 
 /**
- * Pickup hashes: pastebin.com/8EuSv2r1
+ * Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
  */
 declare function DoesPickupOfTypeExistInArea(pickupHash: string | number, x: number, y: number, z: number, radius: number): boolean;
 /**
- * Pickup hashes: pastebin.com/8EuSv2r1
+ * Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
  */
 declare function IsPickupWithinRadius(pickupHash: string | number, x: number, y: number, z: number, radius: number): boolean;
 
@@ -6816,9 +6840,19 @@ declare function DoorSystemSetSpringRemoved(doorHash: string | number, removed:
 declare function N_0xc485e07e4f0b7958(doorHash: string | number, removed: boolean, requestDoor: boolean, forceUpdate: boolean): void;
 
 /**
- * NativeDB Introduced: v1290
+ * Must be called each frame, will play at specified position on screen when called with [`_PLAY_BINK_MOVIE`](#\_0x70D2CC8A542A973C)
+ * @param binkMovie The movie to be drawn (from [`_SET_BINK_MOVIE`](#\_0x338D9F609FD632DB)).
+ * @param posX The centered x position of the movie (0.0 - 1.0).
+ * @param posY The centered y position of the movie (0.0 - 1.0).
+ * @param scaleX The x scale of the movie (0.0 - 1.0).
+ * @param scaleY The y scale of the movie (0.0 - 1.0).
+ * @param rotation The rotation of the movie (0.0 - 360.0).
+ * @param r The red value of the movie (0 - 255).
+ * @param g The green value of the movie (0 - 255).
+ * @param b The blue value of the movie (0 - 255).
+ * @param a The alpha value of the movie (0 - 255).
  */
-declare function DrawBinkMovie(binkMovie: number, p1: number, p2: number, p3: number, p4: number, p5: number, r: number, g: number, b: number, a: number): void;
+declare function DrawBinkMovie(binkMovie: number, posX: number, posY: number, scaleX: number, scaleY: number, rotation: number, r: number, g: number, b: number, a: number): void;
 
 /**
  * x,y,z = start pos
@@ -7296,6 +7330,19 @@ declare function EjectJb700Roof(vehicle: number, x: number, y: number, z: number
  */
 declare function N_0xe38cb9d7d39fdbcc(vehicle: number, x: number, y: number, z: number): void;
 
+/**
+ * Will disable a plane or a helicopter's need to swerve around object in its heightmap when using TASK_PLANE_MISSION or other AI / Pilot behavior.  Will ensure plane flys directly to it's destination or die trying! This native does NOT need to be called every frame, but instead, just called once on the vehicle (NOT THE PED) you're trying to disable avoidance for!
+ * @param vehicle The vehicle handle to toggle obstacle avoidance for.
+ * @param avoidObstacles `true` / `false` to enable/disable heightmap obstacle avoidance respectively!
+ */
+declare function EnableAircraftObstacleAvoidance(vehicle: number, avoidObstacles: boolean): void;
+/**
+ * Will disable a plane or a helicopter's need to swerve around object in its heightmap when using TASK_PLANE_MISSION or other AI / Pilot behavior.  Will ensure plane flys directly to it's destination or die trying! This native does NOT need to be called every frame, but instead, just called once on the vehicle (NOT THE PED) you're trying to disable avoidance for!
+ * @param vehicle The vehicle handle to toggle obstacle avoidance for.
+ * @param avoidObstacles `true` / `false` to enable/disable heightmap obstacle avoidance respectively!
+ */
+declare function N_0x8aa9180de2fedd45(vehicle: number, avoidObstacles: boolean): void;
+
 /**
  * Creates a motion-blur sort of effect, this native does not seem to work, however by using the [`START_SCREEN_EFFECT`](#\_0x2206BF9A37B7F724) native with `"DrugsMichaelAliensFight"` as the effect parameter, you should be able to get the effect.
  * This native does not seem to work, however by using the [START_SCREEN_EFFECT](https://runtime.fivem.net/doc/natives/#\_0x2206BF9A37B7F724) native with "DrugsMichaelAliensFight" as the effect parameter, you should be able to get the effect.
@@ -7317,11 +7364,35 @@ declare function N_0x9dce1f0f78260875(toggle: boolean): void;
 declare function EnableAllControlActions(padIndex: number): void;
 
 /**
- * Creates cartoon effect when Michel smokes the weed
+ * If true, this native will create purple explosions upon projectile impact, add comic-like PTFX when firing a weapon, create a sound on bullet impact and have its own "blood effect".
+ * If the PTFX asset "scr_rcbarry2" is not requested using ([`RequestNamedPtfxAsset`](#\_0xD821490579791273)) then this native **will not work as intended**.
+ * Excerpt from fm_content_drug_lab_work.c:
+ * ```
+ * STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_rcbarry2");
+ * if (STREAMING::HAS_NAMED_PTFX_ASSET_LOADED("scr_rcbarry2"))
+ * {
+ * GRAPHICS::ENABLE_CLOWN_BLOOD_VFX(true);
+ * AUDIO::START_AUDIO_SCENE("DLC_CM2022_DRUG_TRIP_SPRINKLERS_SCENE");
+ * func_720(26);
+ * }
+ * ```
+ * @param toggle Whether to toggle the clown VFX on or off.
  */
 declare function EnableClownBloodVfx(toggle: boolean): void;
 /**
- * Creates cartoon effect when Michel smokes the weed
+ * If true, this native will create purple explosions upon projectile impact, add comic-like PTFX when firing a weapon, create a sound on bullet impact and have its own "blood effect".
+ * If the PTFX asset "scr_rcbarry2" is not requested using ([`RequestNamedPtfxAsset`](#\_0xD821490579791273)) then this native **will not work as intended**.
+ * Excerpt from fm_content_drug_lab_work.c:
+ * ```
+ * STREAMING::REQUEST_NAMED_PTFX_ASSET("scr_rcbarry2");
+ * if (STREAMING::HAS_NAMED_PTFX_ASSET_LOADED("scr_rcbarry2"))
+ * {
+ * GRAPHICS::ENABLE_CLOWN_BLOOD_VFX(true);
+ * AUDIO::START_AUDIO_SCENE("DLC_CM2022_DRUG_TRIP_SPRINKLERS_SCENE");
+ * func_720(26);
+ * }
+ * ```
+ * @param toggle Whether to toggle the clown VFX on or off.
  */
 declare function SetCameraEndtime(toggle: boolean): void;
 
@@ -7676,18 +7747,18 @@ declare function N_0xfcc75460aba29378(): void;
 
 /**
  * END_TEXT_COMMAND_DISPLAY_HELP
- * @param shape 0 for a normal rectangle shape, 1-2 has rounded edges.
- * @param loop if this is true, the message will stay forever unless you call ClearHelp
- * @param beep if this is true, the beeping sound will play
- * @param duration duration in ms of how long this help message should display for. -1 for default
+ * @param shape 0 for a normal rectangle shape, 1 and 2 has rounded edges, and can be used for floating help text hud component `FLOATING_HELP_TEXT_1` and `FLOATING_HELP_TEXT_2`. Use 1 for `FLOATING_HELP_TEXT_1` and 2 for `FLOATING_HELP_TEXT_2`, otherwise the help text will be reset to a normal help text on the top left corner on your screen.
+ * @param loop If this is true, the message will stay forever unless you call [`CLEAR_ALL_HELP_MESSAGES`](#\_0x6178F68A87A4D3A0).
+ * @param beep If this is true, the beeping sound will play. Beeping sound name is `INFO` in sound set `HUD_FRONTEND_DEFAULT_SOUNDSET`.
+ * @param duration Duration in ms of how long this help message should display for. -1 for default.
  */
 declare function EndTextCommandDisplayHelp(shape: number, loop: boolean, beep: boolean, duration: number): void;
 /**
  * END_TEXT_COMMAND_DISPLAY_HELP
- * @param shape 0 for a normal rectangle shape, 1-2 has rounded edges.
- * @param loop if this is true, the message will stay forever unless you call ClearHelp
- * @param beep if this is true, the beeping sound will play
- * @param duration duration in ms of how long this help message should display for. -1 for default
+ * @param shape 0 for a normal rectangle shape, 1 and 2 has rounded edges, and can be used for floating help text hud component `FLOATING_HELP_TEXT_1` and `FLOATING_HELP_TEXT_2`. Use 1 for `FLOATING_HELP_TEXT_1` and 2 for `FLOATING_HELP_TEXT_2`, otherwise the help text will be reset to a normal help text on the top left corner on your screen.
+ * @param loop If this is true, the message will stay forever unless you call [`CLEAR_ALL_HELP_MESSAGES`](#\_0x6178F68A87A4D3A0).
+ * @param beep If this is true, the beeping sound will play. Beeping sound name is `INFO` in sound set `HUD_FRONTEND_DEFAULT_SOUNDSET`.
+ * @param duration Duration in ms of how long this help message should display for. -1 for default.
  */
 declare function DisplayHelpTextFromStringLabel(shape: number, loop: boolean, beep: boolean, duration: number): void;
 
@@ -7731,13 +7802,33 @@ declare function EndTextCommandIsMessageDisplayed(): boolean;
 declare function N_0x8a9ba1ab3e237613(): boolean;
 
 /**
- * END_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED
+ * Returns whether a specific help message is being displayed or not.
+ * ```cpp
+ * enum HudIndexes {
+ * HELP_TEXT = 0,
+ * FLOATING_HELP_TEXT_1 = 1,
+ * FLOATING_HELP_TEXT_2 = 2,
+ * }
+ * ```
+ * @param hudIndex The hud index for help message.
+ * @return `true`: Indicates if the specific help message has been displayed.\
+`false`: Indicates that the specific help message is still being displayed.
  */
-declare function EndTextCommandIsThisHelpMessageBeingDisplayed(p0: number): boolean;
+declare function EndTextCommandIsThisHelpMessageBeingDisplayed(hudIndex: number): boolean;
 /**
- * END_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED
+ * Returns whether a specific help message is being displayed or not.
+ * ```cpp
+ * enum HudIndexes {
+ * HELP_TEXT = 0,
+ * FLOATING_HELP_TEXT_1 = 1,
+ * FLOATING_HELP_TEXT_2 = 2,
+ * }
+ * ```
+ * @param hudIndex The hud index for help message.
+ * @return `true`: Indicates if the specific help message has been displayed.\
+`false`: Indicates that the specific help message is still being displayed.
  */
-declare function N_0x10bddbfc529428dd(p0: number): boolean;
+declare function N_0x10bddbfc529428dd(hudIndex: number): boolean;
 
 /**
  * END_TEXT_COMMAND_*
@@ -9477,8 +9568,8 @@ declare function GetBlipRotation(blip: number): number;
 declare function N_0x003e92ba477f9d7f(blip: number): number;
 
 /**
- * Blips Images + IDs:
- * gtaxscripting.blogspot.com/2016/05/gta-v-blips-id-and-image.html
+ * Gets the sprite id of the specified blip. Blip sprite ids and images can be found [here](https://docs.fivem.net/docs/game-references/blips/).
+ * @param blip The blip handle.
  */
 declare function GetBlipSprite(blip: number): number;
 
@@ -9622,7 +9713,10 @@ declare function GetCamNearClip(cam: number): number;
 declare function GetCamNearDof(cam: number): number;
 
 /**
- * The last parameter, as in other "ROT" methods, is usually 2.
+ * Gets a camera's rotation by handle (`cam`) lookup, outputs a `Vector3` in degrees.
+ * @param cam The camera handle.
+ * @param rotationOrder The order of rotation, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
+ * @return A `Vector3` representing the camera rotation in degrees.
  */
 declare function GetCamRot(cam: number, rotationOrder: number): number[];
 
@@ -10058,17 +10152,22 @@ declare function GetConvar(varName: string, default_: string): string;
 declare function GetConvarInt(varName: string, default_: number): number;
 
 /**
- * ```
+ * Returns the convertible state of the specified vehicle.
+ * ```cpp
  * enum RoofState
  * {
- * ROOFSTATE_UP = 0;
- * ROOFSTATE_LOWERING,
- * ROOFSTATE_DOWN,
- * ROOFSTATE_RAISING
+ * ROOFSTATE_UP = 0,
+ * ROOFSTATE_LOWERING = 1,
+ * ROOFSTATE_DOWN = 2,
+ * ROOFSTATE_RAISING = 3
  * };
  * ```
- * Got a "6" return value but not sure about what the value means
- * 6 -> unknown (Stopped but not fully open ?)
+ * @param vehicle Vehicle to get the state of
+ * @return *   0 when closed/up, the vehicle is not a convertible or the vehicle is null/not provided
+*   1 when closing
+*   2 when open/down
+*   3 when opening
+*   6 unknown/unverified -- possibly stopped but not full open
  */
 declare function GetConvertibleRoofState(vehicle: number): number;
 
@@ -11190,7 +11289,8 @@ declare function GetForcedProp(componentHash: string | number, forcedPropIndex:
 declare function N_0xe1ca84ebf72e691d(componentHash: string | number, forcedPropIndex: number): [number, number, number];
 
 /**
- * GET_FRAME_COUNT
+ * Gets the number of the current frame being displayed.
+ * @return The number of the current frame being displayed.
  */
 declare function GetFrameCount(): number;
 
@@ -11283,16 +11383,10 @@ declare function GetGameplayCamRelativeHeading(): number;
 declare function GetGameplayCamRelativePitch(): number;
 
 /**
- * p0 dosen't seem to change much, I tried it with 0, 1, 2:
- * 0-Pitch(X): -70.000092
- * 0-Roll(Y): -0.000001
- * 0-Yaw(Z): -43.886459
- * 1-Pitch(X): -70.000092
- * 1-Roll(Y): -0.000001
- * 1-Yaw(Z): -43.886463
- * 2-Pitch(X): -70.000092
- * 2-Roll(Y): -0.000002
- * 2-Yaw(Z): -43.886467
+ * This function takes a rotation order and outputs a `Vector3` in degrees.
+ * It first calls a game function to calculate these values given the rotation order and effectively multiplies those values by `180/PI`, hence degrees since the function it calls outputs radians which are then converted to degrees.
+ * @param rotationOrder The order of rotation, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
+ * @return A `Vector3` representing the gameplay camera rotation in degrees.
  */
 declare function GetGameplayCamRot(rotationOrder: number): number[];
 
@@ -11553,7 +11647,8 @@ declare function GetHeliTailRotorHealth(vehicle: number): number;
 declare function GetHeliTailRotorHealth(vehicle: number): number;
 
 /**
- * HUD colors and their values: pastebin.com/d9aHPbXN
+ * Gets hud color RGBA parameter values by passing a hud color index (hudColorIndex).
+ * HUD colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/)
  */
 declare function GetHudColour(hudColorIndex: number): [number, number, number, number];
 
@@ -13047,27 +13142,32 @@ declare function GetNumberOfFreeStacksOfThisSize(stackSize: number): number;
 declare function GetFreeStackSlotsCount(stackSize: number): number;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * GET_NUMBER_OF_PED_DRAWABLE_VARIATIONS
+ * @param ped The ped handle.
+ * @param componentId The component id you want to get the drawable variatons of. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80)
  */
 declare function GetNumberOfPedDrawableVariations(ped: number, componentId: number): number;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS
+ * @param ped The ped handle.
+ * @param propId The prop id you want to get the drawable variations of. Refer to [SET_PED_PROP_INDEX](#\_0x93376B65A266EB5F)
  */
 declare function GetNumberOfPedPropDrawableVariations(ped: number, propId: number): number;
 
 /**
  * Need to check behavior when drawableId = -1
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * @param ped The ped handle.
+ * @param propId The prop id you want to get the texture variations of. Refer to [SET_PED_PROP_INDEX](#\_0x93376B65A266EB5F)
+ * @param drawableId The drawable id of the prop you want to get the texture variations of. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
  */
 declare function GetNumberOfPedPropTextureVariations(ped: number, propId: number, drawableId: number): number;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * GET_NUMBER_OF_PED_TEXTURE_VARIATIONS
+ * @param ped The ped handle.
+ * @param componentId The component id you want to get the texture variations of. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
+ * @param drawableId The drawable id of the component you want to get the texture variations of. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
  */
 declare function GetNumberOfPedTextureVariations(ped: number, componentId: number, drawableId: number): number;
 
@@ -13886,7 +13986,7 @@ declare function GetPedDiesInWater(ped: number): boolean;
  * 4 - Legs
  * 5 - Hands
  * 6 - Foot
- * 7 - ------
+ * 7 - Scarfs/Neck Accessories
  * 8 - Accessories 1
  * 9 - Accessories 2
  * 10- Decals
@@ -13931,24 +14031,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.
@@ -14221,8 +14321,9 @@ declare function GetPedNearbyPeds(ped: number, ignore: number): [number, number]
 declare function GetPedNearbyVehicles(ped: number, sizeAndVehs?: number): [number, number];
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * GET_PED_PALETTE_VARIATION
+ * @param ped The ped handle.
+ * @param componentId The component id to get the palette variation from. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
  */
 declare function GetPedPaletteVariation(ped: number, componentId: number): number;
 
@@ -14252,14 +14353,16 @@ declare function GetPedParachuteState(ped: number): number;
 declare function GetPedParachuteTintIndex(ped: number, outTintIndex?: number): number;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * GET_PED_PROP_INDEX
+ * @param ped The ped handle.
+ * @param componentId The component id to get the prop index from. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
  */
 declare function GetPedPropIndex(ped: number, componentId: number): number;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * GET_PED_PROP_TEXTURE_INDEX
+ * @param ped The ped handle.
+ * @param componentId The component id to get the prop texture index from. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
  */
 declare function GetPedPropTextureIndex(ped: number, componentId: number): number;
 
@@ -14316,8 +14419,9 @@ declare function GetPedTaskCombatTarget(ped: number, p1: number): number;
 declare function N_0x32c27a11307b01cc(ped: number, p1: number): number;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * GET_PED_TEXTURE_VARIATION
+ * @param ped The ped handle.
+ * @param componentId The component id to get the texture variation from. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
  */
 declare function GetPedTextureVariation(ped: number, componentId: number): number;
 
@@ -14818,7 +14922,11 @@ declare function GetPlayerWeaponDefenseModifier(playerId: number): number;
 declare function GetPlayerWeaponDefenseModifier_2(playerId: number): number;
 
 /**
- * Alternative: GET_VEHICLE_PED_IS_IN(PLAYER_PED_ID(), 1);
+ * ### Warning
+ * This native will return `0` if the last vehicle the player was in was destroyed.
+ * ### Alternative
+ * You can use [GET_VEHICLE_PED_IS_IN](#\_0x9A9112A0FE9A4713), which will actually get the last vehicle, even if it was destroyed.
+ * @return A vehicle handle containing the last player's vehicle.
  */
 declare function GetPlayersLastVehicle(): number;
 
@@ -15510,8 +15618,21 @@ declare function GetScriptGfxPosition(x: number, y: number): [number, number];
 declare function N_0x6dd8f5aa635eb4b2(x: number, y: number): [number, number];
 
 /**
- * Gets the status of a script-assigned task.
- * taskHash: https://alloc8or.re/gta5/doc/enums/eScriptTaskHash.txt
+ * Gets the status of a spesifed script-assigned task on the given ped. The return value is always an int between 0-7.
+ * You can set taskHash to `SCRIPT_TASK_ANY` to check if any task is active, it will return 1 for active, 3 for no active.
+ * `SCRIPT_TASK_INVALID` can be similarly used, it returns 7 if there are any active task, and 3 if there are no active tasks.
+ * taskHash list: https://alloc8or.re/gta5/doc/enums/eScriptTaskHash.txt
+ * Returns:
+ * ```
+ * 0 = WAITING_TO_START_TASK
+ * 1 = PERFORMING_TASK
+ * 2 = DORMANT_TASK
+ * 3 = VACANT_STAGE
+ * 7 = TASK_FINISHED_OR_NOT_FOUND
+ * ```
+ * @param ped The ped the task is running on
+ * @param taskHash The hash of the task
+ * @return The status of the script-assigned task.
  */
 declare function GetScriptTaskStatus(ped: number, taskHash: string | number): number;
 
@@ -16474,12 +16595,9 @@ declare function GetVehicleCanActivateParachute(vehicle: number): boolean;
 declare function CanVehicleParachuteBeActivated(vehicle: number): boolean;
 
 /**
- * iVar3 = get_vehicle_cause_of_destruction(uLocal_248[iVar2]);
- * if (iVar3 == joaat("weapon_stickybomb"))
- * {
- * func_171(726);
- * iLocal_260 = 1;
- * }
+ * GET_VEHICLE_CAUSE_OF_DESTRUCTION
+ * @param vehicle The vehicle to get the cause of destruction of.
+ * @return A hash representing the destruction cause. These can be weapon hashes.
  */
 declare function GetVehicleCauseOfDestruction(vehicle: number): number;
 
@@ -16771,7 +16889,11 @@ declare function GetVehicleDensityMultiplier(): number;
 declare function GetVehicleDirtLevel(vehicle: number): number;
 
 /**
+ * Checks the angle of the door mapped from 0.0 - 1.0 where 0.0 is fully closed and 1.0 is fully open.
  * See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#\_0x93D9BD300D7789E5)
+ * @param vehicle Vehicle
+ * @param doorIndex Index of door to check
+ * @return A float representing angle of door mapped from 0.0 to 1.0
  */
 declare function GetVehicleDoorAngleRatio(vehicle: number, doorIndex: number): number;
 
@@ -18221,7 +18343,7 @@ declare function GetWeaponHashFromPickup(pickupHash: string | number): number;
  * @param weaponHash The hash of the Weapon.
  * @return *   **Melee**: 2685387236
 *   **Handgun**: 416676503
-*   **Submachine Gun**: -95776620
+*   **Submachine Gun**: -957766203
 *   **Shotgun**: 860033945
 *   **Assault Rifle**: 970310034
 *   **Light Machine Gun**: 1159398588
@@ -20990,8 +21112,10 @@ declare function IsPedComponentVariationGen9Exclusive(ped: number, componentId:
 
 /**
  * Checks if the component variation is valid, this works great for randomizing components using loops.
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * @param ped The ped handle.
+ * @param componentId The component id to check the variation of. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
+ * @param drawableId The drawable id to get the component variation of. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
+ * @param textureId The texture id to get the component variation of. Refer to [GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS](#\_0xA6E7F1CEB523E171).
  */
 declare function IsPedComponentVariationValid(ped: number, componentId: number, drawableId: number, textureId: number): boolean;
 
@@ -22852,7 +22976,8 @@ declare function N_0xb5cc40fbcb586380(vehicle: number): boolean;
 declare function IsVehicleSirenSoundOn(vehicle: number): boolean;
 
 /**
- * IS_VEHICLE_SIREN_ON
+ * Returns whether the vehicle's lights and sirens are on.
+ * @return Returns false if siren and lights are disabled or true if they are enabled.
  */
 declare function IsVehicleSirenOn(vehicle: number): boolean;
 
@@ -22943,15 +23068,17 @@ declare function N_0x563b65a643ed072e(weaponHash: string | number, vehicle: numb
 /**
  * cpp
  * enum eWindowId {
- * VEH_EXT_WINDSCREEN = 0,
- * VEH_EXT_WINDSCREEN_R = 1,
- * VEH_EXT_WINDOW_LF = 2,
- * VEH_EXT_WINDOW_RF = 3,
- * VEH_EXT_WINDOW_LR = 4,
- * VEH_EXT_WINDOW_RR = 5,
- * VEH_EXT_WINDOW_LM = 6,
- * VEH_EXT_WINDOW_RM = 7,
+ * VEH_EXT_WINDOW_LF = 0,
+ * VEH_EXT_WINDOW_RF = 1,
+ * VEH_EXT_WINDOW_LR = 2,
+ * VEH_EXT_WINDOW_RR = 3,
+ * VEH_EXT_WINDOW_LM = 4,
+ * VEH_EXT_WINDOW_RM = 5,
+ * VEH_EXT_WINDSCREEN = 6,
+ * VEH_EXT_WINDSCREEN_R = 7,
  * }
+ * @param vehicle The vehicle handle
+ * @param windowIndex The index of the window
  */
 declare function IsVehicleWindowIntact(vehicle: number, windowIndex: number): boolean;
 
@@ -23005,8 +23132,7 @@ declare function IsWorldPointWithinBrainActivationRange(): boolean;
 declare function IsXbox360Version(): boolean;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * KNOCK_OFF_PED_PROP
  */
 declare function KnockOffPedProp(ped: number, p1: boolean, p2: boolean, p3: boolean, p4: boolean): void;
 
@@ -27125,11 +27251,6 @@ declare function N_0x8989cbd7b4e82534(p0: number, p1: number, p2: number, p3: nu
  */
 declare function N_0x8a4416c0db05fa66(p0: number): boolean;
 
-/**
- * 0x8AA9180DE2FEDD45
- */
-declare function N_0x8aa9180de2fedd45(vehicle: number, p1: boolean): void;
-
 /**
  * 0x8B0C2964BA471961
  * @return Hard-coded to always return 0.
@@ -38153,6 +38274,7 @@ declare function RegisterObjectScriptBrain(scriptName: string, modelHash: string
 
 /**
  * gtaforums.com/topic/885580-ped-headshotmugshot-txd/
+ * @return The Pedheadshot handle.
  */
 declare function RegisterPedheadshot(ped: number): number;
 
@@ -38431,7 +38553,7 @@ declare function RemoveAllCoverBlockingAreas(): void;
 declare function RemoveAllPedWeapons(ped: number, p1: boolean): void;
 
 /**
- * Pickup hashes: pastebin.com/8EuSv2r1
+ * Pickup hashes can be found [here](https://gist.github.com/4mmonium/1eabfb6b3996e3aa6b9525a3eccf8a0b).
  */
 declare function RemoveAllPickupsOfType(pickupHash: string | number): void;
 
@@ -38578,7 +38700,7 @@ declare function RemoveFromItemset(p0: number, p1: number): void;
 declare function RemoveGroup(groupId: number): void;
 
 /**
- * IPL list: pastebin.com/iNGLY32D
+ * IPL list can be found [here](https://gist.github.com/4mmonium/4c8a076b5f712a7cc64666003009a2e7).
  */
 declare function RemoveIpl(iplName: string): void;
 
@@ -39025,34 +39147,31 @@ declare function HighlightPlacementCoords(x: number, y: number, z: number, color
 declare function RenderScriptCams(render: boolean, ease: boolean, easeTime: number, p3: boolean, p4: boolean): void;
 
 /**
- * HUD colors and their values: pastebin.com/d9aHPbXN
- * --------------------------------------------------
- * makes hudColorIndex2 color into hudColorIndex color
+ * Changes the hud color at a given index (hudColorIndex) by another one (hudColorIndex2).
+ * HUD colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/)
  */
 declare function ReplaceHudColour(hudColorIndex: number, hudColorIndex2: number): void;
 /**
- * HUD colors and their values: pastebin.com/d9aHPbXN
- * --------------------------------------------------
- * makes hudColorIndex2 color into hudColorIndex color
+ * Changes the hud color at a given index (hudColorIndex) by another one (hudColorIndex2).
+ * HUD colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/)
  */
 declare function N_0x1ccc708f0f850613(hudColorIndex: number, hudColorIndex2: number): void;
 /**
- * HUD colors and their values: pastebin.com/d9aHPbXN
- * --------------------------------------------------
- * makes hudColorIndex2 color into hudColorIndex color
+ * Changes the hud color at a given index (hudColorIndex) by another one (hudColorIndex2).
+ * HUD colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/)
  */
 declare function SetHudColoursSwitch(hudColorIndex: number, hudColorIndex2: number): void;
 
 /**
- * HUD colors and their values: pastebin.com/d9aHPbXN
+ * Hud colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/)
  */
 declare function ReplaceHudColourWithRgba(hudColorIndex: number, r: number, g: number, b: number, a: number): void;
 /**
- * HUD colors and their values: pastebin.com/d9aHPbXN
+ * Hud colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/)
  */
 declare function N_0xf314cf4f0211894e(hudColorIndex: number, r: number, g: number, b: number, a: number): void;
 /**
- * HUD colors and their values: pastebin.com/d9aHPbXN
+ * Hud colors can be found [here](https://docs.fivem.net/docs/game-references/hud-colors/)
  */
 declare function SetHudColour(hudColorIndex: number, r: number, g: number, b: number, a: number): void;
 
@@ -39913,9 +40032,11 @@ declare function N_0xe574a662acaefbb1(): void;
 declare function RestartScriptedConversation(): void;
 
 /**
- * RESTORE_PLAYER_STAMINA
+ * Adds a percentage to a players stamina
+ * @param player player to restore the stamina for
+ * @param percentage seems to be a percentage that ranges from 0.0 to 1.0 (1.0 being 100%)
  */
-declare function RestorePlayerStamina(player: number, p1: number): void;
+declare function RestorePlayerStamina(player: number, percentage: number): void;
 
 /**
  * This function will simply bring the dead person back to life.
@@ -41293,22 +41414,28 @@ declare function SetBikeOnStand(vehicle: number, x: number, y: number): void;
 declare function SetBikeLeanAngle(vehicle: number, x: number, y: number): void;
 
 /**
- * NativeDB Introduced: v1290
+ * Creates an integer (usually 1) for a BINK movie to be called with other natives.
+ * [List of all BINK movies (alphabetically ordered) as of b2802](https://gist.github.com/ItsJunction/8046f28c29ea8ff2821e9e4f933f595f)
+ * @param name The BINK movie to play (with or without file extension).
  */
 declare function SetBinkMovie(name: string): number;
 /**
- * NativeDB Introduced: v1290
+ * Creates an integer (usually 1) for a BINK movie to be called with other natives.
+ * [List of all BINK movies (alphabetically ordered) as of b2802](https://gist.github.com/ItsJunction/8046f28c29ea8ff2821e9e4f933f595f)
+ * @param name The BINK movie to play (with or without file extension).
  */
 declare function SetBinkMovieRequested(name: string): number;
 
 /**
- * In percentage: 0.0 - 100.0
- * NativeDB Introduced: v1290
+ * Seeks a BINK movie to a specified position.
+ * @param binkMovie The movie that is being played.
+ * @param progress As a percentage (0.0 - 100.0).
  */
 declare function SetBinkMovieTime(binkMovie: number, progress: number): void;
 /**
- * In percentage: 0.0 - 100.0
- * NativeDB Introduced: v1290
+ * Seeks a BINK movie to a specified position.
+ * @param binkMovie The movie that is being played.
+ * @param progress As a percentage (0.0 - 100.0).
  */
 declare function SetBinkMovieProgress(binkMovie: number, progress: number): void;
 
@@ -41415,7 +41542,8 @@ declare function SetBlipBright(blip: number, toggle: boolean): void;
 declare function SetBlipCategory(blip: number, index: number): void;
 
 /**
- * See https://docs.fivem.net/docs/game-references/blips/#BlipColors
+ * SET_BLIP_COLOUR
+ * @param color See [blip colors here](https://docs.fivem.net/docs/game-references/blips/#blip-colors)
  */
 declare function SetBlipColour(blip: number, color: number): void;
 
@@ -41823,9 +41951,12 @@ declare function SetCamNearDof(cam: number, nearDOF: number): void;
 declare function SetCamParams(cam: number, posX: number, posY: number, posZ: number, rotX: number, rotY: number, rotZ: number, fieldOfView: number, transitionSpeed: number, p9: number, p10: number, rotationOrder: number): void;
 
 /**
- * Sets the rotation of the cam.
- * Last parameter unknown.
- * Last parameter seems to always be set to 2.
+ * Sets the rotation of the camera.
+ * @param cam The camera handle to use, in order to change the rotation
+ * @param rotX Rotation on X
+ * @param rotY Rotation on Y
+ * @param rotZ Rotation on Z
+ * @param rotationOrder The order of rotation, see [`GET_ENTITY_ROTATION`](#\_0xAFBD61CC738D9EB9)
  */
 declare function SetCamRot(cam: number, rotX: number, rotY: number, rotZ: number, rotationOrder: number): void;
 
@@ -44670,7 +44801,7 @@ declare function SetMinimapClipType(_type: number): void;
  * 2: Trevor's air port yellow lift-off markers.
  * 6: Vespucci Beach lifeguard building.
  * 15: Army base.
- * [List of hud colors](https://pastebin.com/d9aHPbXN)
+ * [List of hud colors](https://docs.fivem.net/docs/game-references/hud-colors/)
  * @param componentID The component ID to change.
  * @param toggle True to enable the color, false to disable the effect.
  * @param hudColor The hudcolor index.
@@ -45013,19 +45144,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 hudColorIndex a hud color index, see the full list here: [link](pastebin.com/d9aHPbXN)
+ * @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 hudColorIndex a hud color index, see the full list here: [link](pastebin.com/d9aHPbXN)
+ * @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 hudColorIndex a hud color index, see the full list here: [link](pastebin.com/d9aHPbXN)
+ * @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;
 
@@ -46209,26 +46340,43 @@ declare function SetPedCombatRange(ped: number, p1: number): void;
 /**
  * This native is used to set component variation on a ped. Components, drawables and textures IDs are related to the ped model.
  * ### MP Freemode list of components
- * **0**: Face\
- * **1**: Mask\
- * **2**: Hair\
- * **3**: Torso\
- * **4**: Leg\
- * **5**: Parachute / bag\
- * **6**: Shoes\
- * **7**: Accessory\
- * **8**: Undershirt\
- * **9**: Kevlar\
- * **10**: Badge\
+ * **0**: Face
+ * **1**: Mask
+ * **2**: Hair
+ * **3**: Torso
+ * **4**: Leg
+ * **5**: Parachute / bag
+ * **6**: Shoes
+ * **7**: Accessory
+ * **8**: Undershirt
+ * **9**: Kevlar
+ * **10**: Badge
  * **11**: Torso 2
- * ### Related and useful natives
- * [GET_NUMBER_OF_PED_DRAWABLE_VARIATIONS](#\_0x27561561732A7842)\
- * [GET_NUMBER_OF_PED_TEXTURE_VARIATIONS](#\_0x8F7156A3142A6BAD)
- * [List of component/props ID](gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html) of player_two with examples
+ * List of Component IDs
+ * ```cpp
+ * // Components
+ * enum ePedVarComp
+ * {
+ * PV_COMP_INVALID = 0xFFFFFFFF,
+ * PV_COMP_HEAD = 0, // "HEAD"
+ * PV_COMP_BERD = 1, // "BEARD"
+ * PV_COMP_HAIR = 2, // "HAIR"
+ * PV_COMP_UPPR = 3, // "UPPER"
+ * PV_COMP_LOWR = 4, // "LOWER"
+ * PV_COMP_HAND = 5, // "HAND"
+ * PV_COMP_FEET = 6, // "FEET"
+ * PV_COMP_TEEF = 7, // "TEETH"
+ * PV_COMP_ACCS = 8, // "ACCESSORIES"
+ * PV_COMP_TASK = 9, // "TASK"
+ * PV_COMP_DECL = 10, // "DECL"
+ * PV_COMP_JBIB = 11, // "JBIB"
+ * PV_COMP_MAX = 12,
+ * };
+ * ```
  * @param ped The ped handle.
  * @param componentId The component that you want to set.
- * @param drawableId The drawable id that is going to be set.
- * @param textureId The texture id of the drawable.
+ * @param drawableId The drawable id that is going to be set. Refer to [GET_NUMBER_OF_PED_DRAWABLE_VARIATIONS](#\_0x27561561732A7842).
+ * @param textureId The texture id of the drawable. Refer to [GET_NUMBER_OF_PED_TEXTURE_VARIATIONS](#\_0x8F7156A3142A6BAD).
  * @param paletteId 0 to 3.
  */
 declare function SetPedComponentVariation(ped: number, componentId: number, drawableId: number, textureId: number, paletteId: number): void;
@@ -47170,11 +47318,9 @@ declare function SetPedHelmet(ped: number, canWearHelmet: boolean): void;
 declare function SetPedHelmetFlag(ped: number, helmetFlag: number): void;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
- * ```
- * ```
  * NativeDB Added Parameter 3: BOOL p2
+ * @param ped The ped handle.
+ * @param propIndex The prop index to set the helmet to. Refer to [SET_PED_PROP_INDEX](#\_0x93376B65A266EB5F).
  */
 declare function SetPedHelmetPropIndex(ped: number, propIndex: number): void;
 
@@ -47513,20 +47659,29 @@ declare function SetPedPreferredCoverSet(ped: number, itemSet: number): void;
 declare function N_0x8421eb4da7e391b9(ped: number, itemSet: number): void;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * SET_PED_PRELOAD_PROP_DATA
+ * @param ped The ped handle.
+ * @param componentId The component that you want to set. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
+ * @param drawableId The drawable id that is going to be set. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
+ * @param textureId The texture id of the drawable. Refer to [GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS](#\_0xA6E7F1CEB523E171).
  */
-declare function SetPedPreloadPropData(ped: number, componentId: number, drawableId: number, TextureId: number): boolean;
+declare function SetPedPreloadPropData(ped: number, componentId: number, drawableId: number, textureId: number): boolean;
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * SET_PED_PRELOAD_PROP_DATA
+ * @param ped The ped handle.
+ * @param componentId The component that you want to set. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
+ * @param drawableId The drawable id that is going to be set. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
+ * @param textureId The texture id of the drawable. Refer to [GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS](#\_0xA6E7F1CEB523E171).
  */
-declare function N_0x2b16a3bff1fbce49(ped: number, componentId: number, drawableId: number, TextureId: number): boolean;
+declare function N_0x2b16a3bff1fbce49(ped: number, componentId: number, drawableId: number, textureId: number): boolean;
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * SET_PED_PRELOAD_PROP_DATA
+ * @param ped The ped handle.
+ * @param componentId The component that you want to set. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
+ * @param drawableId The drawable id that is going to be set. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
+ * @param textureId The texture id of the drawable. Refer to [GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS](#\_0xA6E7F1CEB523E171).
  */
-declare function IsPedPropValid(ped: number, componentId: number, drawableId: number, TextureId: number): boolean;
+declare function IsPedPropValid(ped: number, componentId: number, drawableId: number, textureId: number): boolean;
 
 /**
  * from extreme3.c4
@@ -47552,19 +47707,36 @@ declare function SetPedPrimaryLookat(ped: number, lookAt: number): void;
 /**
  * This native is used to set prop variation on a ped. Components, drawables and textures IDs are related to the ped model.
  * ### MP Freemode list of props
- * **0**: Hat\
- * **1**: Glass\
- * **2**: Ear\
- * **6**: Watch\
- * **7**: Bracelet
- * ### Related and useful natives
- * [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47)\
- * [GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS](#\_0xA6E7F1CEB523E171)
- * [List of component/props ID](https://gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html) of player_two with examples
+ * **0**: Hats
+ * **1**: Glasses
+ * **2**: Ears
+ * **6**: Watches
+ * **7**: Bracelets
+ * List of Prop IDs
+ * ```cpp
+ * // Props
+ * enum eAnchorPoints
+ * {
+ * ANCHOR_HEAD = 0, // "p_head"
+ * ANCHOR_EYES = 1, // "p_eyes"
+ * ANCHOR_EARS = 2, // "p_ears"
+ * ANCHOR_MOUTH = 3, // "p_mouth"
+ * ANCHOR_LEFT_HAND = 4, // "p_lhand"
+ * ANCHOR_RIGHT_HAND = 5, // "p_rhand"
+ * ANCHOR_LEFT_WRIST = 6, // "p_lwrist"
+ * ANCHOR_RIGHT_WRIST = 7, // "p_rwrist"
+ * ANCHOR_HIP = 8, // "p_lhip"
+ * ANCHOR_LEFT_FOOT = 9, // "p_lfoot"
+ * ANCHOR_RIGHT_FOOT = 10, // "p_rfoot"
+ * ANCHOR_PH_L_HAND = 11, // "ph_lhand"
+ * ANCHOR_PH_R_HAND = 12, // "ph_rhand"
+ * NUM_ANCHORS = 13,
+ * };
+ * ```
  * @param ped The ped handle.
- * @param componentId The component that you want to set.
- * @param drawableId The drawable id that is going to be set.
- * @param textureId The texture id of the drawable.
+ * @param componentId The component that you want to set. Refer to [SET_PED_COMPONENT_VARIATION](#\_0x262B14F48D29DE80).
+ * @param drawableId The drawable id that is going to be set. Refer to [GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS](#\_0x5FAF9754E789FB47).
+ * @param textureId The texture id of the drawable. Refer to [GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS](#\_0xA6E7F1CEB523E171).
  * @param attach Attached or not.
  */
 declare function SetPedPropIndex(ped: number, componentId: number, drawableId: number, textureId: number, attach: boolean): void;
@@ -47576,19 +47748,18 @@ declare function SetPedRagdollForceFall(ped: number): void;
 
 /**
  * Causes Ped to ragdoll on collision with any object (e.g Running into trashcan). If applied to player you will sometimes trip on the sidewalk.
+ * Needs to be recalled after each ragdoll from a Collision.
  */
 declare function SetPedRagdollOnCollision(ped: number, toggle: boolean): void;
 
 /**
  * p1 is always 0 in R* scripts; and a quick disassembly seems to indicate that p1 is unused.
- * List of component/props ID:
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
  */
 declare function SetPedRandomComponentVariation(ped: number, p1: number): void;
 
 /**
- * List of component/props ID
- * gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html
+ * SET_PED_RANDOM_PROPS
+ * @param ped The ped handle.
  */
 declare function SetPedRandomProps(ped: number): void;
 
@@ -48752,7 +48923,7 @@ declare function N_0x774bd811f656a122(radioStation: string, toggle: boolean): vo
 declare function SetRadioToStationIndex(radioStation: number): void;
 
 /**
- * For a full list, see here: pastebin.com/Kj9t38KF
+ * Find the radio station list [here](https://gist.github.com/4mmonium/b47d6512a2d992cbf4eea15d9038b581)
  */
 declare function SetRadioToStationName(stationName: string): void;
 
@@ -49544,7 +49715,9 @@ declare function SetSubmarineCrushDepths(vehicle: number, toggle: boolean, depth
 declare function JitterVehicle(vehicle: number, toggle: boolean, depth1: number, depth2: number, depth3: number): void;
 
 /**
- * SET_SUPER_JUMP_THIS_FRAME
+ * Allows the player to perform super jumps. This function must be called every frame for it to work.
+ * It basically OR's a flag for a single frame, allowing the ped to perform a super jump only when the flag is set.
+ * @param player The player we are setting this for.
  */
 declare function SetSuperJumpThisFrame(player: number): void;
 
@@ -49963,7 +50136,7 @@ declare function SetTrailerLegsRaised(vehicle: number): void;
 declare function N_0x95cf53b3d687f9fa(vehicle: number): void;
 
 /**
- * SET_TRAIN_CRUISE_SPEED
+ * Used to control train speed, can be used to start and stop its movement as well.
  */
 declare function SetTrainCruiseSpeed(train: number, speed: number): void;
 
@@ -50293,7 +50466,7 @@ declare function SetVehHasRadioOverride(vehicle: number): void;
 declare function N_0x3e45765f3fbb582f(vehicle: number): void;
 
 /**
- * For a full list, see here: pastebin.com/Kj9t38KF
+ * Find the radio station list [here](https://gist.github.com/4mmonium/b47d6512a2d992cbf4eea15d9038b581)
  */
 declare function SetVehRadioStation(vehicle: number, radioStation: string): void;
 
@@ -54696,8 +54869,9 @@ declare function StopAnimPlayback(ped: number, p1: number, p2: boolean): void;
 
 /**
  * [Animations list](https://alexguirre.github.io/animations-list/)
+ * @param animExitSpeed Greater than `0.0`, higher is faster. Setting to `0.0` or using an integer, will cause animation lockout - requiring the animation to be played again or the player be killed.
  */
-declare function StopAnimTask(ped: number, animDictionary: string, animationName: string, p3: number): void;
+declare function StopAnimTask(ped: number, animDictionary: string, animationName: string, animExitSpeed: number): void;
 
 /**
  * STOP_ANY_PED_MODEL_BEING_SUPPRESSED
@@ -56549,7 +56723,7 @@ declare function TaskWarpPedIntoVehicle(ped: number, vehicle: number, seatIndex:
 declare function TaskWrithe(ped: number, target: number, time: number, p3: number): void;
 
 /**
- * For a full list, see here: pastebin.com/yLNWicUi
+ * For a full list, see [here](https://gist.github.com/4mmonium/f76f3ecef649ed275b260b433ea84494).
  */
 declare function TerminateAllScriptsWithThisName(scriptName: string): void;
 

package/package.json

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