function · events
ignore
Removes one generation-scoped event subscription created by this package.
events.ignore(subscription_id) -> removed- Stable ID
events.ignore- Owner
- app.ScriptPackageHost
- Authority
- read_only
- Timing
- post_commit
- Availability
- Phase 14 package callbacks
- Side effects
- none
- Determinism
- Host-created package identity and per-callback budgets.
- Introduced
- 1.0.0
Usage
Remove a subscription created by the current package generation. Calling it again or passing an expired ID returns false without affecting another package.
Parameters
- subscription_id: positive opaque ID returned by events.listen in the current package generation.
Returns
True when the current package owned and removed the subscription; otherwise false.
Cost
Bounded by the package subscription limit. Removal during delivery takes effect before the next event and releases the callback after the current protected call.
Fields
This symbol has no fields.
Errors
- None
Examples
local subscription = events.listen("events.command.completed", on_completed)
-- Later in the same package generation:
events.ignore(subscription)API history
- 1.0.0: Active generation-scoped event delivery added in Phase 14M.