@cybermp/client-types 1.1.9

package/out/precomputed/classes.d.ts

@@ -0,0 +1,12 @@
+/// <reference path="./enums.d.ts" />
+
+declare class 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;
+}

package/out/precomputed/enums.d.ts

@@ -0,0 +1,22 @@
+declare namespace CyberEnums {
+  /**
+   * See {@link worldWeatherState#name}
+   */
+  declare enum WeatherState {
+    SUNNY = "24h_weather_sunny",
+    LIGHT_CLOUDS = "24h_weather_light_clouds",
+    CLOUDY = "24h_weather_cloudy",
+    HEAVY_CLOUDS = "24h_weather_heavy_clouds",
+    FOG = "24h_weather_fog",
+    RAIN = "24h_weather_rain",
+    TOXIC_RAIN = "24h_weather_toxic_rain",
+    POLLUTION = "24h_weather_pollution",
+    SANDSTORM = "24h_weather_sandstorm",
+    DEEP_BLUE = "q302_deeb_blue",
+    LIGHT_RAIN = "q302_light_rain",
+    SQUAT_MORNING = "q302_squat_morning",
+    EPILOGUE_CLOUDY_MORNING = "q306_epilogue_cloudy_morning",
+    RAINY_NIGHT = "q306_rainy_night",
+    COURIER_CLOUDS = "sa_courier_clouds",
+  }
+}

package/out/precomputed/events.d.ts

@@ -0,0 +1,65 @@
+declare interface MpEvents {
+  on(
+    eventName: "onResourceStarted",
+    callback: (resourceName: string) => void
+  ): void;
+
+  on(
+    eventName: "onResourceStopped",
+    callback: (resourceName: string) => void
+  ): void;
+
+  /**
+   * Register a custom event listener.
+   * @param eventName Name of the event.
+   * @param callback Callback function.
+   */
+  on(eventName: string, callback: (...args: any[]) => void): void;
+
+  /**
+   * UnRegister a custom event listener.
+   * @param eventName Name of the event.
+   * @param callback Callback function.
+   */
+  off(eventName: string, callback: (...args: any[]) => void): void;
+
+  /**
+   * Emit a previously registered custom event.
+   *
+   * @param eventName Name of the event.
+   * @param args Arguments to pass.
+   */
+  emit(eventName: string, ...args: any[]): void;
+
+  /**
+   * Register a listener for server event on client.
+   */
+  onServer(eventName: string, callback: (...args: any[]) => void): void;
+
+  /**
+   * Emit an event to the server.
+   */
+  emitServer(eventName: string, ...args: any[]): void;
+
+  /**
+   * Emit an event to the cef.
+   */
+  emitCef(eventName: string, ...args: any[]): void;
+
+  /**
+   * Register a custom cef event listener.
+   * @param eventName Name of the event.
+   * @param callback Callback function.
+   */
+  onCef(eventName: string, callback: (...args: any[]) => void): void;
+
+  /**
+   * Register a command in the client scope.
+   * @param commandName Command name without "/".
+   * @param callback Callback with id and args.
+   */
+  addCommand(
+    commandName: string,
+    callback: (id: number, args: string[]) => void
+  ): void;
+}

package/out/precomputed/game.d.ts

@@ -0,0 +1,140 @@
+/// <reference path="./enums.d.ts" />
+/// <reference path="../enums.d.ts" />
+/// <reference path="./primitives.d.ts" />
+/// <reference path="./classes.d.ts" />
+/// <reference path="../classes.d.ts" />
+
+declare interface MpGamePrecomputed {
+  /**
+   * Method to retrieve input events.
+   */
+  onInputKeyEvent(
+    callback: (
+      action: CyberEnums.EInputAction,
+      key: CyberEnums.EInputKey,
+    ) => void,
+  ): void;
+
+  /**
+   * Event when the game is started.
+   */
+  onGameLoaded(callback: () => void): void;
+
+  /**
+   * Event when tweaks is loaded.
+   */
+  onTweak(callback: () => void): void;
+
+  /**
+   * Event when local player has been spawned.
+   */
+  onLocalPlayerSpawned(callback: () => void): void;
+
+  /**
+   * Get singleton.
+   */
+  getSingleton<T extends keyof MpClasses>(name: T): UnwrapMpClass<MpClasses[T]>;
+
+  /**
+   * Add something to inventory.
+   */
+  AddToInventory(itemName: string, count: number): void;
+
+  /**
+   * Returns model hash convertable to number.
+   * @param name Model name
+   * @param type Model name type
+   * @returns Model hash
+   */
+  getHashFromName(name: string, type: "tweakdbid" | "cname"): string;
+
+  /**
+   * Overrides method function inside selected class.
+   * @param className Class name
+   * @param methodName Method name inside of class
+   * @param {selfFunction} func Function to override instead
+   */
+  override(
+    className: string,
+    methodName: string,
+    func: (self: any, ...args: any[]) => void,
+  ): void;
+
+  /**
+   * Observes method inside selected class.
+   * @param className Class name
+   * @param methodName Method name inside of class
+   * @param {selfFunction} callback Callback of method function.
+   */
+  observeAfter(
+    className: string,
+    methodName: string,
+    callback: (self: any, ...args: any[]) => void,
+  ): void;
+
+  /**
+   * Observes method inside selected class.
+   * @param className Class name
+   * @param methodName Method name inside of class
+   * @param {selfFunction} callback Callback of method function.
+   */
+  observeBefore(
+    className: string,
+    methodName: string,
+    callback: (self: any, ...args: any[]) => void,
+  ): void;
+
+  /**
+   * Alias for {@link observeBefore}.
+   * @param className Class name
+   * @param methodName Method name inside of class
+   * @param {selfFunction} callback Callback of method function.
+   */
+  observe(
+    className: string,
+    methodName: string,
+    callback: (self: any, ...args: any[]) => void,
+  ): void;
+
+  /**
+   * Observes method inside selected class. Can only call methods from {@link MpGame}.
+   * Should be used when it's important for the function to execute quickly (as fast as V8 allows).
+   * @param className Class name
+   * @param methodName Method name inside of class
+   * @param {selfFunction} callback Callback of method function.
+   */
+  observeAfterRaw(
+    className: string,
+    methodName: string,
+    callback: (self: any, ...args: any[]) => void,
+  ): void;
+
+  /**
+   * Observes method inside selected class. Can only call methods from {@link MpGame}.
+   * Should be used when it's important for the function to execute quickly (as fast as V8 allows).
+   * @param className Class name
+   * @param methodName Method name inside of class
+   * @param {selfFunction} callback Callback of method function.
+   */
+  observeBeforeRaw(
+    className: string,
+    methodName: string,
+    callback: (self: any, ...args: any[]) => void,
+  ): void;
+
+  /**
+   * Alias for {@link observeBeforeRaw}.
+   * @param className Class name
+   * @param methodName Method name inside of class
+   * @param {selfFunction} callback Callback of method function.
+   */
+  observeRaw(
+    className: string,
+    methodName: string,
+    callback: (self: any, ...args: any[]) => void,
+  ): void;
+
+  isBlackScreenStarted(): boolean;
+
+  isBlackScreenEnded(): boolean;
+}

package/out/precomputed/global.d.ts

@@ -0,0 +1,137 @@
+/// <reference path="./events.d.ts" />
+/// <reference path="./meta.d.ts" />
+
+declare type ServerVector3 = [number, number, number];
+declare type ServerVector4 = [number, number, number, number];
+
+declare interface MpGlobalPrecomputed {
+  events: MpEvents;
+  meta: MpMeta;
+
+  /**
+   * Focus or unfocus CEF view.
+   */
+  setCefInFocusState(justFocus: boolean, withMouse: boolean): void;
+
+  isInCefFocusState(): boolean;
+
+  /**
+   * Mapping between network and game IDs.
+   */
+  getVehicleGameIdByNetworkId(id: number): number;
+
+  getPlayerGameIdByNetworkId(id: number): number;
+
+  getObjectGameIdByNetworkId(id: number): number;
+
+  getVehicleNetworkIdByGameId(hash: number): number;
+
+  getPlayerNetworkIdByGameId(hash: number): number;
+
+  getObjectNetworkIdByGameId(hash: number): number;
+
+  getPedNetworkIdByGameId(hash: number): number;
+
+  getPedGameIdByNetworkId(hash: number): number;
+
+  /**
+   * Local player spawning API.
+   */
+  setSpawnDataLocalPlayer(
+    modelHash: number,
+    x: number,
+    y: number,
+    z: number,
+    yaw: number,
+  ): void;
+
+  spawnLocalPlayer(): boolean;
+
+  /**
+   * Spawn local-only entities (not synced).
+   */
+  spawnLocalPed(
+    skinHash: number,
+    appHash: number,
+    x: number,
+    y: number,
+    z: number,
+    yaw: number,
+    streaming: boolean,
+  ): number;
+
+  spawnLocalVehicle(
+    skinHash: number,
+    appHash: number,
+    x: number,
+    y: number,
+    z: number,
+    roll: number,
+    pitch: number,
+    yaw: number,
+    streaming: boolean,
+  ): number;
+
+  spawnLocalObject(
+    skinHash: bigint | number,
+    appHash: bigint | number,
+    x: number,
+    y: number,
+    z: number,
+    roll: number,
+    pitch: number,
+    yaw: number,
+    streaming: boolean,
+  ): number;
+
+  despawnLocalPed(hash: number): void;
+
+  despawnLocalVehicle(hash: number): void;
+
+  despawnLocalObject(hash: number): void;
+
+  /**
+   * Get Discord token via game SDK (unstable).
+   */
+  getDiscordOAuth2Token(discordAppId: string): string;
+
+  /**
+   * Get Discord auth code (preferred).
+   */
+  getDiscordCodeAuthorization(discordAppId: string, scopes: string): string;
+
+  /**
+   * Returns current server IP:PORT string.
+   */
+  getCurrentServerEndpoint(): string;
+
+  /**
+   * Get server ID from player hash.
+   */
+  getPlayerServerId(playerHash: number): number;
+
+  /**
+   * Get src variable value as string.
+   */
+  getVar(varName: string): string;
+
+  /**
+   * Get console variable value as integer.
+   */
+  getVarInt(varName: string): number;
+
+  /**
+   * Returns time in ms since game start.
+   */
+  getGameTimer(): number;
+
+  getLauncherSettingsJSON(): string;
+
+  getLauncherSettings(): any;
+
+  changeCefViewUrl(newUrl: string): void;
+
+  setTick(cb: () => void): number;
+
+  clearTick(tickId: number): void;
+}

package/out/precomputed/index.d.ts

@@ -0,0 +1,7 @@
+/// <reference path="./primitives.d.ts" />
+/// <reference path="./classes.d.ts" />
+/// <reference path="./global.d.ts" />
+/// <reference path="./game.d.ts" />
+/// <reference path="./events.d.ts" />
+/// <reference path="./meta.d.ts" />
+/// <reference path="./enums.d.ts" />

package/out/precomputed/meta.d.ts

@@ -0,0 +1,15 @@
+declare interface MpMeta {
+  setGlobalMeta(key: string, value: any, sync?: boolean): void;
+  getGlobalMeta<T = any>(key: string): T;
+  setPlayerMeta(
+    playerId: number,
+    key: string,
+    value: any,
+    sync?: boolean
+  ): void;
+  getPlayerMeta<T = any>(playerId: number, key: string): T;
+  setEntityMeta(netId: number, key: string, value: any, sync?: boolean): void;
+  getEntityMeta<T = any>(netId: number, key: string): T;
+  setLocalPlayerMeta(key: string, value: any): void;
+  getLocalPlayerMeta<T = any>(key: string): T;
+}

package/out/precomputed/primitives.d.ts

@@ -0,0 +1,25 @@
+type UnwrapMpClass<T> = T extends { new (): infer U } ? U : T;
+type CName = string;
+type Handle<T = any> = T;
+type WeakHandle<T = any> = T;
+type ScriptRef<T = any> = T;
+type NodeRef<T = any> = T;
+type TweakDBID = string;
+type CRUID = any;
+type CGUID = any;
+type Variant = any;
+type LocalizationString = string;
+type Uint16 = number;
+type Uint8 = number;
+type Int8 = number;
+type Int16 = number;
+type Int32 = number;
+type DataBuffer = any;
+type serializationDeferredDataBuffer = any;
+type SharedDataBuffer = any;
+type EditorObjectID = any;
+type MessageResourcePath = any;
+type ResAsyncRef<T> = T;
+type CurveData<T> = T;
+type ResRef<T> = T;
+type MultiChannelCurve<T> = T;

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@cybermp/client-types",
+  "version": "1.1.9",
+  "description": "",
+  "main": "./out/index.d.ts",
+  "files": [
+    "./out"
+  ],
+  "keywords": [],
+  "author": "terminaate",
+  "contributors": [
+    "An1by"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@vitest/ui": "4.0.15",
+    "consola": "^3.4.2",
+    "rimraf": "^6.0.1",
+    "ts-morph": "^26.0.0",
+    "vitest": "^4.0.15"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "start": "tsx ./src",
+    "dev": "tsx watch ./src",
+    "build": "npm run start",
+    "test": "vitest run",
+    "test:dev": "vitest"
+  }
+}