@cybermp/client-types 2.2.2 → 2.3.1

package/README.md

@@ -0,0 +1,56 @@
+<h1 align="center">@cybermp/client-types</h1>
+
+✅ **Official** client-side type definitions for CyberMP multiplayer.
+
+## 🚀 Installation
+
+Install the package as a development dependency:
+
+With npm:
+```bash
+npm install --save-dev @cybermp/client-types
+```
+
+With pnpm:
+```bash
+pnpm add -D @cybermp/client-types
+```
+
+With yarn:
+```bash
+yarn add -D @cybermp/client-types
+```
+
+## 🛠️ Configuration & Usage
+
+To make TypeScript aware of the global `mp` variable, choose one of the following two approaches:
+
+### Approach 1: Global Declaration
+Create a `global.d.ts` file in your source root (e.g., `src/global.d.ts`) to make the `mp` namespace available globally across your entire project without explicit imports.
+
+```typescript
+import { MpClient } from '@cybermp/client-types';
+
+declare global {
+  const mp: MpClient;
+}
+```
+
+> ⚠️ **Note:** Ensure your `tsconfig.json` includes your `global.d.ts` file (either via the `"include"` array or the `"files"` array) so the compiler picks up the definitions.
+
+### Approach 2: Scoped Local Variable
+If you prefer to avoid polluting the global scope, you can create a local alias module (e.g., `src/mp.ts`) that links directly to `globalThis`.
+
+```typescript
+import { MpClient } from '@cybermp/client-types';
+
+export const mp = (globalThis as any).mp as MpClient;
+```
+
+## 📜 Documentation
+
+You can find the full documentation [here](https://docs.cyber.mp).
+
+## ⚖️ License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/cyber-mp/cybermp-types/blob/main/LICENSE) for more information.

package/out/bitfields.ts

@@ -14,35 +14,6 @@ export enum workWorkspotItemPolicy {
     "ItemPolicy_DespawnItemOnReaction" = 2
 }
 
-export enum TriggerChannel {
-    "TC_Default" = 0,
-    "TC_Player" = 1,
-    "TC_Camera" = 2,
-    "TC_Human" = 3,
-    "TC_SoundReverbArea" = 4,
-    "TC_SoundAmbientArea" = 5,
-    "TC_Quest" = 6,
-    "TC_Projectiles" = 7,
-    "TC_Vehicle" = 8,
-    "TC_Environment" = 9,
-    "TC_WaterNullArea" = 10,
-    "TC_Custom0" = 16,
-    "TC_Custom1" = 17,
-    "TC_Custom2" = 18,
-    "TC_Custom3" = 19,
-    "TC_Custom4" = 20,
-    "TC_Custom5" = 21,
-    "TC_Custom6" = 22,
-    "TC_Custom7" = 23,
-    "TC_Custom8" = 24,
-    "TC_Custom9" = 25,
-    "TC_Custom10" = 26,
-    "TC_Custom11" = 27,
-    "TC_Custom12" = 28,
-    "TC_Custom13" = 29,
-    "TC_Custom14" = 30
-}
-
 export enum scnChoiceNodeNsChoiceNodeBitFlags {
     "IsFocusClue" = 0,
     "IsValidInteractionFailsafeDisabled" = 1
@@ -63,12 +34,6 @@ export enum rendLightChannel {
     "LC_Automated" = 15
 }
 
-export enum RenderSceneLayerMask {
-    "Default" = 0,
-    "Cyberspace" = 1,
-    "WorldMap" = 2
-}
-
 export enum physicsRagdollBodyPartE {
     "HEAD" = 0,
     "LARM_UPPER" = 1,
@@ -168,13 +133,6 @@ export enum gameEItemDynamicTags {
     "TransmogBlocked" = 3
 }
 
-export enum ETextureChannel {
-    "TextureChannel_R" = 0,
-    "TextureChannel_G" = 1,
-    "TextureChannel_B" = 2,
-    "TextureChannel_A" = 3
-}
-
 export enum entdismembermentWoundTypeE {
     "CLEAN" = 0,
     "COARSE" = 1,
@@ -213,6 +171,53 @@ export enum entdismembermentGoreTypeE {
     "CYBER" = 3
 }
 
+export enum animMuteAnimEvents {
+    "STANDARD" = 0,
+    "FACE_ANIMS" = 1
+}
+
+export enum TriggerChannel {
+    "TC_Default" = 0,
+    "TC_Player" = 1,
+    "TC_Camera" = 2,
+    "TC_Human" = 3,
+    "TC_SoundReverbArea" = 4,
+    "TC_SoundAmbientArea" = 5,
+    "TC_Quest" = 6,
+    "TC_Projectiles" = 7,
+    "TC_Vehicle" = 8,
+    "TC_Environment" = 9,
+    "TC_WaterNullArea" = 10,
+    "TC_Custom0" = 16,
+    "TC_Custom1" = 17,
+    "TC_Custom2" = 18,
+    "TC_Custom3" = 19,
+    "TC_Custom4" = 20,
+    "TC_Custom5" = 21,
+    "TC_Custom6" = 22,
+    "TC_Custom7" = 23,
+    "TC_Custom8" = 24,
+    "TC_Custom9" = 25,
+    "TC_Custom10" = 26,
+    "TC_Custom11" = 27,
+    "TC_Custom12" = 28,
+    "TC_Custom13" = 29,
+    "TC_Custom14" = 30
+}
+
+export enum RenderSceneLayerMask {
+    "Default" = 0,
+    "Cyberspace" = 1,
+    "WorldMap" = 2
+}
+
+export enum ETextureChannel {
+    "TextureChannel_R" = 0,
+    "TextureChannel_G" = 1,
+    "TextureChannel_B" = 2,
+    "TextureChannel_A" = 3
+}
+
 export enum EMeshChunkRenderMask {
     "MCR_Scene" = 0,
     "MCR_Cascade1" = 1,
@@ -247,8 +252,3 @@ export enum CensorshipFlags {
     "Censor_Religion" = 6,
     "Censor_Chinese" = 7
 }
-
-export enum animMuteAnimEvents {
-    "STANDARD" = 0,
-    "FACE_ANIMS" = 1
-}