Events

Listen to game events and emit custom cross-mod events.

Permission required: events

Methods

on(event, callback)

Listen to a game event or custom event. Returns an unsubscribe function.

const unsub = Events.on("Terminal.NmapScan", (data) => {
    console.log(`Scanned ${data.ip}`);
});

// later: unsub();

Parameters:

Name	Type	Description
event	string	Event name
callback	(data) => void	Handler function (typed for known events)

Returns: () => void — unsubscribe function

off(event, callback)

Remove a specific event listener.

Events.off("Terminal.NmapScan", myHandler);

emit(event, data?)

Emit a custom event. Used for cross-mod communication.

Events.emit("MyMod.LevelUp", { level: 5 });

register(name)

Register a custom event name. Optional but recommended for discoverability.

Events.register("MyMod.LevelUp");

Full Event List

See the Events guide for a complete list of all 60+ game events.