Skip to content

sdk.alert_service

Typed-event/live-snapshot alert service. Native notification is optional; history and callbacks work identically in tests and headless environments.

lua
local M = require("sdk.alert_service")

Constants

Lua 5.4 has no enums — these are integer (or string) fields on the module.

NameValueSummary
ServiceServiceAlert service class.

new

function · new(opts)

Create an alert service that watches HP, players, and PZ.

get

function · get(opts)

Return the process-wide alert service, creating it if needed.

Get

alias · Get = get

Same as get.

Alias

Same as get.

start

function · start(...) return default_call("start", ...)

Start the default alert service.

stop

function · stop(...) return default_call("stop", ...)

Stop the default alert service.

configure

function · configure(...) return default_call("configure", ...)

Replace watches and thresholds on the default service.

watch

function · watch(...) return default_call("watch", ...)

Add one named watch to the default service.

unwatch

function · unwatch(...) return default_call("unwatch", ...)

Remove a named watch.

handle

function · handle(...) return default_call("handle", ...)

Feed an inbound event into the default service.

tick

function · tick(...) return default_call("tick", ...)

Evaluate watches on the default service.

history

function · history(...) return default_call("history", ...)

Recent alert firings.

snapshot

function · snapshot(...) return default_call("snapshot", ...)

Current watches and last fire times.

Arcane SDK catalog generated from scripts/sdk