@cybermp-community/client-types 2.5.2 → 2.5.3

package/dist/precomputed/cef.ts

@@ -1,9 +1,23 @@
+/**
+ * Controls the game's built-in CEF browser — focus routing, cursor capture, and URL navigation.
+ */
 export interface MpCef {
   /**
-   * @param focus Is need to focus CEF.
-   * @param cursor By default equals focus. 
+   * Switches keyboard input focus to the web view or back to the game engine.
+   * @param focus - `true` to route input into the web view, `false` to return control to the game.
+   * @param cursor - If `true`, shows and locks the OS cursor; if `false`, hides it.
    */
   setFocus(focus: boolean, cursor?: boolean): void;
+
+  /**
+   * Returns whether the CEF web view currently holds input focus.
+   * @returns `true` if the web view has focus, `false` otherwise.
+   */
   isInFocus(): boolean;
+
+  /**
+   * Navigates the web view to the given URL or local file path.
+   * @param url - Fully qualified URL or local asset path to load.
+   */
   setUrl(url: string): void;
 }

package/dist/precomputed/classes/extend.d.ts

@@ -1,102 +1,163 @@
-
 // biome-ignore-all lint: Precomputed
 import type { UnwrapClass } from '../../game.d.ts';
 import type { MpClasses } from '../../mp-classes.d.ts';
 import * as CyberEnums from '../../enums';
 
 declare module '../../classes.d.ts' {
-    export interface entEntity {
-        GetMorphTargets(): entMorphTargetWeightEntry[];
-    }
-
-    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 redResourceReferenceScriptToken {
-        export function GetHash(value: any): bigint;
-    }
-
-    export interface inkISystemRequestsHandler {
-        StartMainMenu(): void;
-    }
-
-    // TODO: Research
-    export interface gamePuppet {
-        GetGender(): CyberEnums.RedscriptPlayerGender;
-    }
-
-    export interface ScriptedPuppet {
-        GetGender(): CyberEnums.RedscriptPlayerGender;
-    }
-
-    export interface gamePuppetPS {
-        GetGender(): CyberEnums.RedscriptPlayerGender;
-    }
-
-    export interface entEntity {
-        GetMorphWeights(): entMorphTargetWeightEntry[];
-        ReassembleWithComponents(arr: entIComponent[]): void;
-        TeleportPed(position: Vector3, rotation?: EulerAngles): void;
-    }
-
-    export interface AimingStateDecisions {
-        OnItemEquipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
-        OnItemUnequipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
-    }
-
-    export interface AimingStateEvents {
-        OnItemEquipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
-        OnItemUnequipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
-    }
-
-    export interface ApplyStatGroupEffectorCallback {
-        OnItemEquipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
-        OnItemUnequipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
-    }
-
-    export interface gameuiICharacterCustomizationSystem {
-        SetPlayerGender(gender: CyberEnums.PlayerGender, savedPos?: boolean): void;
-        OnPlayerGenderChanged(gender: CyberEnums.PlayerGender): void;
-    }
-}
+  export interface entEntity {
+    GetMorphTargets(): entMorphTargetWeightEntry[];
+  }
+
+  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 {
+    /**
+     * Returns whether gravity is currently applied to this vehicle.
+     * @returns `true` if gravity is active, `false` otherwise.
+     */
+    HasGravity(): boolean;
+
+    /**
+     * Enables or disables gravity on this vehicle.
+     * @param enable - `true` to enable gravity, `false` to disable.
+     * @returns `true` if the state was changed successfully.
+     */
+    EnableGravity(enable: boolean): boolean;
+
+    /**
+     * Applies an instantaneous velocity impulse to the vehicle.
+     * @param velocity - Linear velocity to add.
+     * @param angularVelocity - Angular velocity to add.
+     * @returns `true` if the impulse was applied.
+     */
+    AddLinelyVelocity(velocity: Vector3, angularVelocity: Vector3): boolean;
+
+    /**
+     * Directly sets the vehicle's current linear and angular velocity.
+     * @param velocity - Target linear velocity.
+     * @param angularVelocity - Target angular velocity.
+     * @param switchIndex - Configuration index flag.
+     * @returns `true` if the velocity was updated successfully.
+     */
+    ChangeLinelyVelocity(velocity: Vector3, angularVelocity: Vector3, switchIndex: number): boolean;
+
+    /**
+     * Returns the vehicle's current linear velocity vector.
+     */
+    GetVelocity(): Vector3;
+
+    /**
+     * Returns the vehicle's current angular (rotational) velocity vector.
+     */
+    GetAngularVelocity(): Vector3;
+
+    /**
+     * Returns the physics simulation state bitmask for this vehicle.
+     */
+    GetPhysicsState(): number;
+
+    /**
+     * Returns whether the vehicle is currently in contact with the ground.
+     * @returns `true` if grounded, `false` if airborne.
+     */
+    IsOnGround(): boolean;
+
+    /**
+     * Returns the vehicle's axis-aligned bounding box used for collision.
+     */
+    GetBoundaryBox(): Box;
+
+    /**
+     * Called when this vehicle's network owner changes.
+     */
+    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 redResourceReferenceScriptToken {
+    export function GetHash(value: any): bigint;
+  }
+
+  export interface inkISystemRequestsHandler {
+    StartMainMenu(): void;
+  }
+
+  // TODO: Research
+  export interface gamePuppet {
+    GetGender(): CyberEnums.RedscriptPlayerGender;
+  }
+
+  export interface ScriptedPuppet {
+    GetGender(): CyberEnums.RedscriptPlayerGender;
+  }
+
+  export interface gamePuppetPS {
+    GetGender(): CyberEnums.RedscriptPlayerGender;
+  }
+
+  export interface entEntity {
+    /**
+     * Returns the active morph target weight entries for this entity's mesh.
+     */
+    GetMorphWeights(): entMorphTargetWeightEntry[];
+
+    /**
+     * Rebuilds the entity's visual representation using the provided component list.
+     * @param arr - Components to attach during reassembly.
+     */
+    ReassembleWithComponents(arr: entIComponent[]): void;
+
+    /**
+     * Teleports the entity (ped or game object) to the given world position.
+     * @param position - Target world position.
+     * @param rotation - Optional orientation in Euler angles (Pitch, Roll, Yaw).
+     */
+    TeleportPed(position: Vector3, rotation?: EulerAngles): void;
+  }
+
+  export interface AimingStateDecisions {
+    OnItemEquipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
+    OnItemUnequipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
+  }
+
+  export interface AimingStateEvents {
+    OnItemEquipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
+    OnItemUnequipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
+  }
+
+  export interface ApplyStatGroupEffectorCallback {
+    OnItemEquipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
+    OnItemUnequipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
+  }
+
+  export interface gameuiICharacterCustomizationSystem {
+    /**
+     * Sets the player's gender in the character customization system.
+     * @param gender - Target gender enum value.
+     * @param savedPos - If `true`, the current camera/position state is preserved.
+     */
+    SetPlayerGender(gender: CyberEnums.EPlayerGender, savedPos?: boolean): void;
+
+    /**
+     * Called after the player's gender has been successfully changed.
+     * @param gender - The new gender value.
+     */
+    OnPlayerGenderChanged(gender: CyberEnums.EPlayerGender): void;
+  }
+}

package/dist/precomputed/classes/index.ts

@@ -1,2 +1,2 @@
-export * from "./extend";
-export * from "./screens";
+export * from './extend';
+export * from './screens';

package/dist/precomputed/classes/screens.d.ts

@@ -1,46 +1,67 @@
-import type { MpClasses } from "../../mp-classes.d.ts";
-import type * as C from "../../classes.d.ts";
-import type * as E from "../../enums";
-import type * as M from "../../common.d.ts";
-
-export class LoadingScreenSystem {
-  GetLoadingScreenState(): E.ELoadingScreenState;
-  GetLoadingScreenProgress(): number;
-  OnLoadingScreenStateChange(newState: E.ELoadingScreenState): void;
-}
-
-export class MultiplayerSystem {
-  /**
-   * 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;
-
-  SetDefaultSpawnPosition(position: C.Vector3, yaw: number): void;
-}
-
-declare module "../../mp-classes.d.ts" {
-  export interface MpClasses {
-    LoadingScreenSystem: typeof LoadingScreenSystem;
-    MultiplayerSystem: typeof MultiplayerSystem;
-  }
-}
-
-declare module "../../classes.d.ts" {
-  export namespace ScriptGameInstance {
-    function GetLoadingScreenSystem(): M.Handle<LoadingScreenSystem>;
-    function GetMultiplayerSystem(): M.Handle<MultiplayerSystem>;
-  }
-}
+import type { MpClasses } from '../../mp-classes.d.ts';
+import type * as M from '../../common.d.ts';
+
+/**
+ * Exposes loading screen state and progress.
+ * Accessible via `mp.game.ScriptGameInstance.GetLoadingScreenSystem()`.
+ * @category Natives
+ */
+export class LoadingScreenSystem {
+  /**
+   * Returns the current loading screen state.
+   * @returns State enum value.
+   */
+  GetLoadingScreenState(): CyberEnums.ELoadingScreenState;
+
+  /**
+   * Returns the current loading progress as a number from 0 to 100.
+   */
+  GetLoadingScreenProgress(): number;
+
+  /**
+   * Called when the loading screen transitions to a new state.
+   * @param newState - The state being transitioned into.
+   */
+  OnLoadingScreenStateChange(newState: CyberEnums.ELoadingScreenState): void;
+}
+
+export class MultiplayerSystem {
+  /**
+   * Marks game object classes as deleted, removing them from the multiplayer world state.
+   * @param objectClassMap - Class names from `MpClasses` to remove.
+   */
+  DeclareDeletedObjects(objectClassMap: Array<keyof MpClasses>): void;
+
+  /**
+   * Removes specific game objects from network replication by their unique hash identifiers.
+   * @param objectHashMap - Array of entity hashes to delete.
+   */
+  DeletedObjectsByUniqueHash(objectHashMap: string[]): void;
+
+  /**
+   * Enables or disables the platform's default effect synchronization.
+   * @param value - `true` to use default sync effects, `false` to disable.
+   */
+  UseDefaultEffectsByPlatform(value: boolean): void;
+
+  /**
+   * Sets the fallback spawn position used when no explicit position is provided.
+   * @param position - World coordinates.
+   * @param yaw - Facing angle in degrees.
+   */
+  SetDefaultSpawnPosition(position: Vector3, yaw: number): void;
+}
+
+declare module '../../mp-classes.d.ts' {
+  export interface MpClasses {
+    LoadingScreenSystem: typeof LoadingScreenSystem;
+    MultiplayerSystem: typeof MultiplayerSystem;
+  }
+}
+
+declare module '../../classes.d.ts' {
+  export namespace ScriptGameInstance {
+    function GetLoadingScreenSystem(): M.Handle<LoadingScreenSystem>;
+    function GetMultiplayerSystem(): M.Handle<MultiplayerSystem>;
+  }
+}

package/dist/precomputed/commands.ts

@@ -0,0 +1,17 @@
+/**
+ * Registers and removes client-side console commands.
+ */
+export interface MpCommands {
+  /**
+   * Registers a console command.
+   * @param commandName - Command name without the leading "/".
+   * @param callback - Handler called with the executing player's ID and the parsed argument list.
+   */
+  add(commandName: string, callback: (id: number, args: string[]) => void): void;
+
+  /**
+   * Removes a previously registered console command.
+   * @param commandName - Command name without the leading "/".
+   */
+  remove(commandName: string): void;
+}

package/dist/precomputed/discord.ts

@@ -1,3 +1,23 @@
+/**
+ * Discord integration — rich presence updates and OAuth2 authorization.
+ */
 export interface MpDiscord {
   updateRichPresence(state?: string, details?: string): void;
+
+  /**
+   * Runs Discord's OAuth2 authorization flow and returns an authorization code
+   * that can be exchanged for an access token server-side.
+   * @param discordAppId - Your Discord application's client ID.
+   * @param scopes - Space-separated OAuth2 scopes (e.g., `"identify guilds"`).
+   * @returns The authorization code string.
+   */
+  getOAuth2Token(discordAppId: string, scopes: string): string;
+
+  /**
+   * @deprecated Use {@link getOAuth2Token} instead.
+   * @param discordAppId - Your Discord application's client ID.
+   * @param scopes - Space-separated OAuth2 scopes (e.g., `"identify guilds"`).
+   * @returns The authorization code string.
+   */
+  getCodeAuthorization(discordAppId: string, scopes: string): string;
 }