@citizenfx/client 2.0.11775-1 → 2.0.11873-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -15303,24 +15303,24 @@ declare function GetPedEventData(ped: number, eventType: number, outData?: numbe
15303
15303
  declare function GetPedExtractedDisplacement(ped: number, worldSpace: boolean): number[];
15304
15304
 
15305
15305
  /**
15306
- * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
15306
+ * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
15307
15307
  * @param ped The target ped
15308
15308
  * @return Returns ped's eye colour, or -1 if fails to get.
15309
15309
  */
15310
15310
  declare function GetPedEyeColor(ped: number): number;
15311
+
15311
15312
  /**
15312
15313
  * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
15313
15314
  * @param ped The target ped
15314
15315
  * @return Returns ped's eye colour, or -1 if fails to get.
15315
15316
  */
15316
- declare function N_0x76bba2cee66d47e9(ped: number): number;
15317
-
15317
+ declare function GetPedEyeColor(ped: number): number;
15318
15318
  /**
15319
- * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
15319
+ * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
15320
15320
  * @param ped The target ped
15321
15321
  * @return Returns ped's eye colour, or -1 if fails to get.
15322
15322
  */
15323
- declare function GetPedEyeColor(ped: number): number;
15323
+ declare function N_0x76bba2cee66d47e9(ped: number): number;
15324
15324
 
15325
15325
  /**
15326
15326
  * A getter for [\_SET_PED_FACE_FEATURE](#\_0x71A5C1DBA060049E). Returns 0.0 if fails to get.
@@ -17886,11 +17886,32 @@ declare function GetTotalSuccessfulStuntJumps(): number;
17886
17886
  */
17887
17887
  declare function N_0x6856ec3d35c81ea4(): number;
17888
17888
 
17889
+ /**
17890
+ * GET_TRACK_BRAKING_DISTANCE
17891
+ * @param track The track id (between 0 - 27)
17892
+ * @return The braking distance of the track. Used by trains to determine the point to slow down at when entering a station.
17893
+ */
17894
+ declare function GetTrackBrakingDistance(track: number): number;
17895
+
17896
+ /**
17897
+ * GET_TRACK_MAX_SPEED
17898
+ * @param track The track id (between 0 - 27)
17899
+ * @return The max speed of the track
17900
+ */
17901
+ declare function GetTrackMaxSpeed(track: number): number;
17902
+
17889
17903
  /**
17890
17904
  * Corrected p1. it's basically the 'carriage/trailer number'. So if the train has 3 trailers you'd call the native once with a var or 3 times with 1, 2, 3.
17891
17905
  */
17892
17906
  declare function GetTrainCarriage(train: number, trailerNumber: number): number;
17893
17907
 
17908
+ /**
17909
+ * Gets the trains desired speed.
17910
+ * @param train The train handle
17911
+ * @return The desired cruise speed of the train. Not the speed the train is currently traveling at
17912
+ */
17913
+ declare function GetTrainCruiseSpeed(train: number): number;
17914
+
17894
17915
  /**
17895
17916
  * GET_TRAIN_CURRENT_TRACK_NODE
17896
17917
  * @param train The target train.
@@ -17898,6 +17919,13 @@ declare function GetTrainCarriage(train: number, trailerNumber: number): number;
17898
17919
  */
17899
17920
  declare function GetTrainCurrentTrackNode(train: number): number;
17900
17921
 
17922
+ /**
17923
+ * Gets the direction the train is facing
17924
+ * @param train The train handle
17925
+ * @return True if the train is moving forward on the track, False otherwise
17926
+ */
17927
+ declare function GetTrainDirection(train: number): boolean;
17928
+
17901
17929
  /**
17902
17930
  * Gets the door count for the specified train.
17903
17931
  * @param train The train to obtain the door count for.
@@ -17913,6 +17941,30 @@ declare function GetTrainDoorCount(train: number): number;
17913
17941
  */
17914
17942
  declare function GetTrainDoorOpenRatio(train: number, doorIndex: number): number;
17915
17943
 
17944
+ /**
17945
+ * Gets the speed the train is currently going.
17946
+ * @param train The train handle
17947
+ * @return The current speed of the train
17948
+ */
17949
+ declare function GetTrainSpeed(train: number): number;
17950
+
17951
+ /**
17952
+ * GET_TRAIN_STATE
17953
+ * @param train The train handle
17954
+ * @return The trains current state```cpp
17955
+ enum eTrainState
17956
+ {
17957
+ MOVING = 0,
17958
+ ENTERING_STATION,
17959
+ OPENING_DOORS,
17960
+ STOPPED,
17961
+ CLOSING_DOORS,
17962
+ LEAVING_STATION,
17963
+ }
17964
+ ```
17965
+ */
17966
+ declare function GetTrainState(train: number): number;
17967
+
17916
17968
  /**
17917
17969
  * GET_TV_CHANNEL
17918
17970
  */
@@ -24690,6 +24742,20 @@ declare function SubtractAFromBAndCheckIfNegative(timeA: number, timeB: number):
24690
24742
  */
24691
24743
  declare function IsToggleModOn(vehicle: number, modType: number): boolean;
24692
24744
 
24745
+ /**
24746
+ * Getter for [SET_TRACK_ENABLED](?\_0x4b41e84c)
24747
+ * @param track The track id (between 0 - 27)
24748
+ * @return If this track is enabled.
24749
+ */
24750
+ declare function IsTrackEnabled(track: number): boolean;
24751
+
24752
+ /**
24753
+ * Getter for [SWITCH_TRAIN_TRACK](?\_0xFD813BB7DB977F20). Determines if ambient trains are able to spawn on this track.
24754
+ * @param track The track id (between 0 - 27)
24755
+ * @return If this track allows ambient trains to spawn
24756
+ */
24757
+ declare function IsTrackSwitchedOff(track: number): boolean;
24758
+
24693
24759
  /**
24694
24760
  * returns whether or not a ped is visible within your FOV, not this check auto's to false after a certain distance.
24695
24761
  * Target needs to be tracked.. won't work otherwise.
@@ -54029,6 +54095,27 @@ declare function SetTimecycleModifierStrength(strength: number): void;
54029
54095
  */
54030
54096
  declare function SetTimecycleModifierVar(modifierName: string, varName: string, value1: number, value2: number): void;
54031
54097
 
54098
+ /**
54099
+ * Sets the braking distance of the track. Used by trains to determine the point to slow down when entering a station.
54100
+ * @param track The track id (between 0 - 27)
54101
+ * @param brakingDistance The new braking distance
54102
+ */
54103
+ declare function SetTrackBrakingDistance(track: number, brakingDistance: number): void;
54104
+
54105
+ /**
54106
+ * Toggles the track being active. If disabled mission trains will not be able to spawn on this track and will look for the next closest track to spawn
54107
+ * @param track The track id (between 0 - 27)
54108
+ * @param enabled Should this track be enabled
54109
+ */
54110
+ declare function SetTrackEnabled(track: number, enabled: boolean): void;
54111
+
54112
+ /**
54113
+ * Sets the max speed for the train tracks. Used by ambient trains and for station calculations
54114
+ * @param track The track id (between 0 - 27)
54115
+ * @param newSpeed The tracks new speed
54116
+ */
54117
+ declare function SetTrackMaxSpeed(track: number, newSpeed: number): void;
54118
+
54032
54119
  /**
54033
54120
  * SET_TRACKED_POINT_INFO
54034
54121
  */
@@ -54085,6 +54172,14 @@ declare function SetTrainDoorOpenRatio(train: number, doorIndex: number, ratio:
54085
54172
  */
54086
54173
  declare function SetTrainSpeed(train: number, speed: number): void;
54087
54174
 
54175
+ /**
54176
+ * SET_TRAIN_STATE
54177
+ * @param train The train handle
54178
+ * @param state The trains new state
54179
+ * @return The trains current state, refer to [GET_TRAIN_STATE](?\_0x81b50033)
54180
+ */
54181
+ declare function SetTrainState(train: number, state: number): void;
54182
+
54088
54183
  /**
54089
54184
  * Toggles a train's ability to stop at stations
54090
54185
  * @param train The train handle
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@citizenfx/client",
3
- "version": "2.0.11775-1",
3
+ "version": "2.0.11873-1",
4
4
  "description": "Typings for the CitizenFX client JS API.",
5
5
  "main": "index.js",
6
6
  "scripts": {