@cybermp/client-types 2.2.2 → 2.3.2

package/precomputed/local-storage.d.ts

@@ -1,37 +1,37 @@
-/**
- * Interface providing access to persistent client-side key-value storage.
- * Data saved here remains available across different game sessions and server reconnections.
- */
-export interface MpLocalStorage {
-  /**
-   * Associates a string value with a specific key in the storage database.
-   * If the key already exists, its value will be overwritten.
-   * @param key - The unique identifier name for the storage entry.
-   * @param value - The plaintext string data payload to be stored.
-   */
-  set(key: string, value: string): void;
-
-  /**
-   * Retrieves the stored string value associated with the specified key.
-   * @param key - The unique identifier name of the entry to fetch.
-   * @returns The stored string value, or an empty string/null if the key does not exist.
-   */
-  get(key: string): string;
-
-  /**
-   * Permanently removes a specific key-value entry from the storage map.
-   * @param key - The unique identifier name of the entry to delete.
-   */
-  delete(key: string): void;
-
-  /**
-   * Clears all keys and values currently held in this resource's local storage instance.
-   */
-  deleteAll(): void;
-
-  /**
-   * Explicitly flushes the current state of the in-memory storage data down to the physical disk.
-   * Use this to ensure volatile data isn't lost if the game client unexpectedly crashes.
-   */
-  save(): void;
-}
+/**
+ * Interface providing access to persistent client-side key-value storage.
+ * Data saved here remains available across different game sessions and server reconnections.
+ */
+export interface MpLocalStorage {
+  /**
+   * Associates a string value with a specific key in the storage database.
+   * If the key already exists, its value will be overwritten.
+   * @param key - The unique identifier name for the storage entry.
+   * @param value - The plaintext string data payload to be stored.
+   */
+  set(key: string, value: string): void;
+
+  /**
+   * Retrieves the stored string value associated with the specified key.
+   * @param key - The unique identifier name of the entry to fetch.
+   * @returns The stored string value, or an empty string/null if the key does not exist.
+   */
+  get(key: string): string;
+
+  /**
+   * Permanently removes a specific key-value entry from the storage map.
+   * @param key - The unique identifier name of the entry to delete.
+   */
+  delete(key: string): void;
+
+  /**
+   * Clears all keys and values currently held in this resource's local storage instance.
+   */
+  deleteAll(): void;
+
+  /**
+   * Explicitly flushes the current state of the in-memory storage data down to the physical disk.
+   * Use this to ensure volatile data isn't lost if the game client unexpectedly crashes.
+   */
+  save(): void;
+}

package/precomputed/local.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Manages local player lifecycle operations and the creation of client-side entities.
+ */
+export interface MpLocal {
+  /**
+   * Spawns local player
+   * @param x - Horizontal grid position coordinate value.
+   * @param y - Vertical grid position coordinate value.
+   * @param z - Height grid elevation coordinate value.
+   * @param yaw - The horizontal rotation layout angle in degrees.
+   * @returns `true` if the spawn lifecycle sequence initiated successfully, otherwise `false`.
+   */
+  spawnPlayer(x: number, y: number, z: number, yaw: number): boolean;
+
+  /**
+   * Instantiates a localized ped entity.
+   * This entity remains completely un-synchronized and invisible to other remote clients.
+   * @param skinHash - Asset model signature key hash.
+   * @param appHash - Visual appearance setup key components variation hash.
+   * @param x - Horizontal coordinate space.
+   * @param y - Vertical coordinate space.
+   * @param z - Elevation height space coordinate.
+   * @param yaw - Rotational alignment facing angle.
+   * @param streaming - Controls if engine virtualization automatically handles streaming boundaries tracking.
+   * @returns The resulting unique local game entity handle ID.
+   */
+  spawnPed(
+    skinHash: number | bigint,
+    appHash: number | bigint,
+    x: number,
+    y: number,
+    z: number,
+    yaw: number,
+    streaming: boolean,
+  ): number;
+
+  /**
+   * Instantiates a localized vehicle entity inside the engine environment.
+   * This entity remains completely un-synchronized and invisible to other remote clients.
+   * @param skinHash - Asset model signature key hash.
+   * @param appHash - Visual appearance setup key components variation hash.
+   * @param x - Horizontal coordinate space.
+   * @param y - Vertical coordinate space.
+   * @param z - Elevation height space coordinate.
+   * @param roll - Longitudinal rotation axis orientation angle.
+   * @param pitch - Lateral rotation axis orientation angle.
+   * @param yaw - Directional heading alignment angle.
+   * @param streaming - Controls if engine virtualization automatically handles streaming boundaries tracking.
+   * @returns The resulting unique local game entity handle ID.
+   */
+  spawnVehicle(
+    skinHash: number | bigint,
+    appHash: number | bigint,
+    x: number,
+    y: number,
+    z: number,
+    roll: number,
+    pitch: number,
+    yaw: number,
+    streaming: boolean,
+  ): number;
+
+  /**
+   * Instantiates a localized world object or dynamic prop entity inside the engine environment.
+   * This entity remains completely un-synchronized and invisible to other remote clients.
+   * @param skinHash - Asset model signature key hash.
+   * @param appHash - Visual appearance setup key components variation hash.
+   * @param x - Horizontal coordinate space.
+   * @param y - Vertical coordinate space.
+   * @param z - Elevation height space coordinate.
+   * @param roll - Longitudinal rotation axis orientation angle.
+   * @param pitch - Lateral rotation axis orientation angle.
+   * @param yaw - Directional heading alignment angle.
+   * @param streaming - Controls if engine virtualization automatically handles streaming boundaries tracking.
+   * @returns The resulting unique local game entity handle ID.
+   */
+  spawnObject(
+    skinHash: bigint | number,
+    appHash: bigint | number,
+    x: number,
+    y: number,
+    z: number,
+    roll: number,
+    pitch: number,
+    yaw: number,
+    streaming: boolean,
+  ): number;
+
+  /**
+   * Forces immediate engine de-allocation and cleanup deletion maps targeting an isolated local pedestrian.
+   * @param hash - Unique local game engine entity instance handle to clear.
+   */
+  despawnPed(hash: number): void;
+
+  /**
+   * Forces immediate engine de-allocation and cleanup deletion maps targeting an isolated local vehicle.
+   * @param hash - Unique local game engine entity instance handle to clear.
+   */
+  despawnVehicle(hash: number): void;
+
+  /**
+   * Forces immediate engine de-allocation and cleanup deletion maps targeting an isolated local object.
+   * @param hash - Unique local game engine entity instance handle to clear.
+   */
+  despawnObject(hash: number): void;
+}

package/precomputed/meta.d.ts

@@ -1,78 +1,78 @@
-/**
- * Interface managing cross-resource and synchronized state metadata across the network layer.
- * Allows attaching arbitrary data structures to globals, specific players, the local player, or synchronized network entities.
- */
-export interface MpMeta {
-  /**
-   * Sets a global metadata value accessible across the entire runtime environment.
-   * @param key - The unique identifier string for the metadata entry.
-   * @param value - The data payload to store (can be any serializable object or primitive).
-   * @param sync - Optional flag. If `true`, synchronizes this metadata across the network to all other clients.
-   */
-  setGlobalMeta(key: string, value: any, sync?: boolean): void;
-
-  /**
-   * Retrieves a global metadata value by its key.
-   * @template T - The expected type of the returned metadata value.
-   * @param key - The unique identifier string of the metadata entry to look up.
-   * @returns The stored global metadata value cast to type T, or undefined if it does not exist.
-   */
-  getGlobalMeta<T = any>(key: string): T;
-
-  /**
-   * Assigns a metadata value to a specific remote player using their unique player network ID.
-   * @param playerId - The network identification integer of the target player.
-   * @param key - The unique identifier string for this player's metadata entry.
-   * @param value - The data payload to attach to the player.
-   * @param sync - Optional flag. If `true`, syncs this change to all other connected clients over the network.
-   */
-  setPlayerMeta(
-    playerId: number,
-    key: string,
-    value: any,
-    sync?: boolean,
-  ): void;
-
-  /**
-   * Retrieves a metadata value attached to a specific remote player.
-   * @template T - The expected type of the returned metadata value.
-   * @param playerId - The network identification integer of the target player.
-   * @param key - The unique identifier string of the player's metadata entry.
-   * @returns The stored metadata value cast to type T, or undefined if it does not exist.
-   */
-  getPlayerMeta<T = any>(playerId: number, key: string): T;
-
-  /**
-   * Sets a metadata value restricted or assigned specifically to the local player instance.
-   * @param key - The unique identifier string for the local player's metadata entry.
-   * @param value - The data payload to store.
-   * @param sync - Optional flag. If `true`, relays this local metadata state out to the server and other clients.
-   */
-  setLocalPlayerMeta(key: string, value: any, sync?: boolean): void;
-
-  /**
-   * Retrieves a metadata value attached specifically to the local player instance.
-   * @template T - The expected type of the returned metadata value.
-   * @param key - The unique identifier string of the local player's metadata entry.
-   * @returns The stored metadata value cast to type T, or undefined if it does not exist.
-   */
-  getLocalPlayerMeta<T = any>(key: string): T;
-
-  /**
-   * Attaches a metadata state payload to any synchronized network entity (e.g., vehicles, props, peds) using its network ID.
-   * @param netId - The network-assigned unique identifier tracking the target entity.
-   * @param key - The unique identifier string for the entity's metadata entry.
-   * @param value - The data payload to attach to the entity.
-   * @param sync - Optional flag. If `true`, synchronizes this entity metadata property to all clients tracking this object.
-   */
-  setEntityMeta(netId: number, key: string, value: any, sync?: boolean): void;
-
-  /**
-   * Retrieves a metadata value associated with a synchronized network entity.
-   * @template T - The expected type of the returned metadata value.
-   * @param netId - The network-assigned unique identifier tracking the target entity.
-   * @param key - The unique identifier string of the entity's metadata entry.
-   * @returns The stored metadata value cast to type T, or undefined if it does not exist.
-   */
-  getEntityMeta<T = any>(netId: number, key: string): T;
-}
+/**
+ * Interface managing cross-resource and synchronized state metadata across the network layer.
+ * Allows attaching arbitrary data structures to globals, specific players, the local player, or synchronized network entities.
+ */
+export interface MpMeta {
+  /**
+   * Sets a global metadata value accessible across the entire runtime environment.
+   * @param key - The unique identifier string for the metadata entry.
+   * @param value - The data payload to store (can be any serializable object or primitive).
+   * @param sync - Optional flag. If `true`, synchronizes this metadata across the network to all other clients.
+   */
+  setGlobalMeta(key: string, value: any, sync?: boolean): void;
+
+  /**
+   * Retrieves a global metadata value by its key.
+   * @template T - The expected type of the returned metadata value.
+   * @param key - The unique identifier string of the metadata entry to look up.
+   * @returns The stored global metadata value cast to type T, or undefined if it does not exist.
+   */
+  getGlobalMeta<T = any>(key: string): T;
+
+  /**
+   * Assigns a metadata value to a specific remote player using their unique player network ID.
+   * @param playerId - The network identification integer of the target player.
+   * @param key - The unique identifier string for this player's metadata entry.
+   * @param value - The data payload to attach to the player.
+   * @param sync - Optional flag. If `true`, syncs this change to all other connected clients over the network.
+   */
+  setPlayerMeta(
+    playerId: number,
+    key: string,
+    value: any,
+    sync?: boolean,
+  ): void;
+
+  /**
+   * Retrieves a metadata value attached to a specific remote player.
+   * @template T - The expected type of the returned metadata value.
+   * @param playerId - The network identification integer of the target player.
+   * @param key - The unique identifier string of the player's metadata entry.
+   * @returns The stored metadata value cast to type T, or undefined if it does not exist.
+   */
+  getPlayerMeta<T = any>(playerId: number, key: string): T;
+
+  /**
+   * Sets a metadata value restricted or assigned specifically to the local player instance.
+   * @param key - The unique identifier string for the local player's metadata entry.
+   * @param value - The data payload to store.
+   * @param sync - Optional flag. If `true`, relays this local metadata state out to the server and other clients.
+   */
+  setLocalPlayerMeta(key: string, value: any, sync?: boolean): void;
+
+  /**
+   * Retrieves a metadata value attached specifically to the local player instance.
+   * @template T - The expected type of the returned metadata value.
+   * @param key - The unique identifier string of the local player's metadata entry.
+   * @returns The stored metadata value cast to type T, or undefined if it does not exist.
+   */
+  getLocalPlayerMeta<T = any>(key: string): T;
+
+  /**
+   * Attaches a metadata state payload to any synchronized network entity (e.g., vehicles, props, peds) using its network ID.
+   * @param netId - The network-assigned unique identifier tracking the target entity.
+   * @param key - The unique identifier string for the entity's metadata entry.
+   * @param value - The data payload to attach to the entity.
+   * @param sync - Optional flag. If `true`, synchronizes this entity metadata property to all clients tracking this object.
+   */
+  setEntityMeta(netId: number, key: string, value: any, sync?: boolean): void;
+
+  /**
+   * Retrieves a metadata value associated with a synchronized network entity.
+   * @template T - The expected type of the returned metadata value.
+   * @param netId - The network-assigned unique identifier tracking the target entity.
+   * @param key - The unique identifier string of the entity's metadata entry.
+   * @returns The stored metadata value cast to type T, or undefined if it does not exist.
+   */
+  getEntityMeta<T = any>(netId: number, key: string): T;
+}