@cybermp/client-types 1.2.1 → 1.2.3

package/out/precomputed/classes.d.ts

@@ -1,67 +1,67 @@
-/// <reference path="./enums.d.ts" />
-
-/**
- * Class with custom CyberMP native methods.
- */
-declare interface CyberMP {
-  /**
-   * Removes game object classes (e.g., T extends gameObject, playerPuppet, NpcPuppet) from the map.
-   * @param objectClassMap Array of class names to delete.
-   */
-  DeclareDeletedObjects(objectClassMap: Array<keyof MpClasses>): void;
-
-  /**
-   * Removes game objects by their unique hashes from the map.
-   * @param objectHashMap Array of unique game object hashes to delete.
-   */
-  DeletedObjectsByUniqueHash(objectHashMap: string[]): void;
-
-  /**
-   * Enables or disables synchronization of default effects, as defined by the CyberMP platform.
-   * @param value Whether to use the default effects.
-   */
-  UseDefaultEffectsByPlatform(value: boolean): void;
-}
-
-declare interface worldWeatherScriptInterface extends IScriptable {
-  public SetWeather(
-    weather: CyberEnums.WeatherState,
-    blendTime?: number,
-    priority?: number,
-  ): void;
-  public ResetWeather(forceRestore?: boolean, blendTime?: number): void;
-  public GetWeatherState(): worldWeatherState;
-  public GetEnvironmentDefinition(): worldEnvironmentDefinition;
-}
-
-declare interface vehicleBaseObject extends gameObject {
-  public HasGravity(): boolean;
-  public EnableGravity(is_enable: boolean): boolean;
-  public AddLinelyVelocity(
-    velocity: Vector3,
-    angularVelocity: Vector3,
-  ): boolean;
-  public ChangeLinelyVelocity(
-    velocity: Vector3,
-    angularVelocity: Vector3,
-    switchIndex: number,
-  ): boolean;
-  public GetVelocity(): Vector3;
-  public GetAngularVelocity(): Vector3;
-  public GetPhysicsState(): number;
-  public IsOnGround(): boolean;
-  public GetBoundaryBox(): Box;
-  public VehicleOwnerWasChanged(): void;
-}
-
-declare interface gameMappinSystem extends gamemappinsIMappinSystem {
-  TrackMappin(id: gameNewMappinID): void;
-}
-
-type OnlyExtendingScriptableSystem<T> = {
-  [K in keyof T as T[K] extends typeof gameScriptableSystem ? K : never]: T[K];
-};
-
-declare interface gameScriptableSystemsContainer<Map = OnlyExtendingScriptableSystem<MpClasses>> {
-  "Get"<N extends keyof Map>(systemName: N): UnwrapMpClass<Map[N]>;
-}
+/// <reference path="./enums.d.ts" />
+
+/**
+ * Class with custom CyberMP native methods.
+ */
+declare interface CyberMP {
+  /**
+   * Removes game object classes (e.g., T extends gameObject, playerPuppet, NpcPuppet) from the map.
+   * @param objectClassMap Array of class names to delete.
+   */
+  DeclareDeletedObjects(objectClassMap: Array<keyof MpClasses>): void;
+
+  /**
+   * Removes game objects by their unique hashes from the map.
+   * @param objectHashMap Array of unique game object hashes to delete.
+   */
+  DeletedObjectsByUniqueHash(objectHashMap: string[]): void;
+
+  /**
+   * Enables or disables synchronization of default effects, as defined by the CyberMP platform.
+   * @param value Whether to use the default effects.
+   */
+  UseDefaultEffectsByPlatform(value: boolean): void;
+}
+
+declare interface worldWeatherScriptInterface extends IScriptable {
+  public SetWeather(
+    weather: CyberEnums.WeatherState,
+    blendTime?: number,
+    priority?: number,
+  ): void;
+  public ResetWeather(forceRestore?: boolean, blendTime?: number): void;
+  public GetWeatherState(): worldWeatherState;
+  public GetEnvironmentDefinition(): worldEnvironmentDefinition;
+}
+
+declare interface vehicleBaseObject extends gameObject {
+  public HasGravity(): boolean;
+  public EnableGravity(is_enable: boolean): boolean;
+  public AddLinelyVelocity(
+    velocity: Vector3,
+    angularVelocity: Vector3,
+  ): boolean;
+  public ChangeLinelyVelocity(
+    velocity: Vector3,
+    angularVelocity: Vector3,
+    switchIndex: number,
+  ): boolean;
+  public GetVelocity(): Vector3;
+  public GetAngularVelocity(): Vector3;
+  public GetPhysicsState(): number;
+  public IsOnGround(): boolean;
+  public GetBoundaryBox(): Box;
+  public VehicleOwnerWasChanged(): void;
+}
+
+declare interface gameMappinSystem extends gamemappinsIMappinSystem {
+  TrackMappin(id: gameNewMappinID): void;
+}
+
+type OnlyExtendingScriptableSystem<T> = {
+  [K in keyof T as T[K] extends typeof gameScriptableSystem ? K : never]: T[K];
+};
+
+declare interface gameScriptableSystemsContainer<Map = OnlyExtendingScriptableSystem<MpClasses>> {
+  "Get"<N extends keyof Map>(systemName: N): UnwrapMpClass<Map[N]>;
+}

package/out/precomputed/game.d.ts

@@ -28,8 +28,21 @@ interface ObserveFunction {
   ): void;
 }
 
+interface TweakDB {
+  getRecords<T = any>(str: string): T[];
+  getRecord<T = any>(str: string): T;
+  query(str: string): string[];
+  getFlat<T = any>(str: string): T;
+  setFlats(str: string, arr: any[]): boolean;
+  setFlat(str: string, obj: any): boolean;
+  setFlatNoUpdate(str: string, obj: any): boolean;
+  updateRecord(str: string): boolean;
+  createRecord(key: string, value: string): boolean;
+}
+
 declare interface MpGamePrecomputed {
   CyberMP: CyberMP;
+  TweakDB: TweakDB;
 
   /**
    * Method to retrieve input events.
@@ -51,6 +64,11 @@ declare interface MpGamePrecomputed {
    */
   onTweak(callback: () => void): void;
 
+  /**
+   * Event when tweaks is loaded.
+   */
+  onInit(callback: () => void): void;
+
   /**
    * Event when local player has been spawned.
    */
@@ -132,6 +150,9 @@ declare interface MpGamePrecomputed {
    */
   observeRaw: ObserveFunction;
 
+  toVariant<R = {}>(obj: any, str: string): R;
+  fromVariant<R = any>(obj: any): R;
+
   isBlackScreenStarted(): boolean;
 
   isBlackScreenEnded(): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cybermp/client-types",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "",
   "main": "./out/index.d.ts",
   "files": [