@vttforge/core / HookMap
Interface: HookMap ​
Every hook name Foundry ships, with the arguments it passes.
Extends ​
StaticHooks.DocumentLifecycleHooks.ContextMenuHooks.PlaceableHooks.CanvasLayerHooks
Properties ​
activateCanvasLayer ​
activateCanvasLayer: [
unknown]
Inherited from ​
StaticHooks.activateCanvasLayer
activateDrawingsLayer ​
activateDrawingsLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.activateDrawingsLayer
activateEditorLegacy ​
activateEditorLegacy: [
unknown,Record<string,unknown>,string]
The editor a legacy rich text field opened. Removed in v15.
Inherited from ​
StaticHooks.activateEditorLegacy
activateLightingLayer ​
activateLightingLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.activateLightingLayer
activateNote ​
activateNote: [
unknown,Record<string,unknown>]
Inherited from ​
StaticHooks.activateNote
activateNotesLayer ​
activateNotesLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.activateNotesLayer
activateRegionLayer ​
activateRegionLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.activateRegionLayer
activateSoundsLayer ​
activateSoundsLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.activateSoundsLayer
activateTemplateLayer ​
activateTemplateLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.activateTemplateLayer
activateTilesLayer ​
activateTilesLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.activateTilesLayer
activateTokenLayer ​
activateTokenLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.activateTokenLayer
activateWallsLayer ​
activateWallsLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.activateWallsLayer
applyActiveEffect ​
applyActiveEffect: [
ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>,Record<string,unknown>,unknown,unknown,Record<string,unknown>]
Inherited from ​
StaticHooks.applyActiveEffect
applyCompendiumArt ​
applyCompendiumArt: [
unknown,Record<string,unknown>,CompendiumCollection,Record<string,unknown>]
Inherited from ​
StaticHooks.applyCompendiumArt
applyTokenStatusEffect ​
applyTokenStatusEffect: [
TokenObjectLike,string,boolean]
Inherited from ​
StaticHooks.applyTokenStatusEffect
canvasConfig ​
canvasConfig: [
Record<string,unknown>]
Inherited from ​
StaticHooks.canvasConfig
canvasDraw ​
canvasDraw: [
CanvasApi]
Inherited from ​
StaticHooks.canvasDraw
canvasInit ​
canvasInit: [
CanvasApi]
Inherited from ​
StaticHooks.canvasInit
canvasPan ​
canvasPan: [
CanvasApi, {scale:number;x:number;y:number; }]
Inherited from ​
StaticHooks.canvasPan
canvasReady ​
canvasReady: [
CanvasApi]
Inherited from ​
StaticHooks.canvasReady
canvasTearDown ​
canvasTearDown: [
CanvasApi,Record<string,unknown>]
Inherited from ​
StaticHooks.canvasTearDown
changeSidebarTab ​
changeSidebarTab: [
unknown]
Inherited from ​
StaticHooks.changeSidebarTab
chatBubble ​
chatBubble: [
TokenObjectLike,unknown,string,Record<string,unknown>]
Replaced by chatBubbleHTML, and removed in v15.
Inherited from ​
StaticHooks.chatBubble
chatBubbleHTML ​
chatBubbleHTML: [
TokenObjectLike,HTMLElement,string,Record<string,unknown>]
Inherited from ​
StaticHooks.chatBubbleHTML
chatInput ​
chatInput: [
KeyboardEvent, {recordPending:boolean; }]
Inherited from ​
StaticHooks.chatInput
chatMessage ​
chatMessage: [
unknown,string,Record<string,unknown>]
Inherited from ​
StaticHooks.chatMessage
clientSettingChanged ​
clientSettingChanged: [
string,unknown,Record<string,unknown>]
Inherited from ​
StaticHooks.clientSettingChanged
closeApplicationV2 ​
closeApplicationV2: [
ApplicationV2Members]
Inherited from ​
StaticHooks.closeApplicationV2
closeDetachedWindow ​
closeDetachedWindow: [
string,Window]
Inherited from ​
StaticHooks.closeDetachedWindow
collapseSceneNavigation ​
collapseSceneNavigation: [
unknown,boolean]
Inherited from ​
StaticHooks.collapseSceneNavigation
collapseSidebar ​
collapseSidebar: [
unknown,boolean]
Inherited from ​
StaticHooks.collapseSidebar
combatRound ​
combatRound: [
CombatLike<Record<string,unknown>>, {round:number;turn:number; }, {direction:number; }]
Inherited from ​
StaticHooks.combatRound
combatStart ​
combatStart: [
CombatLike<Record<string,unknown>>, {round:number;turn:number; }]
Inherited from ​
StaticHooks.combatStart
combatTurn ​
combatTurn: [
CombatLike<Record<string,unknown>>, {round:number;turn:number; }, {direction:number; }]
Inherited from ​
StaticHooks.combatTurn
combatTurnChange ​
combatTurnChange: [
CombatLike<Record<string,unknown>>,CombatHistoryData,CombatHistoryData]
Inherited from ​
StaticHooks.combatTurnChange
configureCanvasEnvironment ​
configureCanvasEnvironment: [
Record<string,unknown>]
The environment config, before the canvas reads it.
Inherited from ​
StaticHooks.configureCanvasEnvironment
controlAmbientLight ​
controlAmbientLight: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.controlAmbientLight
controlAmbientSound ​
controlAmbientSound: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.controlAmbientSound
controlDrawing ​
controlDrawing: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.controlDrawing
controlMeasuredTemplate ​
controlMeasuredTemplate: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.controlMeasuredTemplate
controlNote ​
controlNote: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.controlNote
controlRegion ​
controlRegion: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.controlRegion
controlTile ​
controlTile: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.controlTile
controlToken ​
controlToken: [
TokenObjectLike,boolean]
Inherited from ​
PlaceableHooks.controlToken
controlWall ​
controlWall: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.controlWall
createActiveEffect ​
createActiveEffect: [
ActiveEffectLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createActiveEffect
createActor ​
createActor: [
ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createActor
createAdventure ​
createAdventure: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createAdventure
createAmbientLight ​
createAmbientLight: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createAmbientLight
createAmbientSound ​
createAmbientSound: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createAmbientSound
createCard ​
createCard: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createCard
createCards ​
createCards: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createCards
createChatMessage ​
createChatMessage: [
ChatMessageLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createChatMessage
createCombat ​
createCombat: [
CombatLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createCombat
createCombatant ​
createCombatant: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createCombatant
createDrawing ​
createDrawing: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createDrawing
createFogExploration ​
createFogExploration: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createFogExploration
createFolder ​
createFolder: [
FolderLikeDocument,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createFolder
createItem ​
createItem: [
ItemLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createItem
createJournalEntry ​
createJournalEntry: [
JournalEntryLike,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createJournalEntry
createJournalEntryPage ​
createJournalEntryPage: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createJournalEntryPage
createLevel ​
createLevel: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createLevel
createMacro ​
createMacro: [
MacroLike,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createMacro
createMeasuredTemplate ​
createMeasuredTemplate: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createMeasuredTemplate
createNote ​
createNote: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createNote
createPlaylist ​
createPlaylist: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createPlaylist
createPlaylistSound ​
createPlaylistSound: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createPlaylistSound
createProseMirrorEditor ​
createProseMirrorEditor: [
string,Record<string,unknown>]
Inherited from ​
StaticHooks.createProseMirrorEditor
createRegion ​
createRegion: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createRegion
createRegionBehavior ​
createRegionBehavior: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createRegionBehavior
createRollTable ​
createRollTable: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createRollTable
createScene ​
createScene: [
SceneLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createScene
createSetting ​
createSetting: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createSetting
createTile ​
createTile: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createTile
createToken ​
createToken: [
TokenDocumentLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createToken
createUser ​
createUser: [
UserLike,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createUser
createWall ​
createWall: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.createWall
deactivateDrawingsLayer ​
deactivateDrawingsLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.deactivateDrawingsLayer
deactivateLightingLayer ​
deactivateLightingLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.deactivateLightingLayer
deactivateNotesLayer ​
deactivateNotesLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.deactivateNotesLayer
deactivateRegionLayer ​
deactivateRegionLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.deactivateRegionLayer
deactivateSoundsLayer ​
deactivateSoundsLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.deactivateSoundsLayer
deactivateTemplateLayer ​
deactivateTemplateLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.deactivateTemplateLayer
deactivateTilesLayer ​
deactivateTilesLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.deactivateTilesLayer
deactivateTokenLayer ​
deactivateTokenLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.deactivateTokenLayer
deactivateWallsLayer ​
deactivateWallsLayer: [
CanvasLayerLike]
Inherited from ​
CanvasLayerHooks.deactivateWallsLayer
dealCards ​
dealCards: [
DocumentMembers<Record<string,unknown>>,DocumentMembers<Record<string,unknown>>[],Record<string,unknown>]
Inherited from ​
StaticHooks.dealCards
deleteActiveEffect ​
deleteActiveEffect: [
ActiveEffectLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteActiveEffect
deleteActor ​
deleteActor: [
ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteActor
deleteAdventure ​
deleteAdventure: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteAdventure
deleteAmbientLight ​
deleteAmbientLight: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteAmbientLight
deleteAmbientSound ​
deleteAmbientSound: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteAmbientSound
deleteCard ​
deleteCard: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteCard
deleteCards ​
deleteCards: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteCards
deleteChatMessage ​
deleteChatMessage: [
ChatMessageLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteChatMessage
deleteCombat ​
deleteCombat: [
CombatLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteCombat
deleteCombatant ​
deleteCombatant: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteCombatant
deleteDrawing ​
deleteDrawing: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteDrawing
deleteFogExploration ​
deleteFogExploration: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteFogExploration
deleteFolder ​
deleteFolder: [
FolderLikeDocument,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteFolder
deleteItem ​
deleteItem: [
ItemLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteItem
deleteJournalEntry ​
deleteJournalEntry: [
JournalEntryLike,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteJournalEntry
deleteJournalEntryPage ​
deleteJournalEntryPage: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteJournalEntryPage
deleteLevel ​
deleteLevel: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteLevel
deleteMacro ​
deleteMacro: [
MacroLike,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteMacro
deleteMeasuredTemplate ​
deleteMeasuredTemplate: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteMeasuredTemplate
deleteNote ​
deleteNote: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteNote
deletePlaylist ​
deletePlaylist: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deletePlaylist
deletePlaylistSound ​
deletePlaylistSound: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deletePlaylistSound
deleteRegion ​
deleteRegion: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteRegion
deleteRegionBehavior ​
deleteRegionBehavior: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteRegionBehavior
deleteRollTable ​
deleteRollTable: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteRollTable
deleteScene ​
deleteScene: [
SceneLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteScene
deleteSetting ​
deleteSetting: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteSetting
deleteTile ​
deleteTile: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteTile
deleteToken ​
deleteToken: [
TokenDocumentLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteToken
deleteUser ​
deleteUser: [
UserLike,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteUser
deleteWall ​
deleteWall: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.deleteWall
destroyAmbientLight ​
destroyAmbientLight: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.destroyAmbientLight
destroyAmbientSound ​
destroyAmbientSound: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.destroyAmbientSound
destroyDrawing ​
destroyDrawing: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.destroyDrawing
destroyMeasuredTemplate ​
destroyMeasuredTemplate: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.destroyMeasuredTemplate
destroyNote ​
destroyNote: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.destroyNote
destroyRegion ​
destroyRegion: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.destroyRegion
destroyTile ​
destroyTile: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.destroyTile
destroyToken ​
destroyToken: [
TokenObjectLike]
Inherited from ​
PlaceableHooks.destroyToken
destroyWall ​
destroyWall: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.destroyWall
drawAmbientLight ​
drawAmbientLight: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.drawAmbientLight
drawAmbientSound ​
drawAmbientSound: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.drawAmbientSound
drawCanvasVisibility ​
drawCanvasVisibility: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawCanvasVisibility
drawControlsLayer ​
drawControlsLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawControlsLayer
drawDrawing ​
drawDrawing: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.drawDrawing
drawDrawingsLayer ​
drawDrawingsLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawDrawingsLayer
drawEffectsCanvasGroup ​
drawEffectsCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawEffectsCanvasGroup
drawEnvironmentCanvasGroup ​
drawEnvironmentCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawEnvironmentCanvasGroup
drawGridLayer ​
drawGridLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawGridLayer
drawHiddenCanvasGroup ​
drawHiddenCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawHiddenCanvasGroup
drawInterfaceCanvasGroup ​
drawInterfaceCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawInterfaceCanvasGroup
drawLightingLayer ​
drawLightingLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawLightingLayer
drawMeasuredTemplate ​
drawMeasuredTemplate: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.drawMeasuredTemplate
drawNote ​
drawNote: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.drawNote
drawNotesLayer ​
drawNotesLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawNotesLayer
drawOverlayCanvasGroup ​
drawOverlayCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawOverlayCanvasGroup
drawPrimaryCanvasGroup ​
drawPrimaryCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawPrimaryCanvasGroup
drawRegion ​
drawRegion: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.drawRegion
drawRegionLayer ​
drawRegionLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawRegionLayer
drawRenderedCanvasGroup ​
drawRenderedCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawRenderedCanvasGroup
drawSoundsLayer ​
drawSoundsLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawSoundsLayer
drawTemplateLayer ​
drawTemplateLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawTemplateLayer
drawTile ​
drawTile: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.drawTile
drawTilesLayer ​
drawTilesLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawTilesLayer
drawToken ​
drawToken: [
TokenObjectLike]
Inherited from ​
PlaceableHooks.drawToken
drawTokenLayer ​
drawTokenLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawTokenLayer
drawWall ​
drawWall: [
PlaceableObjectLike]
Inherited from ​
PlaceableHooks.drawWall
drawWallsLayer ​
drawWallsLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawWallsLayer
drawWeatherEffects ​
drawWeatherEffects: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.drawWeatherEffects
dropActorSheetData ​
dropActorSheetData: [
ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>,ApplicationV2Members,Record<string,unknown>]
Inherited from ​
StaticHooks.dropActorSheetData
dropCanvasData ​
dropCanvasData: [
CanvasApi,Record<string,unknown>,DragEvent]
Inherited from ​
StaticHooks.dropCanvasData
dropItemSheetData ​
dropItemSheetData: [
ItemLike<Record<string,unknown>>,ApplicationV2Members,Record<string,unknown>]
New in v14.
Inherited from ​
StaticHooks.dropItemSheetData
dropRollTableSheetData ​
dropRollTableSheetData: [
DocumentMembers<Record<string,unknown>>,ApplicationV2Members,Record<string,unknown>]
Inherited from ​
StaticHooks.dropRollTableSheetData
error ​
error: [
string,Error,Record<string,unknown>]
Inherited from ​
StaticHooks.error
getActiveEffectContextOptions ​
getActiveEffectContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getActiveEffectContextOptions
getActiveEffectPlaceableContextOptions ​
getActiveEffectPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getActiveEffectPlaceableContextOptions
getActorContextOptions ​
getActorContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getActorContextOptions
getActorPlaceableContextOptions ​
getActorPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getActorPlaceableContextOptions
getAdventureContextOptions ​
getAdventureContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getAdventureContextOptions
getAdventurePlaceableContextOptions ​
getAdventurePlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getAdventurePlaceableContextOptions
getAmbientLightContextOptions ​
getAmbientLightContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getAmbientLightContextOptions
getAmbientLightPlaceableContextOptions ​
getAmbientLightPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getAmbientLightPlaceableContextOptions
getAmbientSoundContextOptions ​
getAmbientSoundContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getAmbientSoundContextOptions
getAmbientSoundPlaceableContextOptions ​
getAmbientSoundPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getAmbientSoundPlaceableContextOptions
getCardContextOptions ​
getCardContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getCardContextOptions
getCardPlaceableContextOptions ​
getCardPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getCardPlaceableContextOptions
getCardsContextOptions ​
getCardsContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getCardsContextOptions
getCardsPlaceableContextOptions ​
getCardsPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getCardsPlaceableContextOptions
getChatMessageContextOptions ​
getChatMessageContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getChatMessageContextOptions
getChatMessagePlaceableContextOptions ​
getChatMessagePlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getChatMessagePlaceableContextOptions
getCombatantContextOptions ​
getCombatantContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getCombatantContextOptions
getCombatantPlaceableContextOptions ​
getCombatantPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getCombatantPlaceableContextOptions
getCombatContextOptions ​
getCombatContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getCombatContextOptions
getCombatPlaceableContextOptions ​
getCombatPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getCombatPlaceableContextOptions
getDrawingContextOptions ​
getDrawingContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getDrawingContextOptions
getDrawingPlaceableContextOptions ​
getDrawingPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getDrawingPlaceableContextOptions
getFogExplorationContextOptions ​
getFogExplorationContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getFogExplorationContextOptions
getFogExplorationPlaceableContextOptions ​
getFogExplorationPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getFogExplorationPlaceableContextOptions
getFolderContextOptions ​
getFolderContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getFolderContextOptions
getFolderPlaceableContextOptions ​
getFolderPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getFolderPlaceableContextOptions
getHeaderControlsApplicationV2 ​
getHeaderControlsApplicationV2: [
ApplicationV2Members,ApplicationHeaderControlsEntry[]]
Inherited from ​
StaticHooks.getHeaderControlsApplicationV2
getItemContextOptions ​
getItemContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getItemContextOptions
getItemPlaceableContextOptions ​
getItemPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getItemPlaceableContextOptions
getJournalEntryContextOptions ​
getJournalEntryContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getJournalEntryContextOptions
getJournalEntryPageContextOptions ​
getJournalEntryPageContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getJournalEntryPageContextOptions
getJournalEntryPagePlaceableContextOptions ​
getJournalEntryPagePlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getJournalEntryPagePlaceableContextOptions
getJournalEntryPlaceableContextOptions ​
getJournalEntryPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getJournalEntryPlaceableContextOptions
getLevelContextOptions ​
getLevelContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getLevelContextOptions
getLevelPlaceableContextOptions ​
getLevelPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getLevelPlaceableContextOptions
getMacroContextOptions ​
getMacroContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getMacroContextOptions
getMacroPlaceableContextOptions ​
getMacroPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getMacroPlaceableContextOptions
getMeasuredTemplateContextOptions ​
getMeasuredTemplateContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getMeasuredTemplateContextOptions
getMeasuredTemplatePlaceableContextOptions ​
getMeasuredTemplatePlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getMeasuredTemplatePlaceableContextOptions
getNoteContextOptions ​
getNoteContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getNoteContextOptions
getNotePlaceableContextOptions ​
getNotePlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getNotePlaceableContextOptions
getPlaylistContextOptions ​
getPlaylistContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getPlaylistContextOptions
getPlaylistPlaceableContextOptions ​
getPlaylistPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getPlaylistPlaceableContextOptions
getPlaylistSoundContextOptions ​
getPlaylistSoundContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getPlaylistSoundContextOptions
getPlaylistSoundPlaceableContextOptions ​
getPlaylistSoundPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getPlaylistSoundPlaceableContextOptions
getProseMirrorMenuDropDowns ​
getProseMirrorMenuDropDowns: [
unknown]
Inherited from ​
StaticHooks.getProseMirrorMenuDropDowns
getProseMirrorMenuItems ​
getProseMirrorMenuItems: [
unknown,unknown[]]
Inherited from ​
StaticHooks.getProseMirrorMenuItems
getRegionBehaviorContextOptions ​
getRegionBehaviorContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getRegionBehaviorContextOptions
getRegionBehaviorPlaceableContextOptions ​
getRegionBehaviorPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getRegionBehaviorPlaceableContextOptions
getRegionContextOptions ​
getRegionContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getRegionContextOptions
getRegionPlaceableContextOptions ​
getRegionPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getRegionPlaceableContextOptions
getRollTableContextOptions ​
getRollTableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getRollTableContextOptions
getRollTablePlaceableContextOptions ​
getRollTablePlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getRollTablePlaceableContextOptions
getSceneContextOptions ​
getSceneContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getSceneContextOptions
getSceneControlButtons ​
getSceneControlButtons: [
Record<string,SceneControl>]
Inherited from ​
StaticHooks.getSceneControlButtons
getScenePlaceableContextOptions ​
getScenePlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getScenePlaceableContextOptions
getSettingContextOptions ​
getSettingContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getSettingContextOptions
getSettingPlaceableContextOptions ​
getSettingPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getSettingPlaceableContextOptions
getTileContextOptions ​
getTileContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getTileContextOptions
getTilePlaceableContextOptions ​
getTilePlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getTilePlaceableContextOptions
getTokenContextOptions ​
getTokenContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getTokenContextOptions
getTokenPlaceableContextOptions ​
getTokenPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getTokenPlaceableContextOptions
getUserContextOptions ​
getUserContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getUserContextOptions
getUserPlaceableContextOptions ​
getUserPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getUserPlaceableContextOptions
getWallContextOptions ​
getWallContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getWallContextOptions
getWallPlaceableContextOptions ​
getWallPlaceableContextOptions: [
ApplicationV2Members,ContextMenuEntry[]]
Inherited from ​
ContextMenuHooks.getWallPlaceableContextOptions
globalAmbientVolumeChanged ​
globalAmbientVolumeChanged: [
number]
The ambient channel. The argument is clamped to 0 through 1.
Inherited from ​
StaticHooks.globalAmbientVolumeChanged
globalInterfaceVolumeChanged ​
globalInterfaceVolumeChanged: [
number]
The interface channel. The argument is clamped to 0 through 1.
Inherited from ​
StaticHooks.globalInterfaceVolumeChanged
globalPlaylistVolumeChanged ​
globalPlaylistVolumeChanged: [
number]
The music channel. The argument is clamped to 0 through 1.
Inherited from ​
StaticHooks.globalPlaylistVolumeChanged
globalVolumeChanged ​
globalVolumeChanged: [
number]
Declared by Foundry, and nothing fires it. The three below are what a volume change actually calls.
Inherited from ​
StaticHooks.globalVolumeChanged
highlightObjects ​
highlightObjects: [
boolean]
Inherited from ​
StaticHooks.highlightObjects
hotbarDrop ​
hotbarDrop: [
unknown,Record<string,unknown>,number]
Inherited from ​
StaticHooks.hotbarDrop
hotReload ​
hotReload: [
HotReloadData]
Inherited from ​
StaticHooks.hotReload
hoverAmbientLight ​
hoverAmbientLight: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.hoverAmbientLight
hoverAmbientSound ​
hoverAmbientSound: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.hoverAmbientSound
hoverDrawing ​
hoverDrawing: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.hoverDrawing
hoverMeasuredTemplate ​
hoverMeasuredTemplate: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.hoverMeasuredTemplate
hoverNote ​
hoverNote: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.hoverNote
hoverRegion ​
hoverRegion: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.hoverRegion
hoverTile ​
hoverTile: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.hoverTile
hoverToken ​
hoverToken: [
TokenObjectLike,boolean]
Inherited from ​
PlaceableHooks.hoverToken
hoverWall ​
hoverWall: [
PlaceableObjectLike,boolean]
Inherited from ​
PlaceableHooks.hoverWall
i18nInit ​
i18nInit: []
Inherited from ​
StaticHooks.i18nInit
importAdventure ​
importAdventure: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,Record<string,DocumentMembers<Record<string,unknown>>[]>,Record<string,DocumentMembers<Record<string,unknown>>[]>]
Inherited from ​
StaticHooks.importAdventure
init ​
init: []
Inherited from ​
StaticHooks.init
initializeCanvasEnvironment ​
initializeCanvasEnvironment: []
Inherited from ​
StaticHooks.initializeCanvasEnvironment
initializeCombatConfiguration ​
initializeCombatConfiguration: [
Record<string,unknown>]
Inherited from ​
StaticHooks.initializeCombatConfiguration
initializeDynamicTokenRingConfig ​
initializeDynamicTokenRingConfig: [
unknown]
CONFIG.Token.ring, before the ring is built.
Inherited from ​
StaticHooks.initializeDynamicTokenRingConfig
initializeEdges ​
initializeEdges: [
SceneLike<Record<string,unknown>>]
Inherited from ​
StaticHooks.initializeEdges
initializeGlobalLightSourceShaders ​
initializeGlobalLightSourceShaders: [
unknown]
Inherited from ​
CanvasLayerHooks.initializeGlobalLightSourceShaders
initializeLightSources ​
initializeLightSources: [
unknown]
The effects group, after its light sources are built.
Inherited from ​
StaticHooks.initializeLightSources
initializePointDarknessSourceShaders ​
initializePointDarknessSourceShaders: [
unknown]
Inherited from ​
CanvasLayerHooks.initializePointDarknessSourceShaders
initializePointLightSourceShaders ​
initializePointLightSourceShaders: [
unknown]
Inherited from ​
CanvasLayerHooks.initializePointLightSourceShaders
initializePointVisionSourceShaders ​
initializePointVisionSourceShaders: [
unknown]
Inherited from ​
CanvasLayerHooks.initializePointVisionSourceShaders
initializePriorityLightSources ​
initializePriorityLightSources: [
unknown]
Inherited from ​
StaticHooks.initializePriorityLightSources
initializeVisionMode ​
initializeVisionMode: [
unknown]
The visibility layer.
Inherited from ​
StaticHooks.initializeVisionMode
initializeVisionSources ​
initializeVisionSources: [
FoundryCollection<unknown>]
Every vision source on the canvas, keyed by id.
Inherited from ​
StaticHooks.initializeVisionSources
initializeWeatherEffects ​
initializeWeatherEffects: [
unknown,Record<string,unknown>]
The weather layer and the config it was given.
Inherited from ​
StaticHooks.initializeWeatherEffects
lightingRefresh ​
lightingRefresh: [
unknown]
Inherited from ​
StaticHooks.lightingRefresh
modifyTokenAttribute ​
modifyTokenAttribute: [{
attribute:string;isBar:boolean;isDelta:boolean;value:number; },Record<string,unknown>,ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>]
Inherited from ​
StaticHooks.modifyTokenAttribute
moveToken ​
moveToken: [
TokenDocumentLike<Record<string,unknown>>,Record<string,unknown>,Record<string,unknown>,UserLike]
Inherited from ​
StaticHooks.moveToken
openDetachedWindow ​
openDetachedWindow: [
string,Window]
New in v14: an application moved into its own browser window.
Inherited from ​
StaticHooks.openDetachedWindow
passCards ​
passCards: [
DocumentMembers<Record<string,unknown>>,DocumentMembers<Record<string,unknown>>,Record<string,unknown>]
Inherited from ​
StaticHooks.passCards
pasteAmbientLight ​
pasteAmbientLight: [
PlaceableObjectLike[],Record<string,unknown>[], {cut:boolean; }]
Inherited from ​
PlaceableHooks.pasteAmbientLight
pasteAmbientSound ​
pasteAmbientSound: [
PlaceableObjectLike[],Record<string,unknown>[], {cut:boolean; }]
Inherited from ​
PlaceableHooks.pasteAmbientSound
pasteDrawing ​
pasteDrawing: [
PlaceableObjectLike[],Record<string,unknown>[], {cut:boolean; }]
Inherited from ​
PlaceableHooks.pasteDrawing
pasteMeasuredTemplate ​
pasteMeasuredTemplate: [
PlaceableObjectLike[],Record<string,unknown>[], {cut:boolean; }]
Inherited from ​
PlaceableHooks.pasteMeasuredTemplate
pasteNote ​
pasteNote: [
PlaceableObjectLike[],Record<string,unknown>[], {cut:boolean; }]
Inherited from ​
PlaceableHooks.pasteNote
pasteRegion ​
pasteRegion: [
PlaceableObjectLike[],Record<string,unknown>[], {cut:boolean; }]
Inherited from ​
PlaceableHooks.pasteRegion
pasteTile ​
pasteTile: [
PlaceableObjectLike[],Record<string,unknown>[], {cut:boolean; }]
Inherited from ​
PlaceableHooks.pasteTile
pasteToken ​
pasteToken: [
TokenObjectLike[],Record<string,unknown>[], {cut:boolean; }]
Inherited from ​
PlaceableHooks.pasteToken
pasteWall ​
pasteWall: [
PlaceableObjectLike[],Record<string,unknown>[], {cut:boolean; }]
Inherited from ​
PlaceableHooks.pasteWall
pauseGame ​
pauseGame: [
boolean, {broadcast?:boolean;userId?:string; }]
Inherited from ​
StaticHooks.pauseGame
pauseToken ​
pauseToken: [
TokenDocumentLike<Record<string,unknown>>]
Inherited from ​
StaticHooks.pauseToken
planToken ​
planToken: [
TokenDocumentLike<Record<string,unknown>>]
New in v14, alongside the rest of the token movement family.
Inherited from ​
StaticHooks.planToken
preCreateActiveEffect ​
preCreateActiveEffect: [
ActiveEffectLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateActiveEffect
preCreateActor ​
preCreateActor: [
ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateActor
preCreateAdventure ​
preCreateAdventure: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateAdventure
preCreateAmbientLight ​
preCreateAmbientLight: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateAmbientLight
preCreateAmbientSound ​
preCreateAmbientSound: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateAmbientSound
preCreateCard ​
preCreateCard: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateCard
preCreateCards ​
preCreateCards: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateCards
preCreateChatMessage ​
preCreateChatMessage: [
ChatMessageLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateChatMessage
preCreateCombat ​
preCreateCombat: [
CombatLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateCombat
preCreateCombatant ​
preCreateCombatant: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateCombatant
preCreateDrawing ​
preCreateDrawing: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateDrawing
preCreateFogExploration ​
preCreateFogExploration: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateFogExploration
preCreateFolder ​
preCreateFolder: [
FolderLikeDocument,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateFolder
preCreateItem ​
preCreateItem: [
ItemLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateItem
preCreateJournalEntry ​
preCreateJournalEntry: [
JournalEntryLike,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateJournalEntry
preCreateJournalEntryPage ​
preCreateJournalEntryPage: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateJournalEntryPage
preCreateLevel ​
preCreateLevel: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateLevel
preCreateMacro ​
preCreateMacro: [
MacroLike,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateMacro
preCreateMeasuredTemplate ​
preCreateMeasuredTemplate: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateMeasuredTemplate
preCreateNote ​
preCreateNote: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateNote
preCreatePlaylist ​
preCreatePlaylist: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreatePlaylist
preCreatePlaylistSound ​
preCreatePlaylistSound: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreatePlaylistSound
preCreateRegion ​
preCreateRegion: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateRegion
preCreateRegionBehavior ​
preCreateRegionBehavior: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateRegionBehavior
preCreateRollTable ​
preCreateRollTable: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateRollTable
preCreateScene ​
preCreateScene: [
SceneLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateScene
preCreateSetting ​
preCreateSetting: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateSetting
preCreateTile ​
preCreateTile: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateTile
preCreateToken ​
preCreateToken: [
TokenDocumentLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateToken
preCreateUser ​
preCreateUser: [
UserLike,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateUser
preCreateWall ​
preCreateWall: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preCreateWall
preDeleteActiveEffect ​
preDeleteActiveEffect: [
ActiveEffectLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteActiveEffect
preDeleteActor ​
preDeleteActor: [
ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteActor
preDeleteAdventure ​
preDeleteAdventure: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteAdventure
preDeleteAmbientLight ​
preDeleteAmbientLight: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteAmbientLight
preDeleteAmbientSound ​
preDeleteAmbientSound: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteAmbientSound
preDeleteCard ​
preDeleteCard: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteCard
preDeleteCards ​
preDeleteCards: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteCards
preDeleteChatMessage ​
preDeleteChatMessage: [
ChatMessageLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteChatMessage
preDeleteCombat ​
preDeleteCombat: [
CombatLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteCombat
preDeleteCombatant ​
preDeleteCombatant: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteCombatant
preDeleteDrawing ​
preDeleteDrawing: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteDrawing
preDeleteFogExploration ​
preDeleteFogExploration: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteFogExploration
preDeleteFolder ​
preDeleteFolder: [
FolderLikeDocument,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteFolder
preDeleteItem ​
preDeleteItem: [
ItemLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteItem
preDeleteJournalEntry ​
preDeleteJournalEntry: [
JournalEntryLike,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteJournalEntry
preDeleteJournalEntryPage ​
preDeleteJournalEntryPage: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteJournalEntryPage
preDeleteLevel ​
preDeleteLevel: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteLevel
preDeleteMacro ​
preDeleteMacro: [
MacroLike,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteMacro
preDeleteMeasuredTemplate ​
preDeleteMeasuredTemplate: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteMeasuredTemplate
preDeleteNote ​
preDeleteNote: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteNote
preDeletePlaylist ​
preDeletePlaylist: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeletePlaylist
preDeletePlaylistSound ​
preDeletePlaylistSound: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeletePlaylistSound
preDeleteRegion ​
preDeleteRegion: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteRegion
preDeleteRegionBehavior ​
preDeleteRegionBehavior: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteRegionBehavior
preDeleteRollTable ​
preDeleteRollTable: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteRollTable
preDeleteScene ​
preDeleteScene: [
SceneLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteScene
preDeleteSetting ​
preDeleteSetting: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteSetting
preDeleteTile ​
preDeleteTile: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteTile
preDeleteToken ​
preDeleteToken: [
TokenDocumentLike<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteToken
preDeleteUser ​
preDeleteUser: [
UserLike,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteUser
preDeleteWall ​
preDeleteWall: [
DocumentMembers<Record<string,unknown>>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preDeleteWall
preImportAdventure ​
preImportAdventure: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,Record<string,Record<string,unknown>[]>,Record<string,Record<string,unknown>[]>]
Inherited from ​
StaticHooks.preImportAdventure
preMoveToken ​
preMoveToken: [
TokenDocumentLike<Record<string,unknown>>,Record<string,unknown>,Record<string,unknown>]
Inherited from ​
StaticHooks.preMoveToken
preRenderApplicationV2 ​
preRenderApplicationV2: [
ApplicationV2Members,ApplicationRenderContext,ApplicationRenderOptions]
Inherited from ​
StaticHooks.preRenderApplicationV2
preUpdateActiveEffect ​
preUpdateActiveEffect: [
ActiveEffectLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateActiveEffect
preUpdateActor ​
preUpdateActor: [
ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateActor
preUpdateAdventure ​
preUpdateAdventure: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateAdventure
preUpdateAmbientLight ​
preUpdateAmbientLight: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateAmbientLight
preUpdateAmbientSound ​
preUpdateAmbientSound: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateAmbientSound
preUpdateCard ​
preUpdateCard: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateCard
preUpdateCards ​
preUpdateCards: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateCards
preUpdateChatMessage ​
preUpdateChatMessage: [
ChatMessageLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateChatMessage
preUpdateCombat ​
preUpdateCombat: [
CombatLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateCombat
preUpdateCombatant ​
preUpdateCombatant: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateCombatant
preUpdateDrawing ​
preUpdateDrawing: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateDrawing
preUpdateFogExploration ​
preUpdateFogExploration: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateFogExploration
preUpdateFolder ​
preUpdateFolder: [
FolderLikeDocument,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateFolder
preUpdateItem ​
preUpdateItem: [
ItemLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateItem
preUpdateJournalEntry ​
preUpdateJournalEntry: [
JournalEntryLike,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateJournalEntry
preUpdateJournalEntryPage ​
preUpdateJournalEntryPage: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateJournalEntryPage
preUpdateLevel ​
preUpdateLevel: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateLevel
preUpdateMacro ​
preUpdateMacro: [
MacroLike,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateMacro
preUpdateMeasuredTemplate ​
preUpdateMeasuredTemplate: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateMeasuredTemplate
preUpdateNote ​
preUpdateNote: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateNote
preUpdatePlaylist ​
preUpdatePlaylist: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdatePlaylist
preUpdatePlaylistSound ​
preUpdatePlaylistSound: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdatePlaylistSound
preUpdateRegion ​
preUpdateRegion: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateRegion
preUpdateRegionBehavior ​
preUpdateRegionBehavior: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateRegionBehavior
preUpdateRollTable ​
preUpdateRollTable: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateRollTable
preUpdateScene ​
preUpdateScene: [
SceneLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateScene
preUpdateSetting ​
preUpdateSetting: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateSetting
preUpdateTile ​
preUpdateTile: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateTile
preUpdateToken ​
preUpdateToken: [
TokenDocumentLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateToken
preUpdateUser ​
preUpdateUser: [
UserLike,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateUser
preUpdateWall ​
preUpdateWall: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.preUpdateWall
ready ​
ready: []
Inherited from ​
StaticHooks.ready
recordToken ​
recordToken: [
TokenDocumentLike<Record<string,unknown>>]
Inherited from ​
StaticHooks.recordToken
refreshAmbientLight ​
refreshAmbientLight: [
PlaceableObjectLike,Record<string,boolean>]
Inherited from ​
PlaceableHooks.refreshAmbientLight
refreshAmbientSound ​
refreshAmbientSound: [
PlaceableObjectLike,Record<string,boolean>]
Inherited from ​
PlaceableHooks.refreshAmbientSound
refreshDrawing ​
refreshDrawing: [
PlaceableObjectLike,Record<string,boolean>]
Inherited from ​
PlaceableHooks.refreshDrawing
refreshMeasuredTemplate ​
refreshMeasuredTemplate: [
PlaceableObjectLike,Record<string,boolean>]
Inherited from ​
PlaceableHooks.refreshMeasuredTemplate
refreshNote ​
refreshNote: [
PlaceableObjectLike,Record<string,boolean>]
Inherited from ​
PlaceableHooks.refreshNote
refreshRegion ​
refreshRegion: [
PlaceableObjectLike,Record<string,boolean>]
Inherited from ​
PlaceableHooks.refreshRegion
refreshTile ​
refreshTile: [
PlaceableObjectLike,Record<string,boolean>]
Inherited from ​
PlaceableHooks.refreshTile
refreshToken ​
refreshToken: [
TokenObjectLike,Record<string,boolean>]
Inherited from ​
PlaceableHooks.refreshToken
refreshWall ​
refreshWall: [
PlaceableObjectLike,Record<string,boolean>]
Inherited from ​
PlaceableHooks.refreshWall
renderApplicationV2 ​
renderApplicationV2: [
ApplicationV2Members,HTMLElement,ApplicationRenderContext,ApplicationRenderOptions]
Inherited from ​
StaticHooks.renderApplicationV2
renderChatInput ​
renderChatInput: [
unknown,Record<string,HTMLElement>,Record<string,unknown>]
Inherited from ​
StaticHooks.renderChatInput
renderChatMessage ​
renderChatMessage: [
ChatMessageLike<Record<string,unknown>>,unknown,Record<string,unknown>]
Replaced by renderChatMessageHTML, and removed in v15. The second argument is the jQuery object the old hook passed.
Inherited from ​
StaticHooks.renderChatMessage
renderChatMessageHTML ​
renderChatMessageHTML: [
ChatMessageLike<Record<string,unknown>>,HTMLElement,Record<string,unknown>]
renderChatMessage, the jQuery one, is deprecated and goes in v15.
Inherited from ​
StaticHooks.renderChatMessageHTML
returnCards ​
returnCards: [
DocumentMembers<Record<string,unknown>>,DocumentMembers<Record<string,unknown>>[],Record<string,unknown>]
Inherited from ​
StaticHooks.returnCards
rtcSettingsChanged ​
rtcSettingsChanged: [
unknown,Record<string,unknown>]
The audio and video settings, and what changed in them.
Inherited from ​
StaticHooks.rtcSettingsChanged
setup ​
setup: []
Inherited from ​
StaticHooks.setup
sightRefresh ​
sightRefresh: [
unknown]
Inherited from ​
StaticHooks.sightRefresh
stopToken ​
stopToken: [
TokenDocumentLike<Record<string,unknown>>]
Inherited from ​
StaticHooks.stopToken
streamReady ​
streamReady: []
Inherited from ​
StaticHooks.streamReady
targetToken ​
targetToken: [
UserLike,TokenObjectLike,boolean]
Inherited from ​
StaticHooks.targetToken
tearDownCanvasVisibility ​
tearDownCanvasVisibility: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownCanvasVisibility
tearDownControlsLayer ​
tearDownControlsLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownControlsLayer
tearDownDrawingsLayer ​
tearDownDrawingsLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownDrawingsLayer
tearDownEffectsCanvasGroup ​
tearDownEffectsCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownEffectsCanvasGroup
tearDownEnvironmentCanvasGroup ​
tearDownEnvironmentCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownEnvironmentCanvasGroup
tearDownGridLayer ​
tearDownGridLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownGridLayer
tearDownHiddenCanvasGroup ​
tearDownHiddenCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownHiddenCanvasGroup
tearDownInterfaceCanvasGroup ​
tearDownInterfaceCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownInterfaceCanvasGroup
tearDownLightingLayer ​
tearDownLightingLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownLightingLayer
tearDownNotesLayer ​
tearDownNotesLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownNotesLayer
tearDownOverlayCanvasGroup ​
tearDownOverlayCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownOverlayCanvasGroup
tearDownPrimaryCanvasGroup ​
tearDownPrimaryCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownPrimaryCanvasGroup
tearDownRegionLayer ​
tearDownRegionLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownRegionLayer
tearDownRenderedCanvasGroup ​
tearDownRenderedCanvasGroup: [
unknown,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownRenderedCanvasGroup
tearDownSoundsLayer ​
tearDownSoundsLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownSoundsLayer
tearDownTemplateLayer ​
tearDownTemplateLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownTemplateLayer
tearDownTilesLayer ​
tearDownTilesLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownTilesLayer
tearDownTokenLayer ​
tearDownTokenLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownTokenLayer
tearDownWallsLayer ​
tearDownWallsLayer: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownWallsLayer
tearDownWeatherEffects ​
tearDownWeatherEffects: [
CanvasLayerLike,Record<string,unknown>]
Inherited from ​
CanvasLayerHooks.tearDownWeatherEffects
updateActiveEffect ​
updateActiveEffect: [
ActiveEffectLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateActiveEffect
updateActor ​
updateActor: [
ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateActor
updateAdventure ​
updateAdventure: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateAdventure
updateAmbientLight ​
updateAmbientLight: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateAmbientLight
updateAmbientSound ​
updateAmbientSound: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateAmbientSound
updateCard ​
updateCard: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateCard
updateCards ​
updateCards: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateCards
updateChatMessage ​
updateChatMessage: [
ChatMessageLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateChatMessage
updateCombat ​
updateCombat: [
CombatLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateCombat
updateCombatant ​
updateCombatant: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateCombatant
updateCompendium ​
updateCompendium: [
CompendiumCollection,DocumentMembers<Record<string,unknown>>[],Record<string,unknown>,string]
Inherited from ​
StaticHooks.updateCompendium
updateDrawing ​
updateDrawing: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateDrawing
updateFogExploration ​
updateFogExploration: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateFogExploration
updateFolder ​
updateFolder: [
FolderLikeDocument,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateFolder
updateItem ​
updateItem: [
ItemLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateItem
updateJournalEntry ​
updateJournalEntry: [
JournalEntryLike,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateJournalEntry
updateJournalEntryPage ​
updateJournalEntryPage: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateJournalEntryPage
updateLevel ​
updateLevel: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateLevel
updateMacro ​
updateMacro: [
MacroLike,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateMacro
updateMeasuredTemplate ​
updateMeasuredTemplate: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateMeasuredTemplate
updateNote ​
updateNote: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateNote
updatePlaylist ​
updatePlaylist: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updatePlaylist
updatePlaylistSound ​
updatePlaylistSound: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updatePlaylistSound
updateRegion ​
updateRegion: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateRegion
updateRegionBehavior ​
updateRegionBehavior: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateRegionBehavior
updateRollTable ​
updateRollTable: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateRollTable
updateScene ​
updateScene: [
SceneLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateScene
updateSetting ​
updateSetting: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateSetting
updateTile ​
updateTile: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateTile
updateToken ​
updateToken: [
TokenDocumentLike<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateToken
updateUser ​
updateUser: [
UserLike,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateUser
updateWall ​
updateWall: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,DatabaseOperationOptions,string]
Inherited from ​
DocumentLifecycleHooks.updateWall
updateWorldTime ​
updateWorldTime: [
number,number,Record<string,unknown>,string]
Inherited from ​
StaticHooks.updateWorldTime
userConnected ​
userConnected: [
UserLike,boolean]
Inherited from ​
StaticHooks.userConnected
visibilityRefresh ​
visibilityRefresh: [
unknown]
Inherited from ​
StaticHooks.visibilityRefresh