hookEvents

A hook event that fires when a custom active effect is applied.

A hook event that fires immediately prior to PIXI Application construction with the configuration parameters.

A hook event that fires when the Canvas is initialized.

A hook event that fires when the Canvas is panned.

A hook event that fires when the Canvas is ready.

A hook event that fires when the Sidebar tab is changed.

A hook event that fires when a chat bubble is rendered.

A hook event that fires when a user sends a message through the ChatLog.

A hook event that fires whenever this Application is closed.

A hook event that fires when the SceneNavigation menu is expanded or collapsed.

A hook event that fires when the Sidebar is collapsed or expanded.

A hook event that fires when any PlaceableObject is selected or deselected. Substitute the PlaceableObject name in the hook event to target a specific PlaceableObject type, for example "controlToken".

A hook event that fires for every embedded Document type after conclusion of a creation workflow. Substitute the Document name in the hook event to target a specific type, for example "createToken". This hook fires for all connected clients after the creation has been processed.

A hook event that fires when Cards are dealt from a deck to other hands

A hook event that fires for every Document type after conclusion of an deletion workflow. Substitute the Document name in the hook event to target a specific Document type, for example "deleteActor". This hook fires for all connected clients after the deletion has been processed.

A hook event that fires when some useful data is dropped onto an ActorSheet.

A hook event that fires when some useful data is dropped onto the Canvas.

A hook event that fires when some useful data is dropped onto a RollTableConfig.

A hook event that fires whenever foundry experiences an error.

A hook event that fires when the context menu for entries in an Application is constructed. Substitute the Application name in the hook event to target a specific Application, for example "getActorDirectoryEntryContext".

A hook event that fires whenever this Application is first rendered to add buttons to its header.

A hook event that fires when the context menu for a Sound in the PlaylistDirectory is constructed.

A hook event that fires when the Scene controls are initialized.

A hook event that fires when the context menu for a SceneNavigation entry is constructed.

A hook event that fires when the context menu for folders in a SidebarTab is constructed. Substitute the SidebarTab name in the hook event to target a specific SidebarTab, for example "getActorDirectoryFolderContext".

A hook event that fires when the context menu for a PlayersList entry is constructed.

A hook event that fires when the user modifies a global volume slider. The hook name needs to be customized to include the type of global volume being changed, one of: globalPlaylistVolumeChanged, globalAmbientVolumeChanged, or globalInterfaceVolumeChanged.

A hook event that fires whenever data is dropped into a Hotbar slot. The hook provides a reference to the Hotbar application, the dropped data, and the target slot. Default handling of the drop event can be prevented by returning false within the hooked function.

A hook event that fires when any PlaceableObject is hovered over or out. Substitute the PlaceableObject name in the hook event to target a specific PlaceableObject type, for example "hoverToken".

A hook event that fires once Localization translations have been loaded and are ready for use.

A hook event that fires as Foundry is initializing, right before any initialization tasks have begun.

A hook event that fires after LightSource shaders have initialized.

A hook event that fires when the LightingLayer is refreshed.

A hook event that fires when a token's resource bar attribute has been modified.

A hook event that fires when Cards are passed from one stack to another

A hook event that fires when any PlaceableObject is pasted onto the Scene. Substitute the PlaceableObject name in the hook event to target a specific PlaceableObject type, for example "pasteToken".

A hook event that fires when the game is paused or un-paused.

A hook event that fires for every Document type before execution of a creation workflow. Substitute the Document name in the hook event to target a specific Document type, for example "preCreateActor". This hook only fires for the client who is initiating the creation request.

The hook provides the pending document instance which will be used for the Document creation. Hooked functions may modify that data or prevent the workflow entirely by explicitly returning false.

A hook event that fires for every Document type before execution of a deletion workflow. Substitute the Document name in the hook event to target a specific Document type, for example "preDeleteActor". This hook only fires for the client who is initiating the update request.

The hook provides the Document instance which is requested for deletion. Hooked functions may prevent the workflow entirely by explicitly returning false.

A hook event that fires for every Document type before execution of an update workflow. Substitute the Document name in the hook event to target a specific Document type, for example "preUpdateActor". This hook only fires for the client who is initiating the update request.

The hook provides the differential data which will be used to update the Document. Hooked functions may modify that data or prevent the workflow entirely by explicitly returning false.

A hook event that fires when the game is fully ready.

A hook event that fires whenever this Application is rendered. The hook provides the pending application HTML which will be added to the DOM. Hooked functions may modify that HTML or attach interactive listeners to it.

A hook event that fires for each ChatMessage which is rendered for addition to the ChatLog. This hook allows for final customization of the message HTML before it is added to the log.

A hook event that fires when a stack of Cards are returned to the decks they originally came from.

A hook event that fires when the AV settings are changed.

A hook event that fires when Foundry has finished initializing but before the game state has been set up. Fires before any Documents, UI applications, or the Canvas have been initialized.

A hook event that fires when the SightLayer has been refreshed.

A hook event that fires when a token is targeted or un-targeted.

A hook event that fires whenever the contents of a Compendium pack were modified. This hook fires for all connected clients after the update has been processed.

A hook event that fires for every Document type after conclusion of an update workflow. Substitute the Document name in the hook event to target a specific Document type, for example "updateActor". This hook fires for all connected clients after the update has been processed.

A hook event that fires when the World time has been updated.