@nativewrappers/fivem 0.0.1

package/lib/server/index.d.ts

@@ -0,0 +1,7 @@
+export * from './utils';
+export * from './Events';
+export * from './Game';
+export { Convar, Kvp, Resource } from '../../common/index';
+export * from './utils/index';
+export * from './entities/index';
+export * from './cfx/index';

package/lib/server/index.js

@@ -0,0 +1,7 @@
+export * from './utils';
+export * from './Events';
+export * from './Game';
+export { Convar, Kvp, Resource } from '../../common/index';
+export * from './utils/index';
+export * from './entities/index';
+export * from './cfx/index';

package/lib/server/type/Anticheat.d.ts

@@ -0,0 +1,471 @@
+import { Hash } from './Hash';
+/**
+ * @typedef {Object} AnticheatWeaponDamageEvent
+ * @property {number} actionResultId
+ * @property {number} actionResultName
+ * @property {number} damageFlags
+ * @property {number} damageTime
+ * @property {number} damageType
+ * @property {number} f104
+ * @property {boolean} f112
+ * @property {number} f112_1
+ * @property {number} f120
+ * @property {boolean} f133
+ * @property {boolean} hasActionResult
+ * @property {boolean} hasImpactDir
+ * @property {boolean} hasVehicleData
+ * @property {number} hitComponent
+ * @property {boolean} hitEntityWeapon
+ * @property {number} hitGlobalId
+ * @property {number[]} hitGlobalIds
+ * @property {boolean} hitWeaponAmmoAttachment
+ * @property {number} impactDirX
+ * @property {number} impactDirY
+ * @property {number} impactDirZ
+ * @property {boolean} isNetTargetPos
+ * @property {number} localPosX
+ * @property {number} localPosY
+ * @property {number} localPosZ
+ * @property {boolean} overrideDefaultDamage
+ * @property {number} parentGlobalId
+ * @property {boolean} silenced
+ * @property {number} suspensionIndex
+ * @property {number} tyreIndex
+ * @property {number} weaponDamage
+ * @property {number} weaponType
+ * @property {boolean} willKill
+ */
+export type AnticheatWeaponDamageEvent = {
+    actionResultId: number;
+    actionResultName: number;
+    damageFlags: number;
+    damageTime: number;
+    damageType: number;
+    f104: number;
+    f112: boolean;
+    f112_1: number;
+    f120: number;
+    f133: boolean;
+    hasActionResult: boolean;
+    hasImpactDir: boolean;
+    hasVehicleData: boolean;
+    hitComponent: number;
+    hitEntityWeapon: boolean;
+    hitGlobalId: number;
+    hitGlobalIds: number[];
+    hitWeaponAmmoAttachment: boolean;
+    impactDirX: number;
+    impactDirY: number;
+    impactDirZ: number;
+    isNetTargetPos: boolean;
+    localPosX: number;
+    localPosY: number;
+    localPosZ: number;
+    overrideDefaultDamage: boolean;
+    parentGlobalId: number;
+    silenced: boolean;
+    suspensionIndex: number;
+    tyreIndex: number;
+    weaponDamage: number;
+    weaponType: number;
+    willKill: boolean;
+};
+/**
+ * @typedef {Object} AnticheatExplosionEvent
+ * @property {number} f186
+ * @property {number} f208
+ * @property {number} ownerNetId
+ * @property {number} f214
+ * @property {number} explosionType
+ * @property {number} damageScale
+ * @property {number} posX
+ * @property {number} posY
+ * @property {number} posZ
+ * @property {number} f242
+ * @property {number} f104
+ * @property {number} cameraShake
+ * @property {boolean} isAudible
+ * @property {number} f189
+ * @property {boolean} isInvisible
+ * @property {number} f126
+ * @property {number} f241
+ * @property {number} f243
+ * @property {number} f210
+ * @property {number} unkX
+ * @property {number} unkY
+ * @property {number} unkZ
+ * @property {number} f190
+ * @property {number} f191
+ * @property {number} f164
+ * @property {number} posX224
+ * @property {number} posY224
+ * @property {number} posZ224
+ * @property {number} [f168]
+ * @property {number} f240
+ * @property {number} f218
+ * @property {number} f216
+ */
+export type AnticheatExplosionEvent = {
+    f186: number;
+    f208: number;
+    ownerNetId: number;
+    f214: number;
+    explosionType: number;
+    damageScale: number;
+    posX: number;
+    posY: number;
+    posZ: number;
+    f242: number;
+    f104: number;
+    cameraShake: number;
+    isAudible: boolean;
+    f189: number;
+    isInvisible: boolean;
+    f126: number;
+    f241: number;
+    f243: number;
+    f210: number;
+    unkX: number;
+    unkY: number;
+    unkZ: number;
+    f190: number;
+    f191: number;
+    f164: number;
+    posX224: number;
+    posY224: number;
+    posZ224: number;
+    f168?: number;
+    f240: number;
+    f218: number;
+    f216: number;
+};
+/**
+ * @typedef {Object} AnticheatFireEvent
+ * @property {boolean} isEntity
+ * @property {number} entityGlobalId
+ * @property {number} v5X
+ * @property {number} v5Y
+ * @property {number} v5Z
+ * @property {number} posX
+ * @property {number} posY
+ * @property {number} posZ
+ * @property {number} v7
+ * @property {number} v8
+ * @property {number} maxChildren
+ * @property {number} v10
+ * @property {number} v11
+ * @property {number} weaponHash
+ * @property {number} fireId
+ */
+export type AnticheatFireEvent = {
+    isEntity: boolean;
+    entityGlobalId: number;
+    v5X: number;
+    v5Y: number;
+    v5Z: number;
+    posX: number;
+    posY: number;
+    posZ: number;
+    v7: number;
+    v8: number;
+    maxChildren: number;
+    v10: number;
+    v11: number;
+    weaponHash: number;
+    fireId: number;
+};
+/**
+ * @typedef {Object} AnticheatGiveWeaponEvent
+ * @property {number} pedId
+ * @property {Hash} weaponType
+ * @property {number} ammo
+ * @property {boolean} unk1
+ * @property {boolean} givenAsPickup
+ */
+export type AnticheatGiveWeaponEvent = {
+    pedId: number;
+    weaponType: Hash;
+    ammo: number;
+    unk1: boolean;
+    givenAsPickup: boolean;
+};
+/**
+ * @typedef {Object} AnticheatRemoveAllWeaponsEvent
+ * @property {number} pedId
+ */
+export type AnticheatRemoveAllWeaponsEvent = {
+    pedId: number;
+};
+/**
+ * @typedef {Object} AnticheatStartProjectileEvent
+ * @property {boolean} commandFireSingleBullet
+ * @property {number} effectGroup
+ * @property {number} firePositionX
+ * @property {number} firePositionY
+ * @property {number} firePositionZ
+ * @property {number} initialPositionX
+ * @property {number} initialPositionY
+ * @property {number} initialPositionZ
+ * @property {number} ownerId
+ * @property {number} projectileHash
+ * @property {number} targetEntity
+ * @property {number} throwTaskSequence
+ * @property {number} unk10
+ * @property {number} unk11
+ * @property {number} unk12
+ * @property {number} unk13
+ * @property {number} unk14
+ * @property {number} unk15
+ * @property {number} unk16
+ * @property {number} unk3
+ * @property {number} unk4
+ * @property {number} unk5
+ * @property {number} unk6
+ * @property {number} unk7
+ * @property {number} unk9
+ * @property {number} unkX8
+ * @property {number} unkY8
+ * @property {number} unkZ8
+ * @property {number} weaponHash
+ */
+export type AnticheatStartProjectileEvent = {
+    commandFireSingleBullet: boolean;
+    effectGroup: number;
+    firePositionX: number;
+    firePositionY: number;
+    firePositionZ: number;
+    initialPositionX: number;
+    initialPositionY: number;
+    initialPositionZ: number;
+    ownerId: number;
+    projectileHash: number;
+    targetEntity: number;
+    throwTaskSequence: number;
+    unk10: number;
+    unk11: number;
+    unk12: number;
+    unk13: number;
+    unk14: number;
+    unk15: number;
+    unk16: number;
+    unk3: number;
+    unk4: number;
+    unk5: number;
+    unk6: number;
+    unk7: number;
+    unk9: number;
+    unkX8: number;
+    unkY8: number;
+    unkZ8: number;
+    weaponHash: number;
+};
+/**
+ * @typedef {Object} AnticheatPtFxEvent
+ * @property {Hash} assetHash
+ * @property {number} axisBitset
+ * @property {number} effectHash
+ * @property {number} entityNetId
+ * @property {number} f100
+ * @property {number} f105
+ * @property {number} f106
+ * @property {number} f107
+ * @property {boolean} f109
+ * @property {boolean} f110
+ * @property {boolean} f111
+ * @property {number} f92
+ * @property {boolean} isOnEntity
+ * @property {number} offsetX
+ * @property {number} offsetY
+ * @property {number} offsetZ
+ * @property {number} posX
+ * @property {number} posY
+ * @property {number} posZ
+ * @property {number} rotX
+ * @property {number} rotY
+ * @property {number} rotZ
+ * @property {number} scale
+ */
+export type AnticheatPtFxEvent = {
+    assetHash: Hash;
+    axisBitset: number;
+    effectHash: number;
+    entityNetId: number;
+    f100: number;
+    f105: number;
+    f106: number;
+    f107: number;
+    f109: boolean;
+    f110: boolean;
+    f111: boolean;
+    f92: number;
+    isOnEntity: boolean;
+    offsetX: number;
+    offsetY: number;
+    offsetZ: number;
+    posX: number;
+    posY: number;
+    posZ: number;
+    rotX: number;
+    rotY: number;
+    rotZ: number;
+    scale: number;
+};
+/**
+ * @typedef {Object} AnticheatWeaponDamageEvent
+ * @property {number} actionResultId
+ * @property {number} actionResultName
+ * @property {number} damageFlags
+ * @property {number} damageTime
+ * @property {number} damageType
+ * @property {number} f104
+ * @property {boolean} f112
+ * @property {number} f112_1
+ * @property {number} f120
+ * @property {boolean} f133
+ * @property {boolean} hasActionResult
+ * @property {boolean} hasImpactDir
+ * @property {boolean} hasVehicleData
+ * @property {number} hitComponent
+ * @property {boolean} hitEntityWeapon
+ * @property {number} hitGlobalId
+ * @property {number[]} hitGlobalIds
+ * @property {boolean} hitWeaponAmmoAttachment
+ * @property {number} impactDirX
+ * @property {number} impactDirY
+ * @property {number} impactDirZ
+ * @property {boolean} isNetTargetPos
+ * @property {number} localPosX
+ * @property {number} localPosY
+ * @property {number} localPosZ
+ * @property {boolean} overrideDefaultDamage
+ * @property {number} parentGlobalId
+ * @property {boolean} silenced
+ * @property {number} suspensionIndex
+ * @property {number} tyreIndex
+ * @property {number} weaponDamage
+ * @property {number} weaponType
+ * @property {boolean} willKill
+ */
+/**
+ * @typedef {Object} AnticheatExplosionEvent
+ * @property {number} f186
+ * @property {number} f208
+ * @property {number} ownerNetId
+ * @property {number} f214
+ * @property {number} explosionType
+ * @property {number} damageScale
+ * @property {number} posX
+ * @property {number} posY
+ * @property {number} posZ
+ * @property {number} f242
+ * @property {number} f104
+ * @property {number} cameraShake
+ * @property {boolean} isAudible
+ * @property {number} f189
+ * @property {boolean} isInvisible
+ * @property {number} f126
+ * @property {number} f241
+ * @property {number} f243
+ * @property {number} f210
+ * @property {number} unkX
+ * @property {number} unkY
+ * @property {number} unkZ
+ * @property {number} f190
+ * @property {number} f191
+ * @property {number} f164
+ * @property {number} posX224
+ * @property {number} posY224
+ * @property {number} posZ224
+ * @property {number} [f168]
+ * @property {number} f240
+ * @property {number} f218
+ * @property {number} f216
+ */
+/**
+ * @typedef {Object} AnticheatFireEvent
+ * @property {boolean} isEntity
+ * @property {number} entityGlobalId
+ * @property {number} v5X
+ * @property {number} v5Y
+ * @property {number} v5Z
+ * @property {number} posX
+ * @property {number} posY
+ * @property {number} posZ
+ * @property {number} v7
+ * @property {number} v8
+ * @property {number} maxChildren
+ * @property {number} v10
+ * @property {number} v11
+ * @property {number} weaponHash
+ * @property {number} fireId
+ */
+/**
+ * @typedef {Object} AnticheatGiveWeaponEvent
+ * @property {number} pedId
+ * @property {Hash} weaponType
+ * @property {number} ammo
+ * @property {boolean} unk1
+ * @property {boolean} givenAsPickup
+ */
+/**
+ * @typedef {Object} AnticheatRemoveAllWeaponsEvent
+ * @property {number} pedId
+ */
+/**
+ * @typedef {Object} AnticheatStartProjectileEvent
+ * @property {boolean} commandFireSingleBullet
+ * @property {number} effectGroup
+ * @property {number} firePositionX
+ * @property {number} firePositionY
+ * @property {number} firePositionZ
+ * @property {number} initialPositionX
+ * @property {number} initialPositionY
+ * @property {number} initialPositionZ
+ * @property {number} ownerId
+ * @property {number} projectileHash
+ * @property {number} targetEntity
+ * @property {number} throwTaskSequence
+ * @property {number} unk10
+ * @property {number} unk11
+ * @property {number} unk12
+ * @property {number} unk13
+ * @property {number} unk14
+ * @property {number} unk15
+ * @property {number} unk16
+ * @property {number} unk3
+ * @property {number} unk4
+ * @property {number} unk5
+ * @property {number} unk6
+ * @property {number} unk7
+ * @property {number} unk9
+ * @property {number} unkX8
+ * @property {number} unkY8
+ * @property {number} unkZ8
+ * @property {number} weaponHash
+ */
+/**
+ * @typedef {Object} AnticheatPtFxEvent
+ * @property {Hash} assetHash
+ * @property {number} axisBitset
+ * @property {number} effectHash
+ * @property {number} entityNetId
+ * @property {number} f100
+ * @property {number} f105
+ * @property {number} f106
+ * @property {number} f107
+ * @property {boolean} f109
+ * @property {boolean} f110
+ * @property {boolean} f111
+ * @property {number} f92
+ * @property {boolean} isOnEntity
+ * @property {number} offsetX
+ * @property {number} offsetY
+ * @property {number} offsetZ
+ * @property {number} posX
+ * @property {number} posY
+ * @property {number} posZ
+ * @property {number} rotX
+ * @property {number} rotY
+ * @property {number} rotZ
+ * @property {number} scale
+ */

package/lib/server/type/Anticheat.js

@@ -0,0 +1,160 @@
+export {};
+/**
+ * @typedef {Object} AnticheatWeaponDamageEvent
+ * @property {number} actionResultId
+ * @property {number} actionResultName
+ * @property {number} damageFlags
+ * @property {number} damageTime
+ * @property {number} damageType
+ * @property {number} f104
+ * @property {boolean} f112
+ * @property {number} f112_1
+ * @property {number} f120
+ * @property {boolean} f133
+ * @property {boolean} hasActionResult
+ * @property {boolean} hasImpactDir
+ * @property {boolean} hasVehicleData
+ * @property {number} hitComponent
+ * @property {boolean} hitEntityWeapon
+ * @property {number} hitGlobalId
+ * @property {number[]} hitGlobalIds
+ * @property {boolean} hitWeaponAmmoAttachment
+ * @property {number} impactDirX
+ * @property {number} impactDirY
+ * @property {number} impactDirZ
+ * @property {boolean} isNetTargetPos
+ * @property {number} localPosX
+ * @property {number} localPosY
+ * @property {number} localPosZ
+ * @property {boolean} overrideDefaultDamage
+ * @property {number} parentGlobalId
+ * @property {boolean} silenced
+ * @property {number} suspensionIndex
+ * @property {number} tyreIndex
+ * @property {number} weaponDamage
+ * @property {number} weaponType
+ * @property {boolean} willKill
+ */
+/**
+ * @typedef {Object} AnticheatExplosionEvent
+ * @property {number} f186
+ * @property {number} f208
+ * @property {number} ownerNetId
+ * @property {number} f214
+ * @property {number} explosionType
+ * @property {number} damageScale
+ * @property {number} posX
+ * @property {number} posY
+ * @property {number} posZ
+ * @property {number} f242
+ * @property {number} f104
+ * @property {number} cameraShake
+ * @property {boolean} isAudible
+ * @property {number} f189
+ * @property {boolean} isInvisible
+ * @property {number} f126
+ * @property {number} f241
+ * @property {number} f243
+ * @property {number} f210
+ * @property {number} unkX
+ * @property {number} unkY
+ * @property {number} unkZ
+ * @property {number} f190
+ * @property {number} f191
+ * @property {number} f164
+ * @property {number} posX224
+ * @property {number} posY224
+ * @property {number} posZ224
+ * @property {number} [f168]
+ * @property {number} f240
+ * @property {number} f218
+ * @property {number} f216
+ */
+/**
+ * @typedef {Object} AnticheatFireEvent
+ * @property {boolean} isEntity
+ * @property {number} entityGlobalId
+ * @property {number} v5X
+ * @property {number} v5Y
+ * @property {number} v5Z
+ * @property {number} posX
+ * @property {number} posY
+ * @property {number} posZ
+ * @property {number} v7
+ * @property {number} v8
+ * @property {number} maxChildren
+ * @property {number} v10
+ * @property {number} v11
+ * @property {number} weaponHash
+ * @property {number} fireId
+ */
+/**
+ * @typedef {Object} AnticheatGiveWeaponEvent
+ * @property {number} pedId
+ * @property {Hash} weaponType
+ * @property {number} ammo
+ * @property {boolean} unk1
+ * @property {boolean} givenAsPickup
+ */
+/**
+ * @typedef {Object} AnticheatRemoveAllWeaponsEvent
+ * @property {number} pedId
+ */
+/**
+ * @typedef {Object} AnticheatStartProjectileEvent
+ * @property {boolean} commandFireSingleBullet
+ * @property {number} effectGroup
+ * @property {number} firePositionX
+ * @property {number} firePositionY
+ * @property {number} firePositionZ
+ * @property {number} initialPositionX
+ * @property {number} initialPositionY
+ * @property {number} initialPositionZ
+ * @property {number} ownerId
+ * @property {number} projectileHash
+ * @property {number} targetEntity
+ * @property {number} throwTaskSequence
+ * @property {number} unk10
+ * @property {number} unk11
+ * @property {number} unk12
+ * @property {number} unk13
+ * @property {number} unk14
+ * @property {number} unk15
+ * @property {number} unk16
+ * @property {number} unk3
+ * @property {number} unk4
+ * @property {number} unk5
+ * @property {number} unk6
+ * @property {number} unk7
+ * @property {number} unk9
+ * @property {number} unkX8
+ * @property {number} unkY8
+ * @property {number} unkZ8
+ * @property {number} weaponHash
+ */
+/**
+ * @typedef {Object} AnticheatPtFxEvent
+ * @property {Hash} assetHash
+ * @property {number} axisBitset
+ * @property {number} effectHash
+ * @property {number} entityNetId
+ * @property {number} f100
+ * @property {number} f105
+ * @property {number} f106
+ * @property {number} f107
+ * @property {boolean} f109
+ * @property {boolean} f110
+ * @property {boolean} f111
+ * @property {number} f92
+ * @property {boolean} isOnEntity
+ * @property {number} offsetX
+ * @property {number} offsetY
+ * @property {number} offsetZ
+ * @property {number} posX
+ * @property {number} posY
+ * @property {number} posZ
+ * @property {number} rotX
+ * @property {number} rotY
+ * @property {number} rotZ
+ * @property {number} scale
+ */

package/lib/server/type/Hash.d.ts

@@ -0,0 +1,3 @@
+/** @typedef {number} Hash */
+export type Hash = number;
+/** @typedef {number} Hash */

package/lib/server/type/Hash.js

@@ -0,0 +1,2 @@
+export {};
+/** @typedef {number} Hash */

package/lib/server/utils/index.d.ts

@@ -0,0 +1 @@
+export { cleanPlayerName, Vector2, Vector3, Vector4, Maths, Quaternion, Color, Delay, enumValues, getStringFromUInt8Array, getUInt32FromUint8Array, } from '../../../common/utils/index';

package/lib/server/utils/index.js

@@ -0,0 +1 @@
+export { cleanPlayerName, Vector2, Vector3, Vector4, Maths, Quaternion, Color, Delay, enumValues, getStringFromUInt8Array, getUInt32FromUint8Array, } from '../../../common/utils/index';

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@nativewrappers/fivem",
+  "description": "Javascript/Typescript wrapper for the FiveM natives",
+  "author": "Remco Troost <d0p3t>",
+  "license": "MIT",
+  "type": "module",
+  "version": "0.0.1",
+  "exports": {
+    ".": "./lib/common/index.js",
+    "./server": "./lib/server/index.js",
+    "./client": "./lib/server/index.js"
+  },
+  "sideEffects": [
+    "./client/src/models/**"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nativewrappers/fivem-client.git"
+  },
+  "bugs": {
+    "url": "https://github.com/nativewrappers/fivem-client/issues"
+  },
+  "homepage": "https://fivemjs.avarian.dev/",
+  "keywords": [
+    "fivem",
+    "wrapper",
+    "javascript",
+    "typescript",
+    "citizenfx"
+  ],
+  "files": [
+    "./lib/**/*.js",
+    "./lib/**/*.d.ts"
+  ],
+  "devDependencies": {
+    "@citizenfx/client": "2.0.7604-1",
+    "@citizenfx/server": "2.0.7604-1",
+    "@types/node": "^16.18.87",
+    "buffer": "^6.0.3",
+    "prettier": "^2.8.8",
+    "prettier-linter-helpers": "^1.0.0",
+    "typedoc": "^0.25.11",
+    "typedoc-fivemjs-theme": "^0.2.7",
+    "typescript": "^5.4.2"
+  },
+  "scripts": {
+    "delete": "rm -rf lib",
+    "build": "tsc --build",
+    "watch": "tsc --watch",
+    "ci": "pnpm run prettier && pnpm run build",
+    "prettier": "prettier */**/*.ts --check",
+    "prettier-fix": "prettier */**/*.ts --write"
+  }
+}