@vttforge/types / StaticHooks
Interface: StaticHooks ​
The hooks Foundry names itself.
Extended by ​
Properties ​
activateCanvasLayer ​
activateCanvasLayer: [
unknown]
activateEditorLegacy ​
activateEditorLegacy: [
unknown,Record<string,unknown>,string]
The editor a legacy rich text field opened. Removed in v15.
activateNote ​
activateNote: [
unknown,Record<string,unknown>]
applyActiveEffect ​
applyActiveEffect: [
ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>,Record<string,unknown>,unknown,unknown,Record<string,unknown>]
applyCompendiumArt ​
applyCompendiumArt: [
unknown,Record<string,unknown>,CompendiumCollection,Record<string,unknown>]
applyTokenStatusEffect ​
applyTokenStatusEffect: [
TokenObjectLike,string,boolean]
canvasConfig ​
canvasConfig: [
Record<string,unknown>]
canvasDraw ​
canvasDraw: [
CanvasApi]
canvasInit ​
canvasInit: [
CanvasApi]
canvasPan ​
canvasPan: [
CanvasApi, {scale:number;x:number;y:number; }]
canvasReady ​
canvasReady: [
CanvasApi]
canvasTearDown ​
canvasTearDown: [
CanvasApi,Record<string,unknown>]
changeSidebarTab ​
changeSidebarTab: [
unknown]
chatBubble ​
chatBubble: [
TokenObjectLike,unknown,string,Record<string,unknown>]
Replaced by chatBubbleHTML, and removed in v15.
chatBubbleHTML ​
chatBubbleHTML: [
TokenObjectLike,HTMLElement,string,Record<string,unknown>]
chatInput ​
chatInput: [
KeyboardEvent, {recordPending:boolean; }]
chatMessage ​
chatMessage: [
unknown,string,Record<string,unknown>]
clientSettingChanged ​
clientSettingChanged: [
string,unknown,Record<string,unknown>]
closeApplicationV2 ​
closeApplicationV2: [
ApplicationV2Members]
closeDetachedWindow ​
closeDetachedWindow: [
string,Window]
collapseSceneNavigation ​
collapseSceneNavigation: [
unknown,boolean]
collapseSidebar ​
collapseSidebar: [
unknown,boolean]
combatRound ​
combatRound: [
CombatLike<Record<string,unknown>>, {round:number;turn:number; }, {direction:number; }]
combatStart ​
combatStart: [
CombatLike<Record<string,unknown>>, {round:number;turn:number; }]
combatTurn ​
combatTurn: [
CombatLike<Record<string,unknown>>, {round:number;turn:number; }, {direction:number; }]
combatTurnChange ​
combatTurnChange: [
CombatLike<Record<string,unknown>>,CombatHistoryData,CombatHistoryData]
configureCanvasEnvironment ​
configureCanvasEnvironment: [
Record<string,unknown>]
The environment config, before the canvas reads it.
createProseMirrorEditor ​
createProseMirrorEditor: [
string,Record<string,unknown>]
dealCards ​
dealCards: [
DocumentMembers<Record<string,unknown>>,DocumentMembers<Record<string,unknown>>[],Record<string,unknown>]
dropActorSheetData ​
dropActorSheetData: [
ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>,ApplicationV2Members,Record<string,unknown>]
dropCanvasData ​
dropCanvasData: [
CanvasApi,Record<string,unknown>,DragEvent]
dropItemSheetData ​
dropItemSheetData: [
ItemLike<Record<string,unknown>>,ApplicationV2Members,Record<string,unknown>]
New in v14.
dropRollTableSheetData ​
dropRollTableSheetData: [
DocumentMembers<Record<string,unknown>>,ApplicationV2Members,Record<string,unknown>]
error ​
error: [
string,Error,Record<string,unknown>]
getHeaderControlsApplicationV2 ​
getHeaderControlsApplicationV2: [
ApplicationV2Members,ApplicationHeaderControlsEntry[]]
getProseMirrorMenuDropDowns ​
getProseMirrorMenuDropDowns: [
unknown]
getProseMirrorMenuItems ​
getProseMirrorMenuItems: [
unknown,unknown[]]
getSceneControlButtons ​
getSceneControlButtons: [
Record<string,SceneControl>]
globalAmbientVolumeChanged ​
globalAmbientVolumeChanged: [
number]
The ambient channel. The argument is clamped to 0 through 1.
globalInterfaceVolumeChanged ​
globalInterfaceVolumeChanged: [
number]
The interface channel. The argument is clamped to 0 through 1.
globalPlaylistVolumeChanged ​
globalPlaylistVolumeChanged: [
number]
The music channel. The argument is clamped to 0 through 1.
globalVolumeChanged ​
globalVolumeChanged: [
number]
Declared by Foundry, and nothing fires it. The three below are what a volume change actually calls.
highlightObjects ​
highlightObjects: [
boolean]
hotbarDrop ​
hotbarDrop: [
unknown,Record<string,unknown>,number]
hotReload ​
hotReload: [
HotReloadData]
i18nInit ​
i18nInit: []
importAdventure ​
importAdventure: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,Record<string,DocumentMembers<Record<string,unknown>>[]>,Record<string,DocumentMembers<Record<string,unknown>>[]>]
init ​
init: []
initializeCanvasEnvironment ​
initializeCanvasEnvironment: []
initializeCombatConfiguration ​
initializeCombatConfiguration: [
Record<string,unknown>]
initializeDynamicTokenRingConfig ​
initializeDynamicTokenRingConfig: [
unknown]
CONFIG.Token.ring, before the ring is built.
initializeEdges ​
initializeEdges: [
SceneLike<Record<string,unknown>>]
initializeLightSources ​
initializeLightSources: [
unknown]
The effects group, after its light sources are built.
initializePriorityLightSources ​
initializePriorityLightSources: [
unknown]
initializeVisionMode ​
initializeVisionMode: [
unknown]
The visibility layer.
initializeVisionSources ​
initializeVisionSources: [
FoundryCollection<unknown>]
Every vision source on the canvas, keyed by id.
initializeWeatherEffects ​
initializeWeatherEffects: [
unknown,Record<string,unknown>]
The weather layer and the config it was given.
lightingRefresh ​
lightingRefresh: [
unknown]
modifyTokenAttribute ​
modifyTokenAttribute: [{
attribute:string;isBar:boolean;isDelta:boolean;value:number; },Record<string,unknown>,ActorLike<Record<string,unknown>,ItemLike<Record<string,unknown>>>]
moveToken ​
moveToken: [
TokenDocumentLike<Record<string,unknown>>,Record<string,unknown>,Record<string,unknown>,UserLike]
openDetachedWindow ​
openDetachedWindow: [
string,Window]
New in v14: an application moved into its own browser window.
passCards ​
passCards: [
DocumentMembers<Record<string,unknown>>,DocumentMembers<Record<string,unknown>>,Record<string,unknown>]
pauseGame ​
pauseGame: [
boolean, {broadcast?:boolean;userId?:string; }]
pauseToken ​
pauseToken: [
TokenDocumentLike<Record<string,unknown>>]
planToken ​
planToken: [
TokenDocumentLike<Record<string,unknown>>]
New in v14, alongside the rest of the token movement family.
preImportAdventure ​
preImportAdventure: [
DocumentMembers<Record<string,unknown>>,Record<string,unknown>,Record<string,Record<string,unknown>[]>,Record<string,Record<string,unknown>[]>]
preMoveToken ​
preMoveToken: [
TokenDocumentLike<Record<string,unknown>>,Record<string,unknown>,Record<string,unknown>]
preRenderApplicationV2 ​
preRenderApplicationV2: [
ApplicationV2Members,ApplicationRenderContext,ApplicationRenderOptions]
ready ​
ready: []
recordToken ​
recordToken: [
TokenDocumentLike<Record<string,unknown>>]
renderApplicationV2 ​
renderApplicationV2: [
ApplicationV2Members,HTMLElement,ApplicationRenderContext,ApplicationRenderOptions]
renderChatInput ​
renderChatInput: [
unknown,Record<string,HTMLElement>,Record<string,unknown>]
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.
renderChatMessageHTML ​
renderChatMessageHTML: [
ChatMessageLike<Record<string,unknown>>,HTMLElement,Record<string,unknown>]
renderChatMessage, the jQuery one, is deprecated and goes in v15.
returnCards ​
returnCards: [
DocumentMembers<Record<string,unknown>>,DocumentMembers<Record<string,unknown>>[],Record<string,unknown>]
rtcSettingsChanged ​
rtcSettingsChanged: [
unknown,Record<string,unknown>]
The audio and video settings, and what changed in them.
setup ​
setup: []
sightRefresh ​
sightRefresh: [
unknown]
stopToken ​
stopToken: [
TokenDocumentLike<Record<string,unknown>>]
streamReady ​
streamReady: []
targetToken ​
targetToken: [
UserLike,TokenObjectLike,boolean]
updateCompendium ​
updateCompendium: [
CompendiumCollection,DocumentMembers<Record<string,unknown>>[],Record<string,unknown>,string]
updateWorldTime ​
updateWorldTime: [
number,number,Record<string,unknown>,string]
userConnected ​
userConnected: [
UserLike,boolean]
visibilityRefresh ​
visibilityRefresh: [
unknown]