@cybermp/client-types 1.8.0 → 2.0.0

package/out/mp.d.ts

@@ -0,0 +1,8 @@
+import { MpGame } from "./game.d.ts";
+
+// THIS CODE IS GENERATED, PLEASE DO NOT EDIT THIS
+export interface MpClient {
+    game: MpGame;
+}
+
+export * from "./precomputed/mp.d.ts";

package/out/precomputed/cef.d.ts

@@ -1,5 +1,5 @@
-interface MpCef {
-  setFocus(focus: boolean, cursor?: boolean): void;
-  isInFocus(): boolean;
-  setUrl(url: string): void;
-}
+export interface MpCef {
+  setFocus(focus: boolean, cursor?: boolean): void;
+  isInFocus(): boolean;
+  setUrl(url: string): void;
+}

package/out/precomputed/discord.d.ts

@@ -1,3 +1,3 @@
-interface MpDiscord {
-  updateRichPresence(state?: string, details?: string): void;
-}
+export interface MpDiscord {
+  updateRichPresence(state?: string, details?: string): void;
+}

package/out/precomputed/enums.d.ts

@@ -1,7 +1,7 @@
 /**
  * See {@link worldWeatherState#name}
  */
-export enum WeatherState {
+export enum EWeatherState {
   SUNNY = '24h_weather_sunny',
   LIGHT_CLOUDS = '24h_weather_light_clouds',
   CLOUDY = '24h_weather_cloudy',
@@ -19,7 +19,7 @@ export enum WeatherState {
   COURIER_CLOUDS = 'sa_courier_clouds',
 }
 
-export enum VoiceActivationType {
+export enum EVoiceActivationType {
   UNDEFINED = 0,
   VOICE = 1,
   PUSH_TO_TALK = 2,

package/out/precomputed/events.d.ts

@@ -1,14 +1,4 @@
-interface MpEvents {
-  on(
-    eventName: 'onResourceStarted',
-    callback: (resourceName: string) => void,
-  ): void;
-
-  on(
-    eventName: 'onResourceStopped',
-    callback: (resourceName: string) => void,
-  ): void;
-
+export interface MpEvents {
   /**
    * Register a custom event listener.
    * @param eventName Name of the event.

package/out/precomputed/game.d.ts

@@ -1,12 +1,9 @@
-/// <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" />
+import type * as CyberEnums from '../enums';
+import type { MpClasses, Vector3 } from '../game';
 
 type OverrideFunction = <
   C extends keyof MpClasses,
-  I extends UnwrapMpClass<MpClasses[C]>,
+  I extends UnwrapClass<MpClasses[C]>,
   M extends keyof I extends never ? string : keyof I,
 >(
   className: C,
@@ -19,7 +16,7 @@ type OverrideFunction = <
 
 type ObserveFunction = <
   C extends keyof MpClasses,
-  I extends UnwrapMpClass<MpClasses[C]>,
+  I extends UnwrapClass<MpClasses[C]>,
   M extends keyof I extends never ? string : keyof I,
 >(
   className: C,
@@ -39,122 +36,208 @@ interface TweakDB {
   createRecord(key: string, value: string): boolean;
 }
 
-interface MpGamePrecomputed {
-  CyberMP: CyberMP;
-  TweakDB: TweakDB;
-
-  /**
-   * Method to retrieve input events.
-   */
-  onInputKeyEvent(
-    callback: (
-      action: CyberEnums.EInputAction,
-      key: CyberEnums.EInputKey,
-    ) => void,
-  ): void;
-
-  getDisplayResolution(): [number, number];
-
-  /**
-   * Event when the game is started.
-   */
-  onGameLoaded(callback: () => void): void;
-
-  /**
-   * Event when tweaks is loaded.
-   */
-  onTweak(callback: () => void): void;
-
-  /**
-   * Event when tweaks is loaded.
-   */
-  onInit(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]>;
-
+interface CyberMP {
   /**
-   * Add something to inventory.
+   * Removes game object classes (e.g., T extends gameObject, playerPuppet, NpcPuppet) from the map.
+   * @param objectClassMap Array of class names to delete.
    */
-  AddToInventory(itemName: string, count: number): void;
+  DeclareDeletedObjects(objectClassMap: Array<keyof MpClasses>): void;
 
   /**
-   * Returns model hash convertable to number.
-   * @param name Model name
-   * @param type Model name type
-   * @returns Model hash
+   * Removes game objects by their unique hashes from the map.
+   * @param objectHashMap Array of unique game object hashes to delete.
    */
-  getHashFromName(name: string, type: 'tweakdbid' | 'cname'): string;
+  DeletedObjectsByUniqueHash(objectHashMap: string[]): void;
 
   /**
-   * Overrides method function inside selected class.
-   * @param className Class name
-   * @param methodName Method name inside of class
-   * @param {selfFunction} func Function to override instead
+   * Enables or disables synchronization of default effects, as defined by the CyberMP platform.
+   * @param value Whether to use the default effects.
    */
-  override: OverrideFunction;
+  UseDefaultEffectsByPlatform(value: boolean): 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: ObserveFunction;
-
-  /**
-   * Observes method inside selected class.
-   * @param className Class name
-   * @param methodName Method name inside of class
-   * @param {selfFunction} callback Callback of method function.
-   */
-  observeBefore: ObserveFunction;
-
-  /**
-   * Alias for {@link observeBefore}.
-   * @param className Class name
-   * @param methodName Method name inside of class
-   * @param {selfFunction} callback Callback of method function.
-   */
-  observe: ObserveFunction;
-
-  /**
-   * 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: ObserveFunction;
-
-  /**
-   * 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: ObserveFunction;
-
-  /**
-   * Alias for {@link observeBeforeRaw}.
-   * @param className Class name
-   * @param methodName Method name inside of class
-   * @param {selfFunction} callback Callback of method function.
-   */
-  observeRaw: ObserveFunction;
-
-  toVariant<R = {}>(obj: any, str: string): R;
-  fromVariant<R = any>(obj: any): R;
-
-  isBlackScreenStarted(): boolean;
+  SetDefaultSpawnPosition(position: Vector3, yaw: number): void;
+}
 
-  isBlackScreenEnded(): boolean;
+import '../game.d.ts';
+
+declare module '../game.d.ts' {
+  export interface worldWeatherScriptInterface extends IScriptable {
+    SetWeather(
+      weather: CyberEnums.EWeatherState,
+      blendTime?: number,
+      priority?: number,
+    ): void;
+    ResetWeather(forceRestore?: boolean, blendTime?: number): void;
+    GetWeatherState(): worldWeatherState;
+    GetEnvironmentDefinition(): worldEnvironmentDefinition;
+  }
+
+  export interface vehicleBaseObject extends gameObject {
+    HasGravity(): boolean;
+    EnableGravity(enable: boolean): boolean;
+    AddLinelyVelocity(velocity: Vector3, angularVelocity: Vector3): boolean;
+    ChangeLinelyVelocity(
+      velocity: Vector3,
+      angularVelocity: Vector3,
+      switchIndex: number,
+    ): boolean;
+    GetVelocity(): Vector3;
+    GetAngularVelocity(): Vector3;
+    GetPhysicsState(): number;
+    IsOnGround(): boolean;
+    GetBoundaryBox(): Box;
+    VehicleOwnerWasChanged(): void;
+  }
+
+  export 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];
+  };
+
+  export interface gameScriptableSystemsContainer<
+    Map = OnlyExtendingScriptableSystem<MpClasses>,
+  > {
+    Get<N extends keyof Map>(systemName: N): UnwrapClass<Map[N]>;
+  }
+
+  export namespace ScriptGameInstance {
+    export function GetLoadingScreenSystem(): LoadingScreenSystem;
+  }
+
+  export class LoadingScreenSystem {
+    GetLoadingScreenState(): CyberEnums.ELoadingScreenState;
+    GetLoadingScreenProgress(): number;
+    OnLoadingScreenStateChange(newState: CyberEnums.ELoadingScreenState): void;
+  }
+
+  export interface inkISystemRequestsHandler {
+    StartMainMenu(): void;
+  }
+
+  export interface gameuiICharacterCustomizationSystem {
+    SetPlayerGender(gender: CyberEnums.EPlayerGender, savedPos?: boolean): void;
+    OnPlayerGenderChanged(gender: CyberEnums.EPlayerGender): void;
+  }
+
+  export interface MpClasses {
+    LoadingScreenSystem: typeof LoadingScreenSystem;
+  }
+
+  export interface MpGame {
+    CyberMP: CyberMP;
+    TweakDB: TweakDB;
+
+    onInputKeyEvent(
+      callback: (
+        action: CyberEnums.EInputAction,
+        key: CyberEnums.EInputKey,
+      ) => void,
+    ): void;
+
+    getDisplayResolution(): [width: number, height: number];
+
+    /**
+     * Event when the game is started.
+     */
+    onGameLoaded(callback: () => void): void;
+
+    /**
+     * Event when tweaks is loaded.
+     */
+    onTweak(callback: () => void): void;
+
+    /**
+     * Event when tweaks is loaded.
+     */
+    onInit(callback: () => void): void;
+
+    /**
+     * Event when local player has been spawned.
+     */
+    onLocalPlayerSpawned(callback: () => void): void;
+
+    /**
+     * Get singleton.
+     */
+    getSingleton<T extends keyof MpClasses>(name: T): UnwrapClass<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: OverrideFunction;
+
+    /**
+     * Observes method inside selected class.
+     * @param className Class name
+     * @param methodName Method name inside of class
+     * @param {selfFunction} callback Callback of method function.
+     */
+    observeAfter: ObserveFunction;
+
+    /**
+     * Observes method inside selected class.
+     * @param className Class name
+     * @param methodName Method name inside of class
+     * @param {selfFunction} callback Callback of method function.
+     */
+    observeBefore: ObserveFunction;
+
+    /**
+     * Alias for {@link observeBefore}.
+     * @param className Class name
+     * @param methodName Method name inside of class
+     * @param {selfFunction} callback Callback of method function.
+     */
+    observe: ObserveFunction;
+
+    /**
+     * 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: ObserveFunction;
+
+    /**
+     * 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: ObserveFunction;
+
+    /**
+     * Alias for {@link observeBeforeRaw}.
+     * @param className Class name
+     * @param methodName Method name inside of class
+     * @param {selfFunction} callback Callback of method function.
+     */
+    observeRaw: ObserveFunction;
+
+    toVariant<R = Record<string, unknown>>(obj: any, str: string): R;
+    fromVariant<R = any>(obj: any): R;
+  }
 }

package/out/precomputed/index.d.ts

@@ -1,7 +1,11 @@
-/// <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" />
+export * from './cef';
+export * from './classes';
+export * from './discord';
+export * from './enums';
+export * from './events';
+export * from './game';
+export * from './local-storage';
+export * from './meta';
+export * from './mp';
+export * from './primitives';
+export * from './voice-chat';

package/out/precomputed/local-storage.d.ts

@@ -1,7 +1,9 @@
-interface MpLocalStorage {
+export interface MpLocalStorage {
   set(key: string, value: string): void;
   get(key: string): string;
+
   delete(key: string): void;
   deleteAll(): void;
+
   save(): void;
 }

package/out/precomputed/meta.d.ts

@@ -1,15 +1,18 @@
-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;
-}
+export 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;
+
+  setLocalPlayerMeta(key: string, value: any): void;
+  getLocalPlayerMeta<T = any>(key: string): T;
+
+  setEntityMeta(netId: number, key: string, value: any, sync?: boolean): void;
+  getEntityMeta<T = any>(netId: number, key: string): T;
+}

package/out/precomputed/mp.d.ts

@@ -0,0 +1,138 @@
+import type { MpDiscord } from './discord';
+import type { MpEvents } from './events';
+import type { MpLocalStorage } from './local-storage';
+import type { MpMeta } from './meta';
+import type { MpVoiceChat } from './voice-chat';
+
+type ServerVector3 = [number, number, number];
+type ServerVector4 = [number, number, number, number];
+
+import '../mp.d.ts';
+
+declare module '../mp.d.ts' {
+  export interface MpClient {
+    events: MpEvents;
+    meta: MpMeta;
+    voiceChat: MpVoiceChat;
+    cef: MpCef;
+    discord: MpDiscord;
+    localStorage: MpLocalStorage;
+
+    getStreamedPool(
+      objName: 'CVehicle' | 'CPed' | 'CPickup' | 'CObject',
+    ): number[];
+    getStreamedPlayers(): number[];
+
+    /**
+     * 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(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;
+
+    setTick(cb: () => any): number;
+
+    clearTick(tickId: number): void;
+  }
+}

package/out/precomputed/primitives.d.ts

@@ -1,25 +1,13 @@
-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;
+declare global {
+  type UnwrapClass<T> = T extends { new (): infer U } ? U : T;
+  type Handle<T = any> = T;
+  type WeakHandle<T = any> = T;
+  type ScriptRef<T = any> = T;
+  type NodeRef<T = any> = T;
+  type ResAsyncRef<T> = T;
+  type CurveData<T> = T;
+  type ResRef<T> = T;
+  type MultiChannelCurve<T> = T;
+}
+
+export {};

package/out/precomputed/voice-chat.d.ts

@@ -1,19 +1,23 @@
-import * as CyberEnums from '../enums';
+import type * as CyberEnums from '../enums';
 
-declare global {
-  interface MpVoiceChat {
-    enable(state: boolean): void;
-    changeActivationType(type: CyberEnums.VoiceActivationType): void;
-    bindPushToTalkKey(key: number | CyberEnums.EInputKey): void;
-    setOutputVolume(value: number): void;
-    setInputVolume(value: number): void;
-    setMicrophoneSensitivity(value: number): void;
-    getOutputDevices(): string[];
-    getInputDevices(): string[];
-    setOutputDevice(index: number): void;
-    setInputDevice(index: number): void;
-    setVoiceInputDistance(distance: number): void;
-    setVoiceOutputDistance(distance: number): void;
-    isActive(): boolean;
-  }
+export interface MpVoiceChat {
+  enable(state: boolean): void;
+
+  changeActivationType(type: CyberEnums.EVoiceActivationType): void;
+  bindPushToTalkKey(key: number | CyberEnums.EInputKey): void;
+
+  setOutputVolume(value: number): void;
+  setInputVolume(value: number): void;
+  setMicrophoneSensitivity(value: number): void;
+
+  getOutputDevices(): string[];
+  getInputDevices(): string[];
+
+  setOutputDevice(index: number): void;
+  setInputDevice(index: number): void;
+
+  setVoiceInputDistance(distance: number): void;
+  setVoiceOutputDistance(distance: number): void;
+
+  isActive(): boolean;
 }