StaticeventsA mapping of hook events which have functions registered to them.
StaticcallCall hook listeners in the order in which they were registered. Continue calling hooks until either all have been called or one returns false.
Hook listeners which return false denote that the original event has been adequately handled and no further hooks should be called.
The hook being triggered
Arguments passed to the hook callback functions
Were all hooks called without execution being prevented?
StaticcallCall all hook listeners in the order in which they were registered Hooks called this way can not be handled by returning false and will always trigger every hook callback.
The hook being triggered
Arguments passed to the hook callback functions
StaticoffUnregister a callback handler for a particular hook event
The unique name of the hooked event
The function, or ID number for the function, that should be turned off
StaticonRegister a callback handler which should be triggered when a hook is triggered.
The unique name of the hooked event
The callback function which should be triggered when the hook event occurs
Options which customize hook registration
Only trigger the hooked function once
An ID number of the hooked function which can be used to turn off the hook later
StaticonceRegister a callback handler for an event which is only triggered once the first time the event occurs. An alias for Hooks.on with {once: true}
The unique name of the hooked event
The callback function which should be triggered when the hook event occurs
An ID number of the hooked function which can be used to turn off the hook later
StaticonNotify subscribers that an error has occurred within foundry.
The method where the error was caught.
The error.
Optionaloptions: { data?: object; log?: string; msg?: string; notify?: string } = {}Additional options to configure behaviour.
Optionaldata?: objectAdditional data to pass to the hook subscribers.
Optionallog?: stringThe level at which to log the error to console (if at all).
Optionalmsg?: stringA message which should prefix the resulting error or notification.
Optionalnotify?: stringThe level at which to spawn a notification in the UI (if at all).
A simple event framework used throughout Foundry Virtual Tabletop. When key actions or events occur, a "hook" is defined where user-defined callback functions can execute. This class manages the registration and execution of hooked callback functions.