@citizenfx/client 2.0.4590-1 → 2.0.4598-1

package/natives_universal.d.ts

@@ -9880,21 +9880,12 @@ declare function N_0x9d728c1e12bf5518(ped: number): number;
 /**
  * Gets the ped in the specified seat of the passed vehicle.
  * If there is no ped in the seat, and the game considers the vehicle as ambient population, this will create a random occupant ped in the seat, which may be cleaned up by the game fairly soon if not marked as script-owned mission entity.
- * Seat indexes:
- * *   \-1 = Driver
- * *   0 = Front Right Passenger
- * *   1 = Back Left Passenger
- * *   2 = Back Right Passenger
- * *   3 = Further Back Left Passenger (vehicles > 4 seats)
- * *   4 = Further Back Right Passenger (vehicles > 4 seats)
- * *   etc.
- * One can use GET_VEHICLE_MAX_NUMBER_OF_PASSENGERS(vehicle) to get the amount of seats in a vehicle.
  * **NativeDB Added Parameter 3**: BOOL p2 (uses a different GetOccupant function)
  * @param vehicle The vehicle to get the ped for.
- * @param index The seat index.
+ * @param seatIndex See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
  * @return A handle to a ped in the specified vehicle seat, or 0 if no such ped existed.
  */
-declare function GetPedInVehicleSeat(vehicle: number, index: number): number;
+declare function GetPedInVehicleSeat(vehicle: number, seatIndex: number): number;
 
 /**
  * Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).
@@ -15421,27 +15412,43 @@ declare function IsVehicleSearchlightOn(vehicle: number): boolean;
 
 /**
  * Check if a vehicle seat is accessible. If you park your vehicle near a wall and the ped cannot enter/exit this side, the return value toggles from true (not blocked) to false (blocked).
- * seatIndex  = -1 being the driver seat.
- * Use GET_VEHICLE_MAX_NUMBER_OF_PASSENGERS(vehicle) - 1 for last seat index.
  * side = only relevant for bikes/motorcycles to check if the left (false)/right (true) side is blocked.
  * onEnter = check if you can enter (true) or exit (false) a vehicle.
+ * @param vehicle The vehicle to check.
+ * @param seatIndex See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
  */
 declare function IsVehicleSeatAccessible(ped: number, vehicle: number, seatIndex: number, side: boolean, onEnter: boolean): boolean;
 /**
  * Check if a vehicle seat is accessible. If you park your vehicle near a wall and the ped cannot enter/exit this side, the return value toggles from true (not blocked) to false (blocked).
- * seatIndex  = -1 being the driver seat.
- * Use GET_VEHICLE_MAX_NUMBER_OF_PASSENGERS(vehicle) - 1 for last seat index.
  * side = only relevant for bikes/motorcycles to check if the left (false)/right (true) side is blocked.
  * onEnter = check if you can enter (true) or exit (false) a vehicle.
+ * @param vehicle The vehicle to check.
+ * @param seatIndex See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
  */
 declare function N_0x639431e895b9aa57(ped: number, vehicle: number, seatIndex: number, side: boolean, onEnter: boolean): boolean;
 
 /**
- * Use GET_VEHICLE_MAX_NUMBER_OF_PASSENGERS(vehicle) - 1 for last seat index.
- * isTaskRunning = on true the function returns already false while a task on the target seat is running (TASK_ENTER_VEHICLE/TASK_SHUFFLE_TO_NEXT_VEHICLE_SEAT) - on false only when a ped is finally sitting in the seat.
+ * Seat indices range from -1 to [`GET_VEHICLE_MAX_NUMBER_OF_PASSENGERS`](#\_0xA7C4F2C6E744A550) minus one.
+ * ```cpp
+ * // CTaskExitVehicleSeat::eSeatPosition - 1
+ * enum eSeatPosition
+ * {
+ * SF_FrontDriverSide = -1,
+ * SF_FrontPassengerSide = 0,
+ * SF_BackDriverSide = 1,
+ * SF_BackPassengerSide = 2,
+ * SF_AltFrontDriverSide = 3,
+ * SF_AltFrontPassengerSide = 4,
+ * SF_AltBackDriverSide = 5,
+ * SF_AltBackPassengerSide = 6,
+ * };
  * ```
  * ```
  * NativeDB Added Parameter 3: BOOL isTaskRunning
+ * isTaskRunning = on true the function returns already false while a task on the target seat is running (TASK_ENTER_VEHICLE/TASK_SHUFFLE_TO_NEXT_VEHICLE_SEAT) - on false only when a ped is finally sitting in the seat.
+ * ```
+ * @param vehicle The vehicle to check.
+ * @param seatIndex The eSeatPosition or -2 for **any** vehicle seat.
  */
 declare function IsVehicleSeatFree(vehicle: number, seatIndex: number): boolean;
 
@@ -20861,6 +20868,10 @@ declare function NetworkClanAnimation(animDict: string, animName: string): boole
  */
 declare function N_0x729e3401f0430686(animDict: string, animName: string): boolean;
 
+declare function NetworkClanAnyDownloadMembershipPending(): boolean;
+declare function N_0xb3f64a6a91432477(): boolean;
+declare function NetworkIsClanMembershipFinishedDownloading(): boolean;
+
 declare function NetworkClanDownloadMembership(networkHandle: number): [boolean, number];
 
 declare function NetworkClanDownloadMembershipPending(p0: number): [boolean, number];
@@ -20908,7 +20919,13 @@ declare function NetworkClanGetMembershipCount(p0: number): [number, number];
 
 declare function NetworkClanGetMembershipDesc(p1: number): [boolean, number];
 
-declare function NetworkClanGetMembershipValid(p1: number): [boolean, number];
+/**
+ * Checks if a crew/membership for a player, from the cache (i.e. downloaded via NETWORK_CLAN_DOWNLOAD_MEMBERSHIP) is valid.
+ * @param networkHandle A player network handle.
+ * @param membershipIndex If the player has multiple crews/memberships, use \[0-9], or -1 to get the active crew/membership.
+ * @return Returns true if valid, false otherwise.
+ */
+declare function NetworkClanGetMembershipValid(membershipIndex: number): [boolean, number];
 
 /**
  * bufferSize is 35 in the scripts.
@@ -22293,9 +22310,6 @@ declare function N_0xeffb25453d8600f9(): boolean;
  */
 declare function NetworkIsChattingInPlatformParty(networkHandle: number): [boolean, number];
 
-declare function NetworkIsClanMembershipFinishedDownloading(): boolean;
-declare function N_0xb3f64a6a91432477(): boolean;
-
 declare function NetworkIsClockTimeOverridden(): boolean;
 declare function N_0xd7c95d322ff57522(): boolean;
 
@@ -31547,16 +31561,6 @@ declare function SetPedInfiniteAmmo(ped: number, toggle: boolean, weaponHash: st
 
 declare function SetPedInfiniteAmmoClip(ped: number, toggle: boolean): void;
 
-/**
- * Ped: The ped to warp.
- * vehicle: The vehicle to warp the ped into.
- * Seat_Index: [-1 is driver seat, -2 first free passenger seat]
- * Moreinfo of Seat Index
- * DriverSeat = -1
- * Passenger = 0
- * Left Rear = 1
- * RightRear = 2
- */
 declare function SetPedIntoVehicle(ped: number, vehicle: number, seatIndex: number): void;
 
 /**
@@ -31971,10 +31975,12 @@ declare function SetPedUsingActionMode(ped: number, p1: boolean, p2: number, act
 
 /**
  * NativeDB Added Parameter 5: Any p4
+ * @param seatIndex See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
  */
 declare function SetPedVehicleForcedSeatUsage(ped: number, vehicle: number, seatIndex: number, flags: number): void;
 /**
  * NativeDB Added Parameter 5: Any p4
+ * @param seatIndex See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
  */
 declare function N_0x952f06beecd775cc(ped: number, vehicle: number, seatIndex: number, flags: number): void;
 
@@ -37711,15 +37717,9 @@ declare function TaskDriveBy(driverPed: number, targetPed: number, targetVehicle
  * speed 1.0 = walk, 2.0 = run
  * p5 1 = normal, 3 = teleport to vehicle, 16 = teleport directly into vehicle
  * p6 is always 0
- * Usage of seat
- * -1 = driver
- * 0 = passenger
- * 1 = left back seat
- * 2 = right back seat
- * 3 = outside left
- * 4 = outside right
+ * @param seatIndex See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
  */
-declare function TaskEnterVehicle(ped: number, vehicle: number, timeout: number, seat: number, speed: number, flag: number, p6: number): void;
+declare function TaskEnterVehicle(ped: number, vehicle: number, timeout: number, seatIndex: number, speed: number, flag: number, p6: number): void;
 
 declare function TaskEveryoneLeaveVehicle(vehicle: number): void;
 
@@ -38729,17 +38729,7 @@ declare function TaskWanderSpecific(p0: number, p1: number, p2: number, p3: numb
  */
 declare function TaskWanderStandard(ped: number, p1: number, p2: number): void;
 
-/**
- * Seat Numbers
- * -------------------------------
- * Driver = -1
- * Any = -2
- * Left-Rear = 1
- * Right-Front = 0
- * Right-Rear = 2
- * Extra seats = 3-14(This may differ from vehicle type e.g. Firetruck Rear Stand, Ambulance Rear)
- */
-declare function TaskWarpPedIntoVehicle(ped: number, vehicle: number, seat: number): void;
+declare function TaskWarpPedIntoVehicle(ped: number, vehicle: number, seatIndex: number): void;
 
 /**
  * NativeDB Added Parameter 5: Any p4

package/package.json

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