@citizenfx/client 2.0.5374-1 → 2.0.5392-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.
Files changed (2) hide show
  1. package/natives_universal.d.ts +879 -322
  2. package/package.json +1 -1
@@ -144,16 +144,28 @@ declare function N_0xce5d0e5e315db238(x: number, y: number, z: number, width: nu
144
144
  declare function AddBlipForCoord(x: number, y: number, z: number): number;
145
145
 
146
146
  /**
147
- * Returns red ( default ) blip attached to entity.
148
- * Example:
149
- * Blip blip; //Put this outside your case or option
150
- * blip = HUD::ADD_BLIP_FOR_ENTITY(YourPedOrBodyguardName);
151
- * HUD::SET_BLIP_AS_FRIENDLY(blip, true);
147
+ * Create a blip that for default is red (enemy), you can use the [SET_BLIP_AS_FRIENDLY](#\_0xC6F43D0E) to make it blue (friend)
148
+ * Example of enemy:
149
+ * ![enemy](https://i.imgur.com/fl78svv.png)
150
+ * Example of friend:
151
+ * ![friend](https://i.imgur.com/Q16ho5d.png)
152
+ * @param entity The entity handle to create the blip.
153
+ * @return A blip handle.
152
154
  */
153
155
  declare function AddBlipForEntity(entity: number): number;
154
156
 
155
157
  declare function AddBlipForPickup(pickup: number): number;
156
158
 
159
+ /**
160
+ * Create a blip with a radius for the specified coordinates (it doesnt create the blip sprite, so you need to use [AddBlipCoords](#\_0xC6F43D0E))
161
+ * Example image:
162
+ * ![example](https://i.imgur.com/9hQl3DB.png)
163
+ * @param posX The x position of the blip (you can also send a vector3 instead of the bulk coordinates)
164
+ * @param posY The y position of the blip (you can also send a vector3 instead of the bulk coordinates)
165
+ * @param posZ The z position of the blip (you can also send a vector3 instead of the bulk coordinates)
166
+ * @param radius The number that defines the radius of the blip circle
167
+ * @return The blip handle that can be manipulated with every `SetBlip` natives
168
+ */
157
169
  declare function AddBlipForRadius(posX: number, posY: number, posZ: number, radius: number): number;
158
170
 
159
171
  /**
@@ -2293,6 +2305,21 @@ declare function CellCamMoveFinger(direction: number): void;
2293
2305
  */
2294
2306
  declare function MoveFinger(direction: number): void;
2295
2307
 
2308
+ declare function CellCamSetDistance(p0: number): void;
2309
+ declare function N_0x53f4892d18ec90a4(p0: number): void;
2310
+
2311
+ declare function CellCamSetHeadHeight(p0: number): void;
2312
+ declare function N_0x466da42c89865553(p0: number): void;
2313
+
2314
+ declare function CellCamSetHeadPitch(p0: number): void;
2315
+ declare function N_0xd6ade981781fca09(p0: number): void;
2316
+
2317
+ declare function CellCamSetHeadRoll(p0: number): void;
2318
+ declare function N_0xf1e22dc13f5eebad(p0: number): void;
2319
+
2320
+ declare function CellCamSetHorizontalOffset(p0: number): void;
2321
+ declare function N_0x1b0b4aeed5b9b41c(p0: number): void;
2322
+
2296
2323
  /**
2297
2324
  * if the bool "Toggle" is "true" so the phone is lean.
2298
2325
  * if the bool "Toggle" is "false" so the phone is not lean.
@@ -2304,6 +2331,12 @@ declare function CellCamSetLean(toggle: boolean): void;
2304
2331
  */
2305
2332
  declare function SetPhoneLean(toggle: boolean): void;
2306
2333
 
2334
+ declare function CellCamSetRoll(p0: number): void;
2335
+ declare function N_0x15e69e2802c24b8d(p0: number): void;
2336
+
2337
+ declare function CellCamSetVerticalOffset(p0: number): void;
2338
+ declare function N_0x3117d84efa60f77b(p0: number): void;
2339
+
2307
2340
  declare function ChangePlayerPed(player: number, ped: number, b2: boolean, resetDamage: boolean): void;
2308
2341
 
2309
2342
  /**
@@ -2455,6 +2488,10 @@ declare function ClearDrivebyTaskUnderneathDrivingTask(ped: number): void;
2455
2488
  declare function ClearDynamicPauseMenuErrorMessage(): void;
2456
2489
  declare function N_0x7792424aa0eac32e(): void;
2457
2490
 
2491
+ /**
2492
+ * This native **could affect** the arguments of the `CEventNetworkEntityDamage` game event, by clearing the damaging entity before the event is fired.
2493
+ * @param entity The entity to clear the last damaging entity from.
2494
+ */
2458
2495
  declare function ClearEntityLastDamageEntity(entity: number): void;
2459
2496
 
2460
2497
  declare function ClearEntityLastWeaponDamage(entity: number): void;
@@ -2643,10 +2680,15 @@ declare function ClearPedSecondaryTask(ped: number): void;
2643
2680
  declare function ClearPedStoredHatProp(ped: number): void;
2644
2681
  declare function N_0x687c0b594907d2e8(ped: number): void;
2645
2682
 
2683
+ /**
2684
+ * Clear a ped's tasks. Stop animations and other tasks created by scripts.
2685
+ * @param ped Ped id. Use PlayerPedId() for your own character.
2686
+ */
2646
2687
  declare function ClearPedTasks(ped: number): void;
2647
2688
 
2648
2689
  /**
2649
- * Immediately stops the pedestrian from whatever it's doing. They stop fighting, animations, etc. they forget what they were doing.
2690
+ * Immediately stops the pedestrian from whatever it's doing. The difference between this and [CLEAR_PED_TASKS](#\_0xE1EF3C1216AFF2CD) is that this one teleports the ped but does not change the position of the ped.
2691
+ * @param ped Ped id.
2650
2692
  */
2651
2693
  declare function ClearPedTasksImmediately(ped: number): void;
2652
2694
 
@@ -3012,37 +3054,51 @@ declare function CreateAmbientPickup(pickupHash: string | number, posX: number,
3012
3054
  declare function CreateAudioSubmix(name: string): number;
3013
3055
 
3014
3056
  /**
3057
+ * Create a camera with the specified cam name, You can use `SET_CAM_` natives to manipulate the camera.
3058
+ * Cam names:
3059
+ * ```
3015
3060
  * "DEFAULT_SCRIPTED_CAMERA"
3016
3061
  * "DEFAULT_ANIMATED_CAMERA"
3017
3062
  * "DEFAULT_SPLINE_CAMERA"
3018
3063
  * "DEFAULT_SCRIPTED_FLY_CAMERA"
3019
3064
  * "TIMED_SPLINE_CAMERA"
3065
+ * ```
3066
+ * @param camName Is the type of the camera, is always setted to `DEFAULT_SCRIPTED_CAMERA` in Rockstar scripts and in Fivem Forum Posts
3067
+ * @param active Unkown, is always setted to `true` in Rockstar scripts and in Fivem Forum Posts
3068
+ * @return A camera handle.
3020
3069
  */
3021
3070
  declare function CreateCam(camName: string, active: boolean): number;
3022
3071
 
3023
3072
  /**
3024
- * camName is always set to "DEFAULT_SCRIPTED_CAMERA" in Rockstar's scripts.
3025
- * ------------
3073
+ * Create a camera with the specified cam name/type, You can use `SET_CAM_` natives to manipulate the camera.
3026
3074
  * Camera names found in the b617d scripts:
3075
+ * ```
3027
3076
  * "DEFAULT_ANIMATED_CAMERA"
3028
3077
  * "DEFAULT_SCRIPTED_CAMERA"
3029
3078
  * "DEFAULT_SCRIPTED_FLY_CAMERA"
3030
3079
  * "DEFAULT_SPLINE_CAMERA"
3031
- * ------------
3032
- * Side Note: It seems p8 is basically to represent what would be the bool p1 within CREATE_CAM native. As well as the p9 since it's always 2 in scripts seems to represent what would be the last param within SET_CAM_ROT native which normally would be 2.
3080
+ * ```
3081
+ * @param camName Is the type of the camera, is always setted to `DEFAULT_SCRIPTED_CAMERA` in Rockstar scripts and in Fivem Forum Posts
3082
+ * @param posX The x position of the camera (you can also send a vector3 instead of the bulk coordinates)
3083
+ * @param posY The y position of the camera (you can also send a vector3 instead of the bulk coordinates)
3084
+ * @param posZ The z position of the camera (you can also send a vector3 instead of the bulk coordinates)
3085
+ * @param rotX The x rotation of the camera
3086
+ * @param rotY The y rotation of the camera
3087
+ * @param rotZ The z rotation of the camera
3088
+ * @param fov The Field Of View of the camera, is the observable world that is seen
3089
+ * @return A camera handle.
3033
3090
  */
3034
- declare function CreateCamWithParams(camName: string, posX: number, posY: number, posZ: number, rotX: number, rotY: number, rotZ: number, fov: number, p8: boolean, p9: number): number;
3091
+ declare function CreateCamWithParams(camName: string, posX: number, posY: number, posZ: number, rotX: number, rotY: number, rotZ: number, fov: number, active: boolean, rotationOrder: number): number;
3035
3092
 
3036
- declare function CreateCamera(camHash: string | number, p1: boolean): number;
3093
+ declare function CreateCamera(camHash: string | number, active: boolean): number;
3037
3094
 
3038
3095
  /**
3039
- * CAM::_GET_GAMEPLAY_CAM_COORDS can be used instead of posX,Y,Z
3040
- * CAM::_GET_GAMEPLAY_CAM_ROT can be used instead of rotX,Y,Z
3041
- * CAM::_80EC114669DAEFF4() can be used instead of p7 (Possible p7 is FOV parameter. )
3042
- * p8 ???
3043
- * p9 uses 2 by default
3096
+ * CAM::\_GET_GAMEPLAY_CAM_COORDS can be used instead of posX,Y,Z\
3097
+ * CAM::\_GET_GAMEPLAY_CAM_ROT can be used instead of rotX,Y,Z\
3098
+ * CAM::\_80EC114669DAEFF4() can be used instead of p7 (Possible p7 is FOV parameter. )\
3099
+ * rotationOrder is 2 usually
3044
3100
  */
3045
- declare function CreateCameraWithParams(camHash: string | number, posX: number, posY: number, posZ: number, rotX: number, rotY: number, rotZ: number, fov: number, p8: boolean, p9: number): number;
3101
+ declare function CreateCameraWithParams(camHash: string | number, posX: number, posY: number, posZ: number, rotX: number, rotY: number, rotZ: number, fov: number, active: boolean, rotationOrder: number): number;
3046
3102
 
3047
3103
  /**
3048
3104
  * ```
@@ -3097,20 +3153,44 @@ declare function CreateCinematicShot(p0: number, p1: number, p2: number, entity:
3097
3153
  declare function CreateDui(url: string, width: number, height: number): number;
3098
3154
 
3099
3155
  /**
3100
- * clanFlag: takes a number 0-5
3101
- * @param clanFlag takes a number 0-5
3102
- */
3103
- declare function CreateFakeMpGamerTag(ped: number, username: string, pointedClanTag: boolean, isRockstarClan: boolean, clanTag: string, clanFlag: number): number;
3104
- /**
3105
- * clanFlag: takes a number 0-5
3106
- * @param clanFlag takes a number 0-5
3107
- */
3108
- declare function N_0xbfefe3321a3f5015(ped: number, username: string, pointedClanTag: boolean, isRockstarClan: boolean, clanTag: string, clanFlag: number): number;
3109
- /**
3110
- * clanFlag: takes a number 0-5
3111
- * @param clanFlag takes a number 0-5
3112
- */
3113
- declare function CreateMpGamerTag(ped: number, username: string, pointedClanTag: boolean, isRockstarClan: boolean, clanTag: string, clanFlag: number): number;
3156
+ * As per the name, this native creates a "fake" gamer tag that is attached to a specific ped.
3157
+ * Unlike "real" gamer tags, you cannot set the crew colour of these gamer tags.
3158
+ * To create gamer tags for actual players and for more gamer tag information, see [CREATE_MP_GAMER_TAG_WITH_CREW_COLOR](#\_0x6DD05E9D83EFA4C9).
3159
+ * @param ped The ped that the fake gamer tag will be attached to.
3160
+ * @param username The name displayed on the gamer tag.
3161
+ * @param crewIsPrivate If the crew is private. Public crews have a pointed end cap, private crews do not.
3162
+ * @param crewIsRockstar If the crew is a Rockstar crew. Rockstar crews include a Rockstar logo before the name.
3163
+ * @param crewName The name of the crew.
3164
+ * @param crewRank The rank from 1-5 that the player is within the crew. Use 0 if the player is the founder of the crew. Only relevant for private crews.
3165
+ * @return The ID of the new gamer tag.
3166
+ */
3167
+ declare function CreateFakeMpGamerTag(ped: number, username: string, crewIsPrivate: boolean, crewIsRockstar: boolean, crewName: string, crewRank: number): number;
3168
+ /**
3169
+ * As per the name, this native creates a "fake" gamer tag that is attached to a specific ped.
3170
+ * Unlike "real" gamer tags, you cannot set the crew colour of these gamer tags.
3171
+ * To create gamer tags for actual players and for more gamer tag information, see [CREATE_MP_GAMER_TAG_WITH_CREW_COLOR](#\_0x6DD05E9D83EFA4C9).
3172
+ * @param ped The ped that the fake gamer tag will be attached to.
3173
+ * @param username The name displayed on the gamer tag.
3174
+ * @param crewIsPrivate If the crew is private. Public crews have a pointed end cap, private crews do not.
3175
+ * @param crewIsRockstar If the crew is a Rockstar crew. Rockstar crews include a Rockstar logo before the name.
3176
+ * @param crewName The name of the crew.
3177
+ * @param crewRank The rank from 1-5 that the player is within the crew. Use 0 if the player is the founder of the crew. Only relevant for private crews.
3178
+ * @return The ID of the new gamer tag.
3179
+ */
3180
+ declare function N_0xbfefe3321a3f5015(ped: number, username: string, crewIsPrivate: boolean, crewIsRockstar: boolean, crewName: string, crewRank: number): number;
3181
+ /**
3182
+ * As per the name, this native creates a "fake" gamer tag that is attached to a specific ped.
3183
+ * Unlike "real" gamer tags, you cannot set the crew colour of these gamer tags.
3184
+ * To create gamer tags for actual players and for more gamer tag information, see [CREATE_MP_GAMER_TAG_WITH_CREW_COLOR](#\_0x6DD05E9D83EFA4C9).
3185
+ * @param ped The ped that the fake gamer tag will be attached to.
3186
+ * @param username The name displayed on the gamer tag.
3187
+ * @param crewIsPrivate If the crew is private. Public crews have a pointed end cap, private crews do not.
3188
+ * @param crewIsRockstar If the crew is a Rockstar crew. Rockstar crews include a Rockstar logo before the name.
3189
+ * @param crewName The name of the crew.
3190
+ * @param crewRank The rank from 1-5 that the player is within the crew. Use 0 if the player is the founder of the crew. Only relevant for private crews.
3191
+ * @return The ID of the new gamer tag.
3192
+ */
3193
+ declare function CreateMpGamerTag(ped: number, username: string, crewIsPrivate: boolean, crewIsRockstar: boolean, crewName: string, crewRank: number): number;
3114
3194
 
3115
3195
  declare function CreateForcedObject(x: number, y: number, z: number, p3: number, modelHash: string | number, p5: boolean): void;
3116
3196
 
@@ -3231,35 +3311,85 @@ declare function CreateModelSwap(x: number, y: number, z: number, radius: number
3231
3311
  declare function CreateMoneyPickups(x: number, y: number, z: number, value: number, amount: number, model: string | number): void;
3232
3312
 
3233
3313
  /**
3234
- * clanFlag: takes a number 0-5
3235
- * @param player the headDisplayId for the net players is the same as the local id of the ped
3236
- * @param clanFlag takes a number 0-5
3237
- */
3238
- declare function CreateMpGamerTagWithCrewColor(player: number, username: string, pointedClanTag: boolean, isRockstarClan: boolean, clanTag: string, clanFlag: number, r: number, g: number, b: number): void;
3239
- /**
3240
- * clanFlag: takes a number 0-5
3241
- * @param player the headDisplayId for the net players is the same as the local id of the ped
3242
- * @param clanFlag takes a number 0-5
3243
- */
3244
- declare function N_0x6dd05e9d83efa4c9(player: number, username: string, pointedClanTag: boolean, isRockstarClan: boolean, clanTag: string, clanFlag: number, r: number, g: number, b: number): void;
3245
- /**
3246
- * clanFlag: takes a number 0-5
3247
- * @param player the headDisplayId for the net players is the same as the local id of the ped
3248
- * @param clanFlag takes a number 0-5
3249
- */
3250
- declare function CreateMpGamerTagColor(player: number, username: string, pointedClanTag: boolean, isRockstarClan: boolean, clanTag: string, clanFlag: number, r: number, g: number, b: number): void;
3251
- /**
3252
- * clanFlag: takes a number 0-5
3253
- * @param player the headDisplayId for the net players is the same as the local id of the ped
3254
- * @param clanFlag takes a number 0-5
3255
- */
3256
- declare function SetMpGamerTagColor(player: number, username: string, pointedClanTag: boolean, isRockstarClan: boolean, clanTag: string, clanFlag: number, r: number, g: number, b: number): void;
3257
- /**
3258
- * clanFlag: takes a number 0-5
3259
- * @param player the headDisplayId for the net players is the same as the local id of the ped
3260
- * @param clanFlag takes a number 0-5
3261
- */
3262
- declare function CreateMpGamerTagForNetPlayer(player: number, username: string, pointedClanTag: boolean, isRockstarClan: boolean, clanTag: string, clanFlag: number, r: number, g: number, b: number): void;
3314
+ * Creates a gamer tag for the specified local player ID, automatically attached to the player's current ped.
3315
+ * The created gamer tag will have the same ID as the player. You can use [IS_MP_GAMER_TAG_ACTIVE](#\_0x4E929E7A5796FD26) to check if a gamer tag already exists for a player.
3316
+ * After the gamer tag is created, all components will be set as invisible. Use [SET_MP_GAMER_TAG_VISIBILITY](#\_0x63BB75ABEDC1F6A0) to change the visibility of individual components or [\_SET_MP_GAMER_TAG_VISIBILITY_ALL](#\_0xEE76FF7E6A0166B0) to set all of them at once.
3317
+ * To create a gamer tag for a ped that is not a player, see [CREATE_FAKE_MP_GAMER_TAG](#\_0xBFEFE3321A3F5015).
3318
+ * @param player The local player ID to assign the gamer tag to.
3319
+ * @param username The name displayed on the gamer tag.
3320
+ * @param crewIsPrivate If the crew is private. Public crews have a pointed end cap, private crews do not.
3321
+ * @param crewIsRockstar If the crew is a Rockstar crew. Rockstar crews include a Rockstar logo before the name.
3322
+ * @param crewName The name of the crew.
3323
+ * @param crewRank The rank from 1-5 that the player is within the crew. Use 0 if the player is the founder of the crew. Only relevant for private crews.
3324
+ * @param crewR Red component of the crew colour.
3325
+ * @param crewG Green component of the crew colour.
3326
+ * @param crewB Blue component of the crew colour.
3327
+ */
3328
+ declare function CreateMpGamerTagWithCrewColor(player: number, username: string, crewIsPrivate: boolean, crewIsRockstar: boolean, crewName: string, crewRank: number, crewR: number, crewG: number, crewB: number): void;
3329
+ /**
3330
+ * Creates a gamer tag for the specified local player ID, automatically attached to the player's current ped.
3331
+ * The created gamer tag will have the same ID as the player. You can use [IS_MP_GAMER_TAG_ACTIVE](#\_0x4E929E7A5796FD26) to check if a gamer tag already exists for a player.
3332
+ * After the gamer tag is created, all components will be set as invisible. Use [SET_MP_GAMER_TAG_VISIBILITY](#\_0x63BB75ABEDC1F6A0) to change the visibility of individual components or [\_SET_MP_GAMER_TAG_VISIBILITY_ALL](#\_0xEE76FF7E6A0166B0) to set all of them at once.
3333
+ * To create a gamer tag for a ped that is not a player, see [CREATE_FAKE_MP_GAMER_TAG](#\_0xBFEFE3321A3F5015).
3334
+ * @param player The local player ID to assign the gamer tag to.
3335
+ * @param username The name displayed on the gamer tag.
3336
+ * @param crewIsPrivate If the crew is private. Public crews have a pointed end cap, private crews do not.
3337
+ * @param crewIsRockstar If the crew is a Rockstar crew. Rockstar crews include a Rockstar logo before the name.
3338
+ * @param crewName The name of the crew.
3339
+ * @param crewRank The rank from 1-5 that the player is within the crew. Use 0 if the player is the founder of the crew. Only relevant for private crews.
3340
+ * @param crewR Red component of the crew colour.
3341
+ * @param crewG Green component of the crew colour.
3342
+ * @param crewB Blue component of the crew colour.
3343
+ */
3344
+ declare function N_0x6dd05e9d83efa4c9(player: number, username: string, crewIsPrivate: boolean, crewIsRockstar: boolean, crewName: string, crewRank: number, crewR: number, crewG: number, crewB: number): void;
3345
+ /**
3346
+ * Creates a gamer tag for the specified local player ID, automatically attached to the player's current ped.
3347
+ * The created gamer tag will have the same ID as the player. You can use [IS_MP_GAMER_TAG_ACTIVE](#\_0x4E929E7A5796FD26) to check if a gamer tag already exists for a player.
3348
+ * After the gamer tag is created, all components will be set as invisible. Use [SET_MP_GAMER_TAG_VISIBILITY](#\_0x63BB75ABEDC1F6A0) to change the visibility of individual components or [\_SET_MP_GAMER_TAG_VISIBILITY_ALL](#\_0xEE76FF7E6A0166B0) to set all of them at once.
3349
+ * To create a gamer tag for a ped that is not a player, see [CREATE_FAKE_MP_GAMER_TAG](#\_0xBFEFE3321A3F5015).
3350
+ * @param player The local player ID to assign the gamer tag to.
3351
+ * @param username The name displayed on the gamer tag.
3352
+ * @param crewIsPrivate If the crew is private. Public crews have a pointed end cap, private crews do not.
3353
+ * @param crewIsRockstar If the crew is a Rockstar crew. Rockstar crews include a Rockstar logo before the name.
3354
+ * @param crewName The name of the crew.
3355
+ * @param crewRank The rank from 1-5 that the player is within the crew. Use 0 if the player is the founder of the crew. Only relevant for private crews.
3356
+ * @param crewR Red component of the crew colour.
3357
+ * @param crewG Green component of the crew colour.
3358
+ * @param crewB Blue component of the crew colour.
3359
+ */
3360
+ declare function CreateMpGamerTagColor(player: number, username: string, crewIsPrivate: boolean, crewIsRockstar: boolean, crewName: string, crewRank: number, crewR: number, crewG: number, crewB: number): void;
3361
+ /**
3362
+ * Creates a gamer tag for the specified local player ID, automatically attached to the player's current ped.
3363
+ * The created gamer tag will have the same ID as the player. You can use [IS_MP_GAMER_TAG_ACTIVE](#\_0x4E929E7A5796FD26) to check if a gamer tag already exists for a player.
3364
+ * After the gamer tag is created, all components will be set as invisible. Use [SET_MP_GAMER_TAG_VISIBILITY](#\_0x63BB75ABEDC1F6A0) to change the visibility of individual components or [\_SET_MP_GAMER_TAG_VISIBILITY_ALL](#\_0xEE76FF7E6A0166B0) to set all of them at once.
3365
+ * To create a gamer tag for a ped that is not a player, see [CREATE_FAKE_MP_GAMER_TAG](#\_0xBFEFE3321A3F5015).
3366
+ * @param player The local player ID to assign the gamer tag to.
3367
+ * @param username The name displayed on the gamer tag.
3368
+ * @param crewIsPrivate If the crew is private. Public crews have a pointed end cap, private crews do not.
3369
+ * @param crewIsRockstar If the crew is a Rockstar crew. Rockstar crews include a Rockstar logo before the name.
3370
+ * @param crewName The name of the crew.
3371
+ * @param crewRank The rank from 1-5 that the player is within the crew. Use 0 if the player is the founder of the crew. Only relevant for private crews.
3372
+ * @param crewR Red component of the crew colour.
3373
+ * @param crewG Green component of the crew colour.
3374
+ * @param crewB Blue component of the crew colour.
3375
+ */
3376
+ declare function SetMpGamerTagColor(player: number, username: string, crewIsPrivate: boolean, crewIsRockstar: boolean, crewName: string, crewRank: number, crewR: number, crewG: number, crewB: number): void;
3377
+ /**
3378
+ * Creates a gamer tag for the specified local player ID, automatically attached to the player's current ped.
3379
+ * The created gamer tag will have the same ID as the player. You can use [IS_MP_GAMER_TAG_ACTIVE](#\_0x4E929E7A5796FD26) to check if a gamer tag already exists for a player.
3380
+ * After the gamer tag is created, all components will be set as invisible. Use [SET_MP_GAMER_TAG_VISIBILITY](#\_0x63BB75ABEDC1F6A0) to change the visibility of individual components or [\_SET_MP_GAMER_TAG_VISIBILITY_ALL](#\_0xEE76FF7E6A0166B0) to set all of them at once.
3381
+ * To create a gamer tag for a ped that is not a player, see [CREATE_FAKE_MP_GAMER_TAG](#\_0xBFEFE3321A3F5015).
3382
+ * @param player The local player ID to assign the gamer tag to.
3383
+ * @param username The name displayed on the gamer tag.
3384
+ * @param crewIsPrivate If the crew is private. Public crews have a pointed end cap, private crews do not.
3385
+ * @param crewIsRockstar If the crew is a Rockstar crew. Rockstar crews include a Rockstar logo before the name.
3386
+ * @param crewName The name of the crew.
3387
+ * @param crewRank The rank from 1-5 that the player is within the crew. Use 0 if the player is the founder of the crew. Only relevant for private crews.
3388
+ * @param crewR Red component of the crew colour.
3389
+ * @param crewG Green component of the crew colour.
3390
+ * @param crewB Blue component of the crew colour.
3391
+ */
3392
+ declare function CreateMpGamerTagForNetPlayer(player: number, username: string, crewIsPrivate: boolean, crewIsRockstar: boolean, crewName: string, crewRank: number, crewR: number, crewG: number, crewB: number): void;
3263
3393
 
3264
3394
  declare function CreateNewScriptedConversation(): void;
3265
3395
 
@@ -3294,7 +3424,7 @@ declare function CreatePortablePickup_2(pickupHash: string | number, x: number,
3294
3424
  * @param isNetwork Whether to create a network object for the object. If false, the object exists only locally.
3295
3425
  * @param netMissionEntity Whether to register the object as pinned to the script host in the R\* network model.
3296
3426
  * @param doorFlag False to create a door archetype (archetype flag bit 26 set) as a door. Required to be set to true to create door models in network mode.
3297
- * @return A script handle (fwScriptGuid index) for the object, or `0` if the object failed to be created.
3427
+ * @return A script handle for the object, or `0` if the object failed to be created.
3298
3428
  */
3299
3429
  declare function CreateObject(modelHash: string | number, x: number, y: number, z: number, isNetwork: boolean, netMissionEntity: boolean, doorFlag: boolean): number;
3300
3430
 
@@ -4054,6 +4184,15 @@ declare function N_0x7f4724035fdca1dd(padIndex: number): void;
4054
4184
  */
4055
4185
  declare function DisableInterior(interiorID: number, toggle: boolean): void;
4056
4186
 
4187
+ /**
4188
+ * If true is passed, the player won't be able to open the multiplayer chat
4189
+ */
4190
+ declare function DisableMultiplayerChat(disable: boolean): void;
4191
+ /**
4192
+ * If true is passed, the player won't be able to open the multiplayer chat
4193
+ */
4194
+ declare function SetTextChatUnk(disable: boolean): void;
4195
+
4057
4196
  declare function DisableNavmeshInArea(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number): void;
4058
4197
 
4059
4198
  declare function DisableOcclusionThisFrame(): void;
@@ -4413,7 +4552,13 @@ declare function DoesDesObjectExist(object: number): boolean;
4413
4552
  declare function DoesRelationshipGroupExist(groupHash: string | number): boolean;
4414
4553
  declare function N_0xcc6e3b6bb69501f1(groupHash: string | number): boolean;
4415
4554
 
4555
+ /**
4556
+ * Return if the rope was generated or not by the script where the native is called.
4557
+ */
4416
4558
  declare function DoesRopeBelongToThisScript(ropeId: number): boolean;
4559
+ /**
4560
+ * Return if the rope was generated or not by the script where the native is called.
4561
+ */
4417
4562
  declare function N_0x271c9d3aca5d6409(ropeId: number): boolean;
4418
4563
 
4419
4564
  declare function DoesRopeExist(ropeId: number): [boolean, number];
@@ -5211,11 +5356,53 @@ declare function EnableControlAction(padIndex: number, control: number, enable:
5211
5356
  declare function EnableCrosshairThisFrame(): void;
5212
5357
 
5213
5358
  /**
5214
- * https://alloc8or.re/gta5/doc/enums/DispatchType.txt
5359
+ * List of dispatch services:
5360
+ * ```cpp
5361
+ * enum DispatchType
5362
+ * {
5363
+ * DT_Invalid = 0,
5364
+ * DT_PoliceAutomobile,
5365
+ * DT_PoliceHelicopter,
5366
+ * DT_FireDepartment,
5367
+ * DT_SwatAutomobile,
5368
+ * DT_AmbulanceDepartment,
5369
+ * DT_PoliceRiders,
5370
+ * DT_PoliceVehicleRequest,
5371
+ * DT_PoliceRoadBlock,
5372
+ * DT_PoliceAutomobileWaitPulledOver,
5373
+ * DT_PoliceAutomobileWaitCruising,
5374
+ * DT_Gangs,
5375
+ * DT_SwatHelicopter,
5376
+ * DT_PoliceBoat,
5377
+ * DT_ArmyVehicle,
5378
+ * DT_BikerBackup = 15
5379
+ * };
5380
+ * ```
5215
5381
  */
5216
5382
  declare function EnableDispatchService(dispatchService: number, toggle: boolean): void;
5217
5383
  /**
5218
- * https://alloc8or.re/gta5/doc/enums/DispatchType.txt
5384
+ * List of dispatch services:
5385
+ * ```cpp
5386
+ * enum DispatchType
5387
+ * {
5388
+ * DT_Invalid = 0,
5389
+ * DT_PoliceAutomobile,
5390
+ * DT_PoliceHelicopter,
5391
+ * DT_FireDepartment,
5392
+ * DT_SwatAutomobile,
5393
+ * DT_AmbulanceDepartment,
5394
+ * DT_PoliceRiders,
5395
+ * DT_PoliceVehicleRequest,
5396
+ * DT_PoliceRoadBlock,
5397
+ * DT_PoliceAutomobileWaitPulledOver,
5398
+ * DT_PoliceAutomobileWaitCruising,
5399
+ * DT_Gangs,
5400
+ * DT_SwatHelicopter,
5401
+ * DT_PoliceBoat,
5402
+ * DT_ArmyVehicle,
5403
+ * DT_BikerBackup = 15
5404
+ * };
5405
+ * ```
5219
5406
  */
5220
5407
  declare function N_0xdc0f817884cdd856(dispatchService: number, toggle: boolean): void;
5221
5408
 
@@ -5376,48 +5563,8 @@ declare function EndTextCommandBusyString(busySpinnerType: number): void;
5376
5563
  declare function EndTextCommandClearPrint(): void;
5377
5564
  declare function N_0xfcc75460aba29378(): void;
5378
5565
 
5379
- /**
5380
- * -----------
5381
- * p3 (duration in MS) was previously mentioned as "shape", but with some more testing it seems that it's more likely to be a duration in MS. (Tested this when not calling it every tick, but instead only once and let it display for the specified duration).
5382
- * -1 seems to be default delay (around 3 seconds), 5000 (ms) seems to be the max. Anything > 5000 will still result in 5 seconds of display time.
5383
- * Old p3 (shape) description: "shape goes from -1 to 50 (may be more)."
5384
- * --------------
5385
- * p0 is always 0.
5386
- * Example:
5387
- * void FloatingHelpText(char* text)
5388
- * {
5389
- * BEGIN_TEXT_COMMAND_DISPLAY_HELP("STRING");
5390
- * ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
5391
- * END_TEXT_COMMAND_DISPLAY_HELP (0, 0, 1, -1);
5392
- * }
5393
- * Image:
5394
- * - imgbin.org/images/26209.jpg
5395
- * more inputs/icons:
5396
- * - pastebin.com/nqNYWMSB
5397
- * Used to be known as _DISPLAY_HELP_TEXT_FROM_STRING_LABEL
5398
- */
5399
- declare function EndTextCommandDisplayHelp(p0: number, loop: boolean, beep: boolean, shape: number): void;
5400
- /**
5401
- * -----------
5402
- * p3 (duration in MS) was previously mentioned as "shape", but with some more testing it seems that it's more likely to be a duration in MS. (Tested this when not calling it every tick, but instead only once and let it display for the specified duration).
5403
- * -1 seems to be default delay (around 3 seconds), 5000 (ms) seems to be the max. Anything > 5000 will still result in 5 seconds of display time.
5404
- * Old p3 (shape) description: "shape goes from -1 to 50 (may be more)."
5405
- * --------------
5406
- * p0 is always 0.
5407
- * Example:
5408
- * void FloatingHelpText(char* text)
5409
- * {
5410
- * BEGIN_TEXT_COMMAND_DISPLAY_HELP("STRING");
5411
- * ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
5412
- * END_TEXT_COMMAND_DISPLAY_HELP (0, 0, 1, -1);
5413
- * }
5414
- * Image:
5415
- * - imgbin.org/images/26209.jpg
5416
- * more inputs/icons:
5417
- * - pastebin.com/nqNYWMSB
5418
- * Used to be known as _DISPLAY_HELP_TEXT_FROM_STRING_LABEL
5419
- */
5420
- declare function DisplayHelpTextFromStringLabel(p0: number, loop: boolean, beep: boolean, shape: number): void;
5566
+ declare function EndTextCommandDisplayHelp(shape: number, loop: boolean, beep: boolean, duration: number): void;
5567
+ declare function DisplayHelpTextFromStringLabel(shape: number, loop: boolean, beep: boolean, duration: number): void;
5421
5568
 
5422
5569
  /**
5423
5570
  * After applying the properties to the text (See UI::SET_TEXT_), this will draw the text in the applied position. Also 0.0f < x, y < 1.0f, percentage of the axis.
@@ -7261,10 +7408,7 @@ declare function GetConvar(varName: string, default_: string): string;
7261
7408
  declare function GetConvarInt(varName: string, default_: number): number;
7262
7409
 
7263
7410
  /**
7264
- * 0 -> up
7265
- * 1 -> lowering down
7266
- * 2 -> down
7267
- * 3 -> raising up
7411
+ * ```
7268
7412
  * enum RoofState
7269
7413
  * {
7270
7414
  * ROOFSTATE_UP = 0;
@@ -7272,6 +7416,9 @@ declare function GetConvarInt(varName: string, default_: number): number;
7272
7416
  * ROOFSTATE_DOWN,
7273
7417
  * ROOFSTATE_RAISING
7274
7418
  * };
7419
+ * ```
7420
+ * Got a "6" return value but not sure about what the value means
7421
+ * 6 -> unknown (Stopped but not fully open ?)
7275
7422
  */
7276
7423
  declare function GetConvertibleRoofState(vehicle: number): number;
7277
7424
 
@@ -7502,9 +7649,10 @@ declare function GetDisplayNameFromVehicleModel(modelHash: string | number): str
7502
7649
  declare function GetDistanceBetweenCoords(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, useZ: boolean): number;
7503
7650
 
7504
7651
  /**
7505
- * dlcVehicleIndex takes a number from 0 - GET_NUM_DLC_VEHICLES() - 1.
7506
- * outData is a struct of 3 8-byte items.
7507
- * The Second item in the struct *(Hash *)(outData + 1) is the vehicle hash.
7652
+ * The Second item in the struct `*(Hash *)(outData + 1)` is the vehicle hash.
7653
+ * @param dlcVehicleIndex takes a number from 0 to `GET_NUM_DLC_VEHICLES()` - 1.
7654
+ * @param outData a struct of 3 8-byte items.
7655
+ * @return A boolean value return if find or not the dlcVehicleIndex.
7508
7656
  */
7509
7657
  declare function GetDlcVehicleData(dlcVehicleIndex: number, outData?: number): [boolean, number];
7510
7658
 
@@ -8102,6 +8250,11 @@ declare function N_0xe1ca84ebf72e691d(componentHash: string | number, forcedProp
8102
8250
 
8103
8251
  declare function GetFrameCount(): number;
8104
8252
 
8253
+ /**
8254
+ * Gets the high precision frame time of the last frame in seconds.
8255
+ * *note: the example above is way less precise.*
8256
+ * @return The frame time (in seconds) of the last frame.
8257
+ */
8105
8258
  declare function GetFrameTime(): number;
8106
8259
 
8107
8260
  /**
@@ -9259,6 +9412,9 @@ declare function GetNumDispatchedUnitsForPlayer(dispatchService: number): number
9259
9412
  declare function N_0xeb4a0c2d56441717(dispatchService: number): number;
9260
9413
  declare function GetNumberOfDispatchedUnitsForPlayer(dispatchService: number): number;
9261
9414
 
9415
+ /**
9416
+ * Returns the total number of DLC vehicles.
9417
+ */
9262
9418
  declare function GetNumDlcVehicles(): number;
9263
9419
 
9264
9420
  /**
@@ -10153,24 +10309,24 @@ declare function GetPedEventData(ped: number, eventType: number, outData?: numbe
10153
10309
  declare function GetPedExtractedDisplacement(ped: number, worldSpace: boolean): number[];
10154
10310
 
10155
10311
  /**
10156
- * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
10312
+ * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
10157
10313
  * @param ped The target ped
10158
10314
  * @return Returns ped's eye colour, or -1 if fails to get.
10159
10315
  */
10160
10316
  declare function GetPedEyeColor(ped: number): number;
10161
-
10162
10317
  /**
10163
10318
  * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
10164
10319
  * @param ped The target ped
10165
10320
  * @return Returns ped's eye colour, or -1 if fails to get.
10166
10321
  */
10167
- declare function GetPedEyeColor(ped: number): number;
10322
+ declare function N_0x76bba2cee66d47e9(ped: number): number;
10323
+
10168
10324
  /**
10169
- * A getter for [`_SET_PED_EYE_COLOR`](#\_0x50B56988B170AFDF).
10325
+ * A getter for [\_SET_PED_EYE_COLOR](#\_0x50B56988B170AFDF). Returns -1 if fails to get.
10170
10326
  * @param ped The target ped
10171
10327
  * @return Returns ped's eye colour, or -1 if fails to get.
10172
10328
  */
10173
- declare function N_0x76bba2cee66d47e9(ped: number): number;
10329
+ declare function GetPedEyeColor(ped: number): number;
10174
10330
 
10175
10331
  /**
10176
10332
  * A getter for [\_SET_PED_FACE_FEATURE](#\_0x71A5C1DBA060049E). Returns 0.0 if fails to get.
@@ -10492,7 +10648,42 @@ declare function GetPedTimeOfDeath(ped: number): number;
10492
10648
  declare function N_0x1e98817b311ae98a(ped: number): number;
10493
10649
 
10494
10650
  /**
10495
- * https://alloc8or.re/gta5/doc/enums/ePedType.txt
10651
+ * Ped types:
10652
+ * ```cpp
10653
+ * enum ePedType
10654
+ * {
10655
+ * PED_TYPE_PLAYER_0,
10656
+ * PED_TYPE_PLAYER_1,
10657
+ * PED_TYPE_NETWORK_PLAYER,
10658
+ * PED_TYPE_PLAYER_2,
10659
+ * PED_TYPE_CIVMALE,
10660
+ * PED_TYPE_CIVFEMALE,
10661
+ * PED_TYPE_COP,
10662
+ * PED_TYPE_GANG_ALBANIAN,
10663
+ * PED_TYPE_GANG_BIKER_1,
10664
+ * PED_TYPE_GANG_BIKER_2,
10665
+ * PED_TYPE_GANG_ITALIAN,
10666
+ * PED_TYPE_GANG_RUSSIAN,
10667
+ * PED_TYPE_GANG_RUSSIAN_2,
10668
+ * PED_TYPE_GANG_IRISH,
10669
+ * PED_TYPE_GANG_JAMAICAN,
10670
+ * PED_TYPE_GANG_AFRICAN_AMERICAN,
10671
+ * PED_TYPE_GANG_KOREAN,
10672
+ * PED_TYPE_GANG_CHINESE_JAPANESE,
10673
+ * PED_TYPE_GANG_PUERTO_RICAN,
10674
+ * PED_TYPE_DEALER,
10675
+ * PED_TYPE_MEDIC,
10676
+ * PED_TYPE_FIREMAN,
10677
+ * PED_TYPE_CRIMINAL,
10678
+ * PED_TYPE_BUM,
10679
+ * PED_TYPE_PROSTITUTE,
10680
+ * PED_TYPE_SPECIAL,
10681
+ * PED_TYPE_MISSION,
10682
+ * PED_TYPE_SWAT,
10683
+ * PED_TYPE_ANIMAL,
10684
+ * PED_TYPE_ARMY
10685
+ * };
10686
+ * ```
10496
10687
  */
10497
10688
  declare function GetPedType(ped: number): number;
10498
10689
 
@@ -11158,6 +11349,61 @@ declare function GetSafePickupCoords(x: number, y: number, z: number, p3: number
11158
11349
  */
11159
11350
  declare function GetSafeZoneSize(): number;
11160
11351
 
11352
+ /**
11353
+ * Gets mouse selection data from scaleforms with mouse support. Must be checked every frame
11354
+ * Selection types, found in MOUSE_EVENTS.as:
11355
+ * MOUSE_DRAG_OUT = 0;
11356
+ * MOUSE_DRAG_OVER = 1;
11357
+ * MOUSE_DOWN = 2;
11358
+ * MOUSE_MOVE = 3;
11359
+ * MOUSE_UP = 4;
11360
+ * MOUSE_PRESS = 5;
11361
+ * MOUSE_RELEASE = 6;
11362
+ * MOUSE_RELEASE_OUTSIDE = 7;
11363
+ * MOUSE_ROLL_OUT = 8;
11364
+ * MOUSE_ROLL_OVER = 9;
11365
+ * MOUSE_WHEEL_UP = 10;
11366
+ * MOUSE_WHEEL_DOWN = 11;
11367
+ * Scaleforms that this works with:
11368
+ * * COLOUR_SWITCHER\_02
11369
+ * * MP_RESULTS_PANEL
11370
+ * * MP_NEXT_JOB_SELECTION
11371
+ * * SC_LEADERBOARD
11372
+ * Probably works with other scaleforms, needs more research.
11373
+ * @param scaleformHandle Handle of the scaleform
11374
+ * @param received Returns a boolean indicating if the data was received successfully
11375
+ * @param slotIndex Index of the slot the mouse is hovering on
11376
+ * @param p4 Purpose unknown, always returns -1 or 0. Returns item index if using the COLOUR_SWITCHER\_02 scaleform
11377
+ */
11378
+ declare function GetScaleformMovieCursorSelection(scaleformHandle: number): [boolean, any /* actually bool */, number, number, number];
11379
+ /**
11380
+ * Gets mouse selection data from scaleforms with mouse support. Must be checked every frame
11381
+ * Selection types, found in MOUSE_EVENTS.as:
11382
+ * MOUSE_DRAG_OUT = 0;
11383
+ * MOUSE_DRAG_OVER = 1;
11384
+ * MOUSE_DOWN = 2;
11385
+ * MOUSE_MOVE = 3;
11386
+ * MOUSE_UP = 4;
11387
+ * MOUSE_PRESS = 5;
11388
+ * MOUSE_RELEASE = 6;
11389
+ * MOUSE_RELEASE_OUTSIDE = 7;
11390
+ * MOUSE_ROLL_OUT = 8;
11391
+ * MOUSE_ROLL_OVER = 9;
11392
+ * MOUSE_WHEEL_UP = 10;
11393
+ * MOUSE_WHEEL_DOWN = 11;
11394
+ * Scaleforms that this works with:
11395
+ * * COLOUR_SWITCHER\_02
11396
+ * * MP_RESULTS_PANEL
11397
+ * * MP_NEXT_JOB_SELECTION
11398
+ * * SC_LEADERBOARD
11399
+ * Probably works with other scaleforms, needs more research.
11400
+ * @param scaleformHandle Handle of the scaleform
11401
+ * @param received Returns a boolean indicating if the data was received successfully
11402
+ * @param slotIndex Index of the slot the mouse is hovering on
11403
+ * @param p4 Purpose unknown, always returns -1 or 0. Returns item index if using the COLOUR_SWITCHER\_02 scaleform
11404
+ */
11405
+ declare function N_0x632b2940c67f4ea9(scaleformHandle: number): [boolean, any /* actually bool */, number, number, number];
11406
+
11161
11407
  /**
11162
11408
  * methodReturn: The return value of this native: END_SCALEFORM_MOVIE_METHOD_RETURN_VALUE
11163
11409
  */
@@ -12567,6 +12813,19 @@ declare function GetVehiclePedIsUsing(ped: number): number;
12567
12813
  */
12568
12814
  declare function GetVehiclePetrolTankHealth(vehicle: number): number;
12569
12815
 
12816
+ /**
12817
+ * Returns the plates a vehicle has.
12818
+ * ```
12819
+ * enum eVehiclePlateType
12820
+ * {
12821
+ * VPT_FRONT_AND_BACK_PLATES = 0,
12822
+ * VPT_FRONT_PLATES = 1,
12823
+ * VPT_BACK_PLATES = 2,
12824
+ * VPT_NONE = 3,
12825
+ * };
12826
+ * ```
12827
+ * Motorcycles with no visible plates will sometimes return a 2 for unknown reasons.
12828
+ */
12570
12829
  declare function GetVehiclePlateType(vehicle: number): number;
12571
12830
 
12572
12831
  /**
@@ -14626,6 +14885,17 @@ declare function IsModelValid(model: string | number): boolean;
14626
14885
 
14627
14886
  declare function IsMountedWeaponTaskUnderneathDrivingTask(ped: number): boolean;
14628
14887
 
14888
+ /**
14889
+ * Returns true if the cursor is hovering above instructional buttons.
14890
+ * Note: The buttons need to support mouse (with the TOGGLE_MOUSE_SUPPORT scaleform movie method) for it to return true.
14891
+ */
14892
+ declare function IsMouseCursorAboveInstructionalButtons(): boolean;
14893
+ /**
14894
+ * Returns true if the cursor is hovering above instructional buttons.
14895
+ * Note: The buttons need to support mouse (with the TOGGLE_MOUSE_SUPPORT scaleform movie method) for it to return true.
14896
+ */
14897
+ declare function N_0x3d9acb1eb139e702(): boolean;
14898
+
14629
14899
  declare function IsMoveBlendRatioRunning(ped: number): boolean;
14630
14900
 
14631
14901
  declare function IsMoveBlendRatioSprinting(ped: number): boolean;
@@ -16399,7 +16669,7 @@ declare function SetVehicleEnginePowerMultiplier(vehicle: number, value: number)
16399
16669
  /**
16400
16670
  * Sets the water height for a given position and radius.
16401
16671
  */
16402
- declare function ModifyWater(x: number, y: number, radius: number, height: number): void;
16672
+ declare function ModifyWater(x: number, y: number, height: number, radius: number): void;
16403
16673
 
16404
16674
  declare function MoveVehicleDecals(p0: number, p1: number): void;
16405
16675
 
@@ -16623,8 +16893,6 @@ declare function N_0x02e93c796abd3a97(p0: boolean): void;
16623
16893
 
16624
16894
  declare function N_0x03300b57fcac6ddb(p0: boolean): void;
16625
16895
 
16626
- declare function N_0x0379daf89ba09aa5(p0: number, p1: number): void;
16627
-
16628
16896
  declare function N_0x0395cb47b022e62c(p0: number): [boolean, number];
16629
16897
 
16630
16898
  declare function N_0x03c2eebb04b3fb72(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number): void;
@@ -16859,8 +17127,6 @@ declare function N_0x1398582b7f72b3ed(p0: number): void;
16859
17127
 
16860
17128
  declare function N_0x13b350b8ad0eee10(): void;
16861
17129
 
16862
- declare function N_0x13c4b962653a5280(): number;
16863
-
16864
17130
  /**
16865
17131
  * SET_NETWORK_*
16866
17132
  */
@@ -16896,8 +17162,6 @@ declare function N_0x155467aca0f55705(): number;
16896
17162
 
16897
17163
  declare function N_0x159b7318403a1cd8(p0: number): void;
16898
17164
 
16899
- declare function N_0x15e69e2802c24b8d(p0: number): void;
16900
-
16901
17165
  declare function N_0x1612c45f9e3e0d44(): void;
16902
17166
 
16903
17167
  declare function N_0x162c23ca83ed0a62(p0: number): boolean;
@@ -16955,8 +17219,6 @@ declare function N_0x1a7ce7cd3e653485(p0: number): void;
16955
17219
 
16956
17220
  declare function N_0x1a8ea222f9c67dbb(p0: number): number;
16957
17221
 
16958
- declare function N_0x1b0b4aeed5b9b41c(p0: number): void;
16959
-
16960
17222
  /**
16961
17223
  * Sets a value that appears to affect door opening behavior when damaged.
16962
17224
  * SET_*
@@ -17461,8 +17723,6 @@ declare function N_0x30ca2ef91d15adf8(): number;
17461
17723
  */
17462
17724
  declare function N_0x31125fd509d9043f(p0: number): void;
17463
17725
 
17464
- declare function N_0x3117d84efa60f77b(p0: number): void;
17465
-
17466
17726
  /**
17467
17727
  * NativeDB Introduced: v2189
17468
17728
  */
@@ -17518,8 +17778,6 @@ declare function N_0x352e2b5cf420bf3b(p0: number, p1: number): void;
17518
17778
 
17519
17779
  declare function N_0x357b152ef96c30b6(): number;
17520
17780
 
17521
- declare function N_0x359af31a4b52f5ed(): number;
17522
-
17523
17781
  /**
17524
17782
  * NativeDB Introduced: v1290
17525
17783
  */
@@ -17641,8 +17899,6 @@ declare function N_0x3c5c1e2c2ff814b1(toggle: boolean): void;
17641
17899
  */
17642
17900
  declare function N_0x3c788e7f6438754d(checkpointHandle: number, x: number, y: number, z: number): void;
17643
17901
 
17644
- declare function N_0x3d9acb1eb139e702(): number;
17645
-
17646
17902
  declare function N_0x3de3aa516fb126a4(p0: number): void;
17647
17903
 
17648
17904
  /**
@@ -17767,8 +18023,6 @@ declare function N_0x45f35c0edc33b03b(netScene: number, modelHash: string | numb
17767
18023
  */
17768
18024
  declare function N_0x4669b3ed80f24b4e(player: number): void;
17769
18025
 
17770
- declare function N_0x466da42c89865553(p0: number): void;
17771
-
17772
18026
  declare function N_0x469f2ecdec046337(p0: boolean): void;
17773
18027
 
17774
18028
  /**
@@ -17990,8 +18244,6 @@ declare function N_0x53cae13e9b426993(p0: number): void;
17990
18244
  */
17991
18245
  declare function N_0x53ddc75bc3ac0a90(vehicle: number): void;
17992
18246
 
17993
- declare function N_0x53f4892d18ec90a4(p0: number): void;
17994
-
17995
18247
  declare function N_0x5407b7288d0478b7(p0: number): number;
17996
18248
 
17997
18249
  declare function N_0x547237aa71ab44de(p0: number): void;
@@ -18180,11 +18432,6 @@ declare function N_0x5edef0cf8c1dab3c(): boolean;
18180
18432
  */
18181
18433
  declare function N_0x5ee5632f47ae9695(vehicle: number, health: number): void;
18182
18434
 
18183
- /**
18184
- * SET_PLAYER_*
18185
- */
18186
- declare function N_0x5f2013f8bc24ee69(p0: number): void;
18187
-
18188
18435
  declare function N_0x5f456788b05faeac(p0: number, p1: number, p2: number): void;
18189
18436
 
18190
18437
  /**
@@ -18247,8 +18494,6 @@ declare function N_0x62e849b7eb28e770(p0: boolean): void;
18247
18494
 
18248
18495
  declare function N_0x62ecfcfdee7885d6(): void;
18249
18496
 
18250
- declare function N_0x632b2940c67f4ea9(scaleformHandle: number): [boolean, number, number, number];
18251
-
18252
18497
  declare function N_0x63b406d7884bfa95(): number;
18253
18498
 
18254
18499
  declare function N_0x63eb2b972a218cac(): void;
@@ -18633,8 +18878,6 @@ declare function N_0x76b3f29d3f967692(p0: number, p1: number): void;
18633
18878
  */
18634
18879
  declare function N_0x76d26a22750e849e(vehicle: number): void;
18635
18880
 
18636
- declare function N_0x77f16b447824da6c(p0: number): void;
18637
-
18638
18881
  declare function N_0x77faddcbe3499df7(p0: number): void;
18639
18882
 
18640
18883
  declare function N_0x7808619f31ff22db(): number;
@@ -19067,11 +19310,6 @@ declare function N_0x91ef6ee6419e5b97(p0: boolean): void;
19067
19310
 
19068
19311
  declare function N_0x9237e334f6e43156(p0: number): number;
19069
19312
 
19070
- /**
19071
- * DISABLE_*
19072
- */
19073
- declare function N_0x9245e81072704b8a(p0: boolean): void;
19074
-
19075
19313
  declare function N_0x92da6e70ef249bd1(p0: string, p1?: number): [boolean, number];
19076
19314
 
19077
19315
  /**
@@ -20105,8 +20343,6 @@ declare function N_0xcd4d66b43b1dd28d(p0: number, p1: number, p2: number): void;
20105
20343
  */
20106
20344
  declare function N_0xcd74233600c4ea6b(toggle: boolean): void;
20107
20345
 
20108
- declare function N_0xcdca26e80faecb8f(): void;
20109
-
20110
20346
  declare function N_0xcea7c8e1b48ff68c(p0: number, p1: number): void;
20111
20347
 
20112
20348
  declare function N_0xced08cbe8ebb97c7(p0: number, p1: number): void;
@@ -20207,8 +20443,6 @@ declare function N_0xd565f438137f0e10(p0: number, p1: number): void;
20207
20443
 
20208
20444
  declare function N_0xd642319c54aadeb6(): number;
20209
20445
 
20210
- declare function N_0xd6ade981781fca09(p0: number): void;
20211
-
20212
20446
  /**
20213
20447
  * NativeDB Introduced: v2189
20214
20448
  */
@@ -20610,8 +20844,6 @@ declare function N_0xf051d9bfb6ba39c0(p0: number): void;
20610
20844
 
20611
20845
  declare function N_0xf06a6f41cb445443(p0: number): void;
20612
20846
 
20613
- declare function N_0xf06ebb91a81e09e3(p0: boolean): void;
20614
-
20615
20847
  /**
20616
20848
  * NETWORK_RE*
20617
20849
  */
@@ -20631,15 +20863,6 @@ declare function N_0xf13fe2a80c05c561(): boolean;
20631
20863
  */
20632
20864
  declare function N_0xf1a1803d3476f215(value: number): void;
20633
20865
 
20634
- declare function N_0xf1e22dc13f5eebad(p0: number): void;
20635
-
20636
- /**
20637
- * 2 calls found in the b617d scripts:
20638
- * AUDIO::_F1F8157B8C3F171C(l_A42, "Franklin_Bike_Rev", "BIG_SCORE_3A_SOUNDS");
20639
- * AUDIO::_F1F8157B8C3F171C(l_166, "Trevor_Revs_Off", "PALETO_SCORE_SETUP_SOUNDS");
20640
- */
20641
- declare function N_0xf1f8157b8c3f171c(vehicle: number, p1: string, p2: string): void;
20642
-
20643
20866
  declare function N_0xf22ca0fd74b80e7a(p0: number): boolean;
20644
20867
 
20645
20868
  /**
@@ -21433,34 +21656,15 @@ declare function GetNumMembershipDesc(): number;
21433
21656
  declare function NetworkClanGetNumMembershipDesc(): number;
21434
21657
 
21435
21658
  /**
21436
- * BOOL DEBUG_MEMBRESHIP(int Param)
21437
- * {
21438
- * int membership;
21439
- * networkHandleMgr handle;
21440
- * NETWORK_HANDLE_FROM_PLAYER(iSelectedPlayer, &handle.netHandle, 13);
21441
- * if (!_NETWORK_IS_CLAN_MEMBERSHIP_FINISHED_DOWNLOADING())
21442
- * {
21443
- * if (NETWORK_CLAN_REMOTE_MEMBERSHIPS_ARE_IN_CACHE(&Param))
21444
- * {
21445
- * if (NETWORK_CLAN_GET_MEMBERSHIP_COUNT(&Param) > 0)
21446
- * {
21447
- * if (NETWORK_CLAN_GET_MEMBERSHIP_VALID(&Param, 0))
21448
- * {
21449
- * if (NETWORK_CLAN_GET_MEMBERSHIP(&Param, &membership, -1))
21450
- * {
21451
- * _0xF633805A(&membership, 35, &handle.netHandle);
21452
- * }
21453
- * }
21454
- * }
21455
- * }
21456
- * }
21457
- * else
21458
- * {
21459
- * NETWORK_CLAN_DOWNLOAD_MEMBERSHIP(&handle.netHandle);
21460
- * }
21461
- * }
21659
+ * Retrieves a membership for a player, from the cache (i.e. downloaded via NETWORK_CLAN_DOWNLOAD_MEMBERSHIP).
21660
+ * Test C++ code:
21661
+ * https://pastebin.com/CD8wni4C
21662
+ * @param networkHandle A player network handle.
21663
+ * @param clanMembership Output buffer for the membership data. Also known as "desc".
21664
+ * @param membershipIndex If the player has multiple crews/memberships, use \[0-9], or -1 to get the active crew/membership.
21665
+ * @return Returns true on success, false otherwise.
21462
21666
  */
21463
- declare function NetworkClanGetMembership(p2: number): [boolean, number, number];
21667
+ declare function NetworkClanGetMembership(membershipIndex: number): [boolean, number, number];
21464
21668
 
21465
21669
  declare function NetworkClanGetMembershipCount(p0: number): [number, number];
21466
21670
 
@@ -22271,6 +22475,12 @@ declare function NetworkGetDestroyerOfNetworkId(netId: number, weaponHash?: numb
22271
22475
  declare function NetworkGetDisplaynamesFromHandles(p0: number, p1: number, p2: number): number;
22272
22476
  declare function N_0x58cc181719256197(p0: number, p1: number, p2: number): number;
22273
22477
 
22478
+ /**
22479
+ * Get the local entity handle of the given network id
22480
+ * Through this native you can get back the entity that you previously converted to netid with [NetworkGetNetworkIdFromEntity](#\_0x9E35DAB6) or with the `ToNet` natives
22481
+ * @param netId the network id of the entity
22482
+ * @return The local entity handle of the network id
22483
+ */
22274
22484
  declare function NetworkGetEntityFromNetworkId(netId: number): number;
22275
22485
 
22276
22486
  declare function NetworkGetEntityIsLocal(entity: number): boolean;
@@ -22376,6 +22586,15 @@ declare function NetworkGetMaxNumParticipants(): number;
22376
22586
  */
22377
22587
  declare function NetworkGetNumParticipantsHost(): number;
22378
22588
 
22589
+ /**
22590
+ * Get the network id of the given entity
22591
+ * An entity network id is representing a given entity for other clients, is like a handle that every client recognize, can be reconverted to a client entity handle.
22592
+ * These can and will be reused, the network id will not change.
22593
+ * If you need to refer to an entity across machines (clients, or the server), you should use its network id.
22594
+ * Read more at [Network and local IDs](https://docs.fivem.net/docs/scripting-manual/networking/ids/)
22595
+ * @param entity the handle of the entity from which the network id should be taken
22596
+ * @return The network id of the given entity
22597
+ */
22379
22598
  declare function NetworkGetNetworkIdFromEntity(entity: number): number;
22380
22599
 
22381
22600
  declare function NetworkGetNumBodyTrackers(): number;
@@ -22471,8 +22690,16 @@ declare function NetworkGetPresenceInviteHandle(p0: number, p1?: number): [boole
22471
22690
  declare function NetworkGetPresenceInviteId(p0: number): number;
22472
22691
  declare function N_0xdff09646e12ec386(p0: number): number;
22473
22692
 
22474
- declare function NetworkGetPresenceInviteInviter(p0: number): number;
22475
- declare function N_0x4962cc4aa2f345b7(p0: number): number;
22693
+ /**
22694
+ * Returns the Name of the inviter of the specific selected Invite.
22695
+ * @return The Name of the inviter.
22696
+ */
22697
+ declare function NetworkGetPresenceInviteInviter(inviteIndex: number): string;
22698
+ /**
22699
+ * Returns the Name of the inviter of the specific selected Invite.
22700
+ * @return The Name of the inviter.
22701
+ */
22702
+ declare function N_0x4962cc4aa2f345b7(inviteIndex: number): string;
22476
22703
 
22477
22704
  declare function NetworkGetPresenceInviteIsTournament(p0: number): boolean;
22478
22705
  declare function N_0x8806cebfabd3ce05(p0: number): boolean;
@@ -22483,8 +22710,16 @@ declare function N_0x728c4cc7920cd102(p0: number): number;
22483
22710
  declare function NetworkGetPresenceInvitePlaylistLength(p0: number): number;
22484
22711
  declare function N_0xd39b3fff8ffdd5bf(p0: number): number;
22485
22712
 
22486
- declare function NetworkGetPresenceInviteSessionId(p0: number): number;
22487
- declare function N_0x26e1cd96b0903d60(p0: number): number;
22713
+ /**
22714
+ * The Native returns a hash of the session id as string from the specific invite index!
22715
+ * @return A hash of the session id.
22716
+ */
22717
+ declare function NetworkGetPresenceInviteSessionId(inviteIndex: number): number;
22718
+ /**
22719
+ * The Native returns a hash of the session id as string from the specific invite index!
22720
+ * @return A hash of the session id.
22721
+ */
22722
+ declare function N_0x26e1cd96b0903d60(inviteIndex: number): number;
22488
22723
 
22489
22724
  declare function NetworkGetPrimaryClanDataCancel(): void;
22490
22725
  declare function N_0x042e4b70b93e6054(): void;
@@ -23753,6 +23988,27 @@ declare function NetworkSetMissionFinished(): void;
23753
23988
  declare function NetworkSetNoSpectatorChat(toggle: boolean): void;
23754
23989
  declare function N_0xf46a1e03e8755980(toggle: boolean): void;
23755
23990
 
23991
+ /**
23992
+ * Sets whether or not an object (created using `CREATE_OBJECT`, or similar) should have its position/rotation synchronized,
23993
+ * even if it is a 'static' object (for example, having flag 32 - Static - set in its archetype definition).
23994
+ * This has to be called during the same frame the object is created/registered for network, as otherwise it may already
23995
+ * have a remote clone created.
23996
+ * Once a remote clone is created, changing this value will not have any effect on said clone.
23997
+ * @param object The object to set forced blending state for.
23998
+ * @param enabled `true` to enable forced blending.
23999
+ */
24000
+ declare function NetworkSetObjectForceStaticBlend(object: number, enabled: boolean): void;
24001
+ /**
24002
+ * Sets whether or not an object (created using `CREATE_OBJECT`, or similar) should have its position/rotation synchronized,
24003
+ * even if it is a 'static' object (for example, having flag 32 - Static - set in its archetype definition).
24004
+ * This has to be called during the same frame the object is created/registered for network, as otherwise it may already
24005
+ * have a remote clone created.
24006
+ * Once a remote clone is created, changing this value will not have any effect on said clone.
24007
+ * @param object The object to set forced blending state for.
24008
+ * @param enabled `true` to enable forced blending.
24009
+ */
24010
+ declare function N_0x0379daf89ba09aa5(object: number, enabled: boolean): void;
24011
+
23756
24012
  declare function NetworkSetOverrideSpectatorMode(toggle: boolean): void;
23757
24013
 
23758
24014
  declare function NetworkSetPlayerIsPassive(toggle: boolean): void;
@@ -24816,6 +25072,35 @@ declare function AddFrontendMenuContext(hash: string | number): void;
24816
25072
  declare function PauseMenuDeactivateContext(contextHash: string | number): void;
24817
25073
  declare function ObjectDecalToggle(contextHash: string | number): void;
24818
25074
 
25075
+ /**
25076
+ * Disables the loading spinner in Pause Menu when switching from one header tab to another.
25077
+ * @param toggle true to disable and false to re-enable the loading icon.
25078
+ */
25079
+ declare function PauseMenuDisableBusyspinner(toggle: boolean): void;
25080
+ /**
25081
+ * Disables the loading spinner in Pause Menu when switching from one header tab to another.
25082
+ * @param toggle true to disable and false to re-enable the loading icon.
25083
+ */
25084
+ declare function N_0x9245e81072704b8a(toggle: boolean): void;
25085
+
25086
+ /**
25087
+ * If mouse is hovering on a slot, it returns the slot's index, else it returns -1.
25088
+ */
25089
+ declare function PauseMenuGetIndexOfMouseHoveredSlot(): number;
25090
+ /**
25091
+ * If mouse is hovering on a slot, it returns the slot's index, else it returns -1.
25092
+ */
25093
+ declare function N_0x359af31a4b52f5ed(): number;
25094
+
25095
+ /**
25096
+ * If mouse is hovering on a slot, it returns uniqueid of that slot, else it returns -1.
25097
+ */
25098
+ declare function PauseMenuGetUniqueIdOfMouseHoveredSlot(): number;
25099
+ /**
25100
+ * If mouse is hovering on a slot, it returns uniqueid of that slot, else it returns -1.
25101
+ */
25102
+ declare function N_0x13c4b962653a5280(): number;
25103
+
24819
25104
  declare function PauseMenuIsContextActive(contextHash: string | number): boolean;
24820
25105
  declare function N_0x84698ab38d0c6636(contextHash: string | number): boolean;
24821
25106
 
@@ -24830,10 +25115,45 @@ declare function PauseMenuRedrawInstructionalButtons(p0: number): void;
24830
25115
  * Updates instructional buttons in Pause Menu after menu contexts have been toggled. p0 purpose is currently unknown, only 0 is used in scripts.
24831
25116
  */
24832
25117
  declare function EnableDeathbloodSeethrough(p0: number): void;
25118
+ /**
25119
+ * Updates instructional buttons in Pause Menu after menu contexts have been toggled. p0 purpose is currently unknown, only 0 is used in scripts.
25120
+ */
25121
+ declare function N_0x4895bdea16e7c080(p0: number): void;
24833
25122
 
24834
25123
  declare function PauseMenuSetBusySpinner(p0: boolean, p1: number, p2: number): void;
24835
25124
  declare function N_0xc78e239ac5b2ddb9(p0: boolean, p1: number, p2: number): void;
24836
25125
 
25126
+ /**
25127
+ * Shows this warning message when trying to switch pause menu header tabs: https://i.imgur.com/8qmfztu.png
25128
+ * @param setWarn Wether to show the message or not.
25129
+ */
25130
+ declare function PauseMenuSetWarnOnTabChange(setWarn: boolean): void;
25131
+ /**
25132
+ * Shows this warning message when trying to switch pause menu header tabs: https://i.imgur.com/8qmfztu.png
25133
+ * @param setWarn Wether to show the message or not.
25134
+ */
25135
+ declare function N_0xf06ebb91a81e09e3(setWarn: boolean): void;
25136
+
25137
+ /**
25138
+ * Sets current pause menu page/component to the specified value.
25139
+ * Available page IDs: https://pastebin.com/qxuhwjPT
25140
+ */
25141
+ declare function PauseMenuceptionGoDeeper(pageId: number): void;
25142
+ /**
25143
+ * Sets current pause menu page/component to the specified value.
25144
+ * Available page IDs: https://pastebin.com/qxuhwjPT
25145
+ */
25146
+ declare function N_0x77f16b447824da6c(pageId: number): void;
25147
+
25148
+ /**
25149
+ * Forces the Pause Menu to back out of unique pages such as Awards, Unlocks, Key Bindings etc
25150
+ */
25151
+ declare function PauseMenuceptionTheKick(): void;
25152
+ /**
25153
+ * Forces the Pause Menu to back out of unique pages such as Awards, Unlocks, Key Bindings etc
25154
+ */
25155
+ declare function N_0xcdca26e80faecb8f(): void;
25156
+
24837
25157
  declare function PausePlaybackRecordedVehicle(vehicle: number): void;
24838
25158
 
24839
25159
  declare function PauseScriptedConversation(p0: boolean): void;
@@ -26112,25 +26432,8 @@ declare function RemoveAnimDict(animDict: string): void;
26112
26432
  declare function RemoveAnimSet(animSet: string): void;
26113
26433
 
26114
26434
  /**
26115
- * In the C++ SDK, this seems not to work-- the blip isn't removed immediately. I use it for saving cars.
26116
- * E.g.:
26117
- * Ped pped = PLAYER::PLAYER_PED_ID();
26118
- * Vehicle v = PED::GET_VEHICLE_PED_IS_USING(pped);
26119
- * Blip b = HUD::ADD_BLIP_FOR_ENTITY(v);
26120
- * works fine.
26121
- * But later attempting to delete it with:
26122
- * Blip b = HUD::GET_BLIP_FROM_ENTITY(v);
26123
- * if (HUD::DOES_BLIP_EXIST(b)) HUD::REMOVE_BLIP(&b);
26124
- * doesn't work. And yes, doesn't work without the DOES_BLIP_EXIST check either. Also, if you attach multiple blips to the same thing (say, a vehicle), and that thing disappears, the blips randomly attach to other things (in my case, a vehicle).
26125
- * Thus for me, HUD::REMOVE_BLIP(&b) only works if there's one blip, (in my case) the vehicle is marked as no longer needed, you drive away from it and it eventually despawns, AND there is only one blip attached to it. I never intentionally attach multiple blips but if the user saves the car, this adds a blip. Then if they delete it, it is supposed to remove the blip, but it doesn't. Then they can immediately save it again, causing another blip to re-appear.
26126
- * -------------
26127
- * Passing the address of the variable instead of the value works for me.
26128
- * e.g.
26129
- * int blip = HUD::ADD_BLIP_FOR_ENTITY(ped);
26130
- * HUD::REMOVE_BLIP(&blip);
26131
- * Remove blip will currently crash your game, just artificially remove the blip by setting the sprite to a id that is 'invisible'.
26132
- * --
26133
- * It crashes my game.
26435
+ * Removes the blip from your map.
26436
+ * @param blip Blip handle to remove.
26134
26437
  */
26135
26438
  declare function RemoveBlip(blip: number): void;
26136
26439
 
@@ -26209,7 +26512,15 @@ declare function RemoveModelHide(x: number, y: number, z: number, radius: number
26209
26512
 
26210
26513
  declare function RemoveModelSwap(x: number, y: number, z: number, radius: number, originalModel: string | number, newModel: string | number, p6: boolean): void;
26211
26514
 
26515
+ /**
26516
+ * Removes the gamer tag associated with the provided ID. This does not happen instantly. Use [IS_MP_GAMER_TAG_FREE](#\_0x595B5178E412E199) to determine when the ID is free for reuse.
26517
+ * @param gamerTagId A player ID with a gamer tag or a fake gamer tag ID.
26518
+ */
26212
26519
  declare function RemoveMpGamerTag(gamerTagId: number): void;
26520
+ /**
26521
+ * Removes the gamer tag associated with the provided ID. This does not happen instantly. Use [IS_MP_GAMER_TAG_FREE](#\_0x595B5178E412E199) to determine when the ID is free for reuse.
26522
+ * @param gamerTagId A player ID with a gamer tag or a fake gamer tag ID.
26523
+ */
26213
26524
  declare function N_0x31698aa80e0223f8(gamerTagId: number): void;
26214
26525
 
26215
26526
  declare function RemoveMultiplayerBankCash(): void;
@@ -26704,6 +27015,9 @@ declare function RequestPtfxAsset(): void;
26704
27015
 
26705
27016
  declare function RequestScaleformMovie(scaleformName: string): number;
26706
27017
 
27018
+ /**
27019
+ * Same as [REQUEST_SCALEFORM_MOVIE](#\_0x11FE353CF9733E6F), except it seems to fix stretched scaleforms on ultrawide.
27020
+ */
26707
27021
  declare function RequestScaleformMovieInstance(scaleformName: string): number;
26708
27022
 
26709
27023
  /**
@@ -27358,8 +27672,26 @@ declare function PushScaleformMovieFunctionParameterInt(value: number): void;
27358
27672
  */
27359
27673
  declare function PushScaleformMovieMethodParameterInt(value: number): void;
27360
27674
 
27675
+ /**
27676
+ * Values:
27677
+ * 0 - Dialogue Brief
27678
+ * 1 - Help Text Brief
27679
+ * 2 - Mission Objective Brief
27680
+ */
27361
27681
  declare function ScaleformMovieMethodAddParamLatestBriefString(value: number): void;
27682
+ /**
27683
+ * Values:
27684
+ * 0 - Dialogue Brief
27685
+ * 1 - Help Text Brief
27686
+ * 2 - Mission Objective Brief
27687
+ */
27362
27688
  declare function N_0xec52c631a1831c03(value: number): void;
27689
+ /**
27690
+ * Values:
27691
+ * 0 - Dialogue Brief
27692
+ * 1 - Help Text Brief
27693
+ * 2 - Mission Objective Brief
27694
+ */
27363
27695
  declare function ScaleformMovieMethodAddParamIntString(value: number): void;
27364
27696
 
27365
27697
  /**
@@ -28503,6 +28835,25 @@ declare function SetCgoffset(entity: number, x: number, y: number, z: number): v
28503
28835
  */
28504
28836
  declare function SetCheckpointCylinderHeight(checkpoint: number, nearHeight: number, farHeight: number, radius: number): void;
28505
28837
 
28838
+ /**
28839
+ * This multiplies the height of the icon inside a checkpoint with the default height of about 2 units above the checkpoint's coordinates.
28840
+ * @param checkpoint The checkpoint the multiplier should be applied to.
28841
+ * @param height_multiplier The multiplier for the icon height above the checkpoint's coordinates. Default is 1.0
28842
+ */
28843
+ declare function SetCheckpointIconHeight(checkpoint: number, height_multiplier: number): void;
28844
+ /**
28845
+ * This multiplies the height of the icon inside a checkpoint with the default height of about 2 units above the checkpoint's coordinates.
28846
+ * @param checkpoint The checkpoint the multiplier should be applied to.
28847
+ * @param height_multiplier The multiplier for the icon height above the checkpoint's coordinates. Default is 1.0
28848
+ */
28849
+ declare function N_0x4b5b4da5d79f1943(checkpoint: number, height_multiplier: number): void;
28850
+ /**
28851
+ * This multiplies the height of the icon inside a checkpoint with the default height of about 2 units above the checkpoint's coordinates.
28852
+ * @param checkpoint The checkpoint the multiplier should be applied to.
28853
+ * @param height_multiplier The multiplier for the icon height above the checkpoint's coordinates. Default is 1.0
28854
+ */
28855
+ declare function SetCheckpointScale(checkpoint: number, height_multiplier: number): void;
28856
+
28506
28857
  declare function SetCheckpointIconScale(checkpoint: number, scale: number): void;
28507
28858
  declare function N_0x44621483ff966526(checkpoint: number, scale: number): void;
28508
28859
 
@@ -28520,27 +28871,6 @@ declare function SetCheckpointRgba2(checkpoint: number, red: number, green: numb
28520
28871
  */
28521
28872
  declare function SetCheckpointIconRgba(checkpoint: number, red: number, green: number, blue: number, alpha: number): void;
28522
28873
 
28523
- /**
28524
- * p0 - Scale? Looks to be a normalized value (0.0 - 1.0)
28525
- * offroad_races.c4, line ~67407:
28526
- * a_3._f7 = GRAPHICS::CREATE_CHECKPOINT(v_D, v_A, a_4, a_7, v_E, v_F, v_10, sub_62b2(v_A, 220, 255), 0);
28527
- * HUD::GET_HUD_COLOUR(134, &v_E, &v_F, &v_10, &v_11);
28528
- * GRAPHICS::_SET_CHECKPOINT_ICON_RGBA(a_3._f7, v_E, v_F, v_10, sub_62b2(v_A, 70, 210));
28529
- * GRAPHICS::_4B5B4DA5D79F1943(a_3._f7, 0.95);
28530
- * GRAPHICS::SET_CHECKPOINT_CYLINDER_HEIGHT(a_3._f7, 4.0, 4.0, 100.0);
28531
- */
28532
- declare function SetCheckpointScale(checkpoint: number, p0: number): void;
28533
- /**
28534
- * p0 - Scale? Looks to be a normalized value (0.0 - 1.0)
28535
- * offroad_races.c4, line ~67407:
28536
- * a_3._f7 = GRAPHICS::CREATE_CHECKPOINT(v_D, v_A, a_4, a_7, v_E, v_F, v_10, sub_62b2(v_A, 220, 255), 0);
28537
- * HUD::GET_HUD_COLOUR(134, &v_E, &v_F, &v_10, &v_11);
28538
- * GRAPHICS::_SET_CHECKPOINT_ICON_RGBA(a_3._f7, v_E, v_F, v_10, sub_62b2(v_A, 70, 210));
28539
- * GRAPHICS::_4B5B4DA5D79F1943(a_3._f7, 0.95);
28540
- * GRAPHICS::SET_CHECKPOINT_CYLINDER_HEIGHT(a_3._f7, 4.0, 4.0, 100.0);
28541
- */
28542
- declare function N_0x4b5b4da5d79f1943(checkpoint: number, p0: number): void;
28543
-
28544
28874
  declare function SetCinematicButtonActive(p0: boolean): void;
28545
28875
 
28546
28876
  declare function SetCinematicCamShakeAmplitude(p0: number): void;
@@ -30439,24 +30769,6 @@ declare function SetMovementModeOverride(ped: number, name: string): void;
30439
30769
  */
30440
30770
  declare function N_0x781de8fa214e87d2(ped: number, name: string): void;
30441
30771
 
30442
- /**
30443
- * NativeDB Introduced: v1365
30444
- */
30445
- declare function SetMpGamerHealthBarDisplay(gamerTagId: number, toggle: boolean): void;
30446
- /**
30447
- * NativeDB Introduced: v1365
30448
- */
30449
- declare function N_0xd29ec58c2f6b5014(gamerTagId: number, toggle: boolean): void;
30450
-
30451
- /**
30452
- * NativeDB Introduced: v1365
30453
- */
30454
- declare function SetMpGamerHealthBarMax(gamerTagId: number, value: number, maximumValue: number): void;
30455
- /**
30456
- * NativeDB Introduced: v1365
30457
- */
30458
- declare function N_0x1563fe35e9928e67(gamerTagId: number, value: number, maximumValue: number): void;
30459
-
30460
30772
  /**
30461
30773
  * Sets flag's sprite transparency. 0-255.
30462
30774
  */
@@ -30485,10 +30797,24 @@ declare function SetMpGamerTagColour(gamerTagId: number, component: number, hudC
30485
30797
  */
30486
30798
  declare function N_0x613ed644950626ae(gamerTagId: number, component: number, hudColorIndex: number): void;
30487
30799
 
30488
- declare function SetMpGamerTagEnabled(gamerTagId: number, toggle: boolean): void;
30489
- declare function N_0xee76ff7e6a0166b0(gamerTagId: number, toggle: boolean): void;
30490
- declare function SetMpGamerTag_(gamerTagId: number, toggle: boolean): void;
30491
- declare function SetMpGamerTag(gamerTagId: number, toggle: boolean): void;
30800
+ /**
30801
+ * By default, the player health value shown by a gamer tag's health bar is synchronised with the health of the ped it is attached to.
30802
+ * This native disables that behaviour, allowing [`_SET_MP_GAMER_TAG_OVERRIDE_PLAYER_HEALTH`](#\_0x1563FE35E9928E67) to have an effect.
30803
+ * @param toggle If player health synchronisation should be disabled.
30804
+ */
30805
+ declare function SetMpGamerTagDisablePlayerHealthSync(gamerTagId: number, toggle: boolean): void;
30806
+ /**
30807
+ * By default, the player health value shown by a gamer tag's health bar is synchronised with the health of the ped it is attached to.
30808
+ * This native disables that behaviour, allowing [`_SET_MP_GAMER_TAG_OVERRIDE_PLAYER_HEALTH`](#\_0x1563FE35E9928E67) to have an effect.
30809
+ * @param toggle If player health synchronisation should be disabled.
30810
+ */
30811
+ declare function N_0xd29ec58c2f6b5014(gamerTagId: number, toggle: boolean): void;
30812
+ /**
30813
+ * By default, the player health value shown by a gamer tag's health bar is synchronised with the health of the ped it is attached to.
30814
+ * This native disables that behaviour, allowing [`_SET_MP_GAMER_TAG_OVERRIDE_PLAYER_HEALTH`](#\_0x1563FE35E9928E67) to have an effect.
30815
+ * @param toggle If player health synchronisation should be disabled.
30816
+ */
30817
+ declare function SetMpGamerHealthBarDisplay(gamerTagId: number, toggle: boolean): void;
30492
30818
 
30493
30819
  /**
30494
30820
  * Should be enabled as component (2). Has 0 alpha by default.
@@ -30509,15 +30835,6 @@ declare function N_0x3158c77a7e888ab4(gamerTagId: number, hudColorIndex: number)
30509
30835
  */
30510
30836
  declare function SetMpGamerTagHealthBarColor(gamerTagId: number, hudColorIndex: number): void;
30511
30837
 
30512
- /**
30513
- * Displays a bunch of icons above the players name, and level, and their name twice
30514
- */
30515
- declare function SetMpGamerTagIcons(gamerTagId: number, toggle: boolean): void;
30516
- /**
30517
- * Displays a bunch of icons above the players name, and level, and their name twice
30518
- */
30519
- declare function N_0xa67f9c46d612b6f1(gamerTagId: number, toggle: boolean): void;
30520
-
30521
30838
  /**
30522
30839
  * displays wanted star above head
30523
30840
  */
@@ -30534,6 +30851,47 @@ declare function SetMpGamerTagUnk(gamerTagId: number, count: number): void;
30534
30851
  declare function SetMpGamerTagName(gamerTagId: number, _string: string): void;
30535
30852
  declare function N_0xdea2b8283baa3944(gamerTagId: number, _string: string): void;
30536
30853
 
30854
+ /**
30855
+ * Manually sets the player health value for a gamer tag, using the maximum health to calculate what percentage of the bar should be filled.
30856
+ * Has no effect unless [\_SET_MP_GAMER_TAG_DISABLE_PLAYER_HEALTH_SYNC](#\_0xD29EC58C2F6B5014) has been called prior to disable synchronisation with the attached ped.
30857
+ * @param health The amount the health the player has.
30858
+ * @param maximumHealth The maximum amount of health the player could have.
30859
+ */
30860
+ declare function SetMpGamerTagOverridePlayerHealth(gamerTagId: number, health: number, maximumHealth: number): void;
30861
+ /**
30862
+ * Manually sets the player health value for a gamer tag, using the maximum health to calculate what percentage of the bar should be filled.
30863
+ * Has no effect unless [\_SET_MP_GAMER_TAG_DISABLE_PLAYER_HEALTH_SYNC](#\_0xD29EC58C2F6B5014) has been called prior to disable synchronisation with the attached ped.
30864
+ * @param health The amount the health the player has.
30865
+ * @param maximumHealth The maximum amount of health the player could have.
30866
+ */
30867
+ declare function N_0x1563fe35e9928e67(gamerTagId: number, health: number, maximumHealth: number): void;
30868
+ /**
30869
+ * Manually sets the player health value for a gamer tag, using the maximum health to calculate what percentage of the bar should be filled.
30870
+ * Has no effect unless [\_SET_MP_GAMER_TAG_DISABLE_PLAYER_HEALTH_SYNC](#\_0xD29EC58C2F6B5014) has been called prior to disable synchronisation with the attached ped.
30871
+ * @param health The amount the health the player has.
30872
+ * @param maximumHealth The maximum amount of health the player could have.
30873
+ */
30874
+ declare function SetMpGamerHealthBarMax(gamerTagId: number, health: number, maximumHealth: number): void;
30875
+
30876
+ /**
30877
+ * Sets the health bar of a gamer tag to show the health of the last (or current) vehicle of the ped the gamer tag is attached to.
30878
+ * The vehicle health value is stored separate from the player health and using it won't clear any player health overrides.
30879
+ * @param toggle If vehicle health should be displayed instead of player health.
30880
+ */
30881
+ declare function SetMpGamerTagUseVehicleHealth(gamerTagId: number, toggle: boolean): void;
30882
+ /**
30883
+ * Sets the health bar of a gamer tag to show the health of the last (or current) vehicle of the ped the gamer tag is attached to.
30884
+ * The vehicle health value is stored separate from the player health and using it won't clear any player health overrides.
30885
+ * @param toggle If vehicle health should be displayed instead of player health.
30886
+ */
30887
+ declare function N_0xa67f9c46d612b6f1(gamerTagId: number, toggle: boolean): void;
30888
+ /**
30889
+ * Sets the health bar of a gamer tag to show the health of the last (or current) vehicle of the ped the gamer tag is attached to.
30890
+ * The vehicle health value is stored separate from the player health and using it won't clear any player health overrides.
30891
+ * @param toggle If vehicle health should be displayed instead of player health.
30892
+ */
30893
+ declare function SetMpGamerTagIcons(gamerTagId: number, toggle: boolean): void;
30894
+
30537
30895
  /**
30538
30896
  * cpp
30539
30897
  * enum eMpGamerTagComponent
@@ -30615,6 +30973,32 @@ declare function SetMpGamerTagVisibility(gamerTagId: number, component: number,
30615
30973
  */
30616
30974
  declare function N_0x63bb75abedc1f6a0(gamerTagId: number, component: number, toggle: boolean): void;
30617
30975
 
30976
+ /**
30977
+ * Sets the visibility of all components of the gamer tag to the specified value.
30978
+ * @param toggle The new visibility state of all gamer tag components.
30979
+ */
30980
+ declare function SetMpGamerTagVisibilityAll(gamerTagId: number, toggle: boolean): void;
30981
+ /**
30982
+ * Sets the visibility of all components of the gamer tag to the specified value.
30983
+ * @param toggle The new visibility state of all gamer tag components.
30984
+ */
30985
+ declare function N_0xee76ff7e6a0166b0(gamerTagId: number, toggle: boolean): void;
30986
+ /**
30987
+ * Sets the visibility of all components of the gamer tag to the specified value.
30988
+ * @param toggle The new visibility state of all gamer tag components.
30989
+ */
30990
+ declare function SetMpGamerTag_(gamerTagId: number, toggle: boolean): void;
30991
+ /**
30992
+ * Sets the visibility of all components of the gamer tag to the specified value.
30993
+ * @param toggle The new visibility state of all gamer tag components.
30994
+ */
30995
+ declare function SetMpGamerTag(gamerTagId: number, toggle: boolean): void;
30996
+ /**
30997
+ * Sets the visibility of all components of the gamer tag to the specified value.
30998
+ * @param toggle The new visibility state of all gamer tag components.
30999
+ */
31000
+ declare function SetMpGamerTagEnabled(gamerTagId: number, toggle: boolean): void;
31001
+
30618
31002
  /**
30619
31003
  * displays wanted star above head
30620
31004
  */
@@ -30760,6 +31144,22 @@ declare function SetObjectCanClimbOn(object: number, toggle: boolean): void;
30760
31144
  */
30761
31145
  declare function SetObjectAsNoLongerNeeded(object: number): void;
30762
31146
 
31147
+ /**
31148
+ * Overrides a flag on the object which determines if the object should be avoided by a vehicle in task: CTaskVehicleGoToPointWithAvoidanceAutomobile.
31149
+ * Tested on vehicles that were created by the vehicle generators.
31150
+ */
31151
+ declare function SetObjectForceVehiclesToAvoid(object: number, toggle: boolean): void;
31152
+ /**
31153
+ * Overrides a flag on the object which determines if the object should be avoided by a vehicle in task: CTaskVehicleGoToPointWithAvoidanceAutomobile.
31154
+ * Tested on vehicles that were created by the vehicle generators.
31155
+ */
31156
+ declare function N_0x77f33f2ccf64b3aa(object: number, toggle: boolean): void;
31157
+ /**
31158
+ * Overrides a flag on the object which determines if the object should be avoided by a vehicle in task: CTaskVehicleGoToPointWithAvoidanceAutomobile.
31159
+ * Tested on vehicles that were created by the vehicle generators.
31160
+ */
31161
+ declare function SetObjectSomething(object: number, toggle: boolean): void;
31162
+
30763
31163
  /**
30764
31164
  * Sets color of embedded light source.
30765
31165
  * Only appears in am_mp_nightclub.c for the nightclub dancefloor.
@@ -30776,9 +31176,6 @@ declare function SetObjectLightColor(object: number, p1: boolean, r: number, g:
30776
31176
  */
30777
31177
  declare function SetObjectPhysicsParams(object: number, mass: number, gravityFactor: number, linearC: number, linearV: number, linearV2: number, angularC: number, angularV: number, angularV2: number, p9: number, maxAngSpeed: number, buoyancyFactor: number): void;
30778
31178
 
30779
- declare function SetObjectSomething(object: number, p1: boolean): void;
30780
- declare function N_0x77f33f2ccf64b3aa(object: number, p1: boolean): void;
30781
-
30782
31179
  declare function SetObjectStuntPropDuration(object: number, duration: number): void;
30783
31180
  declare function N_0xdf6ca0330f2e737b(object: number, duration: number): void;
30784
31181
 
@@ -30919,11 +31316,12 @@ declare function SetParticleFxLoopedScale(ptfxHandle: number, scale: number): vo
30919
31316
  declare function SetParticleFxNonLoopedAlpha(alpha: number): void;
30920
31317
 
30921
31318
  /**
30922
- * Changes the colour of the particle effect that will be drawn next. The particle can be networked or non-networked, but it must be non-looped for this native to work.
30923
- * The colour parameters accept RGB values on a scale from 0.0 to 1.0, therefore RGB values that follow the standard 0-255 scale can be easily used dividing said value by 255.
30924
- * @param r The red component of the particle's colour, on a scale from 0.0 to 1.0.
30925
- * @param g The green component of the particle's colour, on a scale from 0.0 to 1.0.
30926
- * @param b The blue component of the particle's colour, on a scale from 0.0 to 1.0.
31319
+ * Only works on some fx's, while on others it might SEEM to work "properly", but the colors can be "strange" or even completly different from what you've expected. Reason for this is that those fx's might already have colors "baked into them" which then start to act as a "mixing palette", resulting in a different color than expected. A hypothetical example of this would be if the fx itself is already full (bright) red (RGB: 1.0, 0.0, 0.0) and you then set the color to (bright) green (RGB: 0.0, 1.0, 0.0), that it MIGHT result in Yellow (RGB: 1.0, 1.0, 0.0).
31320
+ * This doc previously stated that the set color is **NOT** networked, however it does actually turns out to be networked. Tested with all fireworks effects and several other FX effects resulted in colored fx effects on all clients when used in combination with [START_NETWORKED_PARTICLE_FX_NON_LOOPED_AT_COORD](#\_0xF56B8137DF10135D).
31321
+ * This might however not be the case for all types of particle fx's, so it's recommended to test this thoroughly with multiple clients before releasing your script for example.
31322
+ * @param r Red (0.0 - 1.0)
31323
+ * @param g Green (0.0 - 1.0)
31324
+ * @param b Blue (0.0 - 1.0)
30927
31325
  */
30928
31326
  declare function SetParticleFxNonLoopedColour(r: number, g: number, b: number): void;
30929
31327
 
@@ -31245,6 +31643,7 @@ declare function SetPedCombatAbility(ped: number, p1: number): void;
31245
31643
  /**
31246
31644
  * These combat attributes seem to be the same as the BehaviourFlags from combatbehaviour.meta.
31247
31645
  * So far, these are the equivalents found:
31646
+ * ```
31248
31647
  * enum CombatAttributes
31249
31648
  * {
31250
31649
  * BF_CanUseCover = 0,
@@ -31255,13 +31654,15 @@ declare function SetPedCombatAbility(ped: number, p1: number): void;
31255
31654
  * BF_CanTauntInVehicle = 20,
31256
31655
  * BF_AlwaysFight = 46,
31257
31656
  * BF_IgnoreTrafficWhenDriving = 52,
31657
+ * BF_FleesFromInvincibleOpponents = 63,
31258
31658
  * BF_FreezeMovement = 292,
31259
31659
  * BF_PlayerCanUseFiringWeapons = 1424
31260
31660
  * };
31261
- * 8 = ?
31262
- * 9 = ?
31263
- * 13 = ?
31264
- * 14 ?
31661
+ * ```
31662
+ * 8 = ?\
31663
+ * 9 = ?\
31664
+ * 13 = ?\
31665
+ * 14 ?\
31265
31666
  * Research thread: gtaforums.com/topic/833391-researchguide-combat-behaviour-flags/
31266
31667
  */
31267
31668
  declare function SetPedCombatAttributes(ped: number, attributeIndex: number, enabled: boolean): void;
@@ -32200,6 +32601,11 @@ declare function SetPedMaxMoveBlendRatio(ped: number, value: number): void;
32200
32601
 
32201
32602
  declare function SetPedMaxTimeInWater(ped: number, value: number): void;
32202
32603
 
32604
+ /**
32605
+ * Set the maximum time a ped can stay underwater. Maximum seems to be 50 seconds.
32606
+ * @param ped Ped id.
32607
+ * @param value Time in seconds. Maximum is 50.0, any value above will be changed to 50.0.
32608
+ */
32203
32609
  declare function SetPedMaxTimeUnderwater(ped: number, value: number): void;
32204
32610
 
32205
32611
  /**
@@ -32630,14 +33036,51 @@ declare function SetPedWeaponMovementClipset(ped: number, clipSet: string): void
32630
33036
 
32631
33037
  /**
32632
33038
  * tintIndex can be the following:
32633
- * 0 - Normal
32634
- * 1 - Green
32635
- * 2 - Gold
32636
- * 3 - Pink
32637
- * 4 - Army
32638
- * 5 - LSPD
32639
- * 6 - Orange
32640
- * 7 - Platinum
33039
+ * 0 : Default/Black
33040
+ * 1 : Green
33041
+ * 2 : Gold
33042
+ * 3 : Pink
33043
+ * 4 : Army
33044
+ * 5 : LSPD
33045
+ * 6 : Orange
33046
+ * 7 : Platinum
33047
+ * tintIndex for MK2 weapons :
33048
+ * 0 : Classic Black
33049
+ * 1 : Classic Gray
33050
+ * 2 : Classic Two-Tone
33051
+ * 3 : Classic White
33052
+ * 4 : Classic Beige
33053
+ * 5 : Classic Green
33054
+ * 6 : Classic Blue
33055
+ * 7 : Classic Earth
33056
+ * 8 : Classic Brown & Black
33057
+ * 9 : Red Contrast
33058
+ * 10 : Blue Contrast
33059
+ * 11 : Yellow Contrast
33060
+ * 12 : Orange Contrast
33061
+ * 13 : Bold Pink
33062
+ * 14 : Bold Purple & Yellow
33063
+ * 15 : Bold Orange
33064
+ * 16 : Bold Green & Purple
33065
+ * 17 : Bold Red Features
33066
+ * 18 : Bold Green Features
33067
+ * 19 : Bold Cyan Features
33068
+ * 20 : Bold Yellow Features
33069
+ * 21 : Bold Red & White
33070
+ * 22 : Bold Blue & White
33071
+ * 23 : Metallic Gold
33072
+ * 24 : Metallic Platinum
33073
+ * 25 : Metallic Gray & Lilac
33074
+ * 26 : Metallic Purple & Lime
33075
+ * 27 : Metallic Red
33076
+ * 28 : Metallic Green
33077
+ * 29 : Metallic Blue
33078
+ * 30 : Metallic White & Aqua
33079
+ * 31 : Metallic Orange & Yellow
33080
+ * 32 : Mettalic Red and Yellow
33081
+ * @param ped The target ped
33082
+ * @param weaponHash The target weapon hash
33083
+ * @param tintIndex Tint for weapon hash
32641
33084
  */
32642
33085
  declare function SetPedWeaponTintIndex(ped: number, weaponHash: string | number, tintIndex: number): void;
32643
33086
 
@@ -32874,10 +33317,9 @@ declare function SetPlayerLeavePedBehind(player: number, toggle: boolean): void;
32874
33317
  declare function N_0xff300c7649724a0b(player: number, toggle: boolean): void;
32875
33318
 
32876
33319
  /**
32877
- * Example from fm_mission_controler.ysc.c4:
32878
- * PLAYER::SET_PLAYER_LOCKON(PLAYER::PLAYER_ID(), 1);
32879
- * All other decompiled scripts using this seem to be using the player id as the first parameter, so I feel the need to confirm it as so.
32880
- * No need to confirm it says PLAYER_ID() so it uses PLAYER_ID() lol.
33320
+ * Used to toggle the square up aim.
33321
+ * @param player The player ID to toggle the lock on for.
33322
+ * @param toggle Set to false to prevent lock on, set to true to allow for lock on.
32881
33323
  */
32882
33324
  declare function SetPlayerLockon(player: number, toggle: boolean): void;
32883
33325
 
@@ -33005,6 +33447,9 @@ declare function SetPlayerRockstarEditorDisabled(toggle: boolean): void;
33005
33447
  */
33006
33448
  declare function N_0x9d8d44adbba61ef2(toggle: boolean): void;
33007
33449
 
33450
+ declare function SetPlayerShortSwitchStyle(style: number): void;
33451
+ declare function N_0x5f2013f8bc24ee69(style: number): void;
33452
+
33008
33453
  declare function SetPlayerSimulateAiming(player: number, toggle: boolean): void;
33009
33454
 
33010
33455
  /**
@@ -33058,8 +33503,22 @@ declare function N_0xbdeb86f4d5809204(value: number): void;
33058
33503
  */
33059
33504
  declare function SetPlayerTeam(player: number, team: number): void;
33060
33505
 
33061
- declare function SetPlayerUnderwaterTimeRemaining(player: number, time: number): number;
33062
- declare function N_0xa0d3e4f7aafb7e78(player: number, time: number): number;
33506
+ /**
33507
+ * Seems to lock the underwater timer of the specified player. Set `percentage` to `50.0` will reduce the value of [GET_PLAYER_UNDERWATER_TIME_REMAINING](#\_0xA1FCF8E6AF40B731) to 5.0.
33508
+ * If you want to increase the underwater time for ped, use [SET_PED_MAX_TIME_UNDERWATER](#\_0x6BA428C528D9E522) instead.
33509
+ * Using this native after [SET_PED_MAX_TIME_UNDERWATER](#\_0x6BA428C528D9E522) **WILL NOT** get what you want. For example, if you set the max time underwater to `100.0` seconds using [SET_PED_MAX_TIME_UNDERWATER](#\_0x6BA428C528D9E522) and then call this native and set the `percentage` to 50.0, you will not get `50.0`, instead `2.0`.
33510
+ * @param player Player id.
33511
+ * @param percentage Maximum is `100.0`. Any value above `100.0` and less than `0.0` will have no effect on [GET_PLAYER_UNDERWATER_TIME_REMAINING](#\_0xA1FCF8E6AF40B731).
33512
+ */
33513
+ declare function SetPlayerUnderwaterTimeRemaining(player: number, percentage: number): number;
33514
+ /**
33515
+ * Seems to lock the underwater timer of the specified player. Set `percentage` to `50.0` will reduce the value of [GET_PLAYER_UNDERWATER_TIME_REMAINING](#\_0xA1FCF8E6AF40B731) to 5.0.
33516
+ * If you want to increase the underwater time for ped, use [SET_PED_MAX_TIME_UNDERWATER](#\_0x6BA428C528D9E522) instead.
33517
+ * Using this native after [SET_PED_MAX_TIME_UNDERWATER](#\_0x6BA428C528D9E522) **WILL NOT** get what you want. For example, if you set the max time underwater to `100.0` seconds using [SET_PED_MAX_TIME_UNDERWATER](#\_0x6BA428C528D9E522) and then call this native and set the `percentage` to 50.0, you will not get `50.0`, instead `2.0`.
33518
+ * @param player Player id.
33519
+ * @param percentage Maximum is `100.0`. Any value above `100.0` and less than `0.0` will have no effect on [GET_PLAYER_UNDERWATER_TIME_REMAINING](#\_0xA1FCF8E6AF40B731).
33520
+ */
33521
+ declare function N_0xa0d3e4f7aafb7e78(player: number, percentage: number): number;
33063
33522
 
33064
33523
  /**
33065
33524
  * modifier's min value is 0.1
@@ -34032,11 +34491,6 @@ declare function SetTextCentre(align: boolean): void;
34032
34491
 
34033
34492
  declare function SetTextChatEnabled(enabled: boolean): boolean;
34034
34493
 
34035
- /**
34036
- * Sets an unknown boolean value in the text chat.
34037
- */
34038
- declare function SetTextChatUnk(p0: boolean): void;
34039
-
34040
34494
  /**
34041
34495
  * colors you input not same as you think?
34042
34496
  * A: for some reason its R B G A
@@ -34215,6 +34669,11 @@ declare function N_0x21973bbf8d17edfa(trackIndex: number, frequency: number): vo
34215
34669
  */
34216
34670
  declare function SetTrainsForceDoorsOpen(forceOpen: boolean): void;
34217
34671
 
34672
+ /**
34673
+ * This native doesn't work like [`SetWeatherTypeTransition`](#\_0x578C752848ECFA0C).
34674
+ * @param modifierName The name of a timecycle
34675
+ * @param transition The speed to transition to `modifierName`. Appears to be half-seconds (?)
34676
+ */
34218
34677
  declare function SetTransitionTimecycleModifier(modifierName: string, transition: number): void;
34219
34678
 
34220
34679
  /**
@@ -35622,6 +36081,25 @@ declare function SetVehicleSt(vehicle: number, toggle: boolean): void;
35622
36081
  */
35623
36082
  declare function N_0x1cf38d529d7441d9(vehicle: number, toggle: boolean): void;
35624
36083
 
36084
+ /**
36085
+ * Overrides the vehicle's startup engine rev sound.
36086
+ * 2 calls found in the b617d scripts:
36087
+ * ```cpp
36088
+ * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_A42, "Franklin_Bike_Rev", "BIG_SCORE_3A_SOUNDS");
36089
+ * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_166, "Trevor_Revs_Off", "PALETO_SCORE_SETUP_SOUNDS");
36090
+ * ```
36091
+ */
36092
+ declare function SetVehicleStartupRevSound(vehicle: number, p1: string, p2: string): void;
36093
+ /**
36094
+ * Overrides the vehicle's startup engine rev sound.
36095
+ * 2 calls found in the b617d scripts:
36096
+ * ```cpp
36097
+ * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_A42, "Franklin_Bike_Rev", "BIG_SCORE_3A_SOUNDS");
36098
+ * AUDIO::SET_VEHICLE_STARTUP_REV_SOUND(l_166, "Trevor_Revs_Off", "PALETO_SCORE_SETUP_SOUNDS");
36099
+ * ```
36100
+ */
36101
+ declare function N_0xf1f8157b8c3f171c(vehicle: number, p1: string, p2: string): void;
36102
+
35625
36103
  /**
35626
36104
  * Locks the vehicle's steering to the desired angle, explained below.
35627
36105
  * Requires to be called onTick. Steering is unlocked the moment the function stops being called on the vehicle.
@@ -36331,23 +36809,26 @@ declare function SetWaypointOff(): void;
36331
36809
  declare function SetWeaponAnimationOverride(ped: number, animStyle: string | number): void;
36332
36810
 
36333
36811
  /**
36334
- * Changes the weapon damage output by the given multiplier value. Must be run every frame.
36812
+ * Changes the weapon damage output by the given multiplier value.
36813
+ * Does NOT need to be called every frame.
36335
36814
  * @param weaponHash Hash of the weapon
36336
36815
  * @param damageMultiplier Damage Multiplier
36337
36816
  */
36338
- declare function SetWeaponDamageModifierThisFrame(weaponHash: string | number, damageMultiplier: number): void;
36817
+ declare function SetWeaponDamageModifier(weaponHash: string | number, damageMultiplier: number): void;
36339
36818
  /**
36340
- * Changes the weapon damage output by the given multiplier value. Must be run every frame.
36819
+ * Changes the weapon damage output by the given multiplier value.
36820
+ * Does NOT need to be called every frame.
36341
36821
  * @param weaponHash Hash of the weapon
36342
36822
  * @param damageMultiplier Damage Multiplier
36343
36823
  */
36344
36824
  declare function N_0x4757f00bc6323cfe(weaponHash: string | number, damageMultiplier: number): void;
36345
36825
  /**
36346
- * Changes the weapon damage output by the given multiplier value. Must be run every frame.
36826
+ * Changes the weapon damage output by the given multiplier value.
36827
+ * Does NOT need to be called every frame.
36347
36828
  * @param weaponHash Hash of the weapon
36348
36829
  * @param damageMultiplier Damage Multiplier
36349
36830
  */
36350
- declare function SetWeaponDamageModifier(weaponHash: string | number, damageMultiplier: number): void;
36831
+ declare function SetWeaponDamageModifierThisFrame(weaponHash: string | number, damageMultiplier: number): void;
36351
36832
 
36352
36833
  /**
36353
36834
  * NativeDB Introduced: v2372
@@ -36799,13 +37280,16 @@ declare function ShutdownLoadingScreen(): void;
36799
37280
  declare function ShutdownLoadingScreenNui(): void;
36800
37281
 
36801
37282
  /**
36802
- * This is to make the player walk without accepting input from INPUT.
36803
- * gaitType is in increments of 100s. 2000, 500, 300, 200, etc.
36804
- * p4 is always 1 and p5 is always 0.
36805
- * C# Example :
36806
- * Function.Call(Hash.SIMULATE_PLAYER_INPUT_GAIT, Game.Player, 1.0f, 100, 1.0f, 1, 0); //Player will go forward for 100ms
37283
+ * This is to make the player walk without accepting input.
37284
+ * Call this native every frame so you can control the direction of your ped.
37285
+ * @param player The player to target (always your local player id).
37286
+ * @param amount For game pads, using anything less than 1.0 will make it partially press analog controls (like sticks/triggers).
37287
+ * @param gaitType Value in increments of 100's. 2000, 500, 300, 200, etc. Set to -1 if you want your ped to walk forever.
37288
+ * @param rotationSpeed Determines the counterclockwise rotation angle when walking.
37289
+ * @param p4 Always true
37290
+ * @param p5 Always false
36807
37291
  */
36808
- declare function SimulatePlayerInputGait(player: number, amount: number, gaitType: number, speed: number, p4: boolean, p5: boolean): void;
37292
+ declare function SimulatePlayerInputGait(player: number, amount: number, gaitType: number, rotationSpeed: number, p4: boolean, p5: boolean): void;
36809
37293
 
36810
37294
  /**
36811
37295
  * Returns the sine of the given number.
@@ -37261,17 +37745,21 @@ declare function N_0xdde23f30cc5a0f03(effectName: string, entity: number, xOffse
37261
37745
  declare function StartParticleFxLoopedOnEntityBone_2(effectName: string, entity: number, xOffset: number, yOffset: number, zOffset: number, xRot: number, yRot: number, zRot: number, boneIndex: number, scale: number, xAxis: boolean, yAxis: boolean, zAxis: boolean): number;
37262
37746
 
37263
37747
  /**
37264
- * network fx
37265
- * ```
37748
+ * NOTE: the [USE_PARTICLE_FX_ASSET](#\_0x6C38AF3693A69A91) needs to be called before EVERY StartNetworkedParticleFxNonLoopedAtCoord(....) call!
37749
+ * List with lots of particle effects: https://vespura.com/fivem/particle-list/
37750
+ * Note: Not all particles on this list are for non looped and vice versa, neither are all of them suited/meant to have SetParticleFxNonLoopedColour(....) called on them.
37266
37751
  * ```
37267
37752
  * NativeDB Added Parameter 12: BOOL p11
37753
+ * ```
37268
37754
  */
37269
37755
  declare function StartNetworkedParticleFxNonLoopedAtCoord(effectName: string, xPos: number, yPos: number, zPos: number, xRot: number, yRot: number, zRot: number, scale: number, xAxis: boolean, yAxis: boolean, zAxis: boolean): boolean;
37270
37756
  /**
37271
- * network fx
37272
- * ```
37757
+ * NOTE: the [USE_PARTICLE_FX_ASSET](#\_0x6C38AF3693A69A91) needs to be called before EVERY StartNetworkedParticleFxNonLoopedAtCoord(....) call!
37758
+ * List with lots of particle effects: https://vespura.com/fivem/particle-list/
37759
+ * Note: Not all particles on this list are for non looped and vice versa, neither are all of them suited/meant to have SetParticleFxNonLoopedColour(....) called on them.
37273
37760
  * ```
37274
37761
  * NativeDB Added Parameter 12: BOOL p11
37762
+ * ```
37275
37763
  */
37276
37764
  declare function StartParticleFxNonLoopedAtCoord_2(effectName: string, xPos: number, yPos: number, zPos: number, xRot: number, yRot: number, zRot: number, scale: number, xAxis: boolean, yAxis: boolean, zAxis: boolean): boolean;
37277
37765
 
@@ -37420,6 +37908,14 @@ declare function StartPlaybackRecordedVehicleWithFlags(vehicle: number, recordin
37420
37908
  */
37421
37909
  declare function StartPlayerSwitch(_from: number, to: number, flags: number, switchType: number): void;
37422
37910
 
37911
+ /**
37912
+ * Teleports the player to the given coordinates.
37913
+ * If findCollisionLand is true it will try to find the Z value for you, this however has a timeout of 100 frames.
37914
+ * When trying to find the Z value the native will take longer the higher the difference from the given Z to the ground, this combined with the timeout can cause the teleport to just teleport to the given Z value, so try to estimate the z value, so don't just pass in 1000.0.
37915
+ * Also if you're in a vehicle and teleportWithVehicle is true it will not find the Z value for you.
37916
+ * @param teleportWithVehicle Teleports the player along with the vehicle they are in.
37917
+ * @param findCollisionLand Attempt to find a ground coordinate at the given XY location; overriding the Z value.
37918
+ */
37423
37919
  declare function StartPlayerTeleport(player: number, x: number, y: number, z: number, heading: number, teleportWithVehicle: boolean, findCollisionLand: boolean, p7: boolean): void;
37424
37920
 
37425
37921
  declare function StartPreloadedConversation(): void;
@@ -37891,10 +38387,6 @@ declare function StatSetFloat(statName: string | number, value: number, save: bo
37891
38387
  */
37892
38388
  declare function StatSetGxtLabel(statName: string | number, value: string, save: boolean): boolean;
37893
38389
 
37894
- /**
37895
- * Example:
37896
- * STATS::STAT_SET_INT(MISC::GET_HASH_KEY("MPPLY_KILLS_PLAYERS"), 1337, true);
37897
- */
37898
38390
  declare function StatSetInt(statName: string | number, value: number, save: boolean): boolean;
37899
38391
 
37900
38392
  declare function StatSetLicensePlate(statName: string | number, str: string): boolean;
@@ -38392,6 +38884,11 @@ declare function TaskCombatPed(ped: number, targetPed: number, p2: number, p3: n
38392
38884
 
38393
38885
  declare function TaskCombatPedTimed(p0: number, ped: number, p2: number, p3: number): void;
38394
38886
 
38887
+ /**
38888
+ * The ped will act like NPC's involved in a gunfight. The ped will squat down with their heads held in place and look around.
38889
+ * @param ped Ped id.
38890
+ * @param duration Duration of the animation in ms. Set to -1 if you do not want a duration.
38891
+ */
38395
38892
  declare function TaskCower(ped: number, duration: number): void;
38396
38893
 
38397
38894
  /**
@@ -38406,7 +38903,7 @@ declare function TaskDriveBy(driverPed: number, targetPed: number, targetVehicle
38406
38903
 
38407
38904
  /**
38408
38905
  * speed 1.0 = walk, 2.0 = run
38409
- * p5 1 = normal, 3 = teleport to vehicle, 16 = teleport directly into vehicle
38906
+ * p5 1 = normal, 3 = teleport to vehicle, 8 = normal/carjack ped from seat, 16 = teleport directly into vehicle
38410
38907
  * p6 is always 0
38411
38908
  * @param seatIndex See eSeatPosition declared in [`IS_VEHICLE_SEAT_FREE`](#\_0x22AC59A870E6A669).
38412
38909
  */
@@ -38648,7 +39145,7 @@ declare function TaskLeaveAnyVehicle(ped: number, p1: number, flags: number): vo
38648
39145
  * Flags from decompiled scripts:
38649
39146
  * 0 = normal exit and closes door.
38650
39147
  * 1 = normal exit and closes door.
38651
- * 16 = teleports outside, door kept closed.
39148
+ * 16 = teleports outside, door kept closed. (This flag does not seem to work for the front seats in buses, NPCs continue to exit normally)
38652
39149
  * 64 = normal exit and closes door, maybe a bit slower animation than 0.
38653
39150
  * 256 = normal exit but does not close the door.
38654
39151
  * 4160 = ped is throwing himself out, even when the vehicle is still.
@@ -38941,9 +39438,39 @@ declare function TaskPutPedDirectlyIntoCover(ped: number, x: number, y: number,
38941
39438
  declare function TaskPutPedDirectlyIntoMelee(ped: number, meleeTarget: number, p2: number, p3: number, p4: number, p5: boolean): void;
38942
39439
 
38943
39440
  /**
39441
+ * Attaches a ped to a rope and allows player control to rappel down a wall.
39442
+ * Disables all collisions while on the rope.
39443
+ * NativeDB Introduced: v1868
39444
+ * @param ped Ped to perform the task
39445
+ * @param x1 X coord to start the task
39446
+ * @param y1 Y coord to start the task
39447
+ * @param z1 Z coord to start the task
39448
+ * @param x2 Second X coord, uses the same position as above in the scripts
39449
+ * @param y2 Second Y coord
39450
+ * @param z2 Second Z coord
39451
+ * @param minZ Minimum Z that the player can descend to
39452
+ * @param ropeId Rope to attach this task to, must be created with [ADD_ROPE](#\_0xE832D760399EB220)
39453
+ * @param clipset Clipset to use for the task
39454
+ * @param p10 Usually 1 in the scripts
39455
+ */
39456
+ declare function TaskRappelDownWall(ped: number, x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, minZ: number, ropeId: number, clipset: string, p10: number): void;
39457
+ /**
39458
+ * Attaches a ped to a rope and allows player control to rappel down a wall.
39459
+ * Disables all collisions while on the rope.
38944
39460
  * NativeDB Introduced: v1868
39461
+ * @param ped Ped to perform the task
39462
+ * @param x1 X coord to start the task
39463
+ * @param y1 Y coord to start the task
39464
+ * @param z1 Z coord to start the task
39465
+ * @param x2 Second X coord, uses the same position as above in the scripts
39466
+ * @param y2 Second Y coord
39467
+ * @param z2 Second Z coord
39468
+ * @param minZ Minimum Z that the player can descend to
39469
+ * @param ropeId Rope to attach this task to, must be created with [ADD_ROPE](#\_0xE832D760399EB220)
39470
+ * @param clipset Clipset to use for the task
39471
+ * @param p10 Usually 1 in the scripts
38945
39472
  */
38946
- declare function TaskRappelDownWall(p0: number, p1: number, p2: number, p3: number, p4: number, p5: number, p6: number, p7: number, p8: number, p9: number, p10: number): void;
39473
+ declare function N_0xeaf66acddc794793(ped: number, x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, minZ: number, ropeId: number, clipset: string, p10: number): void;
38947
39474
 
38948
39475
  /**
38949
39476
  * Only appears twice in the scripts.
@@ -39266,8 +39793,26 @@ declare function TaskVehicleChase(driver: number, targetEnt: number): void;
39266
39793
  */
39267
39794
  declare function TaskVehicleDriveToCoord(ped: number, vehicle: number, x: number, y: number, z: number, speed: number, p6: number, vehicleModel: string | number, drivingMode: number, stopRange: number, p10: number): void;
39268
39795
 
39796
+ /**
39797
+ * You can let your character drive to the destination at the speed and driving style you set. You can use map marks to set the destination.
39798
+ * @param ped Ped id for the task.
39799
+ * @param vehicle Vehicle entity id for the task.
39800
+ * @param x Destination X coordinate.
39801
+ * @param y Destination Y coordinate.
39802
+ * @param z Destination Z coordinate.
39803
+ * @param speed Speed of driving.
39804
+ * @param driveMode More info can be found [here](https://vespura.com/fivem/drivingstyle/)
39805
+ * @param stopRange Stops in the specific range near the destination. 20.0 works fine.
39806
+ */
39269
39807
  declare function TaskVehicleDriveToCoordLongrange(ped: number, vehicle: number, x: number, y: number, z: number, speed: number, driveMode: number, stopRange: number): void;
39270
39808
 
39809
+ /**
39810
+ * Drive randomly with no destination set.
39811
+ * @param ped Ped id for the task.
39812
+ * @param vehicle Vehicle entity id for the task.
39813
+ * @param speed Speed of driving.
39814
+ * @param drivingStyle More info can be found [here](https://vespura.com/fivem/drivingstyle/)
39815
+ */
39271
39816
  declare function TaskVehicleDriveWander(ped: number, vehicle: number, speed: number, drivingStyle: number): void;
39272
39817
 
39273
39818
  /**
@@ -39407,6 +39952,18 @@ declare function TaskVehicleShootAtPed(ped: number, target: number, p2: number):
39407
39952
  */
39408
39953
  declare function TaskVehicleTempAction(driver: number, vehicle: number, action: number, time: number): void;
39409
39954
 
39955
+ /**
39956
+ * Makes a ped wander/patrol around the specified area.
39957
+ * The ped will continue to wander after getting distracted, but only if this additional task is temporary, ie. killing a target, after killing the target it will continue to wander around.
39958
+ * Use `GetIsTaskActive(ped, 222)` to check if the ped is still wandering the area.
39959
+ * @param ped The ped which will wander the area.
39960
+ * @param x The X coordinate.
39961
+ * @param y The Y coordinate
39962
+ * @param z The Z coordinate
39963
+ * @param radius The radius of the area to wander around in
39964
+ * @param minimalLength The minimal length it will wander before waiting timeBetweenWalks seconds before continuing
39965
+ * @param timeBetweenWalks The length of time the ped will stand still/rest between walks
39966
+ */
39410
39967
  declare function TaskWanderInArea(ped: number, x: number, y: number, z: number, radius: number, minimalLength: number, timeBetweenWalks: number): void;
39411
39968
 
39412
39969
  /**