@citizenfx/client 2.0.37579-1 → 2.0.37692-1

package/natives_universal.d.ts

@@ -4811,6 +4811,72 @@ declare function CreateCheckpoint(_type: number, posX1: number, posY1: number, p
  */
 declare function CreateCinematicShot(p0: number, p1: number, p2: number, entity: number): void;
 
+/**
+ * Creates a 2D circular collision shape at the specified position.
+ * @param x Center X coordinate.
+ * @param y Center Y coordinate.
+ * @param radius Circle radius.
+ * @return The collision shape ID, or -1 on failure.
+ */
+declare function CreateColshapeCircle(x: number, y: number, radius: number): number;
+
+/**
+ * Creates an axis-aligned box collision shape at the specified 3D position.
+ * @param x Center X coordinate.
+ * @param y Center Y coordinate.
+ * @param z Center Z coordinate.
+ * @param width Total width.
+ * @param depth Total depth.
+ * @param height Total height.
+ * @return The collision shape ID, or -1 on failure.
+ */
+declare function CreateColshapeCuboid(x: number, y: number, z: number, width: number, depth: number, height: number): number;
+
+/**
+ * Creates a vertical cylinder collision shape at the specified 3D position.
+ * @param x Center X coordinate.
+ * @param y Center Y coordinate.
+ * @param z Center Z coordinate.
+ * @param radius Cylinder radius.
+ * @param height Total height.
+ * @return The collision shape ID, or -1 on failure.
+ */
+declare function CreateColshapeCylinder(x: number, y: number, z: number, radius: number, height: number): number;
+
+/**
+ * Creates a polygon collision shape defined by a set of 2D points extruded between `minZ` and `maxZ`. Requires at least 3 points.
+ * When an entity enters or leaves a collision shape, the `onColshapeEnter` and `onColshapeExit` events are triggered. Both events are called with the entity handle that triggered them and the collision shape ID.
+ * @param minZ Minimum Z height of the polygon.
+ * @param maxZ Maximum Z height of the polygon.
+ * @param points An array of interleaved x, y point pairs (e.g., `{x1, y1, x2, y2, x3, y3, ...}`). Must contain at least 3 pairs.
+ * @return The collision shape ID, or -1 on failure.
+ */
+declare function CreateColshapePolygon(minZ: number, maxZ: number, points: any): number;
+
+/**
+ * Creates a rotated rectangle collision shape at the specified 3D position.
+ * When an entity enters or leaves a collision shape, the `onColshapeEnter` and `onColshapeExit` events are triggered. Both events are called with the entity handle that triggered them and the collision shape ID.
+ * @param x Center X coordinate.
+ * @param y Center Y coordinate.
+ * @param z Center Z coordinate.
+ * @param width Total width.
+ * @param depth Total depth.
+ * @param heading Rotation heading in radians.
+ * @return The collision shape ID, or -1 on failure.
+ */
+declare function CreateColshapeRectangle(x: number, y: number, z: number, width: number, depth: number, heading: number): number;
+
+/**
+ * Creates a spherical collision shape at the specified 3D position.
+ * When an entity enters or leaves a collision shape, the `onColshapeEnter` and `onColshapeExit` events are triggered. Both events are called with the entity handle that triggered them and the collision shape ID.
+ * @param x Center X coordinate.
+ * @param y Center Y coordinate.
+ * @param z Center Z coordinate.
+ * @param radius Sphere radius.
+ * @return The collision shape ID, or -1 on failure.
+ */
+declare function CreateColshapeSphere(x: number, y: number, z: number, radius: number): number;
+
 /**
  * Creates a volume where water effects do not apply.
  * Useful for preventing water collisions from flooding areas underneath them.
@@ -5996,6 +6062,12 @@ declare function DeleteCheckpoint(checkpoint: number): void;
  */
 declare function DeleteChildRope(ropeId: number): void;
 
+/**
+ * Deletes the collision shape with the given ID.
+ * @param colShapeId The collision shape ID.
+ */
+declare function DeleteColshape(colShapeId: number): void;
+
 /**
  * Delete the specified entity, and invalidate the passed handle (i.e., the in/out argument).
  * You might want to check if the entity exists before with [DOES_ENTITY_EXIST](#\_0x7239B21A38F536BA).
@@ -6779,6 +6851,13 @@ declare function IsCargobobMagnetActive(cargobob: number): boolean;
  */
 declare function DoesCargobobHavePickupMagnet(cargobob: number): boolean;
 
+/**
+ * Returns whether a collision shape with the given ID exists.
+ * @param colShapeId The collision shape ID.
+ * @return Returns true if the collision shape exists, false otherwise.
+ */
+declare function DoesColshapeExist(colShapeId: number): boolean;
+
 /**
  * Checks if the context exists for the ped, searching through the voices in its PedVoiceGroup.
  * The final argument can be set to true to allow searching in backup PVGs
@@ -11038,6 +11117,74 @@ declare function N_0xf12e6cd06c73d69e(): string;
  */
 declare function GetCollisionNormalOfLastHitForEntity(entity: number): number[];
 
+/**
+ * Gets the data of a circle collision shape.
+ * @param colShapeId The collision shape ID.
+ * @param x Center X coordinate output.
+ * @param y Center Y coordinate output.
+ * @param radius Circle radius output.
+ * @return Returns true if the data was retrieved successfully. Returns false if the ID is invalid or the shape is of a different type.
+ */
+declare function GetColshapeCircleData(colShapeId: number): [boolean, number, number, number];
+
+/**
+ * Gets the data of a cuboid collision shape.
+ * @param colShapeId The collision shape ID.
+ * @param x Center X coordinate output.
+ * @param y Center Y coordinate output.
+ * @param z Center Z coordinate output.
+ * @param width Width output.
+ * @param depth Depth output.
+ * @param height Height output.
+ * @return Returns true if the data was retrieved successfully. Returns false if the ID is invalid or the shape is of a different type.
+ */
+declare function GetColshapeCuboidData(colShapeId: number): [boolean, number, number, number, number, number, number];
+
+/**
+ * Gets the data of a cylinder collision shape.
+ * @param colShapeId The collision shape ID.
+ * @param x Center X coordinate output.
+ * @param y Center Y coordinate output.
+ * @param z Center Z coordinate output.
+ * @param radius Cylinder radius output.
+ * @param height Height output.
+ * @return Returns true if the data was retrieved successfully. Returns false if the ID is invalid or the shape is of a different type.
+ */
+declare function GetColshapeCylinderData(colShapeId: number): [boolean, number, number, number, number, number];
+
+/**
+ * Gets the vertical bounds of a polygon collision shape.
+ * @param colShapeId The collision shape ID.
+ * @param minZ Lower Z bound output.
+ * @param maxZ Upper Z bound output.
+ * @return Returns true if the data was retrieved successfully. Returns false if the ID is invalid or the shape is of a different type.
+ */
+declare function GetColshapePolygonData(colShapeId: number): [boolean, number, number];
+
+/**
+ * Gets the data of a rectangle collision shape.
+ * @param colShapeId The collision shape ID.
+ * @param x Center X coordinate output.
+ * @param y Center Y coordinate output.
+ * @param z Center Z coordinate output.
+ * @param width Width output.
+ * @param depth Depth output.
+ * @param heading Heading output in radians.
+ * @return Returns true if the data was retrieved successfully. Returns false if the ID is invalid or the shape is of a different type.
+ */
+declare function GetColshapeRectangleData(colShapeId: number): [boolean, number, number, number, number, number, number];
+
+/**
+ * Gets the data of a sphere collision shape.
+ * @param colShapeId The collision shape ID.
+ * @param x Center X coordinate output.
+ * @param y Center Y coordinate output.
+ * @param z Center Z coordinate output.
+ * @param radius Sphere radius output.
+ * @return Returns true if the data was retrieved successfully. Returns false if the ID is invalid or the shape is of a different type.
+ */
+declare function GetColshapeSphereData(colShapeId: number): [boolean, number, number, number, number];
+
 /**
  * p0: Ped Handle
  * p1: int i | 0 <= i <= 27
@@ -22509,6 +22656,56 @@ declare function N_0xeea5ac2eda7c33e8(x: number, y: number, z: number): boolean;
  */
 declare function AreCoordsCollidingWithExterior(x: number, y: number, z: number): boolean;
 
+/**
+ * Returns whether the collision shape with the given ID is a circle.
+ * @param colShapeId The collision shape ID.
+ * @return Returns true if the collision shape exists and is a circle, false otherwise.
+ */
+declare function IsColshapeCircle(colShapeId: number): boolean;
+
+/**
+ * Returns whether the collision shape with the given ID is a cuboid.
+ * @param colShapeId The collision shape ID.
+ * @return Returns true if the collision shape exists and is a cuboid, false otherwise.
+ */
+declare function IsColshapeCuboid(colShapeId: number): boolean;
+
+/**
+ * Returns whether the collision shape with the given ID is a cylinder.
+ * @param colShapeId The collision shape ID.
+ * @return Returns true if the collision shape exists and is a cylinder, false otherwise.
+ */
+declare function IsColshapeCylinder(colShapeId: number): boolean;
+
+/**
+ * Returns whether the collision shape is set to detect the given entity type. Every type is enabled by default; a type reads as disabled only after `SET_COLSHAPE_ENTITY_TYPE(colShapeId, entityType, false)`.
+ * @param colShapeId The collision shape ID.
+ * @param entityType The sync (network) entity type index (e.g. GTA5: automobile `0`, object `5`, ped `6`, player `11`). See `SET_COLSHAPE_ENTITY_TYPE` for the full per-game tables.
+ * @return Returns true if the entity type is detected by the collision shape, false otherwise.
+ */
+declare function IsColshapeEntityTypeSet(colShapeId: number, entityType: number): boolean;
+
+/**
+ * Returns whether the collision shape with the given ID is a polygon.
+ * @param colShapeId The collision shape ID.
+ * @return Returns true if the collision shape exists and is a polygon, false otherwise.
+ */
+declare function IsColshapePolygon(colShapeId: number): boolean;
+
+/**
+ * Returns whether the collision shape with the given ID is a rectangle.
+ * @param colShapeId The collision shape ID.
+ * @return Returns true if the collision shape exists and is a rectangle, false otherwise.
+ */
+declare function IsColshapeRectangle(colShapeId: number): boolean;
+
+/**
+ * Returns whether the collision shape with the given ID is a sphere.
+ * @param colShapeId The collision shape ID.
+ * @return Returns true if the collision shape exists and is a sphere, false otherwise.
+ */
+declare function IsColshapeSphere(colShapeId: number): boolean;
+
 /**
  * Returns true if command line option '-benchmark' is set.
  */
@@ -24795,6 +24992,16 @@ declare function IsPlaylistUnk(tvChannel: number, p1: number): boolean;
  */
 declare function IsPointInAngledArea(xPos: number, yPos: number, zPos: number, x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, width: number, p10: boolean, includez: boolean): boolean;
 
+/**
+ * Returns whether the given 3D point is inside the collision shape.
+ * @param colShapeId The collision shape ID.
+ * @param x Point X coordinate.
+ * @param y Point Y coordinate.
+ * @param z Point Z coordinate.
+ * @return Returns true if the point is inside the collision shape, false otherwise.
+ */
+declare function IsPointInsideColshape(colShapeId: number, x: number, y: number, z: number): boolean;
+
 /**
  * IS_POINT_OBSCURED_BY_A_MISSION_ENTITY
  */
@@ -45774,6 +45981,53 @@ declare function N_0x39bbf623fc803eac(hudColor: number): void;
  */
 declare function SetNotificationColorNext(hudColor: number): void;
 
+/**
+ * Sets whether the collision shape should detect a specific entity type.
+ * By default every entity type is enabled, so a fresh collision shape detects all entities. Setting a type to `false` excludes only that type from detection; every other type stays as it was. To detect a single type (e.g. automobiles only) disable every other type.
+ * The entity type is the sync (network) entity type index (tables below), not the `GET_ENTITY_TYPE` classification.
+ * ### GTA5 sync entity types
+ * | Index | Type |
+ * | --- | --- |
+ * | 0 | automobile |
+ * | 1 | bike |
+ * | 2 | boat |
+ * | 3 | door |
+ * | 4 | heli |
+ * | 5 | object |
+ * | 6 | ped |
+ * | 7 | pickup |
+ * | 8 | pickup placement |
+ * | 9 | plane |
+ * | 10 | submarine |
+ * | 11 | player |
+ * | 12 | trailer |
+ * | 13 | train |
+ * ### RedM sync entity types
+ * | Index | Type |
+ * | --- | --- |
+ * | 0 | animal |
+ * | 1 | automobile |
+ * | 2 | bike |
+ * | 3 | boat |
+ * | 4 | door |
+ * | 5 | heli |
+ * | 6 | object |
+ * | 7 | ped |
+ * | 8 | pickup |
+ * | 9 | pickup placement |
+ * | 10 | plane |
+ * | 11 | submarine |
+ * | 12 | player |
+ * | 13 | trailer |
+ * | 14 | train |
+ * | 15 | draft vehicle |
+ * | 21 | horse |
+ * @param colShapeId The collision shape ID.
+ * @param entityType The sync entity type index (see the tables above).
+ * @param value `true` to include this entity type in detection, `false` to exclude it.
+ */
+declare function SetColshapeEntityType(colShapeId: number, entityType: number, value: boolean): void;
+
 /**
  * SET_COMBAT_FLOAT
  * @param combatType A value between 0-14, See [`GET_COMBAT_FLOAT`](#\_0x52DFF8A10508090A) for a list of possible parameters.

package/package.json

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