gtac-types 0.0.1

package/src/types/server/functions.d.ts

@@ -0,0 +1,890 @@
+/**
+ * GTAC Server-Side Function Declarations
+ *
+ * Defines all server-side global functions and objects available in the
+ * GTA Connected server runtime. Includes network events (addNetworkHandler,
+ * triggerNetworkEvent), command handlers, client queries, element management,
+ * blip/building/object/ped/pickup/player/vehicle queries, messaging,
+ * key binding, resource management, server information, network statistics,
+ * HTTP requests, file I/O, the server-side `gta` world manipulation API,
+ * player spawning, camera fading, and platform timing.
+ *
+ * All declarations are global — no import required.
+ *
+ * @module types/server/functions
+ * @see https://wiki.gtaconnected.com — GTA Connected Wiki
+ *
+ * @example
+ * // Send a message to all players
+ * message("Welcome to the server!", COLOUR_GREEN);
+ *
+ * @example
+ * // Spawn a vehicle on the server
+ * const car = gta.createVehicle(141, 0, 0, 10, 0, 0, 0);
+ */
+
+// ===== Network Events =====
+
+/**
+ * Registers a handler for a custom network event triggered by clients.
+ * The handler receives the triggering `Client` as the first argument,
+ * followed by any additional data sent by the client.
+ *
+ * @param name - Network event name to listen for.
+ * @param handler - Callback receiving the triggering `Client` and any additional arguments.
+ *
+ * @example
+ * addNetworkHandler("onPlayerRequestSpawn", function(client, skinId) {
+ *     spawnPlayer(client, new Vec3(0, 0, 10), 0, skinId);
+ * });
+ */
+declare function addNetworkHandler(
+    name: string,
+    handler: (client: Client, ...args: any[]) => void
+): void;
+
+/**
+ * Sends a custom network event to a specific client or all clients.
+ * Pass `null` as the client parameter to broadcast to all connected clients.
+ *
+ * @param name - Network event name to trigger.
+ * @param client - Target `Client`, or `null` to broadcast to everyone.
+ * @param args - Any number of additional arguments to send with the event.
+ *
+ * @example
+ * // Send to one client
+ * triggerNetworkEvent("onPlayerData", client, playerData);
+ *
+ * @example
+ * // Broadcast to all clients
+ * triggerNetworkEvent("onWeatherChange", null, newWeatherId);
+ */
+declare function triggerNetworkEvent(
+    name: string,
+    client: Client | null,
+    ...args: any[]
+): void;
+
+// ===== Command Handlers =====
+
+/**
+ * Registers a handler for a chat command (e.g. `/cmd`).
+ * The handler receives the command name, the text after the command,
+ * and the `Client` who issued the command.
+ *
+ * @param name - Command name without the leading slash (e.g. `"help"`, `"kill"`).
+ * @param handler - Callback receiving (command, text, client).
+ *
+ * @example
+ * addCommandHandler("heal", function(cmd, text, client) {
+ *     if (client.player) {
+ *         client.player.health = 100;
+ *         messageClient("You have been healed!", client, COLOUR_GREEN);
+ *     }
+ * });
+ */
+declare function addCommandHandler(
+    name: string,
+    handler: (cmd: string, text: string, client: Client) => void
+): void;
+
+/**
+ * Checks whether a command handler is registered for a given name.
+ *
+ * @param name - Command name to check.
+ * @returns `true` if a handler is registered for this command.
+ */
+declare function hasCommandHandler(name: string): boolean;
+
+/**
+ * Removes a previously registered command handler.
+ *
+ * @param name - Command name to unregister.
+ */
+declare function removeCommandHandler(name: string): void;
+
+/**
+ * Executes a server console command programmatically.
+ *
+ * @param cmd - Command string to execute (as if typed in the server console).
+ */
+declare function consoleCommand(cmd: string): void;
+
+// ===== Client Queries =====
+
+/**
+ * Finds a client by their display name (case-insensitive).
+ *
+ * @param name - Client display name to search for.
+ * @returns The matching `Client`, or `null` if no client has that name.
+ */
+declare function getClient(name: string): Client | null;
+
+/**
+ * Gets the `Client` object associated with a `Player` element.
+ *
+ * @param player - The `Player` element to look up.
+ * @returns The `Client` controlling that player.
+ */
+declare function getClientFromPlayerElement(player: Player): Client;
+
+/**
+ * Returns all currently connected clients.
+ *
+ * @returns Array of all `Client` instances.
+ */
+declare function getClients(): Client[];
+
+/**
+ * The server's own local client (console/shell).
+ * This represents the server console as a client for messaging purposes.
+ */
+declare var localClient: Client;
+
+// ===== Element Functions =====
+
+/**
+ * Destroys an element, removing it from the game world and freeing resources.
+ *
+ * @param element - The element to destroy.
+ *
+ * @example
+ * // Clean up a blip when a mission ends
+ * destroyElement(missionBlip);
+ */
+declare function destroyElement(element: Element): void;
+
+/**
+ * Finds an element by its unique numeric ID.
+ *
+ * @param id - The element's numeric ID.
+ * @returns The matching `Element`, or `null` if no element has that ID.
+ */
+declare function getElementFromId(id: number): Element | null;
+
+/**
+ * Finds an element by its display name.
+ *
+ * @param name - The element name to search for.
+ * @returns The matching `Element`, or `null` if not found.
+ */
+declare function getElementFromName(name: string): Element | null;
+
+/**
+ * Gets all elements of a specific type.
+ *
+ * @param type - Element type string (e.g. `"player"`, `"vehicle"`, `"blip"`).
+ * @returns Array of matching `Element` instances.
+ */
+declare function getElementsByType(type: string): Element[];
+
+// ===== Blip Functions =====
+
+/** Returns the total number of blips on the server. */
+declare function getBlipCount(): number;
+
+/** Returns all blip elements. @returns Array of `Blip`. */
+declare function getBlips(): Blip[];
+
+// ===== Building Functions =====
+
+/** Returns the total number of buildings on the server. */
+declare function getBuildingCount(): number;
+
+/** Returns all building elements. @returns Array of `Building`. */
+declare function getBuildings(): Building[];
+
+// ===== Object Functions =====
+
+/** Returns the total number of objects on the server. */
+declare function getObjectCount(): number;
+
+/** Returns all object elements. @returns Array of `Object`. */
+declare function getObjects(): Object[];
+
+// ===== Ped Functions =====
+
+/** Returns the total number of peds on the server. */
+declare function getPedCount(): number;
+
+/** Returns all ped elements. @returns Array of `Ped`. */
+declare function getPeds(): Ped[];
+
+// ===== Pickup Functions =====
+
+/** Returns the total number of pickups on the server. */
+declare function getPickupCount(): number;
+
+/** Returns all pickup elements. @returns Array of `Pickup`. */
+declare function getPickups(): Pickup[];
+
+// ===== Player Functions =====
+
+/** Returns the total number of connected players. */
+declare function getPlayerCount(): number;
+
+/** Returns all player elements. @returns Array of `Player`. */
+declare function getPlayers(): Player[];
+
+/**
+ * Returns a random connected player, or `null` if no players are connected.
+ * Useful for picking a random target for events.
+ *
+ * @returns A random `Player`, or `null` if none exist.
+ */
+declare function getRandomPlayer(): Player | null;
+
+// ===== Vehicle Functions =====
+
+/** Returns the total number of vehicles on the server. */
+declare function getVehicleCount(): number;
+
+/** Returns all vehicle elements. @returns Array of `Vehicle`. */
+declare function getVehicles(): Vehicle[];
+
+// ===== Messaging =====
+
+/**
+ * Sends a message to all connected clients, displayed in their chat window.
+ *
+ * @param text - The message text to send.
+ * @param colour - Optional colour as a packed number (default: white).
+ *
+ * @example
+ * message("Server restart in 5 minutes!", COLOUR_RED);
+ */
+declare function message(text: string, colour?: number): void;
+
+/**
+ * Sends a message to all clients except one.
+ * Useful for broadcasting messages like "X has joined" without sending
+ * to the player who joined.
+ *
+ * @param client - The client to exclude from the broadcast.
+ * @param message - The message text to send.
+ *
+ * @example
+ * addEventHandler("OnPlayerJoin", function(client) {
+ *     messageAllExcept(client, client.name + " has joined the server!");
+ * });
+ */
+declare function messageAllExcept(client: Client, message: string): void;
+
+/**
+ * Sends a private message to a specific client.
+ *
+ * @param text - The message text.
+ * @param client - The target client to send the message to.
+ * @param colour - Optional colour as a packed number.
+ *
+ * @example
+ * messageClient("Welcome back!", client, COLOUR_GREEN);
+ */
+declare function messageClient(
+    text: string,
+    client: Client,
+    colour?: number
+): void;
+
+// ===== Key Binding =====
+
+/**
+ * Binds a key to a handler function on the server.
+ * The handler receives a `KeyEvent` with press/release and key code info.
+ *
+ * @param key - Key name to bind (e.g. `"F1"`, `"Escape"`, `"T"`).
+ * @param handler - Callback invoked with a `KeyEvent` when the key action occurs.
+ *
+ * @example
+ * bindKey("F1", function(event) {
+ *     if (!event.isUp()) {
+ *         message("F1 was pressed!");
+ *     }
+ * });
+ */
+declare function bindKey(
+    key: string,
+    handler: (keyEvent: KeyEvent) => void
+): void;
+
+/**
+ * Unbinds a previously bound key, removing its handler.
+ *
+ * @param key - The key name to unbind.
+ */
+declare function unbindKey(key: string): void;
+
+// ===== Resource Functions =====
+
+/**
+ * Gets a loaded resource by its name.
+ *
+ * @param name - Resource name (as defined in meta.xml).
+ * @returns The matching `Resource`, or `null` if not found.
+ */
+declare function getResource(name: string): Resource | null;
+
+/**
+ * Gets all currently loaded resources.
+ *
+ * @returns Array of all `Resource` instances.
+ */
+declare function getResources(): Resource[];
+
+/**
+ * Gets the current (calling) resource.
+ *
+ * @returns The `Resource` this script belongs to.
+ */
+declare function getThisResource(): Resource;
+
+// ===== Server Functions =====
+
+/**
+ * Returns the server's listening port number.
+ *
+ * @returns The port number the server is listening on.
+ */
+declare function getServerPort(): number;
+
+/**
+ * Returns the server's game identifier string.
+ * Example: `"gta:vc"` for GTA Vice City.
+ *
+ * @returns Game identifier string.
+ */
+declare function getServerGame(): string;
+
+/**
+ * Returns the server's display name (shown in server browsers).
+ *
+ * @returns The current server name.
+ */
+declare function getServerName(): string;
+
+/**
+ * Sets the server's display name.
+ *
+ * @param name - The new server name.
+ */
+declare function setServerName(name: string): void;
+
+/**
+ * Sets the server password. Clients must provide this password to connect.
+ *
+ * @param pass - The new password. Pass an empty string `""` to remove the password requirement.
+ */
+declare function setServerPassword(pass: string): void;
+
+// ===== Network Stats =====
+
+/**
+ * Returns network statistics for the server.
+ *
+ * @returns An object containing network performance metrics (bytes sent/received, packet counts, etc.).
+ */
+declare function getNetworkStats(): object;
+
+/**
+ * Returns the current packet loss percentage.
+ *
+ * @returns Packet loss as a numeric percentage (0.0 = no loss, 100.0 = all lost).
+ */
+declare function getPacketLoss(): number;
+
+// ===== HTTP =====
+
+/**
+ * Represents an HTTP request handle (opaque type).
+ * Returned by `http.createRequest()`, used for configuring and sending HTTP requests.
+ */
+type HTTPRequest = {}
+
+/**
+ * HTTP request API for making web requests from the server.
+ * Supports creating requests, GET, and POST operations with callback-based responses.
+ *
+ * @example
+ * // Simple GET request
+ * http.get("https://api.example.com/data", function(data) {
+ *     console.log("Response: " + data);
+ * });
+ *
+ * @example
+ * // POST request with JSON
+ * http.post("https://api.example.com/submit", '{"key":"value"}', function(data) {
+ *     console.log("Server responded: " + data);
+ * });
+ */
+declare var http: {
+    /**
+     * Creates an HTTP request handle for advanced request configuration.
+     *
+     * @param url - The request URL.
+     * @returns An `HTTPRequest` handle for further configuration before sending.
+     */
+    createRequest(url: string): HTTPRequest;
+
+    /**
+     * Sends a GET request to the specified URL.
+     *
+     * @param url - The request URL.
+     * @param callback - Callback invoked with the response body string when the request completes.
+     */
+    get(url: string, callback: (data: string) => void): void;
+
+    /**
+     * Sends a POST request with a body to the specified URL.
+     *
+     * @param url - The request URL.
+     * @param data - The POST body data (typically JSON or form-encoded).
+     * @param callback - Callback invoked with the response body string when the request completes.
+     */
+    post(url: string, data: string, callback: (data: string) => void): void;
+};
+
+// ===== File I/O =====
+
+/**
+ * Checks whether a file exists on disk.
+ *
+ * @param path - File path (relative to resource root or absolute).
+ * @returns `true` if the file exists and is accessible.
+ */
+declare function fileExists(path: string): boolean;
+
+/**
+ * Opens a file for reading and/or writing.
+ *
+ * @param path - File path to open.
+ * @returns A `FileObject` handle, or `null` if the file could not be opened.
+ */
+declare function fileOpen(path: string): FileObject | null;
+
+/**
+ * Closes an open file handle.
+ *
+ * @param file - The `FileObject` to close.
+ */
+declare function fileClose(file: FileObject): void;
+
+/**
+ * Reads the entire remaining content of an open file.
+ *
+ * @param file - The `FileObject` to read from.
+ * @returns The file content as a string.
+ */
+declare function fileRead(file: FileObject): string;
+
+/**
+ * Writes data to an open file (appends at the current position).
+ *
+ * @param file - The `FileObject` to write to.
+ * @param data - The string data to write.
+ */
+declare function fileWrite(file: FileObject, data: string): void;
+
+/**
+ * Deletes a file from disk permanently.
+ *
+ * @param path - The file path to delete.
+ * @returns `true` if the file was successfully deleted, `false` on failure.
+ */
+declare function fileDelete(path: string): boolean;
+
+/**
+ * Gets the size of an open file in bytes.
+ *
+ * @param file - The `FileObject` to query.
+ * @returns The file size in bytes.
+ */
+declare function fileGetSize(file: FileObject): number;
+
+/**
+ * Gets the absolute path of an open file.
+ *
+ * @param file - The `FileObject` to query.
+ * @returns The absolute file path as a string.
+ */
+declare function fileGetPath(file: FileObject): string;
+
+/**
+ * Loads the complete text content of a file into memory.
+ * Convenience function — opens, reads, and closes the file in one call.
+ *
+ * @param path - File path to load.
+ * @returns The file content as a string, or `null` if the file could not be loaded.
+ */
+declare function loadTextFile(path: string): string | null;
+
+/**
+ * Saves text content to a file, overwriting any existing content.
+ *
+ * @param path - File path to save to.
+ * @param content - The text content to write.
+ * @returns `true` on success, `false` on failure.
+ */
+declare function saveTextFile(path: string, content: string): boolean;
+
+// ===== Game (gta) - Server-Side =====
+
+/**
+ * Server-side GTA world manipulation API.
+ * Provides methods for creating and managing game world elements (blips,
+ * buildings, markers, objects, peds, pickups, vehicles), controlling time
+ * and weather, camera effects, and world physics.
+ *
+ * Note: The server-side `gta` is more limited than the client-side version
+ * — some properties only exist on the client.
+ *
+ * @see https://wiki.gtaconnected.com — GTA Connected Wiki
+ */
+declare var gta: {
+    // -- Time --
+
+    /**
+     * Current in-game time as `{ hour, minute }`.
+     * Server-side time is synchronised to all clients.
+     *
+     * @example
+     * // Check if it's night
+     * if (gta.time.hour >= 20 || gta.time.hour < 6) {
+     *     message("It's nighttime!");
+     * }
+     */
+    time: { hour: number; minute: number };
+
+    // -- Blips --
+
+    /**
+     * Creates a radar blip at a world position (server-side).
+     * Note: Server-side blip creation does not support colour or size parameters.
+     * Use client-side blip functions for custom colours and sizes.
+     *
+     * @param x - X coordinate.
+     * @param y - Y coordinate.
+     * @param z - Z coordinate.
+     * @param icon - Blip icon ID (see Icon enum).
+     * @param dimension - Dimension ID for the blip.
+     * @returns The created `Blip`.
+     */
+    createBlip(
+        x: number,
+        y: number,
+        z: number,
+        icon: number,
+        dimension: number
+    ): Blip;
+
+    /**
+     * Creates a blip attached to an element (server-side).
+     * The blip will follow the element's position automatically.
+     *
+     * @param element - The element to attach the blip to.
+     * @param icon - Blip icon ID (see Icon enum).
+     * @returns The created `Blip`.
+     */
+    createBlipAttachedTo(element: Element, icon: number): Blip;
+
+    // -- Buildings --
+
+    /**
+     * Creates a static building element on the server.
+     *
+     * @param model - Building model ID.
+     * @param x - X position.
+     * @param y - Y position.
+     * @param z - Z position.
+     * @param rx - X rotation (pitch) in degrees.
+     * @param ry - Y rotation (roll) in degrees.
+     * @param rz - Z rotation (yaw) in degrees.
+     * @returns The created `Building`.
+     */
+    createBuilding(
+        model: number,
+        x: number,
+        y: number,
+        z: number,
+        rx: number,
+        ry: number,
+        rz: number
+    ): Building;
+
+    // -- Camera --
+
+    /**
+     * Fades the camera in or out for all clients.
+     *
+     * @param fade - Fade direction: `FADE_IN` (show) or `FADE_OUT` (hide).
+     * @param duration - Duration of the fade in milliseconds.
+     * @param args - Additional arguments (e.g. fade colour).
+     */
+    fadeCamera(fade: number, duration: number, ...args: any[]): void;
+
+    // -- Markers --
+
+    /**
+     * Creates a 3D world marker at the specified position.
+     *
+     * @param x - X coordinate.
+     * @param y - Y coordinate.
+     * @param z - Z coordinate.
+     * @param type - Marker type (cylinder, arrow, checkpoint ring, etc.).
+     * @param size - Marker size/diameter in world units.
+     * @param r - Red colour component (0–255).
+     * @param g - Green colour component (0–255).
+     * @param b - Blue colour component (0–255).
+     * @param a - Alpha/opacity component (0–255).
+     * @returns The created `Marker`.
+     */
+    createMarker(
+        x: number,
+        y: number,
+        z: number,
+        type: number,
+        size: number,
+        r: number,
+        g: number,
+        b: number,
+        a: number
+    ): Marker;
+
+    // -- Objects --
+
+    /**
+     * Creates a placeable object on the server.
+     *
+     * @param model - Object model ID.
+     * @param x - X position.
+     * @param y - Y position.
+     * @param z - Z position.
+     * @param rx - X rotation (pitch) in degrees.
+     * @param ry - Y rotation (roll) in degrees.
+     * @param rz - Z rotation (yaw) in degrees.
+     * @returns The created `Object`.
+     */
+    createObject(
+        model: number,
+        x: number,
+        y: number,
+        z: number,
+        rx: number,
+        ry: number,
+        rz: number
+    ): Object;
+
+    // -- Peds --
+
+    /**
+     * Creates a pedestrian (AI character) on the server.
+     *
+     * @param model - Ped model/skin ID (see PedSkin enum).
+     * @param x - X position.
+     * @param y - Y position.
+     * @param z - Z position.
+     * @param rz - Z rotation (heading) in degrees.
+     * @returns The created `Ped`.
+     */
+    createPed(model: number, x: number, y: number, z: number, rz: number): Ped;
+
+    // -- Pickups --
+
+    /**
+     * Creates a collectible pickup on the server.
+     *
+     * @param model - Pickup model ID (see PickupModel enum).
+     * @param type - Pickup type constant.
+     * @param x - X position.
+     * @param y - Y position.
+     * @param z - Z position.
+     * @returns The created `Pickup`.
+     */
+    createPickup(
+        model: number,
+        type: number,
+        x: number,
+        y: number,
+        z: number
+    ): Pickup;
+
+    // -- Vehicles --
+
+    /**
+     * Creates a vehicle on the server at a position with optional colours.
+     *
+     * @param model - Vehicle model ID (see VehicleModel enum).
+     * @param x - X position.
+     * @param y - Y position.
+     * @param z - Z position.
+     * @param rz - Z rotation (heading) in degrees.
+     * @param c1 - Primary colour ID (optional).
+     * @param c2 - Secondary colour ID (optional).
+     * @returns The created `Vehicle`.
+     *
+     * @example
+     * const infernus = gta.createVehicle(141, 0, 0, 10, 0, 0, 0);
+     * message("Infernus spawned!");
+     */
+    createVehicle(
+        model: number,
+        x: number,
+        y: number,
+        z: number,
+        rz: number,
+        c1?: number,
+        c2?: number
+    ): Vehicle;
+
+    /**
+     * Creates a vehicle at a Vec3 position (convenience overload).
+     *
+     * @param model - Vehicle model ID.
+     * @param position - World position as a `Vec3`.
+     * @returns The created `Vehicle`, or `null` on failure.
+     */
+    createVehicle(model: number, position: Vec3): Vehicle | null;
+
+    // -- Time --
+
+    /**
+     * Gets the real-time duration of one in-game minute in milliseconds.
+     *
+     * @returns Duration in milliseconds (default: 1000 for a 24-minute game day).
+     */
+    getMinuteDuration(): number;
+
+    /**
+     * Sets the real-time duration of one in-game minute.
+     * Affects how fast the in-game clock advances.
+     *
+     * @param ms - Duration per in-game minute in milliseconds.
+     */
+    setMinuteDuration(ms: number): void;
+
+    /**
+     * Gets the current in-game time.
+     *
+     * @returns Object with `hour` (0–23) and `minute` (0–59).
+     */
+    getTime(): { hour: number; minute: number };
+
+    /**
+     * Sets the in-game time (synchronised to all clients).
+     *
+     * @param h - Hour (0–23).
+     * @param m - Minute (0–59).
+     */
+    setTime(h: number, m: number): void;
+
+    // -- Weather --
+
+    /**
+     * Gets the current weather ID.
+     *
+     * @returns Weather ID (0 = sunny, 1 = cloudy, 2 = rainy, 3 = foggy).
+     */
+    getWeather(): number;
+
+    /**
+     * Sets the current weather immediately (synchronised to all clients).
+     *
+     * @param weather - Weather ID to apply.
+     */
+    setWeather(weather: number): void;
+
+    /**
+     * Smoothly blends between two weather states over time.
+     *
+     * @param w1 - Source weather ID.
+     * @param w2 - Target weather ID.
+     * @param percent - Blend percentage (0.0 = all source, 1.0 = all target).
+     */
+    setWeatherBlend(w1: number, w2: number, percent: number): void;
+
+    // -- World --
+
+    /**
+     * Gets the current global gravity multiplier.
+     *
+     * @returns Gravity value (default ~0.008).
+     */
+    getGravity(): number;
+
+    /**
+     * Sets the global gravity multiplier (affects all clients).
+     *
+     * @param g - Gravity value (0.008 = normal, 0.002 = moon-like).
+     */
+    setGravity(g: number): void;
+
+    /**
+     * Gets the current game speed multiplier.
+     *
+     * @returns Game speed (1.0 = normal).
+     */
+    getGameSpeed(): number;
+
+    /**
+     * Sets the game speed multiplier (affects all clients).
+     *
+     * @param speed - Speed value (1.0 = normal, 2.0 = double, 0.5 = slow motion).
+     */
+    setGameSpeed(speed: number): void;
+};
+
+// ===== Player Spawning (Legacy API) =====
+
+/**
+ * Spawns a player at a specified position with a given skin and rotation.
+ *
+ * @param client - The target client to spawn a player for.
+ * @param position - Spawn position as a `Vec3` or `[x, y, z]` array.
+ * @param rotation - Spawn heading/rotation in degrees.
+ * @param skin - Player skin/model ID (see PedSkin enum).
+ *
+ * @example
+ * // Spawn a new player at the default position
+ * addEventHandler("OnPlayerJoin", function(client) {
+ *     spawnPlayer(client, new Vec3(0, 0, 10), 0, 0);
+ * });
+ */
+declare function spawnPlayer(
+    client: Client,
+    position: Vec3 | number[],
+    rotation: number,
+    skin: number
+): void;
+
+/**
+ * Fades the camera for a specific client.
+ *
+ * @param client - The target client.
+ * @param state - `true` to fade in (show), `false` to fade out (hide).
+ * @param duration - Optional fade duration in milliseconds.
+ *
+ * @example
+ * // Fade out, teleport, fade in
+ * fadeCamera(client, false, 1000);
+ * setTimeout(function() {
+ *     client.player.position = new Vec3(100, 200, 10);
+ *     fadeCamera(client, true, 1000);
+ * }, 1000);
+ */
+declare function fadeCamera(
+    client: Client,
+    state: boolean,
+    duration?: number
+): void;
+
+// ===== Platform =====
+
+/**
+ * Platform-level timing information for the server.
+ */
+declare var platform: {
+    /**
+     * High-resolution tick count in milliseconds since the server started.
+     * Use for delta-time calculations, uptime tracking, and performance metrics.
+     */
+    ticks: number;
+};