Server

const

Server

Server console + globals: run commands, register/read/set cvars, and query map/time state.

import { Server } from "@s2script/sdk/server";
// plugins/basecommands/src/plugin.ts:46 — sm_map
Server.command("changelevel " + map);

command(cmd: string): void

— Run cmd at the server console (queued; executes next frame).

isMapValid(map: string): boolean

— Whether map is an installed, valid map file.

getCvar(name: string): string

— A cvar's current value as a string. "" if the cvar doesn't exist (or an unsupported type → "<type>").

setCvar(name: string, value: string): void

— Set a cvar via the server console (so any type is accepted). SECURITY: this builds and runs a console command (<name> <value>), which the console splits on ; — treat value like command() input and sanitize/quote any untrusted value to avoid command injection. Queued: applies next frame.

registerCvar(name: string, opts: {
    type: "bool" | "int" | "float" | "string";
    default: boolean | number | string;
    help?: string;
    flags?: number;
    min?: number;
    max?: number;
  }): boolean

— Register a plugin-owned ConVar (CSSharp FakeConVar / SM CreateConVar parity). Idempotent — re-registering an existing name is a no-op success, and the cvar + its value persist across plugin reloads (SourceMod parity). The shim adds FCVAR_RELEASE (customer-visible); flags are additive raw FCVAR bits. Read the value with getCvar; set it with setCvar/the console. min/max apply to numeric types only.

onCvarChange(name: string, handler: (name: string, newValue: string, oldValue: string) => void): { dispose(): void }

Watch a cvar for changes (SourceMod HookConVarChange, ModSharp's cvar change hook). name is a cvar name, or "*" for every cvar. The handler receives the cvar's name and its new and old values as strings — for "*" the name tells you which one moved. NOTIFY-only: the engine's global change callback runs **after** the value has been applied, so a handler cannot veto a change; returning anything is ignored. A handler that throws is logged and contained, and the remaining handlers still run. Subscriptions are ledgered — unload removes them whether or not dispose() is called.

import { Server } from "@s2script/sdk/server";
Server.onCvarChange("mp_friendlyfire", (name, next, prev) => {
  console.log(`${name}: ${prev} -> ${next}`);
});

readonly maxPlayers: number

— The server's configured max client count (GetMaxClients()). 0 if unavailable.

readonly mapName: string

— The current map name (GetMapName(), the BSP). "" if unavailable.

readonly gameTime: number

— The current map time in seconds (GetGlobals()->curtime). 0 if unavailable.

Import

API reference