Modules

Sound

Players & world

@s2script/sdk/sound

engine-generic sound: emit a named SoundEvent + register custom precache paths.

3 exports

Import

import { SoundEmitOptions } from "@s2script/sdk/sound";

Author-time types ship in the npm package; the engine injects the runtime at plugin load. Add @s2script/sdk to your plugin's dependencies.

API reference

Generated from the shipped type definitions.

interface

SoundEmitOptions

Options for Sound.emit — the source entity, recipient slots, and volume.

entity?: EntityRef

— Source entity (serial-gated; a stale ref emits nothing and returns 0). Omitted -> worldspawn (a global/2D sound).

recipients?: number[]

— Recipient player slots. Omitted -> every valid client. Bot slots are always skipped (no netchannel); an all-bot-skipped set still emits to nobody (a real, safe engine call), whereas requesting NO recipients (an empty array) returns 0 without emitting.

volume?: number

— Volume in [0, 1]. Default 1.0 (out-of-range/NaN clamps to 1.0).

interface

PrecacheContext

Block-scoped precache context — valid ONLY during the onPrecache dispatch. Synchronous use only: a stashed context used after the handler returns (or past an await) is a no-op false (the engine manifest is gone).

add(path: string): boolean

— Add a resource path (e.g. "soundevents/mypack.vsndevts") to the session resource manifest. True iff the engine accepted the add.

const

Sound

Engine-generic sound entry point — play a named SoundEvent to some or all clients.

import { Sound } from "@s2script/sdk/sound";
// global 2D broadcast to every valid client (worldspawn source):
const guid = Sound.emit("MyPack.Ping");
if (guid === 0) console.log("emit failed (unresolved name / stale source)");

emit(name: string, opts?: SoundEmitOptions): number

— Play a named SoundEvent (the engine resolves name->hash; built-in soundevents need no precache). Returns the engine sound GUID (nonzero) or 0 on failure (unresolved engine function / stale source entity / an empty recipients array). An all-bot-skipped recipient set still emits to nobody (a real engine call, may return a nonzero GUID).

Back to modules All packages