@cybermp-community/server-types 1.0.3 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cybermp-community/server-types",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "TypeScript type definitions for the CyberMP server-side environment.",
   "license": "MIT",
   "author": {

package/src/events/events.d.ts

@@ -0,0 +1,52 @@
+import { MpPlayer } from "../entities";
+import { 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;
+}

package/src/events/index.d.ts

@@ -1,52 +1,2 @@
-import { MpPlayer } from "../entities";
-import { 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;
-}
+export * from "./events";
+export * from "./map";

package/src/hashes.d.ts

@@ -1,7 +1,27 @@
 import type { CName, ResRef, TweakDBID } from './shared';
 
+/**
+ * Interface providing utility methods to hash object paths into internal types.
+ */
 export interface MpHashes {
+  /**
+   * Converts a string path into a TweakDBID hash.
+   * @param path - The string path of entry.
+   * @returns The corresponding TweakDBID.
+   */
   tweakdbid(path: string): TweakDBID;
+
+  /**
+   * Converts a string path into a CName hash.
+   * @param path - The string path of entry.
+   * @returns The corresponding CName.
+   */
   cname(path: string): CName;
+
+  /**
+   * Converts a string path into a ResRef hash.
+   * @param path - The string path of entry.
+   * @returns The corresponding ResRef.
+   */
   resref(path: string): ResRef;
 }

package/src/mp/index.d.ts

@@ -1,38 +1,2 @@
-import type { MpCommands } from '../commands';
-import type { MpEntities } from '../entities';
-import type { MpEvents } from '../events';
-import type { MpHashes } from '../hashes';
-import type { MpMeta } from '../meta';
-import type { MpObjects } from '../objects';
-import type { MpPeds } from '../peds';
-import type { MpPickups } from '../pickups';
-import type { MpPlayers } from '../entities/player';
-import type { MpResources } from '../resources';
-import type { MpVehicles } from '../vehicles';
-import type { MpServer as MpServ } from './config';
-import type { MpExports } from '../exports';
-
-export interface MpServer {
-  events: MpEvents;
-  exports: MpExports;
-  meta: MpMeta;
-  resources: MpResources;
-  commands: MpCommands;
-  entities: MpEntities;
-  vehicles: MpVehicles;
-  players: MpPlayers;
-  objects: MpObjects;
-  pickups: MpPickups;
-  peds: MpPeds;
-  hashes: MpHashes;
-
-  /**
-   * Checks if the code is running on the server.
-   * @returns True if running on server, false otherwise.
-   */
-  isServer(): boolean;
-
-  config: MpServ.ServerConfig;
-}
-
-export const mp: MpServer;
+export * from "./multiplayer"
+export * from "./internal-multiplayer";

package/src/mp/internal-multiplayer.d.ts

@@ -0,0 +1,13 @@
+import type { MpVoiceChat } from '../voice-chat';
+
+/**
+ * @deprecated This interface will be removed in future versions.
+ */
+export interface InternalMpServer {
+  voiceChat: MpVoiceChat
+}
+
+/**
+ * @deprecated This variable will be removed in future versions.
+ */
+export const internalMp: InternalMpServer;

package/src/mp/multiplayer.d.ts

@@ -0,0 +1,38 @@
+import type { MpCommands } from '../commands';
+import type { MpEntities } from '../entities';
+import type { MpEvents } from '../events';
+import type { MpHashes } from '../hashes';
+import type { MpMeta } from '../meta';
+import type { MpObjects } from '../objects';
+import type { MpPeds } from '../peds';
+import type { MpPickups } from '../pickups';
+import type { MpPlayers } from '../entities/player';
+import type { MpResources } from '../resources';
+import type { MpVehicles } from '../vehicles';
+import type { MpServer as MpServ } from './config';
+import type { MpExports } from '../exports';
+
+export interface MpServer {
+  events: MpEvents;
+  exports: MpExports;
+  meta: MpMeta;
+  resources: MpResources;
+  commands: MpCommands;
+  entities: MpEntities;
+  vehicles: MpVehicles;
+  players: MpPlayers;
+  objects: MpObjects;
+  pickups: MpPickups;
+  peds: MpPeds;
+  hashes: MpHashes;
+
+  /**
+   * Checks if the code is running on the server.
+   * @returns True if running on server, false otherwise.
+   */
+  isServer(): boolean;
+
+  config: MpServ.ServerConfig & Record<string, string>;
+}
+
+export const mp: MpServer;

package/src/resources.d.ts

@@ -18,6 +18,10 @@ export interface MpResources {
    */
   stop(resourceName: string): void;
 
+  /**
+ * Restarts a specific resource by name.
+ * @param resourceName Name of the resource to restart.
+ */
   restart(resourceName: string): void;
 
   /**

package/src/voice-chat.d.ts

@@ -1,9 +1,26 @@
 import type { MpPlayer } from './entities';
 
+/**
+ * Interface representing the voice chat management system on the server.
+ */
 export interface MpVoiceChat {
-  mutePlayer(player: MpPlayer | number): void;
+  /**
+   * Mutes or unmutes a specific player.
+   * @param player - The player instance or their unique ID.
+   * @param state - Set to `true` to mute, `false` to unmute.
+   */
+  mutePlayer(player: MpPlayer | number, state: boolean): void;
 
+  /**
+   * Creates a new voice chat channel.
+   * @param voiceId - The unique identifier for the voice channel.
+   */
   createChannel(voiceId: number): void;
 
+  /**
+   * Checks whether a specific player is currently muted in the voice chat.
+   * @param player - The player instance or their unique ID.
+   * @returns `true` if the player is muted, `false` otherwise.
+   */
   isPlayerMuted(player: MpPlayer | number): boolean;
 }