@citizenfx/client 2.0.7130-1 → 2.0.7138-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.
@@ -11830,8 +11830,15 @@ declare function GetInteriorFromGameplayCam(): number;
11830
11830
  declare function GetInteriorGroupId(interior: number): number;
11831
11831
 
11832
11832
  /**
11833
- * GET_INTERIOR_*
11834
11833
  * NativeDB Introduced: v1493
11834
+ * @param interior ID of the interior
11835
+ * @return Returns interior heading in radians. Multiply the returned value with 57.29578 (or 180.0 / math.pi) to convert it to degrees.
11836
+ */
11837
+ declare function GetInteriorHeading(interior: number): number;
11838
+ /**
11839
+ * NativeDB Introduced: v1493
11840
+ * @param interior ID of the interior
11841
+ * @return Returns interior heading in radians. Multiply the returned value with 57.29578 (or 180.0 / math.pi) to convert it to degrees.
11835
11842
  */
11836
11843
  declare function GetInteriorHeading(interior: number): number;
11837
11844
 
@@ -14066,24 +14073,24 @@ declare function GetPedEventData(ped: number, eventType: number, outData?: numbe
14066
14073
  declare function GetPedExtractedDisplacement(ped: number, worldSpace: boolean): number[];
14067
14074
 
14068
14075
  /**
14069
- * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
14076
+ * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
14070
14077
  * @param ped The target ped
14071
14078
  * @return Returns ped's eye colour, or -1 if fails to get.
14072
14079
  */
14073
14080
  declare function GetPedEyeColor(ped: number): number;
14074
-
14075
14081
  /**
14076
14082
  * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
14077
14083
  * @param ped The target ped
14078
14084
  * @return Returns ped's eye colour, or -1 if fails to get.
14079
14085
  */
14080
- declare function GetPedEyeColor(ped: number): number;
14086
+ declare function N_0x76bba2cee66d47e9(ped: number): number;
14087
+
14081
14088
  /**
14082
- * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
14089
+ * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
14083
14090
  * @param ped The target ped
14084
14091
  * @return Returns ped's eye colour, or -1 if fails to get.
14085
14092
  */
14086
- declare function N_0x76bba2cee66d47e9(ped: number): number;
14093
+ declare function GetPedEyeColor(ped: number): number;
14087
14094
 
14088
14095
  /**
14089
14096
  * A getter for [\_SET_PED_FACE_FEATURE](#\_0x71A5C1DBA060049E). Returns 0.0 if fails to get.
@@ -14890,6 +14897,8 @@ declare function N_0x78c0d93253149435(): number;
14890
14897
 
14891
14898
  /**
14892
14899
  * GET_PLAYER_SWITCH_STATE
14900
+ * @return * Returns 5 if the player is in the air (in a state of switch).
14901
+ * Returns 12 if the player is either not in the air or if the switch is completed.
14893
14902
  */
14894
14903
  declare function GetPlayerSwitchState(): number;
14895
14904
 
@@ -21864,6 +21873,45 @@ declare function IsPlayerControlOn(player: number): boolean;
21864
21873
  */
21865
21874
  declare function IsPlayerDead(player: number): boolean;
21866
21875
 
21876
+ /**
21877
+ * Violation types:
21878
+ * ```
21879
+ * enum eViolationType {
21880
+ * VT_PAVED_PEDESTRIAN_AREAS = 0,
21881
+ * VT_RUNNING_REDS,
21882
+ * VT_AGAINST_TRAFFIC
21883
+ * };
21884
+ * ```
21885
+ * Checks if a player is performing a certain type of traffic violation.
21886
+ * * Type 0: Checks if the player is driving outside designated road areas pedestrians would walk on (specifically paved sidewalks).
21887
+ * * Type 1: Checks if the player is running through reds, takes some time to return true.
21888
+ * * Type 2: Checks if the player is driving on the wrong side of the road (against traffic).
21889
+ * Used solely in "Al Di Napoli" with type 2 for a voiceline.
21890
+ * @param player Player ID
21891
+ * @param type A violation type from 0 to 2 (`eViolationType`).
21892
+ * @return Whether or not the player is actively performing a certain type of traffic violation.
21893
+ */
21894
+ declare function IsPlayerDrivingDangerously(player: number, _type: number): boolean;
21895
+ /**
21896
+ * Violation types:
21897
+ * ```
21898
+ * enum eViolationType {
21899
+ * VT_PAVED_PEDESTRIAN_AREAS = 0,
21900
+ * VT_RUNNING_REDS,
21901
+ * VT_AGAINST_TRAFFIC
21902
+ * };
21903
+ * ```
21904
+ * Checks if a player is performing a certain type of traffic violation.
21905
+ * * Type 0: Checks if the player is driving outside designated road areas pedestrians would walk on (specifically paved sidewalks).
21906
+ * * Type 1: Checks if the player is running through reds, takes some time to return true.
21907
+ * * Type 2: Checks if the player is driving on the wrong side of the road (against traffic).
21908
+ * Used solely in "Al Di Napoli" with type 2 for a voiceline.
21909
+ * @param player Player ID
21910
+ * @param type A violation type from 0 to 2 (`eViolationType`).
21911
+ * @return Whether or not the player is actively performing a certain type of traffic violation.
21912
+ */
21913
+ declare function N_0xf10b44fd479d69f3(player: number, _type: number): boolean;
21914
+
21867
21915
  /**
21868
21916
  * IS_PLAYER_ENTIRELY_INSIDE_GARAGE
21869
21917
  */
@@ -29546,11 +29594,6 @@ declare function N_0xf06a6f41cb445443(p0: number): void;
29546
29594
  */
29547
29595
  declare function N_0xf083835b70ba9bfe(): void;
29548
29596
 
29549
- /**
29550
- * Only 1 occurrence. p1 was 2.
29551
- */
29552
- declare function N_0xf10b44fd479d69f3(player: number, p1: number): boolean;
29553
-
29554
29597
  /**
29555
29598
  * 0xF11F01D98113536A
29556
29599
  */
@@ -42468,13 +42511,20 @@ declare function SetClockDate(day: number, month: number, year: number): void;
42468
42511
  declare function SetClockTime(hour: number, minute: number, second: number): void;
42469
42512
 
42470
42513
  /**
42471
- * _SET_CLOUD_HAT_OPACITY
42514
+ * Allows modification of the cloud opacity. It can also be used in other contexts, such as when the player is in a switch state [`IS_PLAYER_SWITCH_IN_PROGRESS`](#\_0xD9D2CFFF49FAB35F).
42515
+ * @param opacity The opacity value to set for clouds.
42472
42516
  */
42473
- declare function SetCloudHatOpacity(opacity: number): void;
42517
+ declare function SetCloudsAlpha(opacity: number): void;
42474
42518
  /**
42475
- * _SET_CLOUD_HAT_OPACITY
42519
+ * Allows modification of the cloud opacity. It can also be used in other contexts, such as when the player is in a switch state [`IS_PLAYER_SWITCH_IN_PROGRESS`](#\_0xD9D2CFFF49FAB35F).
42520
+ * @param opacity The opacity value to set for clouds.
42476
42521
  */
42477
42522
  declare function N_0xf36199225d6d8c86(opacity: number): void;
42523
+ /**
42524
+ * Allows modification of the cloud opacity. It can also be used in other contexts, such as when the player is in a switch state [`IS_PLAYER_SWITCH_IN_PROGRESS`](#\_0xD9D2CFFF49FAB35F).
42525
+ * @param opacity The opacity value to set for clouds.
42526
+ */
42527
+ declare function SetCloudHatOpacity(opacity: number): void;
42478
42528
 
42479
42529
  /**
42480
42530
  * SET_COLOUR_OF_NEXT_TEXT_COMPONENT
@@ -55502,42 +55552,6 @@ declare function SwitchCrimeType(player: number, p1: number): void;
55502
55552
  */
55503
55553
  declare function N_0x9a987297ed8bd838(player: number, p1: number): void;
55504
55554
 
55505
- /**
55506
- * Use after using \_SWITCH_OUT_PLAYER to swoop the camera back down to the player's ped.
55507
- */
55508
- declare function SwitchInPlayer(ped: number): void;
55509
- /**
55510
- * Use after using \_SWITCH_OUT_PLAYER to swoop the camera back down to the player's ped.
55511
- */
55512
- declare function N_0xd8295af639fd9cb8(ped: number): void;
55513
-
55514
- /**
55515
- * doesn't act normally when used on mount chilliad
55516
- * flags:
55517
- * 0: normal
55518
- * 1: no transition
55519
- * 255: switch IN
55520
- * switchType: 0 - 3
55521
- * 0: 1 step towards ped
55522
- * 1: 3 steps out from ped
55523
- * 2: 1 step out from ped
55524
- * 3: 1 step towards ped
55525
- */
55526
- declare function SwitchOutPlayer(ped: number, flags: number, switchType: number): void;
55527
- /**
55528
- * doesn't act normally when used on mount chilliad
55529
- * flags:
55530
- * 0: normal
55531
- * 1: no transition
55532
- * 255: switch IN
55533
- * switchType: 0 - 3
55534
- * 0: 1 step towards ped
55535
- * 1: 3 steps out from ped
55536
- * 2: 1 step out from ped
55537
- * 3: 1 step towards ped
55538
- */
55539
- declare function N_0xaab3200ed59016bc(ped: number, flags: number, switchType: number): void;
55540
-
55541
55555
  /**
55542
55556
  * Used in carsteal3 script with p0 = "Carsteal4_spycar".
55543
55557
  * S*
@@ -55560,6 +55574,44 @@ declare function SwitchToInputMappingScheme_2(name: string): boolean;
55560
55574
  */
55561
55575
  declare function N_0x4683149ed1dde7a1(name: string): boolean;
55562
55576
 
55577
+ /**
55578
+ * You can check if the player is in a Switch state with [`IS_PLAYER_SWITCH_IN_PROGRESS`](#\_0xD9D2CFFF49FAB35F).
55579
+ * ***Note:** Doesn't act normally when used on Mount Chiliad.*
55580
+ * @param ped The Ped (player character) for which the switch is initiated.
55581
+ * @param flags Flags control various functionalities: 0 for normal behavior, 1 for no transition, and 255 for Switch IN.
55582
+ * @param switchType Specifies the type of switch (0 - 3): 0 for 1 step towards ped, 1 for 3 steps out from ped, 2 for 1 step out from ped, and 3 for 1 step towards ped.
55583
+ */
55584
+ declare function SwitchToMultiFirstpart(ped: number, flags: number, switchType: number): void;
55585
+ /**
55586
+ * You can check if the player is in a Switch state with [`IS_PLAYER_SWITCH_IN_PROGRESS`](#\_0xD9D2CFFF49FAB35F).
55587
+ * ***Note:** Doesn't act normally when used on Mount Chiliad.*
55588
+ * @param ped The Ped (player character) for which the switch is initiated.
55589
+ * @param flags Flags control various functionalities: 0 for normal behavior, 1 for no transition, and 255 for Switch IN.
55590
+ * @param switchType Specifies the type of switch (0 - 3): 0 for 1 step towards ped, 1 for 3 steps out from ped, 2 for 1 step out from ped, and 3 for 1 step towards ped.
55591
+ */
55592
+ declare function N_0xaab3200ed59016bc(ped: number, flags: number, switchType: number): void;
55593
+ /**
55594
+ * You can check if the player is in a Switch state with [`IS_PLAYER_SWITCH_IN_PROGRESS`](#\_0xD9D2CFFF49FAB35F).
55595
+ * ***Note:** Doesn't act normally when used on Mount Chiliad.*
55596
+ * @param ped The Ped (player character) for which the switch is initiated.
55597
+ * @param flags Flags control various functionalities: 0 for normal behavior, 1 for no transition, and 255 for Switch IN.
55598
+ * @param switchType Specifies the type of switch (0 - 3): 0 for 1 step towards ped, 1 for 3 steps out from ped, 2 for 1 step out from ped, and 3 for 1 step towards ped.
55599
+ */
55600
+ declare function SwitchOutPlayer(ped: number, flags: number, switchType: number): void;
55601
+
55602
+ /**
55603
+ * After using [`SWITCH_TO_MULTI_FIRSTPART`](#\_0xAAB3200ED59016BC) , use this native to smoothly return the camera to the player's character.
55604
+ */
55605
+ declare function SwitchToMultiSecondpart(ped: number): void;
55606
+ /**
55607
+ * After using [`SWITCH_TO_MULTI_FIRSTPART`](#\_0xAAB3200ED59016BC) , use this native to smoothly return the camera to the player's character.
55608
+ */
55609
+ declare function N_0xd8295af639fd9cb8(ped: number): void;
55610
+ /**
55611
+ * After using [`SWITCH_TO_MULTI_FIRSTPART`](#\_0xAAB3200ED59016BC) , use this native to smoothly return the camera to the player's character.
55612
+ */
55613
+ declare function SwitchInPlayer(ped: number): void;
55614
+
55563
55615
  /**
55564
55616
  * Toggles whether ambient trains can spawn on the specified track or not.
55565
55617
  * | trackId | File | Description |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@citizenfx/client",
3
- "version": "2.0.7130-1",
3
+ "version": "2.0.7138-1",
4
4
  "description": "Typings for the CitizenFX client JS API.",
5
5
  "main": "index.js",
6
6
  "scripts": {