@nativewrappers/fivem 0.0.65 → 0.0.73

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 (243) hide show
  1. package/Audio.d.ts +2 -2
  2. package/Blip.d.ts +2 -2
  3. package/Camera.d.ts +1 -1
  4. package/Game.d.ts +1 -1
  5. package/GameplayCamera.d.ts +1 -1
  6. package/Model.d.ts +1 -1
  7. package/ParticleEffect.d.ts +2 -2
  8. package/ParticleEffectAsset.d.ts +1 -1
  9. package/README.md +45 -0
  10. package/Raycast.d.ts +2 -2
  11. package/RelationshipGroup.d.ts +1 -1
  12. package/Tasks.d.ts +3 -3
  13. package/World.d.ts +5 -13
  14. package/cfx/StateBagChangeHandler.d.ts +1 -3
  15. package/common/Command.d.ts +30 -0
  16. package/common/Convar.d.ts +13 -0
  17. package/common/GlobalData.d.ts +8 -0
  18. package/common/Kvp.d.ts +69 -0
  19. package/common/Resource.d.ts +14 -0
  20. package/common/decors/Events.d.ts +54 -0
  21. package/common/index.d.ts +8 -0
  22. package/common/net/NetworkedMap.d.ts +28 -0
  23. package/common/types.d.ts +5 -0
  24. package/common/utils/ClassTypes.d.ts +11 -0
  25. package/common/utils/Color.d.ts +14 -0
  26. package/common/utils/Maths.d.ts +4 -0
  27. package/common/utils/PointF.d.ts +7 -0
  28. package/common/utils/Quaternion.d.ts +10 -0
  29. package/common/utils/Vector.d.ts +429 -0
  30. package/common/utils/Vector2.d.ts +1 -0
  31. package/common/utils/Vector3.d.ts +1 -0
  32. package/common/utils/Vector4.d.ts +1 -0
  33. package/common/utils/cleanPlayerName.d.ts +6 -0
  34. package/common/utils/enumValues.d.ts +12 -0
  35. package/{utils/getStringFromUInt8Array.js → common/utils/getStringFromUInt8Array.d.ts} +1 -3
  36. package/{utils/getUInt32FromUint8Array.js → common/utils/getUInt32FromUint8Array.d.ts} +1 -1
  37. package/common/utils/index.d.ts +12 -0
  38. package/index.d.ts +1 -1
  39. package/index.js +18794 -26
  40. package/interfaces/Dimensions.d.ts +1 -1
  41. package/models/BaseEntity.d.ts +3 -3
  42. package/models/Ped.d.ts +4 -15
  43. package/models/PedBone.d.ts +1 -1
  44. package/models/PedBoneCollection.d.ts +1 -1
  45. package/models/Player.d.ts +1 -1
  46. package/models/Vehicle.d.ts +2 -2
  47. package/models/VehicleDoor.d.ts +2 -2
  48. package/models/VehicleDoorCollection.d.ts +1 -1
  49. package/models/VehicleMod.d.ts +2 -2
  50. package/models/VehicleModCollection.d.ts +2 -2
  51. package/models/VehicleToggleMod.d.ts +2 -2
  52. package/models/VehicleWheel.d.ts +1 -1
  53. package/models/VehicleWheelCollection.d.ts +1 -1
  54. package/models/VehicleWindow.d.ts +2 -2
  55. package/models/VehicleWindowCollection.d.ts +1 -1
  56. package/package.json +6 -4
  57. package/ui/Container.d.ts +2 -2
  58. package/ui/Effects.d.ts +1 -1
  59. package/ui/Hud.d.ts +2 -2
  60. package/ui/InstructionalButtons.d.ts +1 -1
  61. package/ui/Rectangle.d.ts +2 -2
  62. package/ui/Scaleform.d.ts +1 -1
  63. package/ui/Screen.d.ts +1 -1
  64. package/ui/Text.d.ts +1 -1
  65. package/ui/interfaces/IButton.d.ts +1 -1
  66. package/ui/interfaces/IDrawable.d.ts +1 -1
  67. package/ui/menu/items/UIMenuItem.d.ts +1 -1
  68. package/ui/menu/items/UIMenuListItem.d.ts +1 -1
  69. package/ui/menu/items/panels/AbstractUIMenuPanel.d.ts +2 -2
  70. package/ui/menu/items/panels/UIMenuStatisticsPanel.d.ts +1 -1
  71. package/utils/LiteEvent.d.ts +2 -8
  72. package/utils/PointF.d.ts +0 -5
  73. package/utils/String.d.ts +1 -1
  74. package/utils/index.d.ts +2 -2
  75. package/weapon/DlcWeaponData.d.ts +1 -1
  76. package/weapon/Weapon.d.ts +7 -7
  77. package/weapon/WeaponAsset.d.ts +1 -1
  78. package/weapon/WeaponCollection.d.ts +2 -2
  79. package/weaponComponent/DlcWeaponComponentData.d.ts +1 -1
  80. package/weaponComponent/InvalidWeaponComponent.d.ts +1 -1
  81. package/weaponComponent/WeaponComponent.d.ts +3 -3
  82. package/weaponComponent/WeaponComponentCollection.d.ts +3 -3
  83. package/Audio.js +0 -93
  84. package/Blip.js +0 -105
  85. package/Camera.js +0 -162
  86. package/Checkpoint.js +0 -43
  87. package/Events.js +0 -74
  88. package/Game.js +0 -474
  89. package/GameplayCamera.js +0 -141
  90. package/Model.js +0 -213
  91. package/NetworkedScene.js +0 -18
  92. package/ParticleEffect.js +0 -123
  93. package/ParticleEffectAsset.js +0 -105
  94. package/Pickup.js +0 -19
  95. package/Raycast.js +0 -123
  96. package/RelationshipGroup.js +0 -67
  97. package/Rope.js +0 -129
  98. package/TaskSequence.js +0 -48
  99. package/Tasks.js +0 -241
  100. package/World.js +0 -765
  101. package/cfx/StateBagChangeHandler.js +0 -1
  102. package/cfx/index.js +0 -1
  103. package/enums/Alignment.js +0 -6
  104. package/enums/AnimationFlags.js +0 -35
  105. package/enums/AudioFlag.js +0 -38
  106. package/enums/BadgeStyle.js +0 -183
  107. package/enums/Blip.js +0 -225
  108. package/enums/Bone.js +0 -103
  109. package/enums/CameraShake.js +0 -14
  110. package/enums/CameraTypes.js +0 -8
  111. package/enums/CheckboxStyle.js +0 -5
  112. package/enums/Checkpoint.js +0 -67
  113. package/enums/CloudHat.js +0 -27
  114. package/enums/Control.js +0 -361
  115. package/enums/CursorSprite.js +0 -15
  116. package/enums/Driving.js +0 -34
  117. package/enums/ExplosionType.js +0 -45
  118. package/enums/FiringPattern.js +0 -20
  119. package/enums/Font.js +0 -8
  120. package/enums/ForceType.js +0 -9
  121. package/enums/Gender.js +0 -5
  122. package/enums/HelmetType.js +0 -6
  123. package/enums/HudColor.js +0 -184
  124. package/enums/HudComponent.js +0 -54
  125. package/enums/InputMode.js +0 -5
  126. package/enums/InvertAxis.js +0 -7
  127. package/enums/Language.js +0 -15
  128. package/enums/LeaveVehicleFlags.js +0 -11
  129. package/enums/LoadingSpinnerType.js +0 -8
  130. package/enums/MarkerType.js +0 -50
  131. package/enums/MenuAlignment.js +0 -5
  132. package/enums/NotificationType.js +0 -11
  133. package/enums/Parachute.js +0 -15
  134. package/enums/PickupType.js +0 -74
  135. package/enums/RadioStation.js +0 -25
  136. package/enums/RagdollType.js +0 -7
  137. package/enums/RaycastEnums.js +0 -32
  138. package/enums/Relationship.js +0 -10
  139. package/enums/RopeType.js +0 -6
  140. package/enums/ScreenEffect.js +0 -84
  141. package/enums/SpeechModifier.js +0 -40
  142. package/enums/Vehicle.js +0 -376
  143. package/enums/Weather.js +0 -22
  144. package/enums/ZoneID.js +0 -95
  145. package/enums/index.js +0 -42
  146. package/hashes/MaterialHash.js +0 -217
  147. package/hashes/PedHash.js +0 -725
  148. package/hashes/VehicleHash.js +0 -523
  149. package/hashes/WeaponHash.js +0 -161
  150. package/hashes/WeatherTypeHash.js +0 -22
  151. package/hashes/index.js +0 -5
  152. package/interfaces/Dimensions.js +0 -1
  153. package/models/BaseEntity.js +0 -477
  154. package/models/Entity.js +0 -25
  155. package/models/EntityBone.js +0 -26
  156. package/models/EntityBoneCollection.js +0 -18
  157. package/models/Ped.js +0 -692
  158. package/models/PedBone.js +0 -9
  159. package/models/PedBoneCollection.js +0 -21
  160. package/models/Player.js +0 -186
  161. package/models/Prop.js +0 -26
  162. package/models/Vehicle.js +0 -576
  163. package/models/VehicleDoor.js +0 -44
  164. package/models/VehicleDoorCollection.js +0 -62
  165. package/models/VehicleMod.js +0 -35
  166. package/models/VehicleModCollection.js +0 -227
  167. package/models/VehicleToggleMod.js +0 -29
  168. package/models/VehicleWheel.js +0 -23
  169. package/models/VehicleWheelCollection.js +0 -57
  170. package/models/VehicleWindow.js +0 -35
  171. package/models/VehicleWindowCollection.js +0 -57
  172. package/models/index.js +0 -19
  173. package/ui/Container.js +0 -31
  174. package/ui/Effects.js +0 -106
  175. package/ui/Fading.js +0 -69
  176. package/ui/Hud.js +0 -39
  177. package/ui/InstructionalButtons.js +0 -54
  178. package/ui/LoadingPrompt.js +0 -45
  179. package/ui/Notification.js +0 -9
  180. package/ui/Rectangle.js +0 -40
  181. package/ui/Scaleform.js +0 -236
  182. package/ui/Screen.js +0 -72
  183. package/ui/Sprite.js +0 -60
  184. package/ui/Text.js +0 -115
  185. package/ui/Timerbar.js +0 -248
  186. package/ui/index.js +0 -15
  187. package/ui/interfaces/IButton.js +0 -1
  188. package/ui/interfaces/IDrawable.js +0 -1
  189. package/ui/interfaces/index.js +0 -1
  190. package/ui/menu/Menu.js +0 -831
  191. package/ui/menu/MenuControl.js +0 -12
  192. package/ui/menu/MenuControls.js +0 -9
  193. package/ui/menu/MenuSettings.js +0 -54
  194. package/ui/menu/index.js +0 -6
  195. package/ui/menu/items/UIMenuCheckboxItem.js +0 -59
  196. package/ui/menu/items/UIMenuItem.js +0 -1111
  197. package/ui/menu/items/UIMenuListItem.js +0 -119
  198. package/ui/menu/items/UIMenuSeparatorItem.js +0 -29
  199. package/ui/menu/items/UIMenuSliderItem.js +0 -191
  200. package/ui/menu/items/index.js +0 -6
  201. package/ui/menu/items/panels/AbstractUIMenuPanel.js +0 -44
  202. package/ui/menu/items/panels/UIMenuColorPanel.js +0 -217
  203. package/ui/menu/items/panels/UIMenuGridPanel.js +0 -261
  204. package/ui/menu/items/panels/UIMenuPercentagePanel.js +0 -124
  205. package/ui/menu/items/panels/UIMenuStatisticsPanel.js +0 -79
  206. package/ui/menu/items/panels/UIMenuStatisticsPanelItem.js +0 -35
  207. package/ui/menu/items/panels/index.js +0 -6
  208. package/ui/menu/modules/ListItem.js +0 -10
  209. package/ui/menu/modules/index.js +0 -1
  210. package/utils/Animations.js +0 -55
  211. package/utils/Crypto.js +0 -25
  212. package/utils/LiteEvent.js +0 -19
  213. package/utils/Maths.js +0 -10
  214. package/utils/Point.js +0 -30
  215. package/utils/PointF.js +0 -14
  216. package/utils/Quaternion.js +0 -27
  217. package/utils/Size.js +0 -8
  218. package/utils/String.js +0 -25
  219. package/utils/enumValues.js +0 -14
  220. package/utils/index.js +0 -9
  221. package/weapon/DlcWeaponData.js +0 -44
  222. package/weapon/Mk2WeaponHash.js +0 -25
  223. package/weapon/Weapon.js +0 -270
  224. package/weapon/WeaponAsset.js +0 -84
  225. package/weapon/WeaponCollection.js +0 -187
  226. package/weapon/WeaponDisplayNameByHash.js +0 -75
  227. package/weapon/WeaponGroup.js +0 -19
  228. package/weapon/WeaponHudStats.js +0 -38
  229. package/weapon/WeaponLivery.js +0 -14
  230. package/weapon/WeaponLiveryColor.js +0 -35
  231. package/weapon/WeaponTint.js +0 -43
  232. package/weapon/index.js +0 -8
  233. package/weaponComponent/ComponentAttachmentPoint.js +0 -19
  234. package/weaponComponent/ComponentAttachmentPointByHash.js +0 -573
  235. package/weaponComponent/ComponentDisplayNameByHash.js +0 -280
  236. package/weaponComponent/DlcWeaponComponentData.js +0 -44
  237. package/weaponComponent/InvalidWeaponComponent.js +0 -28
  238. package/weaponComponent/WeaponComponent.js +0 -123
  239. package/weaponComponent/WeaponComponentCollection.js +0 -174
  240. package/weaponComponent/WeaponComponentHash.js +0 -887
  241. package/weaponComponent/WeaponComponentHashesByWeaponHash.js +0 -829
  242. package/weaponComponent/WeaponComponentHudStats.js +0 -34
  243. package/weaponComponent/index.js +0 -5
@@ -1,4 +1,4 @@
1
- import { Vector3 } from "../utils";
1
+ import type { Vector3 } from "../utils";
2
2
  export interface Dimensions {
3
3
  min: Vector3;
4
4
  max: Vector3;
@@ -1,11 +1,11 @@
1
1
  import { Blip } from "../Blip";
2
2
  import { ForceType } from "../enums";
3
- import { MaterialHash, WeaponHash } from "../hashes";
3
+ import type { MaterialHash, WeaponHash } from "../hashes";
4
4
  import { Model } from "../Model";
5
5
  import { Quaternion, Vector3 } from "../utils";
6
6
  import { EntityBoneCollection } from "./";
7
- import { EntityBone } from "./EntityBone";
8
- import { StateBagChangeHandler } from "../cfx";
7
+ import type { EntityBone } from "./EntityBone";
8
+ import { type StateBagChangeHandler } from "../cfx";
9
9
  import { ClassTypes } from "../../common/utils/ClassTypes";
10
10
  export declare class BaseEntity {
11
11
  static fromNetworkId(networkId: number): BaseEntity | null;
package/models/Ped.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { Player, Vector3 } from "../";
2
- import { DrivingStyle, FiringPattern, Gender, HelmetType, RagdollType, SpeechModifier, VehicleSeat } from "../enums";
3
- import { WeaponHash } from "../hashes";
2
+ import { type DrivingStyle, type FiringPattern, Gender, type HelmetType, RagdollType, SpeechModifier, VehicleSeat } from "../enums";
3
+ import type { WeaponHash } from "../hashes";
4
4
  import { Tasks } from "../Tasks";
5
5
  import { PedBoneCollection, Vehicle } from "./";
6
6
  import { WeaponCollection } from "../weapon/WeaponCollection";
@@ -187,24 +187,13 @@ export declare class Ped extends BaseEntity {
187
187
  getHeadOverlayNum(overlayId: number): number;
188
188
  getHeadOverlayValue(overlayId: number): number;
189
189
  setHeadOverlayValue(overlayId: number, value: number): void;
190
- getHeadOverlay(overlayId: number): [number, number, number, number, number] | void;
190
+ getHeadOverlay(overlayId: number): [number, number, number, number, number] | null;
191
191
  setHeadOverlay(overlayId: number, index: number, opacity: number): void;
192
192
  getHeadOverlayOpacity(overlayId: number): number;
193
193
  setHeadOverlayOpacity(overlayId: number, opacity: number): void;
194
194
  setHeadOverlayColor(overlayId: number, color: number): void;
195
195
  setHeadBlend(shapeFirstID: number, shapeSecondID: number, shapeThirdID: number, skinFirstID: number, skinSecondID: number, skinThirdID: number, shapeMix: number, skinMix: number, thirdMix: number, isParent?: boolean): void;
196
- getHeadBlend(): [
197
- number,
198
- number,
199
- number,
200
- number,
201
- number,
202
- number,
203
- number,
204
- number,
205
- number,
206
- boolean
207
- ] | void;
196
+ getHeadBlend(): [number, number, number, number, number, number, number, number, number, boolean] | null;
208
197
  finalizeHeadBlend(): void;
209
198
  hasHeadBlendFinished(): boolean;
210
199
  }
@@ -1,4 +1,4 @@
1
- import { Bone } from "../enums";
1
+ import type { Bone } from "../enums";
2
2
  import { EntityBone, Ped } from "./";
3
3
  export declare class PedBone extends EntityBone {
4
4
  constructor(owner: Ped, boneId: Bone);
@@ -1,4 +1,4 @@
1
- import { EntityBoneCollection, Ped, PedBone } from "./";
1
+ import { EntityBoneCollection, type Ped, PedBone } from "./";
2
2
  export declare class PedBoneCollection extends EntityBoneCollection {
3
3
  constructor(owner: Ped);
4
4
  get Core(): PedBone;
@@ -1,5 +1,5 @@
1
1
  import { Model, Color } from "..";
2
- import { StateBagChangeHandler } from "../cfx";
2
+ import { type StateBagChangeHandler } from "../cfx";
3
3
  import { BaseEntity, Ped } from "./";
4
4
  export declare class Player {
5
5
  private handle;
@@ -1,6 +1,6 @@
1
1
  import { Ped, VehicleDoorCollection, VehicleModCollection, VehicleWheelCollection, VehicleWindowCollection } from "./";
2
- import { RadioStation, VehicleClass, VehicleLandingGearState, VehicleLockStatus, VehicleRoofState, VehicleSeat } from "../enums";
3
- import { Model } from "../Model";
2
+ import { type RadioStation, type VehicleClass, type VehicleLandingGearState, type VehicleLockStatus, VehicleRoofState, VehicleSeat } from "../enums";
3
+ import type { Model } from "../Model";
4
4
  import { Vector3 } from "../utils";
5
5
  import { ClassTypes } from "../../common/utils/ClassTypes";
6
6
  import { BaseEntity } from "./BaseEntity";
@@ -1,5 +1,5 @@
1
- import { Vehicle } from "./Vehicle";
2
- import { VehicleDoorIndex } from "../enums";
1
+ import type { Vehicle } from "./Vehicle";
2
+ import type { VehicleDoorIndex } from "../enums";
3
3
  export declare class VehicleDoor {
4
4
  private _owner;
5
5
  private _index;
@@ -1,4 +1,4 @@
1
- import { Vehicle } from "./Vehicle";
1
+ import type { Vehicle } from "./Vehicle";
2
2
  import { VehicleDoorIndex } from "../enums";
3
3
  import { VehicleDoor } from "./VehicleDoor";
4
4
  export declare class VehicleDoorCollection {
@@ -1,5 +1,5 @@
1
- import { Vehicle } from "./Vehicle";
2
- import { VehicleModType } from "../enums";
1
+ import type { Vehicle } from "./Vehicle";
2
+ import type { VehicleModType } from "../enums";
3
3
  export declare class VehicleMod {
4
4
  private _owner;
5
5
  private _modType;
@@ -1,5 +1,5 @@
1
- import { Vehicle } from "./Vehicle";
2
- import { VehicleColor, VehicleModType, VehicleNeonLight, VehiclePaintType, VehicleToggleModType, VehicleWheelType, VehicleWindowTint, LicensePlateStyle, LicensePlateType } from "../enums";
1
+ import type { Vehicle } from "./Vehicle";
2
+ import { type VehicleColor, VehicleModType, VehicleNeonLight, type VehiclePaintType, type VehicleToggleModType, type VehicleWheelType, type VehicleWindowTint, type LicensePlateStyle, type LicensePlateType } from "../enums";
3
3
  import { VehicleMod } from "./VehicleMod";
4
4
  import { Color } from "../utils";
5
5
  import { VehicleToggleMod } from "./VehicleToggleMod";
@@ -1,5 +1,5 @@
1
- import { Vehicle } from "./Vehicle";
2
- import { VehicleToggleModType } from "../enums";
1
+ import type { Vehicle } from "./Vehicle";
2
+ import type { VehicleToggleModType } from "../enums";
3
3
  export declare class VehicleToggleMod {
4
4
  private _owner;
5
5
  private _modType;
@@ -1,4 +1,4 @@
1
- import { Vehicle } from "./Vehicle";
1
+ import type { Vehicle } from "./Vehicle";
2
2
  export declare class VehicleWheel {
3
3
  private _owner;
4
4
  private _index;
@@ -1,4 +1,4 @@
1
- import { Vehicle } from "./Vehicle";
1
+ import type { Vehicle } from "./Vehicle";
2
2
  import { VehicleWheel } from "./VehicleWheel";
3
3
  import { VehicleWheelIndex } from "../enums";
4
4
  export declare class VehicleWheelCollection {
@@ -1,5 +1,5 @@
1
- import { Vehicle } from "./Vehicle";
2
- import { VehicleWindowIndex } from "../enums";
1
+ import type { Vehicle } from "./Vehicle";
2
+ import type { VehicleWindowIndex } from "../enums";
3
3
  export declare class VehicleWindow {
4
4
  private _owner;
5
5
  private _index;
@@ -1,4 +1,4 @@
1
- import { Vehicle } from "./Vehicle";
1
+ import type { Vehicle } from "./Vehicle";
2
2
  import { VehicleWindowIndex } from "../enums";
3
3
  import { VehicleWindow } from "./VehicleWindow";
4
4
  export declare class VehicleWindowCollection {
package/package.json CHANGED
@@ -1,9 +1,14 @@
1
1
  {
2
2
  "name": "@nativewrappers/fivem",
3
3
  "description": "Native wrappers and utilities for use with FiveM.",
4
+ "contributors": [
5
+ "Remco Troost <d0p3t>",
6
+ "Dillon Skaggs <AvarianKnight>",
7
+ "Linden <thelindat>"
8
+ ],
4
9
  "license": "MIT",
5
10
  "type": "module",
6
- "version": "0.0.65",
11
+ "version": "0.0.73",
7
12
  "repository": {
8
13
  "type": "git",
9
14
  "url": "https://github.com/nativewrappers/nativewrappers.git"
@@ -25,8 +30,5 @@
25
30
  ],
26
31
  "exports": {
27
32
  ".": "./index.js"
28
- },
29
- "dependencies": {
30
- "@nativewrappers/common": "0.0.65"
31
33
  }
32
34
  }
package/ui/Container.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { Color, Point, Size } from "../utils";
2
- import { IDrawable } from "./";
1
+ import { type Color, type Point, Size } from "../utils";
2
+ import { type IDrawable } from "./";
3
3
  export declare class Container implements IDrawable {
4
4
  pos: Point;
5
5
  size: Size;
package/ui/Effects.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ScreenEffect } from "../enums";
1
+ import type { ScreenEffect } from "../enums";
2
2
  export declare abstract class Effects {
3
3
  static start(effectName: ScreenEffect, duration?: number, looped?: boolean): void;
4
4
  static stop(screenEffect?: ScreenEffect): void;
package/ui/Hud.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { CursorSprite, HudComponent } from "../enums";
2
- import { Point } from "../utils";
1
+ import { CursorSprite, type HudComponent } from "../enums";
2
+ import type { Point } from "../utils";
3
3
  export declare abstract class Hud {
4
4
  static isComponentActive(component: HudComponent): boolean;
5
5
  static showComponentThisFrame(component: HudComponent): void;
@@ -1,4 +1,4 @@
1
- import { IButton } from "./interfaces/IButton";
1
+ import type { IButton } from "./interfaces/IButton";
2
2
  /**
3
3
  * Draw native instructional buttons in the bottom left of the screen using scaleform
4
4
  *
package/ui/Rectangle.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { Color, Point, Size } from "../utils";
2
- import { IDrawable } from "./";
1
+ import { type Color, Point, Size } from "../utils";
2
+ import { type IDrawable } from "./";
3
3
  export declare class Rectangle implements IDrawable {
4
4
  pos: Point;
5
5
  size: Size;
package/ui/Scaleform.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { PointF, Vector3 } from "../utils";
1
+ import type { PointF, Vector3 } from "../utils";
2
2
  /**
3
3
  * Scaleforms will automatically load when calling any of the render functions.
4
4
  *
package/ui/Screen.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { HudColor, NotificationType } from "../enums";
2
- import { Color, Size, Vector3 } from "../utils";
2
+ import { Color, Size, type Vector3 } from "../utils";
3
3
  import { Notification } from "./";
4
4
  export declare abstract class Screen {
5
5
  static get Resolution(): Size;
package/ui/Text.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { Alignment, Font } from "../enums";
2
2
  import { Color, Point, Size } from "../utils";
3
- import { IDrawable } from "./";
3
+ import { type IDrawable } from "./";
4
4
  export declare class Text implements IDrawable {
5
5
  static draw(caption: string, pos: Point, scale?: number, color?: Color, font?: Font, alignment?: Alignment, dropShadow?: boolean, outline?: boolean, wordWrap?: Size, resolution?: Size): void;
6
6
  static addLongString(str: string): void;
@@ -1,4 +1,4 @@
1
- import { Control } from "../../enums";
1
+ import type { Control } from "../../enums";
2
2
  export interface IButton {
3
3
  controls: Control[];
4
4
  label: string;
@@ -1,4 +1,4 @@
1
- import { Color, Point, Size } from "../../utils/";
1
+ import type { Color, Point, Size } from "../../utils/";
2
2
  export interface IDrawable {
3
3
  pos: Point;
4
4
  size?: Size;
@@ -1,4 +1,4 @@
1
- import { AbstractUIMenuPanel, Menu } from "../";
1
+ import { type AbstractUIMenuPanel, Menu } from "../";
2
2
  import { Rectangle, Sprite, Text } from "../../";
3
3
  import { BadgeStyle } from "../../../enums";
4
4
  import { Color, LiteEvent, Point, Size } from "../../../utils";
@@ -1,5 +1,5 @@
1
1
  import { LiteEvent } from "../../../utils";
2
- import { ListItem } from "../modules/";
2
+ import type { ListItem } from "../modules/";
3
3
  import { UIMenuItem } from "./";
4
4
  export declare class UIMenuListItem extends UIMenuItem {
5
5
  readonly listChanged: LiteEvent;
@@ -1,5 +1,5 @@
1
- import { UIMenuItem } from "../";
2
- import { Rectangle, Sprite } from "../../../";
1
+ import type { UIMenuItem } from "../";
2
+ import { type Rectangle, Sprite } from "../../../";
3
3
  import { Menu } from "../../";
4
4
  export declare abstract class AbstractUIMenuPanel {
5
5
  readonly id: string;
@@ -1,4 +1,4 @@
1
- import { AbstractUIMenuPanel, UIMenuStatisticsPanelItem } from "./";
1
+ import { AbstractUIMenuPanel, type UIMenuStatisticsPanelItem } from "./";
2
2
  import { Rectangle } from "../../../";
3
3
  export declare class UIMenuStatisticsPanel extends AbstractUIMenuPanel {
4
4
  protected readonly background: Rectangle;
@@ -1,13 +1,7 @@
1
- export interface LiteEvent {
2
- on(handler: {
3
- (...args: unknown[]): any;
4
- }): void;
5
- off(handler: {
6
- (...args: unknown[]): any;
7
- }): void;
8
- }
9
1
  export declare class LiteEvent implements LiteEvent {
10
2
  private handlers;
3
+ on(handler: (...args: unknown[]) => any): void;
4
+ off(handler: (...args: unknown[]) => any): void;
11
5
  emit(...args: unknown[]): void;
12
6
  expose(): LiteEvent;
13
7
  }
package/utils/PointF.d.ts CHANGED
@@ -1,8 +1,3 @@
1
- export interface PointF {
2
- x: number;
3
- y: number;
4
- z: number;
5
- }
6
1
  export declare class PointF implements PointF {
7
2
  x: number;
8
3
  y: number;
package/utils/String.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { Font } from "..";
2
- export declare abstract class String {
2
+ export declare abstract class _String {
3
3
  static stringToArray(input: string): string[];
4
4
  static measureStringWidthNoConvert(input: string, font?: Font, scale?: number): number;
5
5
  static measureString(str: string, font?: Font, scale?: number, screenWidth?: number): number;
package/utils/index.d.ts CHANGED
@@ -1,9 +1,9 @@
1
- export { String } from "./String";
1
+ export { _String } from "./String";
2
2
  export { LiteEvent } from "./LiteEvent";
3
3
  export { PointF } from "./PointF";
4
4
  export { Crypto } from "./Crypto";
5
5
  export { Point } from "./Point";
6
6
  export { Size } from "./Size";
7
- export { Vector2, Vector3, Vector4, Maths, Color, Quaternion, Delay, enumValues, getStringFromUInt8Array, getUInt32FromUint8Array, } from "../../common/utils/index";
7
+ export { Vector2, Vector3, Vector4, Maths, Color, Quaternion, Delay, enumValues, getStringFromUInt8Array, getUInt32FromUint8Array, } from "../common/utils/index";
8
8
  export declare const Wait: (milliseconds: number) => Promise<void>;
9
9
  export * from "./Animations";
@@ -1,4 +1,4 @@
1
- import { WeaponHash } from "../hashes";
1
+ import type { WeaponHash } from "../hashes";
2
2
  /**
3
3
  * DlcWeaponData
4
4
  * refer1: https://github.com/citizenfx/fivem/blob/master/code/client/clrcore/External/DlcWeaponStructs.cs#L10
@@ -1,13 +1,13 @@
1
1
  import { WeaponComponentCollection } from "../weaponComponent/WeaponComponentCollection";
2
- import { Ped } from "../models";
3
- import { AmmoType, WeaponHash } from "../hashes";
2
+ import type { Ped } from "../models";
3
+ import { type AmmoType, WeaponHash } from "../hashes";
4
4
  import { Model } from "../Model";
5
- import { WeaponTint } from "./WeaponTint";
6
- import { WeaponGroup } from "./WeaponGroup";
7
- import { WeaponLivery } from "./WeaponLivery";
8
- import { WeaponLiveryColor } from "./WeaponLiveryColor";
5
+ import type { WeaponTint } from "./WeaponTint";
6
+ import type { WeaponGroup } from "./WeaponGroup";
7
+ import type { WeaponLivery } from "./WeaponLivery";
8
+ import type { WeaponLiveryColor } from "./WeaponLiveryColor";
9
9
  import { WeaponHudStats } from "./WeaponHudStats";
10
- import { WeaponComponentHash } from "../weaponComponent";
10
+ import type { WeaponComponentHash } from "../weaponComponent";
11
11
  /**
12
12
  * ped weapon
13
13
  *
@@ -1,4 +1,4 @@
1
- import { WeaponHash } from "../hashes";
1
+ import type { WeaponHash } from "../hashes";
2
2
  /**
3
3
  * weapon asset
4
4
  *
@@ -1,6 +1,6 @@
1
1
  import { Weapon } from "./Weapon";
2
- import { Ped, Prop } from "../models";
3
- import { WeaponHash } from "../hashes";
2
+ import { type Ped, Prop } from "../models";
3
+ import type { WeaponHash } from "../hashes";
4
4
  /**
5
5
  * ped weapons
6
6
  *
@@ -1,4 +1,4 @@
1
- import { WeaponComponentHash } from "./WeaponComponentHash";
1
+ import type { WeaponComponentHash } from "./WeaponComponentHash";
2
2
  /**
3
3
  * DlcWeaponComponentData
4
4
  * refer1: https://github.com/citizenfx/fivem/blob/master/code/client/clrcore/External/DlcWeaponStructs.cs#L130
@@ -1,6 +1,6 @@
1
1
  import { WeaponComponent } from "./WeaponComponent";
2
2
  import { WeaponComponentHash } from "./WeaponComponentHash";
3
- import { WeaponHash } from "../hashes";
3
+ import type { WeaponHash } from "../hashes";
4
4
  import { ComponentAttachmentPoint } from "./ComponentAttachmentPoint";
5
5
  export declare class InvalidWeaponComponent extends WeaponComponent {
6
6
  constructor();
@@ -1,7 +1,7 @@
1
- import { Ped } from "../models";
2
- import { Weapon } from "../weapon";
1
+ import type { Ped } from "../models";
2
+ import type { Weapon } from "../weapon";
3
3
  import { WeaponComponentHash } from "./WeaponComponentHash";
4
- import { WeaponHash } from "../hashes";
4
+ import type { WeaponHash } from "../hashes";
5
5
  import { ComponentAttachmentPoint } from "./ComponentAttachmentPoint";
6
6
  import { WeaponComponentHudStats } from "./WeaponComponentHudStats";
7
7
  /**
@@ -1,6 +1,6 @@
1
- import { Ped } from "../models";
2
- import { Weapon } from "../weapon";
3
- import { WeaponComponentHash } from "./WeaponComponentHash";
1
+ import type { Ped } from "../models";
2
+ import type { Weapon } from "../weapon";
3
+ import type { WeaponComponentHash } from "./WeaponComponentHash";
4
4
  import { WeaponComponent } from "./WeaponComponent";
5
5
  /**
6
6
  * ped weapon components on weapon
package/Audio.js DELETED
@@ -1,93 +0,0 @@
1
- export class Audio {
2
- static playSoundAt(position, sound, set, generateSoundId = true) {
3
- const SOUND_ID = generateSoundId ? GetSoundId() : -1;
4
- PlaySoundFromCoord(SOUND_ID, sound, position.x, position.y, position.z, set ?? "", false, 0, false);
5
- return SOUND_ID;
6
- }
7
- static playSoundFromEntity(entity, sound, set, generateSoundId = true) {
8
- const SOUND_ID = generateSoundId ? GetSoundId() : -1;
9
- PlaySoundFromEntity(SOUND_ID, sound, entity.Handle, set ?? "", false, 0);
10
- return SOUND_ID;
11
- }
12
- static playSoundFrontEnd(sound, set, generateSoundId = true) {
13
- const SOUND_ID = generateSoundId ? GetSoundId() : -1;
14
- PlaySoundFrontend(SOUND_ID, sound, set ?? "", false);
15
- return SOUND_ID;
16
- }
17
- static stopSound(soundId) {
18
- StopSound(soundId);
19
- }
20
- static releaseSound(soundId) {
21
- ReleaseSoundId(soundId);
22
- }
23
- static hasSoundFinished(soundId) {
24
- return HasSoundFinished(soundId);
25
- }
26
- static setAudioFlag(flag, toggle) {
27
- if (typeof flag === "string") {
28
- SetAudioFlag(flag, toggle);
29
- }
30
- else {
31
- SetAudioFlag(this.audioFlags[Number(flag)], toggle);
32
- }
33
- }
34
- static playSound(soundFile, soundSet) {
35
- this.releaseSound(this.playSoundFrontEnd(soundFile, soundSet));
36
- }
37
- static playMusic(musicFile) {
38
- if (!this.cachedMusicFile) {
39
- CancelMusicEvent(musicFile);
40
- }
41
- this.cachedMusicFile = musicFile;
42
- TriggerMusicEvent(musicFile);
43
- }
44
- static stopMusic(musicFile) {
45
- if (!musicFile) {
46
- if (!this.cachedMusicFile) {
47
- CancelMusicEvent(this.cachedMusicFile);
48
- this.cachedMusicFile = "";
49
- }
50
- }
51
- else {
52
- CancelMusicEvent(musicFile ?? "");
53
- }
54
- }
55
- static cachedMusicFile;
56
- static audioFlags = [
57
- "ActivateSwitchWheelAudio",
58
- "AllowCutsceneOverScreenFade",
59
- "AllowForceRadioAfterRetune",
60
- "AllowPainAndAmbientSpeechToPlayDuringCutscene",
61
- "AllowPlayerAIOnMission",
62
- "AllowPoliceScannerWhenPlayerHasNoControl",
63
- "AllowRadioDuringSwitch",
64
- "AllowRadioOverScreenFade",
65
- "AllowScoreAndRadio",
66
- "AllowScriptedSpeechInSlowMo",
67
- "AvoidMissionCompleteDelay",
68
- "DisableAbortConversationForDeathAndInjury",
69
- "DisableAbortConversationForRagdoll",
70
- "DisableBarks",
71
- "DisableFlightMusic",
72
- "DisableReplayScriptStreamRecording",
73
- "EnableHeadsetBeep",
74
- "ForceConversationInterrupt",
75
- "ForceSeamlessRadioSwitch",
76
- "ForceSniperAudio",
77
- "FrontendRadioDisabled",
78
- "HoldMissionCompleteWhenPrepared",
79
- "IsDirectorModeActive",
80
- "IsPlayerOnMissionForSpeech",
81
- "ListenerReverbDisabled",
82
- "LoadMPData",
83
- "MobileRadioInGame",
84
- "OnlyAllowScriptTriggerPoliceScanner",
85
- "PlayMenuMusic",
86
- "PoliceScannerDisabled",
87
- "ScriptedConvListenerMaySpeak",
88
- "SpeechDucksScore",
89
- "SuppressPlayerScubaBreathing",
90
- "WantedMusicDisabled",
91
- "WantedMusicOnMission",
92
- ];
93
- }
package/Blip.js DELETED
@@ -1,105 +0,0 @@
1
- import { Vector3 } from "./utils";
2
- import { BaseEntity } from "./models";
3
- export class Blip {
4
- handle;
5
- constructor(handle) {
6
- this.handle = handle;
7
- }
8
- get Handle() {
9
- return this.handle;
10
- }
11
- get Position() {
12
- return Vector3.fromArray(GetBlipInfoIdCoord(this.handle));
13
- }
14
- set Position(location) {
15
- SetBlipCoords(this.handle, location.x, location.y, location.z);
16
- }
17
- set Rotation(rotation) {
18
- SetBlipRotation(this.handle, rotation);
19
- }
20
- set Scale(scale) {
21
- SetBlipScale(this.handle, scale);
22
- }
23
- get Type() {
24
- return GetBlipInfoIdType(this.handle);
25
- }
26
- get Alpha() {
27
- return GetBlipAlpha(this.handle);
28
- }
29
- set Alpha(alpha) {
30
- SetBlipAlpha(this.handle, alpha);
31
- }
32
- set Priority(priority) {
33
- SetBlipPriority(this.handle, priority);
34
- }
35
- set NumberLabel(number) {
36
- ShowNumberOnBlip(this.handle, number);
37
- }
38
- get Color() {
39
- return GetBlipColour(this.handle);
40
- }
41
- set Color(color) {
42
- SetBlipColour(this.handle, color);
43
- }
44
- get Sprite() {
45
- return GetBlipSprite(this.handle);
46
- }
47
- set Sprite(sprite) {
48
- SetBlipSprite(this.handle, sprite);
49
- }
50
- set Display(display) {
51
- SetBlipDisplay(this.handle, display);
52
- }
53
- set Name(name) {
54
- BeginTextCommandSetBlipName("STRING");
55
- AddTextComponentSubstringPlayerName(name);
56
- EndTextCommandSetBlipName(this.handle);
57
- }
58
- setNameToPlayerName(player) {
59
- SetBlipNameToPlayerName(this.handle, player.Handle);
60
- }
61
- get Entity() {
62
- return new BaseEntity(GetBlipInfoIdEntityIndex(this.handle));
63
- }
64
- set ShowHeadingIndicator(show) {
65
- ShowHeadingIndicatorOnBlip(this.handle, show);
66
- }
67
- set ShowRoute(show) {
68
- SetBlipRoute(this.handle, show);
69
- }
70
- set IsFriendly(friendly) {
71
- SetBlipAsFriendly(this.handle, friendly);
72
- }
73
- set IsFriend(friend) {
74
- SetBlipFriend(this.handle, friend);
75
- }
76
- set IsCrew(crew) {
77
- SetBlipCrew(this.handle, crew);
78
- }
79
- get IsFlashing() {
80
- return IsBlipFlashing(this.handle);
81
- }
82
- set IsFlashing(flashing) {
83
- SetBlipFlashes(this.handle, flashing);
84
- }
85
- get IsOnMinimap() {
86
- return IsBlipOnMinimap(this.handle);
87
- }
88
- get IsShortRange() {
89
- return IsBlipShortRange(this.handle);
90
- }
91
- set IsShortRange(shortRange) {
92
- SetBlipAsShortRange(this.handle, shortRange);
93
- }
94
- removeNumberLabel() {
95
- HideNumberOnBlip(this.handle);
96
- }
97
- delete() {
98
- if (this.exists()) {
99
- RemoveBlip(this.handle);
100
- }
101
- }
102
- exists() {
103
- return DoesBlipExist(this.handle);
104
- }
105
- }