@cybermp-community/server-types 1.2.0 → 1.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cybermp-community/server-types",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "TypeScript type definitions for the CyberMP server-side environment.",
   "license": "CC BY-SA 4.0",
   "author": {
@@ -12,7 +12,7 @@
   ],
   "repository": {
     "type": "gitlab",
-    "url": "https://gitlab.com/cybermp/types/server"
+    "url": "git+https://gitlab.com/cybermp/types/server.git"
   },
   "publishConfig": {
     "access": "public"

package/src/commands.ts

@@ -6,8 +6,11 @@ export interface MpCommands {
    * @param commandName Command name without "/".
    * @param callback Callback with player and args.
    */
-  add(
-    commandName: string,
-    callback: (player: MpPlayer, args: string[]) => void,
-  ): void;
+  add(commandName: string, callback: (player: MpPlayer, args: string[]) => void): void;
+
+  /**
+   * Unregister a command.
+   * @param commandName Command name without "/".
+   */
+  remove(commandName: string): void;
 }

package/src/entities/entity.ts

@@ -5,6 +5,10 @@ import type { Rotation, Vector3 } from '../shared';
 import type { MpVehicle } from '../vehicles';
 import type { MpPlayer } from './player';
 
+/**
+ * Enumeration of available entity types.
+ * @category Entities
+ */
 export enum EntityType {
   Player = 1,
   Vehicle = 2,
@@ -14,6 +18,10 @@ export enum EntityType {
   GameObject = 6,
 }
 
+/**
+ * Union type representing any entity in the server environment.
+ * @category Entities
+ */
 export type MpAnyEntity =
   | MpPlayer
   | MpVehicle
@@ -22,25 +30,70 @@ export type MpAnyEntity =
   | MpPickup
   | MpEntity<EntityType.GameObject>;
 
+/**
+ * Base interface representing a generic world entity.
+ * @category Entities
+ */
 export interface MpEntity<TEntityType extends EntityType = EntityType> {
+  /** Unique ID of the entity. */
   readonly id: number;
+
+  /** The player who originally spawned/synced this entity. */
   readonly firstOwner: MpPlayer;
+
+  /** Coordinates representing the entity's position. */
   readonly position: Vector3;
+
+  /** Rotation angles (pitch, roll, yaw) of the entity. */
   readonly rotation: Rotation;
+
+  /** Yaw rotation value. */
   readonly yaw: number;
+
+  /** Type classification of this entity. */
   readonly type: TEntityType;
+
+  /** True if the entity is currently active in the world. */
   readonly exist: boolean;
-  
+
+  /** Current syncing owner of the entity. */
   owner: MpPlayer;
+
+  /** Virtual world/dimension ID. */
   dimension: number;
+
+  /** Streaming distance radius. */
   streamingRadius: number;
 
+  /**
+   * Retrieves custom metadata stored on the entity.
+   * @param key The key of the metadata.
+   */
   getMeta<T = any>(key: string): T;
+
+  /**
+   * Sets custom metadata on the entity.
+   * @param key The key of the metadata.
+   * @param value The value to store.
+   * @param sync Optional flag to immediately sync with clients.
+   */
   setMeta(key: string, value: any, sync?: boolean): void;
 }
 
+/**
+ * Manager interface for handling entity collections.
+ * @category Entities
+ */
 export interface MpEntities<T extends MpEntity = MpEntity> {
+  /**
+   * Checks if an entity is registered and exists.
+   * @param entity Entity object or its ID.
+   */
   exists(entity: T | number): boolean;
 
+  /**
+   * Finds and returns an entity by instance or ID.
+   * @param entity Entity object or its ID.
+   */
   at(entity: T | number): T;
 }

package/src/entities/index.ts

@@ -1,2 +1,2 @@
-export * from "./entity";
-export * from "./player";
+export * from './entity';
+export * from './player';

package/src/entities/player.ts

@@ -5,24 +5,74 @@ import type { MpVehicle } from '../vehicles';
 export type MpPlayerIdentifierType = 'steam' | 'ip';
 export type PlayerIdentifierType = MpPlayerIdentifierType;
 
+/**
+ * Interface representing a player entity on the server.
+ * @category Entities/Players
+ */
 export interface MpPlayer extends MpEntity<EntityType.Player> {
+  /** The player's current speed and direction vector. */
   readonly velocity: Vector3;
+
+  /** Health value of the player. */
   readonly health: number;
+
+  /** Username or nickname. */
   readonly nickname: string;
+
+  /** Network latency in ms. */
   readonly ping: number;
+
+  /** Active vehicle occupant is in, if any. */
   readonly vehicle: MpVehicle | null;
+
+  /** Most recent vehicle the player occupied. */
   readonly lastVehicle: MpVehicle | null;
+
+  /** The IP address of the player. */
   readonly ip: string;
 
+  /**
+   * Kicks the player from the server.
+   * @param reason The reason message shown to the player.
+   */
   kick(reason?: string): void;
+
+  /**
+   * Gets a specific network identifier.
+   * @param type Identifier type ('steam' or 'ip').
+   */
   getIdentifier(type: PlayerIdentifierType): string;
 
+  /**
+   * Triggers an event on the player's client.
+   * @param eventName Name of the event.
+   * @param args Payload data.
+   */
   emit(eventName: string, ...args: any[]): void;
+
+  /** Mutes the player's audio communication. */
   mute(): void;
 }
 
+/**
+ * Interface representing the player manager.
+ * @category Entities/Players
+ */
 export interface MpPlayers extends MpEntities<MpPlayer> {
+  /**
+   * Disconnects a player from the server.
+   * @param player Player instance or ID.
+   * @param reason Reason string.
+   */
   kick(player: MpPlayer | number, reason?: string): void;
+
+  /**
+   * Retrieves identifier info for a player.
+   * @param player Player instance or ID.
+   * @param type Type of identifier.
+   */
   getIdentifier(player: MpPlayer | number, type: PlayerIdentifierType): string;
+
+  /** Converts the player collection into a standard array. */
   toArray(): MpPlayer[];
 }

package/src/events/events.ts

@@ -1,52 +1,48 @@
-import type { MpPlayer } from "../players";
-import type { MpEventsMap } from "./map";
-
-export interface MpEvents {
-  /**
-   * Listen for a shared (server or client) custom event.
-   * @param eventName The name of the custom event.
-   * @param callback The callback to run when triggered.
-   */
-  on<E extends keyof MpEventsMap>(eventName: E, callback: MpEventsMap[E]): void;
-  on(eventName: string, callback: (...args: any[]) => void): void;
-
-  /**
-   * Listen for a client-side event on the server.
-   * @param eventName The name of the event.
-   * @param callback Function triggered when the event is received.
-   */
-  onClient(
-    eventName: string,
-    callback: (player: MpPlayer, ...args: any[]) => void,
-  ): void;
-
-  /**
-   * Unregister a custom event listener.
-   * @param eventName Name of the event.
-   * @param callback Callback function.
-   */
-  off<E extends keyof MpEventsMap>(
-    eventName: E,
-    callback: MpEventsMap[E],
-  ): void;
-  off(eventName: string, callback: (...args: any[]) => void): void;
-
-  /**
-   * Emit a shared custom event.
-   * @param eventName The event name to emit.
-   * @param args Arguments to pass to the handler.
-   */
-  emit(eventName: string, ...args: any[]): void;
-
-  /**
-   * Emit a client-side event from the server.
-   * @param eventName Resource name to emit from.
-   * @param playerId Target player entity/network ID.
-   * @param args Arguments to send with the event.
-   */
-  emitClient(
-    player: MpPlayer | number,
-    eventName: string,
-    ...args: any[]
-  ): void;
+import type { MpPlayer } from '../players';
+import type { MpEventsMap } from './map';
+
+/**
+ * Event system for subscribing, emitting, and handling multiplayer events.
+ *
+ * Provides both strongly typed and generic event APIs.
+ * @category Events
+ */
+export interface MpEvents {
+  /**
+   * Listen for a shared (server or client) custom event.
+   * @param eventName The name of the custom event.
+   * @param callback The callback to run when triggered.
+   */
+  on<E extends keyof MpEventsMap>(eventName: E, callback: MpEventsMap[E]): void;
+  on(eventName: string, callback: (...args: any[]) => void): void;
+
+  /**
+   * Listen for a client-side event on the server.
+   * @param eventName The name of the event.
+   * @param callback Function triggered when the event is received.
+   */
+  onClient(eventName: string, callback: (player: MpPlayer, ...args: any[]) => void): void;
+
+  /**
+   * Unregister a custom event listener.
+   * @param eventName Name of the event.
+   * @param callback Callback function.
+   */
+  off<E extends keyof MpEventsMap>(eventName: E, callback: MpEventsMap[E]): void;
+  off(eventName: string, callback: (...args: any[]) => void): void;
+
+  /**
+   * Emit a shared custom event.
+   * @param eventName The event name to emit.
+   * @param args Arguments to pass to the handler.
+   */
+  emit(eventName: string, ...args: any[]): void;
+
+  /**
+   * Emit a client-side event from the server.
+   * @param eventName Resource name to emit from.
+   * @param playerId Target player entity/network ID.
+   * @param args Arguments to send with the event.
+   */
+  emitClient(player: MpPlayer | number, eventName: string, ...args: any[]): void;
 }

package/src/events/index.ts

@@ -1,3 +1,3 @@
-export * from "./events";
-export * from "./map";
-export * from "./types";
+export * from './events';
+export * from './map';
+export * from './types';

package/src/events/map.ts

@@ -1,6 +1,6 @@
-import type { VehicleSeat } from "../vehicles";
-import type { EntityType, MpAnyEntity, MpPlayer } from "../entities";
-import type { GameHash, Vector3Object } from "../shared";
+import type { VehicleSeat } from '../vehicles';
+import type { EntityType, MpAnyEntity, MpPlayer } from '../entities';
+import type { GameHash, Vector3Object } from '../shared';
 import type {
   DamageEventData,
   DoorStateChangeEventData,
@@ -19,42 +19,96 @@ import type {
   VehicleDestructionChangeEventData,
   VehicleHittedByPlayerEventData,
   VehicleWeaponShootEventData,
-} from "./types";
+} from './types';
 
+/**
+ * Interface mapping event names to their respective callback signatures.
+ * @category Events
+ */
 export interface MpEventsMap {
+  /** Fires when any resource starts running on the server. */
   anyResourceStart(resourceName: string): void;
+
+  /** Fires when any resource is stopped. */
   anyResourceStop(resourceName: string): void;
+
+  /** Fires when any server-side resource is started. */
   anyServerResourceStart(resourceName: string): void;
+
+  /** Fires when any server-side resource is stopped. */
   anyServerResourceStop(resourceName: string): void;
+
+  /** Fires when the current resource starts. */
   resourceStart(): void;
+
+  /** Fires when the current resource stops. */
   resourceStop(): void;
+
+  /** Fires when all server resources are reloaded/refreshed. */
   resourcesRefresh(): void;
 
+  /** Fires when a player begins connecting to the server. */
   playerConnecting(tempId: number, name: string): void;
+
+  /** Fires once a player has successfully joined the server. */
   playerConnected(playerId: number, tempId: string): void;
+
+  /** Fires when a player spawns into the world. */
   playerSpawn(playerId: number): void;
+
+  /** Fires when a player respawns after death. */
   playerRespawn(playerId: number, data: Vector3Object): void;
+
+  /** Fires when a player is despawned. */
   playerDespawn(playerId: number): void;
+
+  /** Fires when a player dies. */
   playerDeath(playerId: number, data: PlayerDeathEventData): void;
+
+  /** Fires when a player leaves the server. */
   playerDisconnected(playerId: number, reason: string): void;
+
+  /** Fires when a player's character appearance changes. */
   playerAppearanceChange(
     playerId: number,
     data: PlayerAppearanceChangeEventData,
   ): undefined | boolean;
+
+  /** Fires when a player starts healing. */
   playerHealing(playerId: number): undefined | boolean;
+
+  /** Fires when a player is knocked down (ragdolled). */
   playerKnockdown(playerId: number): undefined | boolean;
 
-  globalMetaChange<T = any, K = T>(
-    key: string,
-    newValue: T,
-    oldValue: K,
-  ): undefined | boolean;
+  /**
+   * Fires when global metadata is modified.
+   * @param key The key of the updated metadata.
+   * @param newValue The new value of the metadata.
+   * @param oldValue The previous value of the metadata.
+   */
+  globalMetaChange<T = any, K = T>(key: string, newValue: T, oldValue: K): undefined | boolean;
+
+  /**
+   * Fires when a player's custom metadata is updated.
+   * @param player The player instance.
+   * @param key The metadata key.
+   * @param newValue The new value.
+   * @param oldValue The previous value.
+   */
   playerMetaChange<T = any, K = T>(
     player: MpPlayer,
     key: string,
     newValue: T,
     oldValue: K,
   ): undefined | boolean;
+
+  /**
+   * Fires when metadata on any entity is updated.
+   * @param entity The entity instance.
+   * @param key The metadata key.
+   * @param newValue The new value.
+   * @param oldValue The previous value.
+   */
   entityMetaChange<T = any, K = T>(
     entity: MpAnyEntity,
     key: string,
@@ -62,77 +116,101 @@ export interface MpEventsMap {
     oldValue: K,
   ): undefined | boolean;
 
+  /** Fires when a player takes damage. */
   damage(playerId: number, data: DamageEventData): undefined | boolean;
-  meleeAction(
-    playerId: number,
-    data: MeleeActionEventData,
-  ): undefined | boolean;
-  shootAction(
-    playerId: number,
-    data: ShootActionEventData,
-  ): undefined | boolean;
+
+  /** Fires when a player performs a melee strike. */
+  meleeAction(playerId: number, data: MeleeActionEventData): undefined | boolean;
+
+  /** Fires when a player fires a weapon. */
+  shootAction(playerId: number, data: ShootActionEventData): undefined | boolean;
+
+  /** Fires when a player reloads their firearm. */
   weaponReload(playerId: number, weaponHash: GameHash): undefined | boolean;
-  throwGrenade(
-    playerId: number,
-    data: ThrowGrenadeEventData,
-  ): undefined | boolean;
 
+  /** Fires when a player throws a grenade. */
+  throwGrenade(playerId: number, data: ThrowGrenadeEventData): undefined | boolean;
+
+  /** Fires when a fire source is created. */
   fire(playerId: number, data: FireEventData): undefined | boolean;
+
+  /** Fires when an explosion is triggered. */
   explosion(playerId: number, data: ExplosionEventData): undefined | boolean;
 
-  doorStateChange(
-    playerId: number,
-    data: DoorStateChangeEventData,
-  ): undefined | boolean;
-  liftStateChange(
-    playerId: number,
-    data: LiftStateChangeEventData,
-  ): undefined | boolean;
+  /** Fires when a door's open/close state is altered. */
+  doorStateChange(playerId: number, data: DoorStateChangeEventData): undefined | boolean;
+
+  /** Fires when a lift (elevator) changes state. */
+  liftStateChange(playerId: number, data: LiftStateChangeEventData): undefined | boolean;
 
+  /** Fires when any server entity is spawned. */
   entitySpawn(id: number, type: EntityType): void;
+
+  /** Fires when any server entity is despawned. */
   entityDespawn(id: number, type: EntityType): void;
+
+  /** Fires when a generic object spawns. */
   objectSpawn(id: number): void;
+
+  /** Fires when a generic object despawns. */
   objectDespawn(id: number): void;
+
+  /** Fires when a Ped (NPC) spawns. */
   pedSpawn(id: number): void;
+
+  /** Fires when a Ped (NPC) despawns. */
   pedDespawn(id: number): void;
+
+  /** Fires when a game object spawns. */
   gameObjectSpawn(id: number): void;
+
+  /** Fires when a game object despawns. */
   gameObjectDespawn(id: number): void;
 
-  vehicleCustomizationChange(
-    playerId: number,
-    data: VehicleCustomizationChangeEventData,
-  ): void;
-  vehicleDestructionChange(
-    playerId: number,
-    data: VehicleDestructionChangeEventData,
-  ): void;
+  /** Fires when a vehicle's appearance/customization changes. */
+  vehicleCustomizationChange(playerId: number, data: VehicleCustomizationChangeEventData): void;
+
+  /** Fires when a vehicle's damage/destruction state updates. */
+  vehicleDestructionChange(playerId: number, data: VehicleDestructionChangeEventData): void;
+
+  /** Fires when a vehicle entity spawns. */
   vehicleSpawn(id: number): void;
+
+  /** Fires when a vehicle entity despawns. */
   vehicleDespawn(id: number): void;
-  vehicleWeaponShoot(
-    id: number,
-    data: VehicleWeaponShootEventData,
-  ): undefined | boolean;
-  vehicleHittedByPlayer(
-    id: number,
-    data: VehicleHittedByPlayerEventData,
-  ): undefined | boolean;
+
+  /** Fires when a vehicle-mounted weapon is fired. */
+  vehicleWeaponShoot(id: number, data: VehicleWeaponShootEventData): undefined | boolean;
+
+  /** Fires when a vehicle is hit by a player. */
+  vehicleHittedByPlayer(id: number, data: VehicleHittedByPlayerEventData): undefined | boolean;
+
+  /** Fires when a player exits a vehicle. */
   exitVehicle(id: number): void;
+
+  /** Fires when a player enters a vehicle. */
   enterVehicle(id: number, seat: VehicleSeat): void;
 
-  pickupChange(
-    playerId: number,
-    data: PickupChangeEventData,
-  ): undefined | boolean;
-  pickupRaise(
-    playerId: number,
-    data: PickupDespawnEventData,
-  ): undefined | boolean;
-  pickupDrop(
-    playerId: number,
-    data: PickupCreateEventData,
-  ): undefined | boolean;
+  /** Fires when a player exits a vehicle. */
+  playerExitVehicle(playerId: number, vehicleId: number): void;
+
+  /** Fires when a player enters a vehicle. */
+  playerEnterVehicle(playerId: number, vehicleId: number, seat: VehicleSeat): void;
+
+  /** Fires when a pickup's state or inventory changes. */
+  pickupChange(playerId: number, data: PickupChangeEventData): undefined | boolean;
+
+  /** Fires when a player picks up an item. */
+  pickupRaise(playerId: number, data: PickupDespawnEventData): undefined | boolean;
+
+  /** Fires when a player drops an item. */
+  pickupDrop(playerId: number, data: PickupCreateEventData): undefined | boolean;
+
+  /** Fires when a pickup spawns. */
   pickupSpawn(id: number): void;
+
+  /** Fires when a pickup despawns. */
   pickupDespawn(id: number): void;
 }
 
-export type { MeleeActionType } from "./types";
+export type { MeleeActionType } from './types';

package/src/events/types.ts

@@ -1,5 +1,9 @@
 import type { GameHash, Vector3Object } from '../shared';
 
+/**
+ * Data describing a damage event between players.
+ * @category Events/Players
+ */
 export interface DamageEventData {
   damageType: number;
   weaponHash: GameHash;
@@ -23,6 +27,9 @@ export interface DamageEventData {
   physicsMaterials: string[];
 }
 
+/**
+ * @category Events/Players
+ */
 export enum MeleeActionType {
   QuickMelee = 1,
   ComboAttack1 = 2,
@@ -34,17 +41,26 @@ export enum MeleeActionType {
   CrouchAttack = 8,
 }
 
+/**
+ * @category Events/Players
+ */
 export type MeleeActionEventData = Vector3Object & {
   type: MeleeActionType;
   weaponHash: GameHash;
   instigatorID: number;
 };
 
+/**
+ * @category Events/Players
+ */
 export type ShootActionEventData = Vector3Object & {
   weaponHash: GameHash;
   instigatorID: number;
 };
 
+/**
+ * @category Events/Players
+ */
 export interface ThrowGrenadeEventData {
   weaponHash: GameHash;
   type: number;
@@ -59,11 +75,19 @@ export interface ThrowGrenadeEventData {
   aimposZ: number;
 }
 
+/**
+ * Data for a door state change event.
+ * @category Events/World
+ */
 export type DoorStateChangeEventData = Vector3Object & {
   hashObject: GameHash;
   state: boolean;
 };
 
+/**
+ * Data for lift/elevator state changes.
+ * @category Events/World
+ */
 export type LiftStateChangeEventData = Vector3Object & {
   hashObject: GameHash;
   playerID: number;
@@ -72,6 +96,10 @@ export type LiftStateChangeEventData = Vector3Object & {
   maxFloor: number;
 };
 
+/**
+ * Explosion event information.
+ * @category Events/World
+ */
 export type ExplosionEventData = Vector3Object & {
   isVehicle: boolean;
   vehicleID: number;
@@ -79,6 +107,9 @@ export type ExplosionEventData = Vector3Object & {
   objNetID: number;
 };
 
+/**
+ * @category Events/Players
+ */
 export interface AppearancePropertyData {
   meshType: number;
   isEnabed: boolean;
@@ -87,12 +118,18 @@ export interface AppearancePropertyData {
   chunkMask: GameHash;
 }
 
+/**
+ * @category Events/Players
+ */
 export interface AppearanceWeightPropertyData {
   targetHash: GameHash;
   regionHash: GameHash;
   weight: number;
 }
 
+/**
+ * @category Events/Players
+ */
 export interface PlayerAppearanceChangeEventData {
   skinneds: AppearancePropertyData[];
   garments: AppearancePropertyData[];
@@ -100,10 +137,16 @@ export interface PlayerAppearanceChangeEventData {
   weights: AppearanceWeightPropertyData[];
 }
 
+/**
+ * @category Events/Players
+ */
 export interface PlayerDeathEventData {
   killerId?: number;
 }
 
+/**
+ * @category Events/Vehicles
+ */
 export interface VehicleCustomizationChangeEventData {
   isVehicleWasCustomized: boolean;
   isEnabledVehCustomization: boolean;
@@ -122,6 +165,9 @@ export interface VehicleCustomizationChangeEventData {
   hashAppearance: GameHash;
 }
 
+/**
+ * @category Events/Vehicles
+ */
 export interface VehicleDestructionChangeEventData {
   vehicleID: number;
   brokenGlass: number;
@@ -130,6 +176,9 @@ export interface VehicleDestructionChangeEventData {
   windshieldShattered: boolean;
 }
 
+/**
+ * @category Events/Vehicles
+ */
 export interface VehicleWeaponShootEventData {
   type: number;
   numBullets: number;
@@ -148,12 +197,18 @@ export interface VehicleWeaponShootEventData {
   tracePosZ: number;
 }
 
+/**
+ * @category Events/Vehicles
+ */
 export interface VehicleHittedByPlayerEventData {
   componentNameHash: GameHash;
   tweaponHash: GameHash;
   byOwner: boolean;
 }
 
+/**
+ * @category Events/World
+ */
 export type FireEventData = Vector3Object & {
   hashObject: GameHash;
   dirX: number;
@@ -161,18 +216,27 @@ export type FireEventData = Vector3Object & {
   dirZ: number;
 };
 
+/**
+ * @category Events/Pickups
+ */
 export interface PickupChangeEventData {
   pickupNetId: number;
   pickupHash: GameHash;
   pickupHashes: GameHash[];
 }
 
+/**
+ * @category Events/Pickups
+ */
 export interface PickupDespawnEventData {
   pickupNetId: number;
   pickupHash: GameHash;
   isBag: boolean;
 }
 
+/**
+ * @category Events/Pickups
+ */
 export type PickupCreateEventData = Vector3Object & {
   pickupNetId: number;
   pickupHash: GameHash;
@@ -181,4 +245,3 @@ export type PickupCreateEventData = Vector3Object & {
 };
 
 export type PickupDropEventData = PickupCreateEventData;
-

package/src/exports.ts

@@ -1,12 +1,12 @@
-export type MpExports = MpExternalExports & MpCreateExport;
-
-interface MpExternalExports {
-  [module: string]: {
-    [name: string]: <T extends unknown[] = unknown[], R = unknown>(...args: T) => R | Promise<R>;
-  };
-}
-
-type MpCreateExport = <T extends unknown[] = unknown[], R = unknown>(
-  name: string,
-  callback: (...args: T) => R | Promise<R>,
-) => void;
+export type MpExports = MpExternalExports & MpCreateExport;
+
+interface MpExternalExports {
+  [module: string]: {
+    [name: string]: <T extends unknown[] = unknown[], R = unknown>(...args: T) => R | Promise<R>;
+  };
+}
+
+type MpCreateExport = <T extends unknown[] = unknown[], R = unknown>(
+  name: string,
+  callback: (...args: T) => R | Promise<R>,
+) => void;

package/src/meta.ts

@@ -1,23 +1,16 @@
 import type { MpEntity } from './entities';
 import type { MpPlayer } from './players';
 
+/**
+ * Sets/gets metadata for the any entity.
+ */
 export interface MpMeta {
   setGlobalMeta(key: string, value: any, sync?: boolean): void;
   getGlobalMeta<T = any>(key: string): T;
 
-  setPlayerMeta(
-    player: MpPlayer | number,
-    key: string,
-    value: any,
-    sync?: boolean,
-  ): void;
+  setPlayerMeta(player: MpPlayer | number, key: string, value: any, sync?: boolean): void;
   getPlayerMeta<T = any>(player: MpPlayer | number, key: string): T;
 
-  setEntityMeta(
-    entity: MpEntity | number,
-    key: string,
-    value: any,
-    sync?: boolean,
-  ): void;
+  setEntityMeta(entity: MpEntity | number, key: string, value: any, sync?: boolean): void;
   getEntityMeta<T = any>(entity: MpEntity | number, key: string): T;
 }

package/src/mp/config.d.ts

@@ -1,5 +1,5 @@
 export namespace MpServer {
-  export interface CoreOverrides {
+  export interface CoreConfigOverrides {
     change_player_on_death_logic?: boolean;
     disable_side_quests_notifications?: boolean;
     change_vehicles_logic?: boolean;
@@ -13,6 +13,8 @@ export namespace MpServer {
     disable_no_combat?: boolean;
   }
 
+  export type CoreOverrides = CoreConfigOverrides;
+
   export interface CoreConfig {
     nametags?: boolean;
     death_autostand?: boolean;
@@ -22,11 +24,12 @@ export namespace MpServer {
     disable_drop_points?: boolean;
     disable_location_dependent_quests?: boolean;
     disable_garage?: boolean;
-    overrides?: CoreOverrides;
+    overrides?: CoreConfigOverrides;
     files?: string[];
   }
 
   export interface ServerConfig {
+    [key: string]: any;
     tcp_host: string;
     udp_host: string;
     connection_host_addr: string;
@@ -34,10 +37,21 @@ export namespace MpServer {
     secret_token: string;
     resources: string[];
     disable_VoIP_server: boolean;
+    disable_voice: boolean;
     core?: CoreConfig;
   }
 }
 
+/**
+ * @category Global/Config
+ */
+export type CoreConfigOverrides = MpServer.CoreConfigOverrides;
 export type CoreOverrides = MpServer.CoreOverrides;
+/**
+ * @category Global/Config
+ */
 export type CoreConfig = MpServer.CoreConfig;
+/**
+ * @category Global/Config
+ */
 export type ServerConfig = MpServer.ServerConfig;

package/src/mp/index.d.ts

@@ -1,3 +1,3 @@
-export type { CoreConfig, CoreOverrides, ServerConfig } from "./config";
-export * from "./multiplayer";
-export * from "./internal-multiplayer";
+export type { CoreConfig, CoreOverrides, ServerConfig } from './config';
+export * from './multiplayer';
+export * from './internal-multiplayer';

package/src/mp/multiplayer.d.ts

@@ -45,4 +45,4 @@ export interface MpServer {
   config: MpServ.ServerConfig & Record<string, string>;
 }
 
-export const mp: MpServer;
+export declare const mp: MpServer;

package/src/objects.ts

@@ -1,22 +1,56 @@
 import type { EntityType, MpEntities, MpEntity } from './entities';
 import type { TweakDBID, Vector3 } from './shared';
 
+/**
+ * Interface representing a spawned static or dynamic object.
+ * @category Entities/Objects
+ */
 export interface MpObject extends MpEntity<EntityType.GameObject> {
+  /** The TweakDBID model hash of this object. */
   readonly model: TweakDBID;
 
+  /** Deletes the object from the world. */
   destroy(): void;
 }
 
+/**
+ * Options configuration for spawning an object.
+ * @category Entities/Objects
+ */
 export interface CreateObjectOptions {
+  /** Model TweakDBID to spawn. */
   model: TweakDBID;
+
+  /** Location coordinates. */
   position: Vector3;
+
+  /** Heading direction (yaw) in degrees. */
   yaw?: number;
+
+  /** If true, physics simulation is enabled on the object. */
   dynamic?: boolean;
+
+  /** The virtual dimension assigned to the object. */
   dimension?: number;
 }
 
+/**
+ * Interface for managing world objects.
+ * @category Entities/Objects
+ */
 export interface MpObjects extends MpEntities<MpObject> {
+  /**
+   * Spawns a new object into the world.
+   * @param options Object configuration properties.
+   */
   create(options: CreateObjectOptions): MpObject;
+
+  /**
+   * Removes and deletes an object.
+   * @param entity Object instance or its ID.
+   */
   destroy(entity: MpObject | number): void;
+
+  /** Converts the object collection to a standard array. */
   toArray(): MpObject[];
 }

package/src/peds.ts

@@ -1,27 +1,65 @@
 import type { EntityType, MpEntities, MpEntity } from './entities';
 import type { CName, TweakDBID, Vector3 } from './shared';
 
+/**
+ * Interface representing an NPC (Ped) entity.
+ * @category Entities/Peds
+ */
 export interface MpPed extends MpEntity<EntityType.Ped> {
+  /** Current health value of the NPC. */
   readonly health: number;
+
+  /** Model TweakDBID hash of the Ped. */
   readonly model: TweakDBID;
+
+  /** Active appearance name. */
   readonly appearance: CName;
 
+  /** Deletes the NPC from the server. */
   destroy(): void;
 }
 
+/**
+ * Configuration properties for spawning a new Ped.
+ * @category Entities/Peds
+ */
 export interface CreatePedOptions {
+  /** Model TweakDBID. */
   model: TweakDBID;
+
+  /** Appearance identification hash. */
   appearance: CName;
+
+  /** Coordinates for spawning. */
   position: Vector3;
+
+  /** Starting health value. */
   health?: number;
+
+  /** Starting rotation yaw angle. */
   yaw?: number;
+
+  /** Dimension world ID. */
   dimension?: number;
 }
 
+/**
+ * Manager interface for handling Peds.
+ * @category Entities/Peds
+ */
 export interface MpPeds extends MpEntities<MpPed> {
+  /**
+   * Spawns a new Ped into the server environment.
+   * @param options Spawn options and properties.
+   */
   create(options: CreatePedOptions): MpPed;
 
+  /**
+   * Destroys and despawns the Ped.
+   * @param ped Ped instance or its ID.
+   */
   destroy(ped: MpPed | number): void;
 
+  /** Converts the Ped collection to a standard array. */
   toArray(): MpPed[];
 }

package/src/pickups.ts

@@ -1,27 +1,60 @@
 import type { EntityType, MpEntities, MpEntity } from './entities';
 import type { TweakDBID, Vector3 } from './shared';
 
+/**
+ * Enumeration representing categories of item pickups.
+ * @category Entities/Pickups
+ */
 export enum PickupType {
   Clothes = 1,
   Weapon = 2,
   Other = 3,
 }
 
+/**
+ * Interface representing a world item pickup entity.
+ * @category Entities/Pickups
+ */
 export interface MpPickup extends MpEntity<EntityType.Pickup> {
+  /** The model TweakDBID hash of this pickup. */
   readonly model: TweakDBID;
+
+  /** Classification type of the pickup. */
   readonly pickupType: PickupType;
 
+  /** Deletes the pickup entity. */
   destroy(): void;
 }
 
+/**
+ * Configuration options for spawning a pickup.
+ * @category Entities/Pickups
+ */
 export interface CreatePickupOptions {
+  /** Model TweakDBID of the item. */
   model: TweakDBID;
+
+  /** Classification category type. */
   type: PickupType;
+
+  /** Spawning coordinates. */
   position: Vector3;
+
+  /** Starting heading yaw rotation in degrees. */
   yaw?: number;
+
+  /** Target dimension world ID. */
   dimension?: number;
-};
+}
 
+/**
+ * Manager interface for item pickups.
+ * @category Entities/Pickups
+ */
 export interface MpPickups extends MpEntities<MpPickup> {
+  /**
+   * Spawns a new item pickup into the server world.
+   * @param options Pickup spawning configuration.
+   */
   create(options: CreatePickupOptions): MpPickup;
 }

package/src/resources.ts

@@ -1,4 +1,11 @@
 export interface MpResources {
+  /**
+   * Reads a TOML configuration file and returns its raw contents.
+   * @param name Name or key of the TOML file.
+   * @returns Raw TOML string.
+   */
+  getTOML(name: string): string;
+
   /**
    * Gets the current state of a resource.
    * @param resourceName The resource to check.
@@ -19,11 +26,16 @@ export interface MpResources {
   stop(resourceName: string): void;
 
   /**
- * Restarts a specific resource by name.
- * @param resourceName Name of the resource to restart.
- */
+   * Restarts a specific resource by name.
+   * @param resourceName Name of the resource to restart.
+   */
   restart(resourceName: string): void;
 
+  /**
+   * Re-indexes all resources.
+   */
+  refresh(): void;
+
   /**
    * Gets the current resource's name.
    * @returns Resource name.

package/src/shared/hash.ts

@@ -1,4 +1,16 @@
-export type GameHash = bigint | number;
-export type TweakDBID = GameHash;
-export type CName = GameHash;
-export type ResRef = GameHash;
+/**
+ * @category Hashes
+ */
+export type GameHash = bigint | number;
+/**
+ * @category Hashes
+ */
+export type TweakDBID = GameHash;
+/**
+ * @category Hashes
+ */
+export type CName = GameHash;
+/**
+ * @category Hashes
+ */
+export type ResRef = GameHash;

package/src/shared/index.ts

@@ -1,6 +1,9 @@
-export * from "./transform";
-export * from "./hash";
+export * from './transform';
+export * from './hash';
 
+/**
+ * @ignore
+ */
 export interface Class<T, Arguments extends unknown[] = any[]> {
   prototype: Pick<T, keyof T>;
   new (...arguments_: Arguments): T;

package/src/shared/transform.ts

@@ -1,9 +1,31 @@
-export type Vector3 = [x: number, y: number, z: number];
-export type Vector4 = [x: number, y: number, z: number, w: number];
-export type Rotation = [pitch: number, roll: number, yaw: number];
-
-export interface Vector3Object {
-    posX: number;
-    posY: number;
-    posZ: number;
-}
+/**
+ * 0 - x
+ * 1 - y
+ * 2 - z
+ * @category Global
+ */
+export type Vector3 = [x: number, y: number, z: number];
+/**
+ * 0 - x
+ * 1 - y
+ * 2 - z
+ * 3 - w
+ * @category Global
+ */
+export type Vector4 = [x: number, y: number, z: number, w: number];
+/**
+ * 0 - pitch
+ * 1 - roll
+ * 2 - yaw
+ * @category Global
+ */
+export type Rotation = [pitch: number, roll: number, yaw: number];
+
+/**
+ * @category Events/World
+ */
+export interface Vector3Object {
+  posX: number;
+  posY: number;
+  posZ: number;
+}

package/src/vehicles.ts

@@ -1,7 +1,11 @@
-import type { EntityType, MpEntities, MpEntity } from "./entities";
-import type { MpPlayer } from "./players";
-import type { CName, TweakDBID, Vector3 } from "./shared";
+import type { EntityType, MpEntities, MpEntity } from './entities';
+import type { MpPlayer } from './players';
+import type { CName, TweakDBID, Vector3 } from './shared';
 
+/**
+ * Enumeration representing available seating positions inside a vehicle.
+ * @category Entities/Vehicles
+ */
 export enum VehicleSeat {
   Driver = 0,
   Passenger = 1,
@@ -9,41 +13,107 @@ export enum VehicleSeat {
   RearRight = 3,
 }
 
+/**
+ * Interface representing a vehicle entity on the server.
+ * @category Entities/Vehicles
+ */
 export interface MpVehicle extends MpEntity<EntityType.Vehicle> {
+  /** The model TweakDBID hash of the vehicle. */
   readonly model: TweakDBID;
+
+  /** Active appearance name. */
   readonly appearance: CName;
+
+  /** Current durability/health value of the vehicle. */
   readonly health: number;
+
+  /** Physical velocity vector. */
   readonly velocity: Vector3;
+
+  /** Angular velocity vector. */
   readonly angularVelocity: Vector3;
 
+  /** Seating positions mapping players currently in the vehicle. */
   seats: MpVehicleSeats;
 
+  /** Seating positions mapping players who last occupied the vehicle. */
   lastSeats: MpVehicleSeats;
 
+  /**
+   * Retrieves the occupant of a specific seat.
+   * @param seat Seating position (e.g. Driver).
+   */
   getPlayerInSeat(seat: VehicleSeat): MpPlayer | null;
+
+  /**
+   * Retrieves the last occupant of a specific seat.
+   * @param seat Seating position.
+   */
   getLastPlayerInSeat(seat: VehicleSeat): MpPlayer | null;
 
+  /** Deletes the vehicle entity from the server. */
   destroy(): void;
 }
 
+/**
+ * Structure representing mapped occupants for each vehicle seat.
+ * @category Entities/Vehicles
+ */
 export interface MpVehicleSeats {
+  /** Player in driver seat. */
   readonly driver: MpPlayer | null;
+
+  /** Player in front passenger seat. */
   readonly passenger: MpPlayer | null;
+
+  /** Player in rear left seat. */
   readonly rearLeft: MpPlayer | null;
+
+  /** Player in rear right seat. */
   readonly rearRight: MpPlayer | null;
 }
 
+/**
+ * Configuration properties for spawning a new vehicle.
+ * @category Entities/Vehicles
+ */
 export interface CreateVehicleOptions {
+  /** Vehicle model TweakDBID. */
   model: TweakDBID;
+
+  /** Appearance record name. */
   appearance: CName;
+
+  /** Spawning location coordinates. */
   position: Vector3;
+
+  /** Initial heading yaw angle in degrees. */
   yaw?: number;
+
+  /** Initial health value. */
   health?: number;
+
+  /** Initial dimension world ID. */
   dimension?: number;
 }
 
+/**
+ * Manager interface for handling vehicles.
+ * @category Entities/Vehicles
+ */
 export interface MpVehicles extends MpEntities<MpVehicle> {
+  /**
+   * Spawns a new vehicle into the world.
+   * @param options Vehicle configuration and attributes.
+   */
   create(options: CreateVehicleOptions): MpVehicle;
+
+  /**
+   * Despawns and deletes a vehicle.
+   * @param vehicle Vehicle instance or ID.
+   */
   destroy(vehicle: MpVehicle | number): void;
+
+  /** Converts the vehicle collection to a standard array. */
   toArray(): MpVehicle[];
 }