@citizenfx/client 2.0.5242-1 → 2.0.5251-1

package/natives_universal.d.ts

@@ -1790,8 +1790,9 @@ declare function SetTextEntry_2(GxtEntry: string): void;
  * GRAPHICS::BEGIN_TEXT_COMMAND_SCALEFORM_STRING("STRTNM1");
  * HUD::_0x17299B63C7683A2B(v_3);
  * GRAPHICS::END_TEXT_COMMAND_SCALEFORM_STRING();
+ * @param textLabel a GXT text label
  */
-declare function BeginTextCommandScaleformString(componentType: string): void;
+declare function BeginTextCommandScaleformString(textLabel: string): void;
 /**
  * Called prior to adding a text component to the UI. After doing so, GRAPHICS::END_TEXT_COMMAND_SCALEFORM_STRING is called.
  * Examples:
@@ -1808,8 +1809,9 @@ declare function BeginTextCommandScaleformString(componentType: string): void;
  * GRAPHICS::BEGIN_TEXT_COMMAND_SCALEFORM_STRING("STRTNM1");
  * HUD::_0x17299B63C7683A2B(v_3);
  * GRAPHICS::END_TEXT_COMMAND_SCALEFORM_STRING();
+ * @param textLabel a GXT text label
  */
-declare function BeginTextComponent(componentType: string): void;
+declare function BeginTextComponent(textLabel: string): void;
 
 /**
  * Starts a text command to change the name of a blip displayed in the pause menu.
@@ -3016,7 +3018,7 @@ declare function CreateAudioSubmix(name: string): number;
  * "DEFAULT_SCRIPTED_FLY_CAMERA"
  * "TIMED_SPLINE_CAMERA"
  */
-declare function CreateCam(camName: string, p1: boolean): number;
+declare function CreateCam(camName: string, active: boolean): number;
 
 /**
  * camName is always set to "DEFAULT_SCRIPTED_CAMERA" in Rockstar's scripts.
@@ -3821,7 +3823,17 @@ declare function DecorGetInt(entity: number, propertyName: string): number;
 declare function DecorIsRegisteredAsType(propertyName: string, _type: number): boolean;
 
 /**
- * https://alloc8or.re/gta5/doc/enums/eDecorType.txt
+ * Decor types:
+ * ```
+ * enum eDecorType
+ * {
+ * DECOR_TYPE_FLOAT = 1,
+ * DECOR_TYPE_BOOL = 2,
+ * DECOR_TYPE_INT = 3,
+ * DECOR_TYPE_UNK = 4,
+ * DECOR_TYPE_TIME = 5
+ * };
+ * ```
  */
 declare function DecorRegister(propertyName: string, _type: number): void;
 
@@ -4328,6 +4340,25 @@ declare function DoesExtraExist(vehicle: number, extraId: number): boolean;
 
 declare function DoesGroupExist(groupId: number): boolean;
 
+/**
+ * Used in pi_menu.c. Checks if there is a brief entry for specified value.
+ * Values:
+ * 0 - Dialogue brief
+ * 1 - Help text brief
+ * 2 - Mission Objective brief
+ * @param briefValue A value indicating brief text.
+ */
+declare function DoesLatestBriefStringExist(briefValue: number): boolean;
+/**
+ * Used in pi_menu.c. Checks if there is a brief entry for specified value.
+ * Values:
+ * 0 - Dialogue brief
+ * 1 - Help text brief
+ * 2 - Mission Objective brief
+ * @param briefValue A value indicating brief text.
+ */
+declare function N_0x5e657ef1099edd65(briefValue: number): boolean;
+
 declare function DoesNavmeshBlockingObjectExist(p0: number): boolean;
 declare function N_0x0eaeb0db4b132399(p0: number): boolean;
 
@@ -5452,9 +5483,9 @@ declare function EndTextCommandGetLineCount(x: number, y: number): number;
 declare function EndTextCommandObjective(p0: boolean): void;
 declare function N_0xcfdbdf5ae59ba0f4(p0: boolean): void;
 
-declare function EndTextCommandOverrideButtonText(p0: number): void;
-declare function N_0xa86911979638106f(p0: number): void;
-declare function EndTextCommandTimer(p0: number): void;
+declare function EndTextCommandOverrideButtonText(buttonIndex: number): void;
+declare function N_0xa86911979638106f(buttonIndex: number): void;
+declare function EndTextCommandTimer(buttonIndex: number): void;
 
 /**
  * Draws the subtitle at middle center of the screen.
@@ -15640,7 +15671,13 @@ declare function N_0x563b65a643ed072e(weaponHash: string | number, vehicle: numb
  */
 declare function IsVehicleWindowIntact(vehicle: number, windowIndex: number): boolean;
 
+/**
+ * Returns true if a Warning Message or ReportUGC menu is active.
+ */
 declare function IsWarningMessageActive(): boolean;
+/**
+ * Returns true if a Warning Message or ReportUGC menu is active.
+ */
 declare function IsMedicalDisabled(): boolean;
 
 /**
@@ -15924,6 +15961,15 @@ declare function LocalizationGetSystemLanguage(): number;
  */
 declare function N_0x497420e022796b3f(): number;
 
+/**
+ * Updates the display of the MP/SP loading buttons, and locks the state so that other options are not displayed or changed. This can only be done once.
+ */
+declare function LockLoadingScreenButtons(): void;
+/**
+ * Updates the display of the MP/SP loading buttons, and locks the state so that other options are not displayed or changed. This can only be done once.
+ */
+declare function N_0xb1577667c3708f9b(): void;
+
 /**
  * Locks the minimap to the specified angle in integer degrees.
  * angle: The angle in whole degrees. If less than 0 or greater than 360, unlocks the angle.
@@ -17227,9 +17273,13 @@ declare function N_0x3bd770d281982db5(p0: number, p1: number): number;
 declare function N_0x3c5c1e2c2ff814b1(toggle: boolean): void;
 
 /**
+ * ```
  * NativeDB Introduced: v1180
+ * ```
+ * Sets the given checkpoint target to the new coords
+ * @param checkpointHandle the handle of a created checkpoint
  */
-declare function N_0x3c788e7f6438754d(p0: number, p1: number, p2: number, p3: number): void;
+declare function N_0x3c788e7f6438754d(checkpointHandle: number, x: number, y: number, z: number): void;
 
 declare function N_0x3d9acb1eb139e702(): number;
 
@@ -17389,9 +17439,6 @@ declare function N_0x487912fd248efddf(p0: number, p1: number): boolean;
  */
 declare function N_0x4879e4fe39074cdf(): boolean;
 
-declare function N_0x4895bdea16e7c080(p0: number): void;
-declare function EnableDeathbloodSeethrough(p0: number): void;
-
 /**
  * Only found 3 times in decompiled scripts. Not a whole lot to go off of.
  * MISC::_48F069265A0E4BEC(a_0, "Movie_Name_For_This_Player");
@@ -17755,11 +17802,6 @@ declare function N_0x5e3aa4ca2b6fb0ee(p0: number): void;
 
 declare function N_0x5e569ec46ec21cae(vehicle: number, toggle: boolean): void;
 
-/**
- * DOES_*
- */
-declare function N_0x5e657ef1099edd65(p0: number): boolean;
-
 /**
  * example from completionpercentage_controller.ysc.c4
  * if (STATS::_5EAD2BF6484852E4()) {
@@ -19204,8 +19246,6 @@ declare function N_0xb1381b97f70c7b30(): void;
 
 declare function N_0xb13e88e655e5a3bc(): void;
 
-declare function N_0xb1577667c3708f9b(): void;
-
 declare function N_0xb17bc6453f6cf5ac(p0: number, p1: number): void;
 
 declare function N_0xb1b6216ca2e7b55e(p0: number, p1: boolean, p2: boolean): void;
@@ -19846,9 +19886,13 @@ declare function N_0xdaf80797fc534bec(p0: number): void;
 declare function N_0xdaf87174be7454ff(p0: number): boolean;
 
 /**
+ * ```
  * NativeDB Introduced: v1180
+ * ```
+ * This native is used for the "larger" circular checkpoints, and sets the circle/ring around the checkpoint to point in the same direction as the inner arrow
+ * @param checkpointHandle the handle of a created checkpoint
  */
-declare function N_0xdb1ea9411c8911ec(p0: number): void;
+declare function N_0xdb1ea9411c8911ec(checkpointHandle: number): void;
 
 declare function N_0xdb41d07a45a6d4b7(p0: number): number;
 
@@ -19882,8 +19926,6 @@ declare function N_0xdbf860cf1db8e599(p0: number): number;
  */
 declare function N_0xdc6f8601faf2e893(entity: number, toggle: boolean): void;
 
-declare function N_0xdc9da9e8789f5246(): void;
-
 /**
  * Always returns false.
  * ```
@@ -22568,7 +22610,12 @@ declare function NetworkIsInTransition(): boolean;
 
 declare function NetworkIsInTutorialSession(): boolean;
 
-declare function NetworkIsInactiveProfile(p0: number): [boolean, number];
+/**
+ * Checks if the networkHandle is the same as any other user that is signed in on the local machine.
+ * For example, if your console has two or more users signed in (on different controllers), the profile that is not controlling the game would be "inactive".
+ * @return Returns true if the networkHandle is signed in on the same machine, but is not the main player.
+ */
+declare function NetworkIsInactiveProfile(networkHandle: number): [boolean, number];
 
 declare function NetworkIsLocalPlayerInvincible(): boolean;
 
@@ -24415,6 +24462,15 @@ declare function N_0x84698ab38d0c6636(contextHash: string | number): boolean;
 declare function PauseMenuIsContextMenuActive(): number;
 declare function N_0x2a25adc48f87841f(): number;
 
+/**
+ * Updates instructional buttons in Pause Menu after menu contexts have been toggled. p0 purpose is currently unknown, only 0 is used in scripts.
+ */
+declare function PauseMenuRedrawInstructionalButtons(p0: number): void;
+/**
+ * Updates instructional buttons in Pause Menu after menu contexts have been toggled. p0 purpose is currently unknown, only 0 is used in scripts.
+ */
+declare function EnableDeathbloodSeethrough(p0: number): void;
+
 declare function PauseMenuSetBusySpinner(p0: boolean, p1: number, p2: number): void;
 declare function N_0xc78e239ac5b2ddb9(p0: boolean, p1: number, p2: number): void;
 
@@ -28134,6 +28190,9 @@ declare function SetCinematicCamShakeAmplitude(p0: number): void;
  */
 declare function SetCinematicModeActive(toggle: boolean): void;
 
+declare function SetCinematicNewsChannelActiveThisUpdate(): void;
+declare function N_0xdc9da9e8789f5246(): void;
+
 declare function SetClockDate(day: number, month: number, year: number): void;
 
 /**
@@ -30500,7 +30559,11 @@ declare function SetParticleFxLoopedScale(ptfxHandle: number, scale: number): vo
 declare function SetParticleFxNonLoopedAlpha(alpha: number): void;
 
 /**
- * only works on some fx's, not networked
+ * Changes the colour of the particle effect that will be drawn next. The particle can be networked or non-networked, but it must be non-looped for this native to work.
+ * The colour parameters accept RGB values on a scale from 0.0 to 1.0, therefore RGB values that follow the standard 0-255 scale can be easily used dividing said value by 255.
+ * @param r The red component of the particle's colour, on a scale from 0.0 to 1.0.
+ * @param g The green component of the particle's colour, on a scale from 0.0 to 1.0.
+ * @param b The blue component of the particle's colour, on a scale from 0.0 to 1.0.
  */
 declare function SetParticleFxNonLoopedColour(r: number, g: number, b: number): void;
 
@@ -31138,7 +31201,7 @@ declare function SetPedComponentVariation(ped: number, componentId: number, draw
  * _0xB60EA2BA = 245,
  * _0x536B0950 = 246,
  * _0x0C754ACA = 247,
- * _0x69D28F3E = 248,
+ * CPED_CONFIG_FLAG_DisableVehicleSeatRandomAnimations = 248,
  * _0x12659168 = 249,
  * _0x1BDF2F04 = 250,
  * _0x7728FAA3 = 251,
@@ -31991,7 +32054,7 @@ declare function SetPedPrimaryLookat(ped: number, lookAt: number): void;
  * ### 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](gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html) of player_two with examples
+ * [List of component/props ID](https://gtaxscripting.blogspot.com/2016/04/gta-v-peds-component-and-props.html) of player_two with examples
  * @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.
@@ -32487,6 +32550,8 @@ declare function SetPlayerMeleeWeaponDefenseModifier(player: number, modifier: n
 /**
  * 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.
+ * @param player The player to set the model for
+ * @param model The hash of the model to use
  */
 declare function SetPlayerModel(player: number, model: string | number): void;
 
@@ -35974,7 +36039,7 @@ declare function SetWeatherOwnedByNetwork(network: boolean): void;
 declare function SetWeatherTypeNow(weatherType: string): void;
 
 /**
- * Refer to [`SET_WEATHER_TYPE_NOW_PERSIST`](#\_0xED712CA327900C8A) for weather types.
+ * Refer to [`SET_WEATHER_TYPE_NOW`](#0x29B487C359E19889) for weather types.
  */
 declare function SetWeatherTypeNowPersist(weatherType: string): void;
 
@@ -36124,7 +36189,23 @@ declare function ShiftLeft(value: number, bitShift: number): number;
 
 declare function ShiftRight(value: number, bitShift: number): number;
 
-declare function ShootSingleBulletBetweenCoords(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, damage: number, p7: boolean, weaponHash: string | number, ownerPed: number, isAudible: boolean, isInvisible: boolean, speed: number): void;
+/**
+ * Shoots a bullet from the first vector to the second vector. The weapon used as weaponHash should already be loaded via REQUEST_WEAPON_ASSET, otherwise the bullet may fail to materialise.
+ * @param x1 The X coordinate to start the shot at.
+ * @param y1 The Y coordinate to start the shot at.
+ * @param z1 The Z coordinate to start the shot at.
+ * @param x2 The X coordinate the shot should end up at.
+ * @param y2 The Y coordinate the shot should end up at.
+ * @param z2 The Z coordinate the shot should end up at.
+ * @param damage The amount of damage the bullet carries.
+ * @param pureAccuracy Whether the bullet should have pinpoint accuracy.
+ * @param weaponHash Hash of the weapon the bullet is used as ammunition for.
+ * @param ownerPed Owner of the bullet, e.g. if the bullet kills someone the kill feed shows 'X was shot by ownerPed.'
+ * @param isAudible Whether the bullet should be audible. Optional, defaults to true
+ * @param isInvisible Whether the bullet should be invisible. Optional, defaults to false
+ * @param speed Speed the bullet should fly at. Optional
+ */
+declare function ShootSingleBulletBetweenCoords(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, damage: number, pureAccuracy: boolean, weaponHash: string | number, ownerPed: number, isAudible: boolean, isInvisible: boolean, speed: number): void;
 
 /**
  * entity - entity to ignore
@@ -36654,30 +36735,13 @@ declare function StartEntityFire(entity: number): number;
 /**
  * Does the same as [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E), except blocking until the shape test completes.
  * Use [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E) instead. Literally. Rockstar named this correctly: it's expensive, and it's synchronous.
- * ```
- * This function casts a ray from Point1 to Point2 and returns it's ray handle.  A simple ray cast will 'shoot' a line from point A to point B, and return whether or not the ray reached it's destination or if it hit anything and if it did hit anything, will return the handle of what it hit (entity handle) and coordinates of where the ray reached.
- * You can use _GET_RAYCAST_RESULT to get the result of the raycast
- * Entity is an entity to ignore, such as the player.
- * Flags are intersection bit flags.  They tell the ray what to care about and what not to care about when casting. Passing -1 will intersect with everything, presumably.
- * Flags:
- * 1: Intersect with map
- * 2: Intersect with vehicles (used to be mission entities?) (includes train)
- * 4: Intersect with peds? (same as 8)
- * 8: Intersect with peds? (same as 4)
- * 16: Intersect with objects
- * 32: Water?
- * 64: Unknown
- * 128: Unknown
- * 256: Intersect with vegetation (plants, coral. trees not included)
- * NOTE: Raycasts that intersect with mission_entites (flag = 2) has limited range and will not register for far away entites. The range seems to be about 30 metres.
- * ```
  * @param x1 Starting X coordinate.
  * @param y1 Starting Y coordinate.
  * @param z1 Starting Z coordinate.
  * @param x2 Ending X coordinate.
  * @param y2 Ending Y coordinate.
  * @param z2 Ending Z coordinate.
- * @param flags Flags.
+ * @param flags See [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E).
  * @param entity An entity to ignore, or 0.
  * @param p8 A bit mask with bits 1, 2 and/or 4, relating to collider types. 4 should usually be used.
  * @return A shape test handle.
@@ -36686,30 +36750,13 @@ declare function StartExpensiveSynchronousShapeTestLosProbe(x1: number, y1: numb
 /**
  * Does the same as [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E), except blocking until the shape test completes.
  * Use [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E) instead. Literally. Rockstar named this correctly: it's expensive, and it's synchronous.
- * ```
- * This function casts a ray from Point1 to Point2 and returns it's ray handle.  A simple ray cast will 'shoot' a line from point A to point B, and return whether or not the ray reached it's destination or if it hit anything and if it did hit anything, will return the handle of what it hit (entity handle) and coordinates of where the ray reached.
- * You can use _GET_RAYCAST_RESULT to get the result of the raycast
- * Entity is an entity to ignore, such as the player.
- * Flags are intersection bit flags.  They tell the ray what to care about and what not to care about when casting. Passing -1 will intersect with everything, presumably.
- * Flags:
- * 1: Intersect with map
- * 2: Intersect with vehicles (used to be mission entities?) (includes train)
- * 4: Intersect with peds? (same as 8)
- * 8: Intersect with peds? (same as 4)
- * 16: Intersect with objects
- * 32: Water?
- * 64: Unknown
- * 128: Unknown
- * 256: Intersect with vegetation (plants, coral. trees not included)
- * NOTE: Raycasts that intersect with mission_entites (flag = 2) has limited range and will not register for far away entites. The range seems to be about 30 metres.
- * ```
  * @param x1 Starting X coordinate.
  * @param y1 Starting Y coordinate.
  * @param z1 Starting Z coordinate.
  * @param x2 Ending X coordinate.
  * @param y2 Ending Y coordinate.
  * @param z2 Ending Z coordinate.
- * @param flags Flags.
+ * @param flags See [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E).
  * @param entity An entity to ignore, or 0.
  * @param p8 A bit mask with bits 1, 2 and/or 4, relating to collider types. 4 should usually be used.
  * @return A shape test handle.
@@ -36718,30 +36765,13 @@ declare function CastRayPointToPoint(x1: number, y1: number, z1: number, x2: num
 /**
  * Does the same as [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E), except blocking until the shape test completes.
  * Use [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E) instead. Literally. Rockstar named this correctly: it's expensive, and it's synchronous.
- * ```
- * This function casts a ray from Point1 to Point2 and returns it's ray handle.  A simple ray cast will 'shoot' a line from point A to point B, and return whether or not the ray reached it's destination or if it hit anything and if it did hit anything, will return the handle of what it hit (entity handle) and coordinates of where the ray reached.
- * You can use _GET_RAYCAST_RESULT to get the result of the raycast
- * Entity is an entity to ignore, such as the player.
- * Flags are intersection bit flags.  They tell the ray what to care about and what not to care about when casting. Passing -1 will intersect with everything, presumably.
- * Flags:
- * 1: Intersect with map
- * 2: Intersect with vehicles (used to be mission entities?) (includes train)
- * 4: Intersect with peds? (same as 8)
- * 8: Intersect with peds? (same as 4)
- * 16: Intersect with objects
- * 32: Water?
- * 64: Unknown
- * 128: Unknown
- * 256: Intersect with vegetation (plants, coral. trees not included)
- * NOTE: Raycasts that intersect with mission_entites (flag = 2) has limited range and will not register for far away entites. The range seems to be about 30 metres.
- * ```
  * @param x1 Starting X coordinate.
  * @param y1 Starting Y coordinate.
  * @param z1 Starting Z coordinate.
  * @param x2 Ending X coordinate.
  * @param y2 Ending Y coordinate.
  * @param z2 Ending Z coordinate.
- * @param flags Flags.
+ * @param flags See [START_SHAPE_TEST_LOS_PROBE](#\_0x7EE9F5D83DD4F90E).
  * @param entity An entity to ignore, or 0.
  * @param p8 A bit mask with bits 1, 2 and/or 4, relating to collider types. 4 should usually be used.
  * @return A shape test handle.
@@ -37073,44 +37103,96 @@ declare function StartScriptFire(X: number, Y: number, Z: number, maxChildren: n
 
 declare function StartScriptPhoneConversation(p0: boolean, p1: boolean): void;
 
+/**
+ * See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
+ */
 declare function StartShapeTestBound(entity: number, flags1: number, flags2: number): number;
+/**
+ * See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
+ */
 declare function N_0x37181417ce7c8900(entity: number, flags1: number, flags2: number): number;
 
+/**
+ * See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
+ */
 declare function StartShapeTestBoundingBox(entity: number, flags1: number, flags2: number): number;
+/**
+ * See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
+ */
 declare function N_0x052837721a854ec7(entity: number, flags1: number, flags2: number): number;
 
 /**
  * For more information, see [`START_EXPENSIVE_SYNCHRONOUS_SHAPE_TEST_LOS_PROBE`](#\_0x377906D8A31E5586) and [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E).
- */
-declare function StartShapeTestBox(x: number, y: number, z: number, x1: number, y2: number, z2: number, rotX: number, rotY: number, rotZ: number, p9: number, flags: number, entity: number, p12: number): number;
+ * @param x Starting X coordinate.
+ * @param y Starting Y coordinate.
+ * @param z Starting Z coordinate.
+ * @param x1 Ending X coordinate.
+ * @param y1 Ending Y coordinate.
+ * @param z1 Ending Z coordinate.
+ * @param p9 Unknown, always 2 or 0
+ * @param flags See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
+ * @param p12 A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
+ */
+declare function StartShapeTestBox(x: number, y: number, z: number, x1: number, y1: number, z1: number, rotX: number, rotY: number, rotZ: number, p9: number, flags: number, entity: number, p12: number): number;
 /**
  * For more information, see [`START_EXPENSIVE_SYNCHRONOUS_SHAPE_TEST_LOS_PROBE`](#\_0x377906D8A31E5586) and [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E).
+ * @param x Starting X coordinate.
+ * @param y Starting Y coordinate.
+ * @param z Starting Z coordinate.
+ * @param x1 Ending X coordinate.
+ * @param y1 Ending Y coordinate.
+ * @param z1 Ending Z coordinate.
+ * @param p9 Unknown, always 2 or 0
+ * @param flags See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
+ * @param p12 A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
  */
-declare function N_0xfe466162c4401d18(x: number, y: number, z: number, x1: number, y2: number, z2: number, rotX: number, rotY: number, rotZ: number, p9: number, flags: number, entity: number, p12: number): number;
+declare function N_0xfe466162c4401d18(x: number, y: number, z: number, x1: number, y1: number, z1: number, rotX: number, rotY: number, rotZ: number, p9: number, flags: number, entity: number, p12: number): number;
 
 /**
  * Raycast from point to point, where the ray has a radius.
- * flags:
- * vehicles=10
- * peds =12
- * Iterating through flags yields many ped / vehicle/ object combinations
- * p9 = 7, but no idea what it does
- * Entity is an entity to ignore
+ * @param x1 Starting X coordinate.
+ * @param y1 Starting Y coordinate.
+ * @param z1 Starting Z coordinate.
+ * @param x2 Ending X coordinate.
+ * @param y2 Ending Y coordinate.
+ * @param z2 Ending Z coordinate.
+ * @param flags See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
+ * @param entity Entity to ignore, or 0.
+ * @param p9 A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
  */
 declare function StartShapeTestCapsule(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, radius: number, flags: number, entity: number, p9: number): number;
 /**
  * Raycast from point to point, where the ray has a radius.
- * flags:
- * vehicles=10
- * peds =12
- * Iterating through flags yields many ped / vehicle/ object combinations
- * p9 = 7, but no idea what it does
- * Entity is an entity to ignore
+ * @param x1 Starting X coordinate.
+ * @param y1 Starting Y coordinate.
+ * @param z1 Starting Z coordinate.
+ * @param x2 Ending X coordinate.
+ * @param y2 Ending Y coordinate.
+ * @param z2 Ending Z coordinate.
+ * @param flags See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
+ * @param entity Entity to ignore, or 0.
+ * @param p9 A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
  */
 declare function Cast_3dRayPointToPoint(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, radius: number, flags: number, entity: number, p9: number): number;
 
 /**
  * Asynchronously starts a line-of-sight (raycast) world probe shape test.
+ * ```cpp
+ * enum TraceFlags
+ * {
+ * None = 0,
+ * IntersectWorld = 1,
+ * IntersectVehicles = 2,
+ * IntersectPedsSimpleCollision = 4,
+ * IntersectPeds = 8,
+ * IntersectObjects = 16,
+ * IntersectWater = 32,
+ * Unknown = 128,
+ * IntersectFoliage = 256,
+ * IntersectEverything = 4294967295
+ * }
+ * ```
+ * NOTE: Raycasts that intersect with mission_entites (flag = 2) has limited range and will not register for far away entites. The range seems to be about 30 metres.
  * Use the handle with [GET_SHAPE_TEST_RESULT](#\_0x3D87450E15D98694) or [GET_SHAPE_TEST_RESULT_INCLUDING_MATERIAL](#\_0x65287525D951F6BE) until it returns 0 or 2.
  * @param x1 Starting X coordinate.
  * @param y1 Starting Y coordinate.
@@ -37120,12 +37202,28 @@ declare function Cast_3dRayPointToPoint(x1: number, y1: number, z1: number, x2:
  * @param z2 Ending Z coordinate.
  * @param flags Flags.
  * @param entity An entity to ignore, or 0.
- * @param p8 A bit mask with bits 1, 2 and/or 4, relating to collider types. 4 should usually be used.
+ * @param p8 A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
  * @return A shape test handle.
  */
 declare function StartShapeTestLosProbe(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, flags: number, entity: number, p8: number): number;
 /**
  * Asynchronously starts a line-of-sight (raycast) world probe shape test.
+ * ```cpp
+ * enum TraceFlags
+ * {
+ * None = 0,
+ * IntersectWorld = 1,
+ * IntersectVehicles = 2,
+ * IntersectPedsSimpleCollision = 4,
+ * IntersectPeds = 8,
+ * IntersectObjects = 16,
+ * IntersectWater = 32,
+ * Unknown = 128,
+ * IntersectFoliage = 256,
+ * IntersectEverything = 4294967295
+ * }
+ * ```
+ * NOTE: Raycasts that intersect with mission_entites (flag = 2) has limited range and will not register for far away entites. The range seems to be about 30 metres.
  * Use the handle with [GET_SHAPE_TEST_RESULT](#\_0x3D87450E15D98694) or [GET_SHAPE_TEST_RESULT_INCLUDING_MATERIAL](#\_0x65287525D951F6BE) until it returns 0 or 2.
  * @param x1 Starting X coordinate.
  * @param y1 Starting Y coordinate.
@@ -37135,7 +37233,7 @@ declare function StartShapeTestLosProbe(x1: number, y1: number, z1: number, x2:
  * @param z2 Ending Z coordinate.
  * @param flags Flags.
  * @param entity An entity to ignore, or 0.
- * @param p8 A bit mask with bits 1, 2 and/or 4, relating to collider types. 4 should usually be used.
+ * @param p8 A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
  * @return A shape test handle.
  */
 declare function N_0x7ee9f5d83dd4f90e(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, flags: number, entity: number, p8: number): number;
@@ -37147,6 +37245,7 @@ declare function N_0x7ee9f5d83dd4f90e(x1: number, y1: number, z1: number, x2: nu
  * it returns a ShapeTest handle that can be used with GET_SHAPE_TEST_RESULT.
  * In its only usage in game scripts its called with flag set to 511, entity to player_ped_id and flag2 set to 7
  * ```
+ * See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
  */
 declare function StartShapeTestSurroundingCoords(flag: number, entity: number, flag2: number): [number, number[], number[]];
 /**
@@ -37156,19 +37255,47 @@ declare function StartShapeTestSurroundingCoords(flag: number, entity: number, f
  * it returns a ShapeTest handle that can be used with GET_SHAPE_TEST_RESULT.
  * In its only usage in game scripts its called with flag set to 511, entity to player_ped_id and flag2 set to 7
  * ```
+ * See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E) for flags.
  */
 declare function N_0xff6be494c7987f34(flag: number, entity: number, flag2: number): [number, number[], number[]];
 
 /**
  * Performs the same type of trace as START_SHAPE_TEST_CAPSULE, but with some different hardcoded parameters.
+ * @param x1 Starting X coordinate.
+ * @param y1 Starting Y coordinate.
+ * @param z1 Starting Z coordinate.
+ * @param x2 Ending X coordinate.
+ * @param y2 Ending Y coordinate.
+ * @param z2 Ending Z coordinate.
+ * @param flags See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
+ * @param entity An entity to ignore, or 0.
+ * @param p9 A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
  */
 declare function StartShapeTestSweptSphere(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, radius: number, flags: number, entity: number, p9: number): number;
 /**
  * Performs the same type of trace as START_SHAPE_TEST_CAPSULE, but with some different hardcoded parameters.
+ * @param x1 Starting X coordinate.
+ * @param y1 Starting Y coordinate.
+ * @param z1 Starting Z coordinate.
+ * @param x2 Ending X coordinate.
+ * @param y2 Ending Y coordinate.
+ * @param z2 Ending Z coordinate.
+ * @param flags See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
+ * @param entity An entity to ignore, or 0.
+ * @param p9 A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
  */
 declare function N_0xe6ac6c45fbe83004(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, radius: number, flags: number, entity: number, p9: number): number;
 /**
  * Performs the same type of trace as START_SHAPE_TEST_CAPSULE, but with some different hardcoded parameters.
+ * @param x1 Starting X coordinate.
+ * @param y1 Starting Y coordinate.
+ * @param z1 Starting Z coordinate.
+ * @param x2 Ending X coordinate.
+ * @param y2 Ending Y coordinate.
+ * @param z2 Ending Z coordinate.
+ * @param flags See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
+ * @param entity An entity to ignore, or 0.
+ * @param p9 A bit mask with bits 1, 2, 4, or 7 relating to collider types. 4 and 7 are usually used.
  */
 declare function StartShapeTestCapsule_2(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, radius: number, flags: number, entity: number, p9: number): number;
 
@@ -39047,11 +39174,15 @@ declare function TerraingridSetParams(x: number, y: number, z: number, p3: numbe
  */
 declare function N_0x1c4fc5752bcd8e48(x: number, y: number, z: number, p3: number, rotation: number, p5: number, width: number, height: number, p8: number, scale: number, glowIntensity: number, normalHeight: number, heightDiff: number): void;
 
-declare function TestProbeAgainstAllWater(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number, p7: number): boolean;
+/**
+ * Flags are identical to START_SHAPE_TEST\*, however, 128 is automatically set.
+ * @param flag See [`START_SHAPE_TEST_LOS_PROBE`](#\_0x7EE9F5D83DD4F90E)
+ */
+declare function TestProbeAgainstAllWater(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, flag: number): [boolean, number[]];
 
 declare function TestProbeAgainstWater(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number): [boolean, number[]];
 
-declare function TestVerticalProbeAgainstAllWater(x: number, y: number, z: number, p3: number, height?: number): [boolean, number];
+declare function TestVerticalProbeAgainstAllWater(x: number, y: number, z: number, flag: number, height?: number): [boolean, number];
 
 declare function TextureDownloadGetName(p0: number): string;
 

package/package.json

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