@citizenfx/server 2.0.14862-1 → 2.0.18270-1

package/build.sh

@@ -22,5 +22,5 @@ npm config set git-tag-version false
 cp -a $ROOT/out/server/citizen/scripting/v8/index.d.ts $ROOT/out/server/citizen/scripting/v8/natives_server.d.ts .
 sed -i 's/natives_universal\.d\.ts/natives_server.d.ts/g' index.d.ts
 npm version "2.0.${CI_PIPELINE_ID}-1"
-npm publish
+npm publish --tag latest
 fi

package/natives_server.d.ts

@@ -167,8 +167,8 @@ declare function SetPedDecoration(ped: number, collection: string | number, over
  * *   **reserved**: Currently unused.
  * *   **replicated**: Whether the set is meant to be replicated.
  * At this time, the change handler can't opt to reject changes.
- * If bagName refers to an entity, use [GET_ENTITY_FROM_STATE_BAG_NAME](?\_0x4BDF1868) to get the entity handle
- * If bagName refers to a player, use [GET_PLAYER_FROM_STATE_BAG_NAME](?\_0xA56135E0) to get the player handle
+ * If bagName refers to an entity, use [GET_ENTITY_FROM_STATE_BAG_NAME](#\_0x4BDF1867) to get the entity handle
+ * If bagName refers to a player, use [GET_PLAYER_FROM_STATE_BAG_NAME](#\_0xA56135E0) to get the player handle
  * @param keyFilter The key to check for, or null for no filter.
  * @param bagFilter The bag ID to check for such as `entity:65535`, or null for no filter.
  * @param handler The handler function.
@@ -390,6 +390,13 @@ declare function DoesPlayerOwnSku(playerSrc: string, skuId: number): boolean;
  */
 declare function DoesPlayerOwnSkuExt(playerSrc: string, skuId: number): boolean;
 
+/**
+ * DOES_TRAIN_STOP_AT_STATIONS
+ * @param train The train handle
+ * @return True if the train stops at stations. False otherwise
+ */
+declare function DoesTrainStopAtStations(train: number): boolean;
+
 /**
  * DROP_PLAYER
  */
@@ -596,7 +603,7 @@ declare function GetEntityCollisionDisabled(entity: number): boolean;
 declare function GetEntityCoords(entity: number): number[];
 
 /**
- * Returns the entity handle for the specified state bag name. For use with [ADD_STATE_BAG_CHANGE_HANDLER](?\_0x5BA35AAF).
+ * Returns the entity handle for the specified state bag name. For use with [ADD_STATE_BAG_CHANGE_HANDLER](#\_0x5BA35AAF).
  * @param bagName An internal state bag ID from the argument to a state bag change handler.
  * @return The entity handle or 0 if the state bag name did not refer to an entity, or the entity does not exist.
  */
@@ -745,6 +752,7 @@ declare function GetEntityVelocity(entity: number): number[];
  * *   3258
  * *   3323
  * *   3407
+ * *   3570
  * *   RedM
  * *   1311
  * *   1355
@@ -837,7 +845,7 @@ declare function GetHeliMainRotorDamageScale(heli: number): number;
 /**
  * GET_HELI_MAIN_ROTOR_HEALTH
  * @param vehicle The target vehicle.
- * @return See the client-side [GET_HELI_MAIN_ROTOR_HEALTH](https://docs.fivem.net/natives/?\_0xE4CB7541F413D2C5) for the return value.
+ * @return See the client-side [GET_HELI_MAIN_ROTOR_HEALTH](#\_0xE4CB7541F413D2C5) for the return value.
  */
 declare function GetHeliMainRotorHealth(vehicle: number): number;
 
@@ -949,6 +957,69 @@ declare function GetLandingGearState(vehicle: number): number;
  */
 declare function GetLastPedInVehicleSeat(vehicle: number, seatIndex: number): number;
 
+/**
+ * Gets the specific entity type (as an integer), which can be one of the following defined down below:
+ * #### FiveM:
+ * ```cpp
+ * enum eNetObjEntityType
+ * {
+ * Automobile = 0,
+ * Bike = 1,
+ * Boat = 2,
+ * Door = 3,
+ * Heli = 4,
+ * Object = 5,
+ * Ped = 6,
+ * Pickup = 7,
+ * PickupPlacement = 8,
+ * Plane = 9,
+ * Submarine = 10,
+ * Player = 11,
+ * Trailer = 12,
+ * Train = 13
+ * };
+ * ```
+ * #### RedM:
+ * ```cpp
+ * enum eNetObjEntityType
+ * {
+ * Animal = 0,
+ * Automobile = 1,
+ * Bike = 2,
+ * Boat = 3,
+ * Door = 4,
+ * Heli = 5,
+ * Object = 6,
+ * Ped = 7,
+ * Pickup = 8,
+ * PickupPlacement = 9,
+ * Plane = 10,
+ * Submarine = 11,
+ * Player = 12,
+ * Trailer = 13,
+ * Train = 14,
+ * DraftVeh = 15,
+ * StatsTracker = 16,
+ * PropSet = 17,
+ * AnimScene = 18,
+ * GroupScenario = 19,
+ * Herd = 20,
+ * Horse = 21,
+ * WorldState = 22,
+ * WorldProjectile = 23,
+ * Incident = 24,
+ * Guardzone = 25,
+ * PedGroup = 26,
+ * CombatDirector = 27,
+ * PedSharedTargeting = 28,
+ * Persistent = 29
+ * };
+ * ```
+ * @param entity The entity to get the specific type of.
+ * @return The specific entity type returned as an integer value or -1 if the entity is invalid.
+ */
+declare function GetNetTypeFromEntity(entity: number): number;
+
 /**
  * GET_NUM_PLAYER_IDENTIFIERS
  */
@@ -1109,8 +1180,8 @@ declare function GetPlayerFromStateBagName(bagName: string): number;
 declare function GetPlayerGuid(playerSrc: string): string;
 
 /**
- * To get the number of identifiers, use [GET_NUM_PLAYER_IDENTIFIERS](?\_0xFF7F66AB)
- * To get a specific type of identifier, use [GET_PLAYER_IDENTIFIER_BY_TYPE](?\_0xA61C8FC6)
+ * To get the number of identifiers, use [GET_NUM_PLAYER_IDENTIFIERS](#\_0xFF7F66AB)
+ * To get a specific type of identifier, use [GET_PLAYER_IDENTIFIER_BY_TYPE](#\_0xA61C8FC6)
  * @return Returns the identifier at the specific index, if out of bounds returns `null`
  */
 declare function GetPlayerIdentifier(playerSrc: string, identiferIndex: number): string;
@@ -1410,6 +1481,13 @@ declare function GetThrusterSideRcsThrottle(jetpack: number): number;
  */
 declare function GetThrusterThrottle(jetpack: number): number;
 
+/**
+ * GET_TRAIN_BACKWARD_CARRIAGE
+ * @param train The train handle
+ * @return The handle of the carriage behind this train in the chain. Otherwise returns 0 if the train is the caboose of the chain.
+ */
+declare function GetTrainBackwardCarriage(train: number): number;
+
 /**
  * GET_TRAIN_CARRIAGE_ENGINE
  * @param train The entity handle.
@@ -1424,6 +1502,51 @@ declare function GetTrainCarriageEngine(train: number): number;
  */
 declare function GetTrainCarriageIndex(train: number): number;
 
+/**
+ * Gets the trains desired speed.
+ * @param train The train handle
+ * @return The desired cruise speed of the train. Not the speed the train is currently traveling at
+ */
+declare function GetTrainCruiseSpeed(train: number): number;
+
+/**
+ * Gets the direction the train is facing
+ * @param train The train handle
+ * @return True if the train is moving forward on the track, False otherwise
+ */
+declare function GetTrainDirection(train: number): boolean;
+
+/**
+ * GET_TRAIN_FORWARD_CARRIAGE
+ * @param train The train handle
+ * @return The handle of the carriage in front of this train in the chain. Otherwise returns 0 if the train has no carriage in front of it
+ */
+declare function GetTrainForwardCarriage(train: number): number;
+
+/**
+ * GET_TRAIN_STATE
+ * @param train The train handle
+ * @return The trains current state```cpp
+enum eTrainState
+{
+    MOVING = 0,
+    ENTERING_STATION,
+    OPENING_DOORS,
+    STOPPED,
+    CLOSING_DOORS,
+    LEAVING_STATION,
+}
+```
+ */
+declare function GetTrainState(train: number): number;
+
+/**
+ * GET_TRAIN_TRACK_INDEX
+ * @param train The train handle
+ * @return The track index the train is currently on.
+ */
+declare function GetTrainTrackIndex(train: number): number;
+
 /**
  * GET_VEHICLE_BODY_HEALTH
  */
@@ -1522,7 +1645,7 @@ declare function GetVehicleHeadlightsColour(vehicle: number): number;
 declare function GetVehicleHomingLockonState(vehicle: number): number;
 
 /**
- * This is a getter for the client-side native [`START_VEHICLE_HORN`](https://docs.fivem.net/natives/?\_0x9C8C6504B5B63D2C), which allows you to return the horn type of the vehicle.
+ * This is a getter for the client-side native [`START_VEHICLE_HORN`](#\_0x9C8C6504B5B63D2C), which allows you to return the horn type of the vehicle.
  * **Note**: This native only gets the hash value set with `START_VEHICLE_HORN`. If a wrong hash is passed into `START_VEHICLE_HORN`, it will return this wrong hash.
  * ```cpp
  * enum eHornTypes
@@ -1830,6 +1953,13 @@ declare function IsPlayerUsingSuperJump(playerSrc: string): boolean;
  */
 declare function IsPrincipalAceAllowed(principal: string, object: string): boolean;
 
+/**
+ * IS_TRAIN_CABOOSE
+ * @param train The train handle
+ * @return Returns true if the train is the caboose of the chain.
+ */
+declare function IsTrainCaboose(train: number): boolean;
+
 /**
  * IS_VEHICLE_ENGINE_STARTING
  */
@@ -1851,7 +1981,7 @@ declare function IsVehicleSirenOn(vehicle: number): boolean;
 declare function IsVehicleTyreBurst(vehicle: number, wheelID: number, completely: boolean): boolean;
 
 /**
- * See the client-side [IS_VEHICLE_WINDOW_INTACT](https://docs.fivem.net/natives/?\_0x46E571A0E20D01F1) for a window indexes list.
+ * See the client-side [IS_VEHICLE_WINDOW_INTACT](#\_0x46E571A0E20D01F1) for a window indexes list.
  * @param vehicle The target vehicle.
  * @param windowIndex The window index.
  */
@@ -2896,7 +3026,7 @@ declare function SetPedHairColor(ped: number, colorID: number, highlightColorID:
  * **Other information:**
  * IDs start at zero and go Male Non-DLC, Female Non-DLC, Male DLC, and Female DLC.</br>
  * This native function is often called prior to calling natives such as:
- * *   [`SetPedHairColor`](#\_0xBB43F090)
+ * *   [`SetPedHairColor`](#\_0xA23FE32C)
  * *   [`SetPedHeadOverlayColor`](#\_0x78935A27)
  * *   [`SetPedHeadOverlay`](#\_0xD28DBA90)
  * *   [`SetPedFaceFeature`](#\_0x6C8D4458)

package/package.json

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