subscriptions
The subscriptions namespace — the engine's Luau API reference for subscriptions.
The subscriptions namespace — 4 functions.
globals/subscriptions/cancel
globals/subscriptions/cancel(id: string) -> boolean
Cancel a subscription by id: disconnects the live connection immediately and marks the row cancelled. Returns true when a live subscription was cancelled, false for an unknown or already-disconnected id.
globals/subscriptions/get
globals/subscriptions/get(id: string) -> SubscriptionRow?
One subscription row by id, or nil when the id is unknown (never tracked, or evicted after its publisher was destroyed).
globals/subscriptions/list
globals/subscriptions/list(filter: SubscriptionFilter?) -> { SubscriptionRow }
Every tracked subscription row, optionally filtered by publisher instance id, publisher entity id, event name, and/or connected state.
globals/subscriptions/publishers
globals/subscriptions/publishers() -> { PublisherRow }
Every live event publisher: component instance, entity, and per-event fire stats (fires happen whether or not anyone subscribes) plus current subscriber ids.