Add-ons/SotA Event System (SES)/Event reference
More actions
Event reference
This page groups the events provided by SES 1.45.1. Native relays preserve the game's callback arguments; synthesized events are inferred from supported getters and may arrive on the next polling interval. Consult the approved source for the exact payload before treating an event as an interface contract.[1]
Lifecycle and direct relays
| Area | Events |
|---|---|
| Lifecycle | ShroudOnStart, ShroudOnUpdate, ShroudOnGUI, ShroudOnDisableScript, ShroudOnLogout
|
| Scenes | ShroudOnSceneLoaded, ShroudOnSceneUnloaded, and synthesized ShroudOnSceneChange with current and previous friendly/raw names
|
| Chat and combat | ShroudOnConsoleInput, ShroudOnCombatEvents, ShroudOnExperienceGain
|
| UI input | ShroudOnInputChange, ShroudOnToggleChange, mouse click/over/out plus polled mouse down/up/move/drag, and per-key down/up events
|
| Media | ShroudOnPlayFX, ShroudOnPlaySound, loaded/stopped sound events, and watched-instance sound started/stopped events
|
Object input also has ID-specific forms such as ShroudOnInputChange<objectID> and ShroudOnMouseClick<objectID><objectKind>.
Player and world state
| Area | Synthesized events |
|---|---|
| Vitals and state | ShroudOnHealthChanged, ShroudOnFocusChanged, ShroudOnGoldChanged, ShroudOnCombatModeChanged, ShroudOnUIActiveChange, ShroudOnPVPFlagChanged
|
| Experience | Pooled and total adventurer/producer experience changed; adventurer and producer attenuation changed |
| Inventory and decks | ShroudOnInventoryChanged, ShroudOnCurrentDeckChanged, ShroudOnDeckListChanged
|
| New Britannian time | ShroudOnGameDayChanged, ShroudOnGamePeriodOfDayChanged, ShroudOnGameSeasonChanged
|
| Map beacon | ShroudOnBeaconSet, ShroudOnBeaconArrived, ShroudOnBeaconCleared
|
Inventory changes are aggregated by item name and report previous and current quantities. Beacon arrival is inferred when a disappearing beacon was within the configured distance of the player's current position; otherwise SES reports a clear.[1]
Buffs, pets, and party
Player and pet effects provide Added, Removed, DurationChanged, and Recast events. Added and duration events include available duration, percentage, description, value, tick, and icon information; a recast is inferred when remaining duration rises.
Pet events cover summon, dismiss, and individual observed stat changes. Party events cover a member entering or leaving the current scene and health changes for members in that scene.
Performance model
Synthesized polling is subscriber-gated. Default intervals are 0.5 seconds for scene, UI, combat mode, vitals, attenuation, experience, inventory, game time, decks, buffs, pets, party, PVP, and beacon state; sound polling defaults to 0.1 seconds. Mouse and watched-key transitions are checked per update. Individual poll blocks and individual callbacks are error-isolated.[1]
These events report supported observable state. They do not grant movement, combat, targeting, loot, or trade control, and SES requests no Internet permission.
References
- ↑ 1.0 1.1 1.2 Community Addons: approved SES 1.45.1 package, reviewed October 13, 2026.