@citizenfx/client 2.0.6335-1 → 2.0.6342-1

package/natives_universal.d.ts

@@ -7170,6 +7170,20 @@ declare function N_0xc1f981a6f74f0c23(vehicle: number, p1: boolean): void;
 declare function GetBoatBoomPositionRatio_3(vehicle: number, p1: boolean): void;
 declare function N_0x0f3b4d4e43177236(vehicle: number, p1: boolean): void;
 
+/**
+ * This native returns the index of a calming quad if the given point is inside its bounds.
+ * @param x The X coordinate
+ * @param y The Y coordinate
+ * @return The calming quad index at the given position. Returns -1 if there isn't any there.
+ */
+declare function GetCalmingQuadAtCoords(x: number, y: number): number;
+
+declare function GetCalmingQuadBounds(waterQuad: number): [boolean, number, number, number, number];
+
+declare function GetCalmingQuadCount(): number;
+
+declare function GetCalmingQuadDampening(waterQuad: number, calmingQuadDampening?: number): [boolean, number];
+
 /**
  * Enumerated type defined in camControlHelperMetadataViewModes:
  * ```cpp
@@ -13535,6 +13549,71 @@ declare function GetWaterHeight(x: number, y: number, z: number, height?: number
 
 declare function GetWaterHeightNoWaves(x: number, y: number, z: number, height?: number): [boolean, number];
 
+declare function GetWaterQuadAlpha(waterQuad: number): [boolean, number, number, number, number];
+
+/**
+ * This native returns the index of a water quad if the given point is inside its bounds.
+ * *If you also want to check for water level, check out [`GetWaterQuadAtCoords_3d`](#\_0xF8E03DB8)*
+ * @param x The X coordinate
+ * @param y The Y coordinate
+ * @return The water quad index at the given position. Returns -1 if there isn't any there.
+ */
+declare function GetWaterQuadAtCoords(x: number, y: number): number;
+
+/**
+ * This alternative implementation of [`GetWaterQuadAtCoords`](#\_0x17321452) also checks the height of the water level.
+ * @param x The X coordinate
+ * @param y The Y coordinate
+ * @param z The water level inside the water quad
+ * @return The water quad index at the given position. Returns -1 if there isn't any there. Also returns -1 if the given point is above the water level.
+ */
+declare function GetWaterQuadAtCoords_3d(x: number, y: number, z: number): number;
+
+declare function GetWaterQuadBounds(waterQuad: number): [boolean, number, number, number, number];
+
+declare function GetWaterQuadCount(): number;
+
+declare function GetWaterQuadHasLimitedDepth(waterQuad: number, hasLimitedDepth?: number): [boolean, number];
+
+declare function GetWaterQuadIsInvisible(waterQuad: number, isInvisible?: number): [boolean, number];
+
+/**
+ * *level is defined as "z" in water.xml*
+ * @param waterQuad The returned water quad level
+ * @return Returns true on success. Level is undefined on failure
+ */
+declare function GetWaterQuadLevel(waterQuad: number, waterQuadLevel?: number): [boolean, number];
+
+declare function GetWaterQuadNoStencil(waterQuad: number, noStencil?: number): [boolean, number];
+
+/**
+ * Valid type definitions:
+ * *   **0** Square
+ * *   **1** Right triangle where the 90 degree angle is at maxX, minY
+ * *   **2** Right triangle where the 90 degree angle is at minX, minY
+ * *   **3** Right triangle where the 90 degree angle is at minX, maxY
+ * *   **4** Right triangle where the 90 degree angle is at maxY, maxY
+ * @param waterQuad The water quad index
+ * @return Returns true on success. Type is undefined on failure
+ */
+declare function GetWaterQuadType(waterQuad: number, waterType?: number): [boolean, number];
+
+declare function GetWaveQuadAmplitude(waveQuad: number, waveQuadAmplitude?: number): [boolean, number];
+
+/**
+ * This native returns the index of a wave quad if the given point is inside its bounds.
+ * @param x The X coordinate
+ * @param y The Y coordinate
+ * @return The wave quad index at the given position. Returns -1 if there isn't any there.
+ */
+declare function GetWaveQuadAtCoords(x: number, y: number): number;
+
+declare function GetWaveQuadBounds(waveQuad: number): [boolean, number, number, number, number];
+
+declare function GetWaveQuadCount(): number;
+
+declare function GetWaveQuadDirection(waveQuad: number): [boolean, number, number];
+
 declare function GetWaypointBlipEnumId(): number;
 declare function GetBlipInfoIdIterator(): number;
 
@@ -16955,6 +17034,14 @@ declare function LoadStream(streamName: string, soundSet: string): boolean;
  */
 declare function LoadStreamWithStartOffset(streamName: string, startOffset: number, soundSet: string): boolean;
 
+/**
+ * Define the xml in a resources fxmanifest, under the file(s) section.
+ * @param resourceName The name of the resource containing your modified water definition
+ * @param fileName The name of the file
+ * @return Returns true on success.
+ */
+declare function LoadWaterFromPath(resourceName: string, fileName: string): boolean;
+
 declare function LoadingscreenGetLoadFreemode(): boolean;
 declare function N_0xef7d17bc6c85264c(): boolean;
 
@@ -27982,6 +28069,11 @@ declare function ResetVehicleWheels(vehicle: number, toggle: boolean): void;
 
 declare function ResetWantedLevelDifficulty(player: number): void;
 
+/**
+ * Resets the water to the games default water.xml.
+ */
+declare function ResetWater(): void;
+
 /**
  * NativeDB Introduced: v323
  */
@@ -29265,6 +29357,10 @@ declare function SetBoatSinksWhenWrecked(vehicle: number, toggle: boolean): void
 declare function N_0x8f719973e1445ba2(vehicle: number, toggle: boolean): void;
 declare function SetBoatExplodesOnWreckedAction(vehicle: number, toggle: boolean): void;
 
+declare function SetCalmingQuadBounds(waterQuad: number, minX: number, minY: number, maxX: number, maxY: number): boolean;
+
+declare function SetCalmingQuadDampening(calmingQuad: number, dampening: number): boolean;
+
 /**
  * Set camera as active/inactive.
  */
@@ -37691,6 +37787,66 @@ declare function SetWarningMessage_3(entryHeader: string, entryLine1: string, in
  */
 declare function SetWarningMessageWithHeaderUnk(entryHeader: string, entryLine1: string, flags: number, entryLine2: string, p4: boolean, p5: number, showBg: boolean, p9: number, p10: number): [number, number];
 
+declare function SetWaterQuadAlpha(waterQuad: number, a0: number, a1: number, a2: number, a3: number): boolean;
+
+/**
+ * This native allows you to update the bounds of a specified water quad index.
+ * @param waterQuad The water quad index
+ * @param minX The minX coordinate
+ * @param minY The minY coordinate
+ * @param maxX The maxX coordinate
+ * @param maxY The maxY coordinate
+ * @return Returns true on success.
+ */
+declare function SetWaterQuadBounds(waterQuad: number, minX: number, minY: number, maxX: number, maxY: number): boolean;
+
+declare function SetWaterQuadHasLimitedDepth(waterQuad: number, hasLimitedDepth: boolean): boolean;
+
+declare function SetWaterQuadIsInvisible(waterQuad: number, isInvisible: boolean): boolean;
+
+declare function SetWaterQuadLevel(waterQuad: number, level: number): boolean;
+
+declare function SetWaterQuadNoStencil(waterQuad: number, noStencil: boolean): boolean;
+
+/**
+ * This native allows you to update the water quad type.
+ * Valid type definitions:
+ * *   **0** Square
+ * *   **1** Right triangle where the 90 degree angle is at maxX, minY
+ * *   **2** Right triangle where the 90 degree angle is at minX, minY
+ * *   **3** Right triangle where the 90 degree angle is at minX, maxY
+ * *   **4** Right triangle where the 90 degree angle is at maxY, maxY
+ * @param waterQuad The water quad index
+ * @param type The water quad type
+ * @return Returns true on success.
+ */
+declare function SetWaterQuadType(waterQuad: number, _type: number): boolean;
+
+declare function SetWaveQuadAmplitude(waveQuad: number, amplitude: number): boolean;
+
+/**
+ * This native allows you to update the bounds of a specified water quad index.
+ * @param waveQuad The wave quad index
+ * @param minX The minX coordinate
+ * @param minY The minY coordinate
+ * @param maxX The maxX coordinate
+ * @param maxY The maxY coordinate
+ * @return Returns true on success.
+ */
+declare function SetWaveQuadBounds(waveQuad: number, minX: number, minY: number, maxX: number, maxY: number): boolean;
+
+/**
+ * directionX/Y should be constrained between -1.0 and 1.0
+ * A positive value will create the wave starting at min and rolling towards max
+ * A negative value will create the wave starting at max and rolling towards min
+ * Applying both values allows you to make diagonal waves
+ * @param waveQuad The wave quad index
+ * @param directionX The minX coordinate
+ * @param directionY The minY coordinate
+ * @return Returns true on success.
+ */
+declare function SetWaveQuadDirection(waveQuad: number, directionX: number, directionY: number): boolean;
+
 /**
  * This native removes the current waypoint from the map.
  * Example:

package/package.json

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