@citizenfx/client 2.0.5535-1 → 2.0.5536-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.
@@ -1342,6 +1342,7 @@ declare function N_0xfd1695c5d3b05439(entity1: number, entity2: number, entityBo
1342
1342
 
1343
1343
  declare function AttachEntityToCargobob(vehicle: number, entity: number, p2: number, x: number, y: number, z: number): void;
1344
1344
  declare function N_0xa1dd82f3ccf9a01e(vehicle: number, entity: number, p2: number, x: number, y: number, z: number): void;
1345
+ declare function AttachEntityToCargobob(vehicle: number, entity: number, p2: number, x: number, y: number, z: number): void;
1345
1346
 
1346
1347
  /**
1347
1348
  * Attaches entity1 to bone (boneIndex) of entity2.
@@ -2094,7 +2095,21 @@ declare function CanRegisterMissionPickups(amount: number): boolean;
2094
2095
 
2095
2096
  declare function CanRegisterMissionVehicles(amount: number): boolean;
2096
2097
 
2098
+ /**
2099
+ * Returns when it is safe to start applying changes to cutscene entities.
2100
+ * Should always be used for applying components.
2101
+ * See [`SET_CUTSCENE_PED_COMPONENT_VARIATION_FROM_PED`](#\_0x2A56C06EBEF2B0D9) and [`REGISTER_ENTITY_FOR_CUTSCENE`](#\_0xE40C1C56DF95C2E8) for an example.
2102
+ * This will be true before the cutscene is considered loaded
2103
+ * @return Whether you can request assets for cutscene entities, like components.
2104
+ */
2097
2105
  declare function CanRequestAssetsForCutsceneEntity(): boolean;
2106
+ /**
2107
+ * Returns when it is safe to start applying changes to cutscene entities.
2108
+ * Should always be used for applying components.
2109
+ * See [`SET_CUTSCENE_PED_COMPONENT_VARIATION_FROM_PED`](#\_0x2A56C06EBEF2B0D9) and [`REGISTER_ENTITY_FOR_CUTSCENE`](#\_0xE40C1C56DF95C2E8) for an example.
2110
+ * This will be true before the cutscene is considered loaded
2111
+ * @return Whether you can request assets for cutscene entities, like components.
2112
+ */
2098
2113
  declare function N_0xb56bbbcc2955d9cb(): boolean;
2099
2114
 
2100
2115
  /**
@@ -2102,8 +2117,18 @@ declare function N_0xb56bbbcc2955d9cb(): boolean;
2102
2117
  */
2103
2118
  declare function CanSetEnterStateForRegisteredEntity(cutsceneEntName: string, modelHash: string | number): boolean;
2104
2119
 
2120
+ /**
2121
+ * Whether or not it is safe to run functions on the camera,
2122
+ * as the camera is now no longer being used by the cutscene.
2123
+ * @param p0 Mostly false
2124
+ */
2105
2125
  declare function CanSetExitStateForCamera(p0: boolean): boolean;
2106
2126
 
2127
+ /**
2128
+ * Whether it is safe to start doing scripted actions on the entity, like simulating walking out of a cutscene.
2129
+ * @param cutsceneEntName i.e Michael
2130
+ * @param modelHash Can be 0
2131
+ */
2107
2132
  declare function CanSetExitStateForRegisteredEntity(cutsceneEntName: string, modelHash: string | number): boolean;
2108
2133
 
2109
2134
  declare function CanShuffleSeat(vehicle: number, seatIndex: number): boolean;
@@ -7577,10 +7602,36 @@ declare function GetCutFileNumSections(cutsceneName: string): number;
7577
7602
  */
7578
7603
  declare function N_0x0abc54de641dc0fc(cutsceneName: string): number;
7579
7604
 
7605
+ /**
7606
+ * Returns the time of the cutscene's end accounting for [`REQUEST_CUTSCENE_WITH_PLAYBACK_LIST`](\_0xC23DE0E91C30B58C)
7607
+ * If a cutscene is laid out with 10 second sections, and section 0 and 1 are enabled then it would be 20000ms.
7608
+ * ```
7609
+ * NativeDB Introduced: v1734
7610
+ * ```
7611
+ */
7612
+ declare function GetCutsceneEndTime(): number;
7613
+ /**
7614
+ * Returns the time of the cutscene's end accounting for [`REQUEST_CUTSCENE_WITH_PLAYBACK_LIST`](\_0xC23DE0E91C30B58C)
7615
+ * If a cutscene is laid out with 10 second sections, and section 0 and 1 are enabled then it would be 20000ms.
7616
+ * ```
7617
+ * NativeDB Introduced: v1734
7618
+ * ```
7619
+ */
7620
+ declare function N_0x971d7b15bcdbef99(): number;
7621
+
7580
7622
  declare function GetCutsceneSectionPlaying(): number;
7581
7623
 
7624
+ /**
7625
+ * Gets the elapsed time of the current cutscene in
7626
+ * @return Elapsed time in milliseconds
7627
+ */
7582
7628
  declare function GetCutsceneTime(): number;
7583
7629
 
7630
+ /**
7631
+ * Gets the total length of the cutscene irrespective of playback list in milliseconds
7632
+ * To account for sections, see [`_GET_CUTSCENE_END_TIME`]()
7633
+ * @return Cutscene total length in milliseconds
7634
+ */
7584
7635
  declare function GetCutsceneTotalDuration(): number;
7585
7636
 
7586
7637
  declare function GetDeadPedPickupCoords(ped: number, p1: number, p2: number): number[];
@@ -7948,6 +7999,12 @@ declare function GetEntityHeightAboveGround(entity: number): number;
7948
7999
  */
7949
8000
  declare function GetEntityIndexFromMapdata(mapdata: number, entity: number): number;
7950
8001
 
8002
+ /**
8003
+ * Returns the handle of a cutscene entity, can be ped
8004
+ * @param cutsceneEntName I.E MP\_1, MP\_4, Michael, Trevor
8005
+ * @param modelHash Not strictly neccasary, can get 0
8006
+ * @return Returns entity handle
8007
+ */
7951
8008
  declare function GetEntityIndexOfCutsceneEntity(cutsceneEntName: string, modelHash: string | number): number;
7952
8009
 
7953
8010
  declare function GetEntityIndexOfRegisteredEntity(cutsceneEntName: string, modelHash: string | number): number;
@@ -8749,11 +8806,6 @@ declare function GetIsRightVehicleHeadlightDamaged(vehicle: number): boolean;
8749
8806
  */
8750
8807
  declare function IsHeadlightRBroken(vehicle: number): boolean;
8751
8808
 
8752
- /**
8753
- * NativeDB Introduced: v1290
8754
- */
8755
- declare function GetIsSubmarineVehicleTransformed(vehicle: number): boolean;
8756
-
8757
8809
  /**
8758
8810
  * Task index enum: https://alloc8or.re/gta5/doc/enums/eTaskTypeIndex.txt
8759
8811
  */
@@ -12168,16 +12220,6 @@ declare function GetVehicleAttachedToCargobob(cargobob: number): number;
12168
12220
  */
12169
12221
  declare function GetVehicleBodyHealth(vehicle: number): number;
12170
12222
 
12171
- /**
12172
- * NativeDB Added Parameter 2: float maxEngineHealth
12173
- * NativeDB Added Parameter 3: float maxPetrolTankHealth
12174
- * NativeDB Added Parameter 4: float maxBodyHealth
12175
- * NativeDB Added Parameter 5: float maxMainRotorHealth
12176
- * NativeDB Added Parameter 6: float maxTailRotorHealth
12177
- * NativeDB Added Parameter 7: float maxUnkHealth
12178
- */
12179
- declare function GetVehicleBodyHealth_2(vehicle: number): number;
12180
-
12181
12223
  /**
12182
12224
  * Gets the amount of bombs that this vehicle has. As far as I know, this does *not* impact vehicle weapons or the ammo of those weapons in any way, it is just a way to keep track of the amount of bombs in a specific plane.
12183
12225
  * In decompiled scripts this is used to check if the vehicle has enough bombs before a bomb can be dropped (bombs are dropped by using [`_SHOOT_SINGLE_BULLET_BETWEEN_COORDS_WITH_EXTRA_PARAMS`](#\_0xBFE5756E7407064A)).
@@ -12497,6 +12539,25 @@ declare function GetVehicleHasParachute(vehicle: number): boolean;
12497
12539
  declare function HasVehicleParachute(vehicle: number): boolean;
12498
12540
  declare function DoesVehicleHaveParachute(vehicle: number): boolean;
12499
12541
 
12542
+ /**
12543
+ * NativeDB Added Parameter 2: float maxEngineHealth
12544
+ * NativeDB Added Parameter 3: float maxPetrolTankHealth
12545
+ * NativeDB Added Parameter 4: float maxBodyHealth
12546
+ * NativeDB Added Parameter 5: float maxMainRotorHealth
12547
+ * NativeDB Added Parameter 6: float maxTailRotorHealth
12548
+ * NativeDB Added Parameter 7: float maxUnkHealth
12549
+ */
12550
+ declare function GetVehicleHealthPercentage(vehicle: number): number;
12551
+ /**
12552
+ * NativeDB Added Parameter 2: float maxEngineHealth
12553
+ * NativeDB Added Parameter 3: float maxPetrolTankHealth
12554
+ * NativeDB Added Parameter 4: float maxBodyHealth
12555
+ * NativeDB Added Parameter 5: float maxMainRotorHealth
12556
+ * NativeDB Added Parameter 6: float maxTailRotorHealth
12557
+ * NativeDB Added Parameter 7: float maxUnkHealth
12558
+ */
12559
+ declare function GetVehicleBodyHealth_2(vehicle: number): number;
12560
+
12500
12561
  declare function GetVehicleHighGear(vehicle: number): number;
12501
12562
 
12502
12563
  /**
@@ -14062,7 +14123,13 @@ declare function N_0x62ab793144de75dc(ped: number, p1: number, p2: boolean): voi
14062
14123
  */
14063
14124
  declare function HidePedWeaponForScriptedCutscene(ped: number, toggle: boolean): void;
14064
14125
 
14126
+ /**
14127
+ * Related to portable pickups
14128
+ */
14065
14129
  declare function HidePickup(pickup: number, toggle: boolean): void;
14130
+ /**
14131
+ * Related to portable pickups
14132
+ */
14066
14133
  declare function N_0x867458251d47ccb2(pickup: number, toggle: boolean): void;
14067
14134
 
14068
14135
  declare function HideScriptedHudComponentThisFrame(id: number): void;
@@ -14977,7 +15044,7 @@ declare function IsNuiFocusKeepingInput(): boolean;
14977
15044
  declare function IsNuiFocused(): boolean;
14978
15045
 
14979
15046
  declare function IsObjectAPickup(object: number): boolean;
14980
- declare function N_0x0378c08504160d0d(object: number): boolean;
15047
+ declare function N_0xfc481c641ebbd27d(object: number): boolean;
14981
15048
 
14982
15049
  /**
14983
15050
  * NativeDB Introduced: v1365
@@ -14986,7 +15053,7 @@ declare function IsObjectAPortablePickup(object: number): boolean;
14986
15053
  /**
14987
15054
  * NativeDB Introduced: v1365
14988
15055
  */
14989
- declare function N_0xfc481c641ebbd27d(object: number): boolean;
15056
+ declare function N_0x0378c08504160d0d(object: number): boolean;
14990
15057
 
14991
15058
  declare function IsObjectEntirelyInsideGarage(garageHash: string | number, entity: number, p2: number, p3: number): boolean;
14992
15059
  declare function N_0x372ef6699146a1e4(garageHash: string | number, entity: number, p2: number, p3: number): boolean;
@@ -16121,6 +16188,15 @@ declare function IsVehicleInBurnout(vehicle: number): boolean;
16121
16188
  */
16122
16189
  declare function IsVehicleInGarageArea(garageName: string, vehicle: number): boolean;
16123
16190
 
16191
+ /**
16192
+ * NativeDB Introduced: v1290
16193
+ */
16194
+ declare function IsVehicleInSubmarineMode(vehicle: number): boolean;
16195
+ /**
16196
+ * NativeDB Introduced: v1290
16197
+ */
16198
+ declare function GetIsSubmarineVehicleTransformed(vehicle: number): boolean;
16199
+
16124
16200
  declare function IsVehicleInteriorLightOn(vehicle: number): boolean;
16125
16201
 
16126
16202
  declare function IsVehicleModel(vehicle: number, model: string | number): boolean;
@@ -17591,7 +17667,10 @@ declare function N_0x2c42340f916c5930(p0: number): number;
17591
17667
  */
17592
17668
  declare function N_0x2c4a1590abf43e8b(vehicle: number, p1: boolean): void;
17593
17669
 
17594
- declare function N_0x2c9f302398e13141(p0: number, p1: number): void;
17670
+ /**
17671
+ * Correct native name lies between SET_BLIP_SPRITE and SET_RADIUS_BLIP_EDGE alphabetically.
17672
+ */
17673
+ declare function N_0x2c9f302398e13141(blip: number, p1: number): void;
17595
17674
 
17596
17675
  declare function N_0x2cd90358f67d0aa8(p0: number): void;
17597
17676
 
@@ -19358,14 +19437,6 @@ declare function N_0x96e2929292a4db77(componentHash: string | number): number;
19358
19437
 
19359
19438
  declare function N_0x96e6d5150dbf1c09(p0: number, p1: number, p2: number): void;
19360
19439
 
19361
- /**
19362
- * GET_CUTSCENE_\*
19363
- * ```
19364
- * NativeDB Introduced: v1734
19365
- * ```
19366
- */
19367
- declare function N_0x971d7b15bcdbef99(): number;
19368
-
19369
19440
  declare function N_0x973d76aa760a6cb6(p0: boolean): void;
19370
19441
 
19371
19442
  /**
@@ -20169,6 +20240,10 @@ declare function N_0xc34bc448da29f5e9(entity: number, toggle: boolean): void;
20169
20240
 
20170
20241
  declare function N_0xc35a6d07c93802b2(): void;
20171
20242
 
20243
+ /**
20244
+ * Vehicle must be a plane.
20245
+ * Native name is between SET_VEHICLE_BRAKE_LIGHTS and SET_VEHICLE_BULLDOZER_ARM_POSITION alphabetically.
20246
+ */
20172
20247
  declare function N_0xc361aa040d6637a8(vehicle: number, p1: boolean): void;
20173
20248
 
20174
20249
  declare function N_0xc42dd763159f3461(): boolean;
@@ -20374,7 +20449,10 @@ declare function N_0xd0ee05fe193646ea(): [boolean, number, number, number];
20374
20449
  declare function N_0xd10282b6e3751ba0(): number;
20375
20450
 
20376
20451
  /**
20452
+ * Sets a byte that is then used in session_host and session_join metrics when hosting or joining a session
20453
+ * ```
20377
20454
  * PLAYSTATS_S*
20455
+ * ```
20378
20456
  */
20379
20457
  declare function N_0xd1032e482629049e(p0: number): void;
20380
20458
 
@@ -20598,6 +20676,9 @@ declare function N_0xe111a7c0d200cbc5(p0: number, p1: number): void;
20598
20676
  */
20599
20677
  declare function N_0xe154b48b68ef72bc(p0: number): boolean;
20600
20678
 
20679
+ /**
20680
+ * Native name is SET_PLANE_\*
20681
+ */
20601
20682
  declare function N_0xe16142b94664defd(vehicle: number, p1: boolean): void;
20602
20683
 
20603
20684
  /**
@@ -20917,8 +20998,6 @@ declare function N_0xf55e4046f6f831dc(p0: number, p1: number): void;
20917
20998
 
20918
20999
  declare function N_0xf56dfb7b61be7276(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number, p7: number, p8: number, p9: number, p10: number, p11: number, p12?: number): [boolean, number];
20919
21000
 
20920
- declare function N_0xf5bb8dac426a52c0(): [number, number, number, number];
20921
-
20922
21001
  declare function N_0xf6baaaf762e1bf40(p0: string, p1?: number): [boolean, number];
20923
21002
 
20924
21003
  declare function N_0xf6f4383b7c92f11a(p0: number): void;
@@ -25662,10 +25741,11 @@ declare function PlaystatsCollectible(p0: number, p1: number, p2: number, p3: nu
25662
25741
  declare function PlaystatsCopyRankIntoNewSlot(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number): void;
25663
25742
  declare function N_0xb7257ba2550ea10a(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number): void;
25664
25743
 
25665
- declare function PlaystatsCrateCreatedMissionDone(p0: number, p1: number, p2: number): void;
25744
+ declare function PlaystatsCrateCreated(p0: number, p1: number, p2: number): void;
25666
25745
  declare function N_0xafc7e5e075a96f46(p0: number, p1: number, p2: number): void;
25667
25746
  declare function PlaystatsAmbientMissionCrateCreated(p0: number, p1: number, p2: number): void;
25668
25747
  declare function PlaystatsCrateCreated(p0: number, p1: number, p2: number): void;
25748
+ declare function PlaystatsCrateCreatedMissionDone(p0: number, p1: number, p2: number): void;
25669
25749
 
25670
25750
  /**
25671
25751
  * NativeDB Added Parameter 7: Any p6
@@ -25736,6 +25816,7 @@ declare function PlaystatsH2InstanceEnd(p1: number, p2: number, p3: number): num
25736
25816
 
25737
25817
  declare function PlaystatsHeistSaveCheat(hash: string | number, p1: number): void;
25738
25818
  declare function N_0xf4ff020a08bc8863(hash: string | number, p1: number): void;
25819
+ declare function PlaystatsHeistSaveCheat(hash: string | number, p1: number): void;
25739
25820
 
25740
25821
  declare function PlaystatsHoldUpMissionDone(p0: number, p1: number, p2: number, p3: number): void;
25741
25822
  declare function N_0xcb00196b31c39eb1(p0: number, p1: number, p2: number, p3: number): void;
@@ -25754,6 +25835,9 @@ declare function PlaystatsImportExportMissionDone(p0: number, p1: number, p2: nu
25754
25835
  declare function N_0x2b69f5074c894811(p0: number, p1: number, p2: number, p3: number): void;
25755
25836
  declare function PlaystatsImpExp(p0: number, p1: number, p2: number, p3: number): void;
25756
25837
 
25838
+ declare function PlaystatsJobBend(): [number, number, number, number];
25839
+ declare function N_0xf5bb8dac426a52c0(): [number, number, number, number];
25840
+
25757
25841
  declare function PlaystatsLeaveJobChain(p0: number, p1: number, p2: number, p3: number, p4: number): void;
25758
25842
  declare function N_0xc5be134ec7ba96a0(p0: number, p1: number, p2: number, p3: number, p4: number): void;
25759
25843
 
@@ -26148,7 +26232,14 @@ declare function RegisterCommand(commandName: string, handler: Function, restric
26148
26232
  */
26149
26233
  declare function RegisterEntities(factory: Function): void;
26150
26234
 
26151
- declare function RegisterEntityForCutscene(cutscenePed: number, cutsceneEntName: string, p2: number, modelHash: string | number, p4: number): void;
26235
+ /**
26236
+ * This can only be run once [`CAN_REQUEST_ASSETS_FOR_CUTSCENE_ENTITY`](#\_0xB56BBBCC2955D9CB) is true, but can be run before [`HAS_CUTSCENE_LOADED`](#\_0xC59F528E9AB9F339)
26237
+ * @param cutsceneEntity Entity to put into the cutscene.
26238
+ * @param cutsceneEntName cHandle of cutscene entity, i.e Michael, MP\_1, MP\_4, Lamar
26239
+ * @param modelHash Not strictly neccasary, often 0 in R\* scripts
26240
+ * @param p4 0 for SP, 64 for MP seemingly
26241
+ */
26242
+ declare function RegisterEntityForCutscene(cutsceneEntity: number, cutsceneEntName: string, p2: number, modelHash: string | number, p4: number): void;
26152
26243
 
26153
26244
  declare function RegisterEnumToSave(name: string): number;
26154
26245
 
@@ -26272,6 +26363,9 @@ declare function RegisterStreamingFileFromKvs(kvsKey: string): void;
26272
26363
  */
26273
26364
  declare function RegisterStreamingFileFromUrl(registerAs: string, url: string): void;
26274
26365
 
26366
+ /**
26367
+ * Only used twice in armenian1.c
26368
+ */
26275
26369
  declare function RegisterSynchronisedScriptSpeech(): void;
26276
26370
 
26277
26371
  /**
@@ -26900,27 +26994,24 @@ declare function RequestCutFile(cutsceneName: string): void;
26900
26994
  */
26901
26995
  declare function N_0x06a3524161c502ba(cutsceneName: string): void;
26902
26996
 
26903
- /**
26904
- * flags: Usually 8
26905
- */
26906
26997
  declare function RequestCutscene(cutsceneName: string, flags: number): void;
26907
26998
 
26908
26999
  /**
26909
- * flags: Usually 8
26910
27000
  * playbackFlags: Which scenes should be played.
26911
27001
  * Example: 0x105 (bit 0, 2 and 8 set) will enable scene 1, 3 and 9.
27002
+ * @param flags Usually 8
26912
27003
  */
26913
27004
  declare function RequestCutsceneWithPlaybackList(cutsceneName: string, playbackFlags: number, flags: number): void;
26914
27005
  /**
26915
- * flags: Usually 8
26916
27006
  * playbackFlags: Which scenes should be played.
26917
27007
  * Example: 0x105 (bit 0, 2 and 8 set) will enable scene 1, 3 and 9.
27008
+ * @param flags Usually 8
26918
27009
  */
26919
27010
  declare function N_0xc23de0e91c30b58c(cutsceneName: string, playbackFlags: number, flags: number): void;
26920
27011
  /**
26921
- * flags: Usually 8
26922
27012
  * playbackFlags: Which scenes should be played.
26923
27013
  * Example: 0x105 (bit 0, 2 and 8 set) will enable scene 1, 3 and 9.
27014
+ * @param flags Usually 8
26924
27015
  */
26925
27016
  declare function RequestCutsceneEx(cutsceneName: string, playbackFlags: number, flags: number): void;
26926
27017
 
@@ -27996,11 +28087,15 @@ declare function SetAnimLooped(p0: number, p1: boolean, p2: number, p3: boolean)
27996
28087
  /**
27997
28088
  * NativeDB Introduced: v2372
27998
28089
  */
27999
- declare function SetAnimPlaybackTime(entity: number, p1: number, p2: number, p3: boolean): void;
28090
+ declare function SetAnimPhase(entity: number, p1: number, p2: number, p3: boolean): void;
28000
28091
  /**
28001
28092
  * NativeDB Introduced: v2372
28002
28093
  */
28003
28094
  declare function N_0xddf3cb5a0a4c0b49(entity: number, p1: number, p2: number, p3: boolean): void;
28095
+ /**
28096
+ * NativeDB Introduced: v2372
28097
+ */
28098
+ declare function SetAnimPlaybackTime(entity: number, p1: number, p2: number, p3: boolean): void;
28004
28099
 
28005
28100
  declare function SetAnimRate(p0: number, p1: number, p2: number, p3: boolean): void;
28006
28101
 
@@ -28774,11 +28869,11 @@ declare function SetCargobobHookCanAttach(vehicle: number, toggle: boolean): voi
28774
28869
  declare function N_0x94a68da412c4007d(vehicle: number, toggle: boolean): void;
28775
28870
 
28776
28871
  /**
28777
- * Stops cargobob from beeing able to detach the attached vehicle.
28872
+ * Stops cargobob from being able to detach the attached vehicle.
28778
28873
  */
28779
28874
  declare function SetCargobobHookCanDetach(cargobob: number, toggle: boolean): void;
28780
28875
  /**
28781
- * Stops cargobob from beeing able to detach the attached vehicle.
28876
+ * Stops cargobob from being able to detach the attached vehicle.
28782
28877
  */
28783
28878
  declare function N_0x571feb383f629926(cargobob: number, toggle: boolean): void;
28784
28879
 
@@ -28987,37 +29082,61 @@ declare function SetCutsceneAudioOverride(name: string): void;
28987
29082
  declare function SetCutsceneCanBeSkipped(p0: boolean): void;
28988
29083
  declare function N_0x41faa8fb2ece8720(p0: boolean): void;
28989
29084
 
29085
+ /**
29086
+ * Only used in networked environment with MP cutscenes
29087
+ * @param cutsceneEntName MP\_1, MP\_2, etc
29088
+ * @param p1 Always 0 in R\* scripts
29089
+ * @param p2 Always 1 in R\* scripts
29090
+ */
28990
29091
  declare function SetCutsceneEntityStreamingFlags(cutsceneEntName: string, p1: number, p2: number): void;
29092
+ /**
29093
+ * Only used in networked environment with MP cutscenes
29094
+ * @param cutsceneEntName MP\_1, MP\_2, etc
29095
+ * @param p1 Always 0 in R\* scripts
29096
+ * @param p2 Always 1 in R\* scripts
29097
+ */
28991
29098
  declare function N_0x4c61c75bee8184c2(cutsceneEntName: string, p1: number, p2: number): void;
28992
29099
 
28993
29100
  declare function SetCutsceneFadeValues(p0: boolean, p1: boolean, p2: boolean, p3: boolean): void;
28994
29101
 
28995
29102
  /**
28996
- * p3 could be heading. Needs more research.
29103
+ * Sets cutscene location, used for multiplayer apartments/businesses.
29104
+ * @param p4 Often -1, 0 or 1
28997
29105
  */
28998
- declare function SetCutsceneOrigin(x: number, y: number, z: number, p3: number, p4: number): void;
29106
+ declare function SetCutsceneOrigin(x: number, y: number, z: number, heading: number, p4: number): void;
28999
29107
 
29000
- declare function SetCutscenePedComponentVariation(cutsceneEntName: string, p1: number, p2: number, p3: number, modelHash: string | number): void;
29108
+ /**
29109
+ * See [`SET_PED_COMPONENT_VARIATION`](#\_0x262B14F48D29DE80)
29110
+ */
29111
+ declare function SetCutscenePedComponentVariation(cutsceneEntName: string, componentId: number, drawableId: number, textureId: number, modelHash: string | number): void;
29001
29112
 
29113
+ /**
29114
+ * Sets the components for a cutscene ped, this will take precendence over the cutscene's component overrides. This does not require the entity be registered.
29115
+ * See
29116
+ * @param cutsceneEntName cut file cHandle, i.e Michael, Lamar, Franklin, MP\_1-MP\_4 etc
29117
+ * @param ped Ped to copy components from
29118
+ * @param modelHash Not strictly neccasary, can be 0
29119
+ */
29002
29120
  declare function SetCutscenePedComponentVariationFromPed(cutsceneEntName: string, ped: number, modelHash: string | number): void;
29121
+ /**
29122
+ * Sets the components for a cutscene ped, this will take precendence over the cutscene's component overrides. This does not require the entity be registered.
29123
+ * See
29124
+ * @param cutsceneEntName cut file cHandle, i.e Michael, Lamar, Franklin, MP\_1-MP\_4 etc
29125
+ * @param ped Ped to copy components from
29126
+ * @param modelHash Not strictly neccasary, can be 0
29127
+ */
29003
29128
  declare function N_0x2a56c06ebef2b0d9(cutsceneEntName: string, ped: number, modelHash: string | number): void;
29004
29129
 
29005
29130
  /**
29006
- * Thanks R*! ;)
29007
- * if ((l_161 == 0) || (l_161 == 2)) {
29008
- * sub_2ea27("Trying to set Jimmy prop variation");
29009
- * CUTSCENE::_0546524ADE2E9723("Jimmy_Boston", 1, 0, 0, 0);
29010
- * }
29131
+ * See [`SET_PED_PROP_INDEX`](\_0x93376B65A266EB5F)
29132
+ * @param cutsceneEntName i.e Michael, Trevor, MP\_1, MP\_4
29011
29133
  */
29012
- declare function SetCutscenePedPropVariation(cutsceneEntName: string, p1: number, p2: number, p3: number, modelHash: string | number): void;
29134
+ declare function SetCutscenePedPropVariation(cutsceneEntName: string, componentId: number, drawableId: number, textureId: number, modelHash: string | number): void;
29013
29135
  /**
29014
- * Thanks R*! ;)
29015
- * if ((l_161 == 0) || (l_161 == 2)) {
29016
- * sub_2ea27("Trying to set Jimmy prop variation");
29017
- * CUTSCENE::_0546524ADE2E9723("Jimmy_Boston", 1, 0, 0, 0);
29018
- * }
29136
+ * See [`SET_PED_PROP_INDEX`](\_0x93376B65A266EB5F)
29137
+ * @param cutsceneEntName i.e Michael, Trevor, MP\_1, MP\_4
29019
29138
  */
29020
- declare function N_0x0546524ade2e9723(cutsceneEntName: string, p1: number, p2: number, p3: number, modelHash: string | number): void;
29139
+ declare function N_0x0546524ade2e9723(cutsceneEntName: string, componentId: number, drawableId: number, textureId: number, modelHash: string | number): void;
29021
29140
 
29022
29141
  /**
29023
29142
  * Only used twice in R* scripts
@@ -37571,7 +37690,8 @@ declare function N_0x92790862e36c2ada(): void;
37571
37690
  declare function StartCutscene(flags: number): void;
37572
37691
 
37573
37692
  /**
37574
- * flags: Usually 0.
37693
+ * Similar to [`SET_CUTSCENE_ORIGIN`](\_0xB812B3FD1C01CF27) but without heading and doesn't need [`START_CUTSCENE`](\_0x186D5CB5E7B0FF7B)
37694
+ * @param flags Usually 0
37575
37695
  */
37576
37696
  declare function StartCutsceneAtCoords(x: number, y: number, z: number, flags: number): void;
37577
37697
 
@@ -38494,6 +38614,9 @@ declare function N_0x806058bbdc136e06(): void;
38494
38614
 
38495
38615
  declare function StopCutsceneCamShaking(): void;
38496
38616
 
38617
+ /**
38618
+ * Stop cutscene instantly, will dump registered entities right where they were when ran.
38619
+ */
38497
38620
  declare function StopCutsceneImmediately(): void;
38498
38621
 
38499
38622
  /**
@@ -40111,17 +40234,6 @@ declare function TextureDownloadRelease(p0: number): void;
40111
40234
 
40112
40235
  declare function TextureDownloadRequest(FilePath: string, Name: string, p3: boolean): [number, number];
40113
40236
 
40114
- /**
40115
- * Used in the native scripts to reference "GET_PEDHEADSHOT_TXD_STRING" and "CHAR_DEFAULT".
40116
- * NativeDB Introduced: v323
40117
- */
40118
- declare function ThefeedAddTxdRef(txdString1: string, txnString1: string, txdString2: string, txnString2: string): void;
40119
- /**
40120
- * Used in the native scripts to reference "GET_PEDHEADSHOT_TXD_STRING" and "CHAR_DEFAULT".
40121
- * NativeDB Introduced: v323
40122
- */
40123
- declare function N_0x317eba71d7543f52(txdString1: string, txnString1: string, txdString2: string, txnString2: string): void;
40124
-
40125
40237
  declare function ThefeedClearFrozenPost(): void;
40126
40238
  declare function N_0x80fe4f3ab4e1b62a(): void;
40127
40239
  declare function ThefeedFlushPersistent(): void;
@@ -40353,6 +40465,22 @@ declare function ThefeedSpsExtendWidescreenOn(): void;
40353
40465
  declare function N_0xd4438c0564490e63(): void;
40354
40466
  declare function ThefeedEnableBaselineOffset(): void;
40355
40467
 
40468
+ /**
40469
+ * Used in the native scripts to reference "GET_PEDHEADSHOT_TXD_STRING" and "CHAR_DEFAULT".
40470
+ * NativeDB Introduced: v323
40471
+ */
40472
+ declare function ThefeedUpdateItemTexture(txdString1: string, txnString1: string, txdString2: string, txnString2: string): void;
40473
+ /**
40474
+ * Used in the native scripts to reference "GET_PEDHEADSHOT_TXD_STRING" and "CHAR_DEFAULT".
40475
+ * NativeDB Introduced: v323
40476
+ */
40477
+ declare function N_0x317eba71d7543f52(txdString1: string, txnString1: string, txdString2: string, txnString2: string): void;
40478
+ /**
40479
+ * Used in the native scripts to reference "GET_PEDHEADSHOT_TXD_STRING" and "CHAR_DEFAULT".
40480
+ * NativeDB Introduced: v323
40481
+ */
40482
+ declare function ThefeedAddTxdRef(txdString1: string, txnString1: string, txdString2: string, txnString2: string): void;
40483
+
40356
40484
  /**
40357
40485
  * Counts up. Every 1000 is 1 real-time second. Use SETTIMERA(int value) to set the timer (e.g.: SETTIMERA(0)).
40358
40486
  */
@@ -40415,7 +40543,7 @@ declare function TrackVehicleVisibility(vehicle: number): void;
40415
40543
  * @param vehicle A vehicle handle.
40416
40544
  * @param instantly If true, the vehicle will be instantly transformed, when false the transform animation plays normally.
40417
40545
  */
40418
- declare function TransformSubmarineToVehicle(vehicle: number, instantly: boolean): void;
40546
+ declare function TransformToCar(vehicle: number, instantly: boolean): void;
40419
40547
  /**
40420
40548
  * Transforms the `stormberg` to its "road vehicle" variant. If the vehicle is already in that state then the vehicle transformation audio will still play, but the vehicle won't change at all.
40421
40549
  * @param vehicle A vehicle handle.
@@ -40428,13 +40556,19 @@ declare function N_0x2a69ffd1b42bff9e(vehicle: number, instantly: boolean): void
40428
40556
  * @param instantly If true, the vehicle will be instantly transformed, when false the transform animation plays normally.
40429
40557
  */
40430
40558
  declare function TransformStormbergToRoadVehicle(vehicle: number, instantly: boolean): void;
40559
+ /**
40560
+ * Transforms the `stormberg` to its "road vehicle" variant. If the vehicle is already in that state then the vehicle transformation audio will still play, but the vehicle won't change at all.
40561
+ * @param vehicle A vehicle handle.
40562
+ * @param instantly If true, the vehicle will be instantly transformed, when false the transform animation plays normally.
40563
+ */
40564
+ declare function TransformSubmarineToVehicle(vehicle: number, instantly: boolean): void;
40431
40565
 
40432
40566
  /**
40433
40567
  * Transforms the `stormberg` to its "water vehicle" variant. If the vehicle is already in that state then the vehicle transformation audio will still play, but the vehicle won't change at all.
40434
40568
  * @param vehicle A vehicle handle.
40435
40569
  * @param instantly If true, the vehicle will be instantly transformed, when false the transform animation plays normally.
40436
40570
  */
40437
- declare function TransformVehicleToSubmarine(vehicle: number, instantly: boolean): void;
40571
+ declare function TransformToSubmarine(vehicle: number, instantly: boolean): void;
40438
40572
  /**
40439
40573
  * Transforms the `stormberg` to its "water vehicle" variant. If the vehicle is already in that state then the vehicle transformation audio will still play, but the vehicle won't change at all.
40440
40574
  * @param vehicle A vehicle handle.
@@ -40447,6 +40581,12 @@ declare function N_0xbe4c854ffdb6eebe(vehicle: number, instantly: boolean): void
40447
40581
  * @param instantly If true, the vehicle will be instantly transformed, when false the transform animation plays normally.
40448
40582
  */
40449
40583
  declare function TransformStormbergToWaterVehicle(vehicle: number, instantly: boolean): void;
40584
+ /**
40585
+ * Transforms the `stormberg` to its "water vehicle" variant. If the vehicle is already in that state then the vehicle transformation audio will still play, but the vehicle won't change at all.
40586
+ * @param vehicle A vehicle handle.
40587
+ * @param instantly If true, the vehicle will be instantly transformed, when false the transform animation plays normally.
40588
+ */
40589
+ declare function TransformVehicleToSubmarine(vehicle: number, instantly: boolean): void;
40450
40590
 
40451
40591
  /**
40452
40592
  * The backing function for TriggerEvent.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@citizenfx/client",
3
- "version": "2.0.5535-1",
3
+ "version": "2.0.5536-1",
4
4
  "description": "Typings for the CitizenFX client JS API.",
5
5
  "main": "index.js",
6
6
  "scripts": {