@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -3
- package/package.json +40 -18
- package/src/configuration/configuration.d.mts +24 -23
- package/src/configuration/documents.d.mts +295 -0
- package/src/configuration/globals.d.mts +8 -2
- package/src/configuration/index.d.mts +1 -0
- package/src/foundry/client/apps/app.d.mts +121 -119
- package/src/foundry/client/apps/av/av-config.d.mts +13 -8
- package/src/foundry/client/apps/av/cameras.d.mts +11 -11
- package/src/foundry/client/apps/dice/dice-config.d.mts +22 -8
- package/src/foundry/client/apps/form.d.mts +112 -94
- package/src/foundry/client/apps/forms/actor.d.mts +22 -12
- package/src/foundry/client/apps/forms/adventure-exporter.d.mts +13 -8
- package/src/foundry/client/apps/forms/adventure-importer.d.mts +15 -7
- package/src/foundry/client/apps/forms/base-sheet.d.mts +14 -7
- package/src/foundry/client/apps/forms/card-config.d.mts +17 -9
- package/src/foundry/client/apps/forms/cards-config.d.mts +13 -14
- package/src/foundry/client/apps/forms/combat-config.d.mts +7 -7
- package/src/foundry/client/apps/forms/combatant-config.d.mts +4 -4
- package/src/foundry/client/apps/forms/default-sheets-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/effect-config.d.mts +6 -6
- package/src/foundry/client/apps/forms/folder-config.d.mts +5 -5
- package/src/foundry/client/apps/forms/fonts.d.mts +42 -35
- package/src/foundry/client/apps/forms/grid-config.d.mts +11 -11
- package/src/foundry/client/apps/forms/image-popout.d.mts +28 -22
- package/src/foundry/client/apps/forms/item.d.mts +6 -6
- package/src/foundry/client/apps/forms/journal-page-sheet.d.mts +17 -15
- package/src/foundry/client/apps/forms/journal-sheet.d.mts +46 -37
- package/src/foundry/client/apps/forms/macro-config.d.mts +6 -6
- package/src/foundry/client/apps/forms/measure-template.d.mts +8 -8
- package/src/foundry/client/apps/forms/ownership.d.mts +5 -5
- package/src/foundry/client/apps/forms/playlist-config.d.mts +7 -9
- package/src/foundry/client/apps/forms/playlist-sound-config.d.mts +6 -6
- package/src/foundry/client/apps/forms/roll-table-config.d.mts +9 -10
- package/src/foundry/client/apps/forms/scene-config.d.mts +39 -39
- package/src/foundry/client/apps/forms/sheet-config.d.mts +8 -8
- package/src/foundry/client/apps/forms/user-config.d.mts +11 -11
- package/src/foundry/client/apps/hud/chatbubble.d.mts +14 -9
- package/src/foundry/client/apps/hud/container.d.mts +3 -3
- package/src/foundry/client/apps/hud/controls.d.mts +124 -84
- package/src/foundry/client/apps/hud/hotbar.d.mts +12 -12
- package/src/foundry/client/apps/hud/hud.d.mts +4 -4
- package/src/foundry/client/apps/hud/menu.d.mts +6 -6
- package/src/foundry/client/apps/hud/navigation.d.mts +11 -11
- package/src/foundry/client/apps/hud/pause.d.mts +7 -7
- package/src/foundry/client/apps/hud/players.d.mts +11 -11
- package/src/foundry/client/apps/i18n.d.mts +31 -27
- package/src/foundry/client/apps/placeables/drawing-config.d.mts +41 -33
- package/src/foundry/client/apps/placeables/drawing-hud.d.mts +4 -4
- package/src/foundry/client/apps/placeables/index.d.mts +0 -2
- package/src/foundry/client/apps/placeables/note-config.d.mts +27 -17
- package/src/foundry/client/apps/placeables/tile-config.d.mts +23 -10
- package/src/foundry/client/apps/placeables/tile-hud.d.mts +8 -8
- package/src/foundry/client/apps/placeables/token-config.d.mts +84 -63
- package/src/foundry/client/apps/placeables/token-hud.d.mts +10 -10
- package/src/foundry/client/apps/placeables/wall-config.d.mts +19 -16
- package/src/foundry/client/apps/sidebar/apps/chat-popout.d.mts +5 -5
- package/src/foundry/client/apps/sidebar/apps/client-settings.d.mts +2 -2
- package/src/foundry/client/apps/sidebar/apps/compendium.d.mts +13 -10
- package/src/foundry/client/apps/sidebar/apps/invitation-links.d.mts +3 -3
- package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/apps/module-management.d.mts +6 -6
- package/src/foundry/client/apps/sidebar/apps/permission-config.d.mts +6 -6
- package/src/foundry/client/apps/sidebar/apps/support-details.d.mts +33 -28
- package/src/foundry/client/apps/sidebar/apps/tours-management.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/apps/world-config.d.mts +12 -9
- package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts +40 -32
- package/src/foundry/client/apps/sidebar/document-directory.d.mts +44 -37
- package/src/foundry/client/apps/sidebar/package-configuration.d.mts +3 -3
- package/src/foundry/client/apps/sidebar/sidebar-tab.d.mts +3 -3
- package/src/foundry/client/apps/sidebar/sidebar.d.mts +7 -7
- package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts +4 -4
- package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts +4 -4
- package/src/foundry/client/apps/sidebar/tabs/chat-log.d.mts +34 -29
- package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.mts +15 -15
- package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.mts +21 -12
- package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts +4 -4
- package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.mts +4 -4
- package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts +8 -8
- package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts +21 -21
- package/src/foundry/client/apps/sidebar/tabs/roll-table-directory.d.mts +4 -4
- package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts +6 -6
- package/src/foundry/client/apps/sidebar/tabs/settings.d.mts +12 -12
- package/src/foundry/client/apps/templates.d.mts +2 -2
- package/src/foundry/client/av/clients/simplepeer.d.mts +4 -4
- package/src/foundry/client/av/settings.d.mts +16 -13
- package/src/foundry/client/config.d.mts +1982 -1823
- package/src/foundry/client/core/document-index.d.mts +12 -4
- package/src/foundry/client/core/hooks.d.mts +0 -2
- package/src/foundry/client/core/image.d.mts +13 -11
- package/src/foundry/client/core/issues.d.mts +11 -6
- package/src/foundry/client/core/keybindings.d.mts +3 -3
- package/src/foundry/client/core/nue.d.mts +1 -1
- package/src/foundry/client/core/packages.d.mts +393 -63
- package/src/foundry/client/core/settings.d.mts +34 -12
- package/src/foundry/client/core/socket.d.mts +2 -2
- package/src/foundry/client/core/sorting.d.mts +6 -6
- package/src/foundry/client/core/time.d.mts +6 -3
- package/src/foundry/client/core/tooltip.d.mts +1 -1
- package/src/foundry/client/core/tour.d.mts +58 -49
- package/src/foundry/client/core/tours.d.mts +1 -1
- package/src/foundry/client/core/utils.d.mts +3 -3
- package/src/foundry/client/core/workers.d.mts +24 -17
- package/src/foundry/client/data/abstract/canvas-document.d.mts +9 -15
- package/src/foundry/client/data/abstract/client-document.d.mts +133 -172
- package/src/foundry/client/data/abstract/directory-collection-mixin.d.mts +14 -36
- package/src/foundry/client/data/abstract/document-collection.d.mts +89 -65
- package/src/foundry/client/data/abstract/world-collection.d.mts +47 -53
- package/src/foundry/client/data/collections/actors.d.mts +24 -31
- package/src/foundry/client/data/collections/cards.d.mts +10 -6
- package/src/foundry/client/data/collections/combats.d.mts +12 -8
- package/src/foundry/client/data/collections/compendium-collection.d.mts +79 -66
- package/src/foundry/client/data/collections/compendium-folders.d.mts +6 -6
- package/src/foundry/client/data/collections/compendium-packs.d.mts +4 -4
- package/src/foundry/client/data/collections/fog.d.mts +10 -6
- package/src/foundry/client/data/collections/folder.d.mts +15 -10
- package/src/foundry/client/data/collections/items.d.mts +11 -7
- package/src/foundry/client/data/collections/journal.d.mts +16 -10
- package/src/foundry/client/data/collections/macros.d.mts +15 -22
- package/src/foundry/client/data/collections/messages.d.mts +14 -10
- package/src/foundry/client/data/collections/playlists.d.mts +12 -9
- package/src/foundry/client/data/collections/scenes.d.mts +19 -31
- package/src/foundry/client/data/collections/settings.d.mts +10 -6
- package/src/foundry/client/data/collections/tables.d.mts +11 -7
- package/src/foundry/client/data/collections/users.d.mts +14 -11
- package/src/foundry/client/data/documents/active-effect.d.mts +652 -88
- package/src/foundry/client/data/documents/actor-delta.d.mts +672 -28
- package/src/foundry/client/data/documents/actor.d.mts +722 -60
- package/src/foundry/client/data/documents/adventure.d.mts +482 -49
- package/src/foundry/client/data/documents/ambient-light.d.mts +426 -21
- package/src/foundry/client/data/documents/ambient-sound.d.mts +474 -15
- package/src/foundry/client/data/documents/card.d.mts +570 -39
- package/src/foundry/client/data/documents/cards.d.mts +742 -78
- package/src/foundry/client/data/documents/chat-message.d.mts +578 -45
- package/src/foundry/client/data/documents/combat.d.mts +701 -71
- package/src/foundry/client/data/documents/combatant.d.mts +510 -28
- package/src/foundry/client/data/documents/drawing.d.mts +543 -16
- package/src/foundry/client/data/documents/fog-exploration.d.mts +413 -27
- package/src/foundry/client/data/documents/folder.d.mts +461 -40
- package/src/foundry/client/data/documents/item.d.mts +679 -25
- package/src/foundry/client/data/documents/journal-entry-page.d.mts +587 -21
- package/src/foundry/client/data/documents/journal-entry.d.mts +621 -20
- package/src/foundry/client/data/documents/macro.d.mts +530 -25
- package/src/foundry/client/data/documents/measured-template.d.mts +480 -16
- package/src/foundry/client/data/documents/note.d.mts +495 -18
- package/src/foundry/client/data/documents/playlist-sound.d.mts +429 -27
- package/src/foundry/client/data/documents/playlist.d.mts +666 -75
- package/src/foundry/client/data/documents/region-behavior.d.mts +468 -38
- package/src/foundry/client/data/documents/region.d.mts +661 -35
- package/src/foundry/client/data/documents/scene.d.mts +986 -149
- package/src/foundry/client/data/documents/setting.d.mts +397 -15
- package/src/foundry/client/data/documents/table-result.d.mts +479 -17
- package/src/foundry/client/data/documents/table.d.mts +663 -80
- package/src/foundry/client/data/documents/tile.d.mts +502 -16
- package/src/foundry/client/data/documents/token.d.mts +1114 -90
- package/src/foundry/client/data/documents/user.d.mts +495 -27
- package/src/foundry/client/data/documents/wall.d.mts +550 -15
- package/src/foundry/client/game.d.mts +58 -92
- package/src/foundry/client/head.d.mts +5 -6
- package/src/foundry/client/hooks.d.mts +237 -221
- package/src/foundry/client/pixi/board.d.mts +95 -89
- package/src/foundry/client/pixi/core/containers/base-canvas-group.d.mts +6 -5
- package/src/foundry/client/pixi/core/containers/cached-container.d.mts +5 -5
- package/src/foundry/client/pixi/core/containers/full-canvas-container.d.mts +2 -2
- package/src/foundry/client/pixi/core/containers/point-source-mesh.d.mts +3 -3
- package/src/foundry/client/pixi/core/containers/quad-mesh.d.mts +3 -3
- package/src/foundry/client/pixi/core/containers/quadtree.d.mts +23 -21
- package/src/foundry/client/pixi/core/containers/sprite-mesh.d.mts +5 -5
- package/src/foundry/client/pixi/core/containers/unbound-container.d.mts +5 -5
- package/src/foundry/client/pixi/core/interaction/canvas-animation.d.mts +57 -51
- package/src/foundry/client/pixi/core/interaction/control-icon.d.mts +3 -3
- package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts +7 -7
- package/src/foundry/client/pixi/core/interaction/ping.d.mts +19 -11
- package/src/foundry/client/pixi/core/interaction/pings/chevron.d.mts +7 -2
- package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts +29 -23
- package/src/foundry/client/pixi/core/interaction/render-flags.d.mts +83 -38
- package/src/foundry/client/pixi/core/interaction/resize-handle.d.mts +3 -3
- package/src/foundry/client/pixi/core/interaction/targets.d.mts +9 -9
- package/src/foundry/client/pixi/core/loader.d.mts +8 -8
- package/src/foundry/client/pixi/core/shapes/limited-angle-polygon.d.mts +9 -4
- package/src/foundry/client/pixi/core/shapes/polygon-mesher.d.mts +3 -3
- package/src/foundry/client/pixi/core/shapes/precise-text.d.mts +3 -3
- package/src/foundry/client/pixi/core/shapes/ray.d.mts +23 -17
- package/src/foundry/client/pixi/core/shapes/source-polygon.d.mts +19 -14
- package/src/foundry/client/pixi/extensions/circle.d.mts +1 -1
- package/src/foundry/client/pixi/extensions/observable-transform.d.mts +3 -3
- package/src/foundry/client/pixi/groups/effects.d.mts +4 -4
- package/src/foundry/client/pixi/groups/environment.d.mts +5 -5
- package/src/foundry/client/pixi/groups/hidden.d.mts +3 -3
- package/src/foundry/client/pixi/groups/interface.d.mts +6 -6
- package/src/foundry/client/pixi/groups/overlay.d.mts +3 -3
- package/src/foundry/client/pixi/groups/primary.d.mts +11 -11
- package/src/foundry/client/pixi/groups/rendered.d.mts +3 -3
- package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts +3 -3
- package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts +13 -13
- package/src/foundry/client/pixi/layers/base/placeables-layer.d.mts +279 -233
- package/src/foundry/client/pixi/layers/controls/cursor.d.mts +17 -8
- package/src/foundry/client/pixi/layers/controls/door.d.mts +26 -14
- package/src/foundry/client/pixi/layers/controls/layer.d.mts +89 -79
- package/src/foundry/client/pixi/layers/controls/ruler.d.mts +121 -96
- package/src/foundry/client/pixi/layers/effects/background-effects.d.mts +4 -5
- package/src/foundry/client/pixi/layers/effects/coloration-effects.d.mts +6 -4
- package/src/foundry/client/pixi/layers/effects/darkness-effects.d.mts +7 -4
- package/src/foundry/client/pixi/layers/effects/illumination-effects.d.mts +19 -16
- package/src/foundry/client/pixi/layers/effects/visibility.d.mts +101 -84
- package/src/foundry/client/pixi/layers/effects/weather/particles/effect.d.mts +13 -4
- package/src/foundry/client/pixi/layers/effects/weather/particles/leaves.d.mts +31 -2
- package/src/foundry/client/pixi/layers/effects/weather-effects.d.mts +134 -59
- package/src/foundry/client/pixi/layers/grid/highlight.d.mts +13 -3
- package/src/foundry/client/pixi/layers/grid/layer.d.mts +89 -87
- package/src/foundry/client/pixi/layers/grid/mesh.d.mts +36 -15
- package/src/foundry/client/pixi/layers/masks/depth.d.mts +3 -3
- package/src/foundry/client/pixi/layers/masks/occlusion.d.mts +4 -4
- package/src/foundry/client/pixi/layers/masks/vision.d.mts +6 -6
- package/src/foundry/client/pixi/layers/placeables/drawings.d.mts +15 -11
- package/src/foundry/client/pixi/layers/placeables/lighting.d.mts +11 -10
- package/src/foundry/client/pixi/layers/placeables/notes.d.mts +47 -28
- package/src/foundry/client/pixi/layers/placeables/regions.d.mts +25 -12
- package/src/foundry/client/pixi/layers/placeables/sounds.d.mts +81 -63
- package/src/foundry/client/pixi/layers/placeables/templates.d.mts +10 -11
- package/src/foundry/client/pixi/layers/placeables/tiles.d.mts +28 -17
- package/src/foundry/client/pixi/layers/placeables/tokens.d.mts +67 -46
- package/src/foundry/client/pixi/layers/placeables/walls.d.mts +50 -51
- package/src/foundry/client/pixi/perception/clockwise-sweep.d.mts +22 -16
- package/src/foundry/client/pixi/perception/detection-mode.d.mts +123 -51
- package/src/foundry/client/pixi/perception/fog.d.mts +34 -19
- package/src/foundry/client/pixi/perception/perception-manager.d.mts +137 -137
- package/src/foundry/client/pixi/perception/vision-mode.d.mts +92 -67
- package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts +3 -3
- package/src/foundry/client/pixi/placeable.d.mts +241 -146
- package/src/foundry/client/pixi/placeables/drawing.d.mts +260 -134
- package/src/foundry/client/pixi/placeables/light.d.mts +204 -66
- package/src/foundry/client/pixi/placeables/note.d.mts +150 -55
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts +7 -6
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts +3 -3
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts +2 -2
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts +4 -4
- package/src/foundry/client/pixi/placeables/region.d.mts +219 -110
- package/src/foundry/client/pixi/placeables/sound.d.mts +211 -68
- package/src/foundry/client/pixi/placeables/template.d.mts +186 -100
- package/src/foundry/client/pixi/placeables/tile.d.mts +211 -142
- package/src/foundry/client/pixi/placeables/token.d.mts +911 -568
- package/src/foundry/client/pixi/placeables/wall.d.mts +253 -130
- package/src/foundry/client/pixi/webgl/extensions/batch-renderer.d.mts +27 -5
- package/src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/helpers/framebuffer-snapshot.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/helpers/smooth-noise.d.mts +13 -5
- package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts +6 -6
- package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts +2 -2
- package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts +4 -4
- package/src/foundry/client/pixi/webgl/shaders/filters/base-mask-filter.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/filters/blur.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/filters/effects-masking.d.mts +6 -3
- package/src/foundry/client/pixi/webgl/shaders/filters/environment.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/filters/glow-overlay.d.mts +4 -4
- package/src/foundry/client/pixi/webgl/shaders/filters/invisibility.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/filters/outline-overlay.d.mts +4 -4
- package/src/foundry/client/pixi/webgl/shaders/filters/transition.d.mts +6 -6
- package/src/foundry/client/pixi/webgl/shaders/filters/visibility.d.mts +8 -5
- package/src/foundry/client/pixi/webgl/shaders/filters/vision-mask-filter.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/filters/void.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/filters/weather-occlusion-masks.d.mts +4 -4
- package/src/foundry/client/pixi/webgl/shaders/fragment-channel-mixin.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/grid/grid.d.mts +4 -4
- package/src/foundry/client/pixi/webgl/shaders/lighting/background-lighting.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/base-lighting.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/coloration-lighting.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/darkness-lighting.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/bewitching-wave.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/black-hole.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/chroma.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/emanation.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/energy-field.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fairy-light.d.mts +6 -6
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/flame.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fog.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/force-grid.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/ghost-light.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/hexa-dome.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/light-dome.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/magical-gloom.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/pulse.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/radial-rainbow.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/revolving-light.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/roiling-mass.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/siren-light.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/smoke-patch.d.mts +6 -5
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/star-light.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/sunburst.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/swirling-rainbow.d.mts +4 -3
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/torch.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/vortex.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/wave.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/lighting/illumination-lighting.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/region/adjust-darkness-level.d.mts +7 -7
- package/src/foundry/client/pixi/webgl/shaders/region/base.d.mts +4 -4
- package/src/foundry/client/pixi/webgl/shaders/region/highlight.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/samplers/base-sampler.d.mts +4 -4
- package/src/foundry/client/pixi/webgl/shaders/samplers/baseline-illumination.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/samplers/color-adjustment.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/samplers/depth.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/samplers/fog-of-war.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/samplers/occlusion.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/samplers/primary.d.mts +4 -4
- package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts +4 -6
- package/src/foundry/client/pixi/webgl/shaders/vision/background-vision.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/vision/base-vision.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/vision/coloration-vision.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/vision/effects/amplification.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/vision/effects/wave.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/vision/illumination-vision.d.mts +3 -3
- package/src/foundry/client/pixi/webgl/shaders/weather/base-weather.d.mts +14 -15
- package/src/foundry/client/pixi/webgl/shaders/weather/effect.d.mts +20 -27
- package/src/foundry/client/pixi/webgl/shaders/weather/fog.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/weather/rain.d.mts +5 -5
- package/src/foundry/client/pixi/webgl/shaders/weather/snow.d.mts +5 -5
- package/src/foundry/client/pixi/workers/texture-worker.d.mts +5 -5
- package/src/foundry/client/tours/setup-tour.d.mts +15 -10
- package/src/foundry/client/ui/dialog.d.mts +3 -3
- package/src/foundry/client/ui/dragdrop.d.mts +33 -27
- package/src/foundry/client/ui/editor.d.mts +29 -21
- package/src/foundry/client/ui/filepicker.d.mts +42 -37
- package/src/foundry/client/ui/filter.d.mts +60 -48
- package/src/foundry/client/ui/forms.d.mts +22 -22
- package/src/foundry/client/ui/prosemirror.d.mts +15 -7
- package/src/foundry/client/ui/secrets.d.mts +43 -28
- package/src/foundry/client/ui/tabs.d.mts +40 -33
- package/src/foundry/client-esm/_module.d.mts +5 -5
- package/src/foundry/client-esm/_types.d.mts +2 -1
- package/src/foundry/client-esm/applications/api/application.d.mts +93 -31
- package/src/foundry/client-esm/applications/api/dialog.d.mts +23 -23
- package/src/foundry/client-esm/applications/api/document-sheet.d.mts +85 -32
- package/src/foundry/client-esm/applications/api/handlebars-application.d.mts +1 -1
- package/src/foundry/client-esm/applications/apps/av/camera-popout.d.mts +1 -1
- package/src/foundry/client-esm/applications/apps/av/cameras.d.mts +2 -2
- package/src/foundry/client-esm/applications/apps/compendium-art-config.d.mts +4 -5
- package/src/foundry/client-esm/applications/apps/file-picker.d.mts +2 -2
- package/src/foundry/client-esm/applications/apps/grid-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/apps/image-popout.d.mts +1 -1
- package/src/foundry/client-esm/applications/apps/permission-config.d.mts +1 -1
- package/src/foundry/client-esm/applications/dice/roll-resolver.d.mts +4 -4
- package/src/foundry/client-esm/applications/elements/file-picker.d.mts +1 -1
- package/src/foundry/client-esm/applications/elements/prosemirror-editor.d.mts +1 -1
- package/src/foundry/client-esm/applications/hud/drawing-hud.d.mts +1 -1
- package/src/foundry/client-esm/applications/hud/tile-hud.d.mts +1 -1
- package/src/foundry/client-esm/applications/hud/token-hud.d.mts +1 -1
- package/src/foundry/client-esm/applications/sheets/active-effect-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts +2 -2
- package/src/foundry/client-esm/applications/sheets/adventure-exporter.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/adventure-importer.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts +5 -5
- package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts +4 -4
- package/src/foundry/client-esm/applications/sheets/card-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/cards-config.d.mts +2 -2
- package/src/foundry/client-esm/applications/sheets/combatant-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/drawing-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/folder-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts +2 -2
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-category-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-sheet.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-sheet.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/macro-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/note-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/playlist-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/playlist-sound-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/region-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/roll-table-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/roll-table-sheet.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/scene-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/table-result-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/template-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/tile-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/token/mixin.d.mts +1 -0
- package/src/foundry/client-esm/applications/sheets/token/token-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/user-config.d.mts +4 -4
- package/src/foundry/client-esm/applications/sheets/wall-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/sidebar/apps/chat-popout.d.mts +1 -1
- package/src/foundry/client-esm/applications/sidebar/sidebar-tab.d.mts +2 -2
- package/src/foundry/client-esm/applications/sidebar/tabs/actor-directory.d.mts +1 -1
- package/src/foundry/client-esm/applications/sidebar/tabs/cards-directory.d.mts +1 -1
- package/src/foundry/client-esm/applications/sidebar/tabs/combat-tracker.d.mts +242 -1
- package/src/foundry/client-esm/applications/sidebar/tabs/item-directory.d.mts +1 -1
- package/src/foundry/client-esm/applications/sidebar/tabs/journal-directory.d.mts +1 -1
- package/src/foundry/client-esm/applications/sidebar/tabs/macro-directory.d.mts +1 -1
- package/src/foundry/client-esm/applications/sidebar/tabs/playlist-directory.d.mts +1 -1
- package/src/foundry/client-esm/applications/sidebar/tabs/roll-table-directory.d.mts +1 -1
- package/src/foundry/client-esm/applications/sidebar/tabs/scene-directory.d.mts +1 -1
- package/src/foundry/client-esm/applications/ui/region-legend.d.mts +2 -2
- package/src/foundry/client-esm/applications/ux/context-menu.d.mts +56 -36
- package/src/foundry/client-esm/audio/_types.d.mts +2 -0
- package/src/foundry/client-esm/audio/biquad.d.mts +76 -26
- package/src/foundry/client-esm/audio/cache.d.mts +31 -20
- package/src/foundry/client-esm/audio/convolver.d.mts +47 -25
- package/src/foundry/client-esm/audio/helper.d.mts +124 -80
- package/src/foundry/client-esm/audio/sound.d.mts +202 -97
- package/src/foundry/client-esm/audio/timeout.d.mts +28 -12
- package/src/foundry/client-esm/canvas/edges/collision.d.mts +12 -4
- package/src/foundry/client-esm/canvas/edges/edge.d.mts +13 -8
- package/src/foundry/client-esm/canvas/edges/edges.d.mts +3 -2
- package/src/foundry/client-esm/canvas/edges/vertex.d.mts +12 -10
- package/src/foundry/client-esm/canvas/regions/geometry.d.mts +14 -7
- package/src/foundry/client-esm/canvas/regions/mesh.d.mts +25 -14
- package/src/foundry/client-esm/canvas/regions/polygon-tree.d.mts +50 -19
- package/src/foundry/client-esm/canvas/regions/shape.d.mts +45 -34
- package/src/foundry/client-esm/canvas/scene-manager.d.mts +7 -6
- package/src/foundry/client-esm/canvas/smaa/blend.d.mts +14 -3
- package/src/foundry/client-esm/canvas/smaa/edges.d.mts +25 -3
- package/src/foundry/client-esm/canvas/smaa/smaa.d.mts +119 -20
- package/src/foundry/client-esm/canvas/smaa/weights.d.mts +26 -3
- package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts +69 -39
- package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts +66 -40
- package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts +78 -19
- package/src/foundry/client-esm/canvas/sources/point-darkness-source.d.mts +37 -20
- package/src/foundry/client-esm/canvas/sources/point-effect-source.d.mts +39 -20
- package/src/foundry/client-esm/canvas/sources/point-light-source.d.mts +41 -12
- package/src/foundry/client-esm/canvas/sources/point-movement-source.d.mts +15 -4
- package/src/foundry/client-esm/canvas/sources/point-sound-source.d.mts +29 -14
- package/src/foundry/client-esm/canvas/sources/point-vision-source.d.mts +84 -39
- package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts +115 -41
- package/src/foundry/client-esm/canvas/tokens/ring-config.d.mts +83 -21
- package/src/foundry/client-esm/canvas/tokens/ring-data.d.mts +66 -93
- package/src/foundry/client-esm/canvas/tokens/ring.d.mts +146 -51
- package/src/foundry/client-esm/client.d.mts +16 -16
- package/src/foundry/client-esm/data/_module.d.mts +1 -1
- package/src/foundry/client-esm/data/calendar.d.mts +26 -39
- package/src/foundry/client-esm/data/client-backend.d.mts +6 -6
- package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts +1 -1
- package/src/foundry/client-esm/data/region-behaviors/base.d.mts +5 -5
- package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts +2 -2
- package/src/foundry/client-esm/data/terrain-data.d.mts +1 -1
- package/src/foundry/client-esm/dice/parser.d.mts +5 -27
- package/src/foundry/client-esm/dice/roll.d.mts +63 -80
- package/src/foundry/client-esm/dice/terms/coin.d.mts +4 -8
- package/src/foundry/client-esm/dice/terms/dice.d.mts +85 -64
- package/src/foundry/client-esm/dice/terms/die.d.mts +7 -7
- package/src/foundry/client-esm/dice/terms/fate.d.mts +5 -5
- package/src/foundry/client-esm/dice/terms/function.d.mts +13 -16
- package/src/foundry/client-esm/dice/terms/numeric.d.mts +2 -4
- package/src/foundry/client-esm/dice/terms/operator.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/parenthetical.d.mts +8 -9
- package/src/foundry/client-esm/dice/terms/pool.d.mts +13 -28
- package/src/foundry/client-esm/dice/terms/string.d.mts +3 -3
- package/src/foundry/client-esm/dice/terms/term.d.mts +10 -5
- package/src/foundry/client-esm/dice/twister.d.mts +3 -3
- package/src/foundry/client-esm/documents/_module.d.mts +1 -1
- package/src/foundry/client-esm/helpers/_types.d.mts +12 -46
- package/src/foundry/client-esm/helpers/compendium-art.d.mts +57 -4
- package/src/foundry/client-esm/packages/_module.d.mts +1 -1
- package/src/foundry/client-esm/packages/_types.d.mts +2 -0
- package/src/foundry/client-esm/utils/_module.d.mts +1 -1
- package/src/foundry/client-esm/utils/_types.d.mts +2 -1
- package/src/foundry/common/_types.d.mts +1 -1
- package/src/foundry/common/abstract/_module.d.mts +1 -0
- package/src/foundry/common/abstract/_types.d.mts +60 -54
- package/src/foundry/common/abstract/backend.d.mts +28 -16
- package/src/foundry/common/abstract/data.d.mts +133 -116
- package/src/foundry/common/abstract/document.d.mts +1233 -440
- package/src/foundry/common/abstract/embedded-collection.d.mts +2 -2
- package/src/foundry/common/abstract/singleton-collection.d.mts +1 -1
- package/src/foundry/common/abstract/type-data.d.mts +35 -43
- package/src/foundry/common/config.d.mts +3 -3
- package/src/foundry/common/constants.d.mts +27 -26
- package/src/foundry/common/data/_types.d.mts +2 -0
- package/src/foundry/common/data/data.d.mts +189 -87
- package/src/foundry/common/data/fields.d.mts +579 -258
- package/src/foundry/common/data/validation-failure.d.mts +9 -4
- package/src/foundry/common/documents/_types.d.mts +16 -9
- package/src/foundry/common/documents/active-effect.d.mts +280 -180
- package/src/foundry/common/documents/actor-delta.d.mts +317 -70
- package/src/foundry/common/documents/actor.d.mts +304 -103
- package/src/foundry/common/documents/adventure.d.mts +254 -140
- package/src/foundry/common/documents/ambient-light.d.mts +267 -76
- package/src/foundry/common/documents/ambient-sound.d.mts +267 -110
- package/src/foundry/common/documents/card.d.mts +267 -176
- package/src/foundry/common/documents/cards.d.mts +299 -128
- package/src/foundry/common/documents/chat-message.d.mts +276 -160
- package/src/foundry/common/documents/combat.d.mts +300 -91
- package/src/foundry/common/documents/combatant.d.mts +283 -88
- package/src/foundry/common/documents/drawing.d.mts +286 -207
- package/src/foundry/common/documents/fog-exploration.d.mts +258 -72
- package/src/foundry/common/documents/folder.d.mts +248 -85
- package/src/foundry/common/documents/item.d.mts +305 -101
- package/src/foundry/common/documents/journal-entry-page.d.mts +279 -190
- package/src/foundry/common/documents/journal-entry.d.mts +294 -70
- package/src/foundry/common/documents/macro.d.mts +254 -134
- package/src/foundry/common/documents/measured-template.d.mts +293 -137
- package/src/foundry/common/documents/note.d.mts +274 -151
- package/src/foundry/common/documents/playlist-sound.d.mts +260 -96
- package/src/foundry/common/documents/playlist.d.mts +279 -122
- package/src/foundry/common/documents/region-behavior.d.mts +305 -64
- package/src/foundry/common/documents/region.d.mts +309 -90
- package/src/foundry/common/documents/roll-table.d.mts +286 -104
- package/src/foundry/common/documents/scene.d.mts +276 -344
- package/src/foundry/common/documents/setting.d.mts +229 -55
- package/src/foundry/common/documents/table-result.d.mts +267 -96
- package/src/foundry/common/documents/tile.d.mts +301 -172
- package/src/foundry/common/documents/token.d.mts +350 -452
- package/src/foundry/common/documents/user.d.mts +256 -146
- package/src/foundry/common/documents/wall.d.mts +272 -157
- package/src/foundry/common/grid/_types.d.mts +2 -0
- package/src/foundry/common/grid/base.d.mts +58 -37
- package/src/foundry/common/grid/hexagonal.d.mts +19 -19
- package/src/foundry/common/grid/square.d.mts +1 -1
- package/src/foundry/common/packages/_module.d.mts +5 -5
- package/src/foundry/common/packages/_types.d.mts +2 -0
- package/src/foundry/common/packages/base-module.d.mts +6 -24
- package/src/foundry/common/packages/base-package.d.mts +18 -16
- package/src/foundry/common/packages/base-system.d.mts +6 -78
- package/src/foundry/common/packages/base-world.d.mts +7 -60
- package/src/foundry/common/packages/sub-types.d.mts +1 -1
- package/src/foundry/common/primitives/array.d.mts +3 -3
- package/src/foundry/common/primitives/math.d.mts +7 -1
- package/src/foundry/common/primitives/number.d.mts +1 -1
- package/src/foundry/common/primitives/set.d.mts +17 -14
- package/src/foundry/common/prosemirror/_types.d.mts +2 -0
- package/src/foundry/common/prosemirror/dropdown.d.mts +1 -1
- package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts +1 -1
- package/src/foundry/common/prosemirror/menu.d.mts +3 -3
- package/src/foundry/common/prosemirror/plugin.d.mts +1 -1
- package/src/foundry/common/prosemirror/schema/index.d.mts +0 -1
- package/src/foundry/common/prosemirror/util.d.mts +1 -1
- package/src/foundry/common/utils/bitmask.d.mts +4 -1
- package/src/foundry/common/utils/collection.d.mts +59 -24
- package/src/foundry/common/utils/event-emitter.d.mts +46 -19
- package/src/foundry/common/utils/helpers.d.mts +13 -13
- package/src/foundry/common/utils/http.d.mts +2 -2
- package/src/foundry/common/utils/string-tree.d.mts +45 -39
- package/src/foundry/common/utils/word-tree.d.mts +10 -23
- package/src/tsconfig.json +1 -5
- package/src/types/augments/pixi.d.mts +28 -28
- package/src/types/config.d.mts +12 -12
- package/src/types/documentConfiguration.d.mts +282 -597
- package/src/types/lib.d.mts +4 -4
- package/src/types/workers/image-compressor.d.mts +1 -1
- package/src/utils/index.d.mts +255 -60
- package/tsconfig.json +29 -0
- package/tsconfig.main.json +8 -0
- package/tsconfig.miscellaneous.json +16 -0
- package/src/foundry/client/apps/placeables/light-config.d.mts +0 -100
- package/src/foundry/client/apps/placeables/sound-config.d.mts +0 -44
- package/src/foundry/common/documents/module.d.mts +0 -35
@@ -1,22 +1,26 @@
|
|
1
1
|
import type { EditorState, Plugin } from "prosemirror-state";
|
2
|
-
import type { DeepPartial, EmptyObject,
|
3
|
-
import type Document from "
|
4
|
-
import type {
|
5
|
-
import type
|
6
|
-
import type
|
7
|
-
import type
|
8
|
-
import type
|
9
|
-
|
2
|
+
import type { DeepPartial, EmptyObject, ValueOf } from "fvtt-types/utils";
|
3
|
+
import type Document from "#common/abstract/document.d.mts";
|
4
|
+
import type { ProseMirrorDropDown } from "#common/prosemirror/menu.d.mts";
|
5
|
+
import type ProseMirrorMenu from "#common/prosemirror/menu.d.mts";
|
6
|
+
import type PointVisionSource from "#client-esm/canvas/sources/point-vision-source.d.mts";
|
7
|
+
import type RenderedEffectSource from "#client-esm/canvas/sources/rendered-effect-source.d.mts";
|
8
|
+
import type {
|
9
|
+
DatabaseCreateOperation,
|
10
|
+
DatabaseDeleteOperation,
|
11
|
+
DatabaseUpdateOperation,
|
12
|
+
} from "#common/abstract/_types.d.mts";
|
13
|
+
import type CompendiumArt from "#client-esm/helpers/compendium-art.d.mts";
|
10
14
|
|
11
15
|
declare global {
|
12
16
|
/**
|
13
|
-
* This namespace contains typescript specific type definitions for the {@link Hooks} callback functions. It contains an
|
14
|
-
* interface ({@link Hooks.StaticCallbacks}) for callbacks with static names. There are more function types in the
|
17
|
+
* This namespace contains typescript specific type definitions for the {@link Hooks | `Hooks`} callback functions. It contains an
|
18
|
+
* interface ({@link Hooks.StaticCallbacks | `Hooks.StaticCallbacks`}) for callbacks with static names. There are more function types in the
|
15
19
|
* namespace for the dynamic hooks, whose names are generated at runtime. There is also a union of all of the dynamic
|
16
|
-
* hooks ({@link Hooks.DynamicCallbacks}).
|
20
|
+
* hooks ({@link Hooks.DynamicCallbacks | `Hooks.DynamicCallbacks`}).
|
17
21
|
*
|
18
|
-
* Callback types remarked to be called with {@link Hooks.callAll} do not care about the return value of the callback.
|
19
|
-
* Callback types remarked to be called with {@link Hooks.call} do care about the return value and will stop executing
|
22
|
+
* Callback types remarked to be called with {@link Hooks.callAll | `Hooks.callAll`} do not care about the return value of the callback.
|
23
|
+
* Callback types remarked to be called with {@link Hooks.call | `Hooks.call`} do care about the return value and will stop executing
|
20
24
|
* remaining callbacks if `false` is returned. If a callback type does not have such a remark, pay attention to the
|
21
25
|
* return value documentation.
|
22
26
|
*
|
@@ -53,20 +57,37 @@ declare global {
|
|
53
57
|
once?: boolean;
|
54
58
|
}
|
55
59
|
|
60
|
+
interface HotReloadData {
|
61
|
+
/** The type of package which was modified */
|
62
|
+
packageType: string;
|
63
|
+
|
64
|
+
/** The id of the package which was modified */
|
65
|
+
packageId: string;
|
66
|
+
|
67
|
+
/** The updated stringified file content */
|
68
|
+
content: string;
|
69
|
+
|
70
|
+
/** The relative file path which was modified */
|
71
|
+
path: string;
|
72
|
+
|
73
|
+
/** The file extension which was modified, e.g. "js", "css", "html" */
|
74
|
+
extension: string;
|
75
|
+
}
|
76
|
+
|
56
77
|
interface StaticCallbacks {
|
57
78
|
/** Core lifecycle */
|
58
79
|
|
59
80
|
/**
|
60
81
|
* A hook event that fires as Foundry is initializing, right before any initialization tasks have begun.
|
61
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
62
|
-
* @see {@link Game#initialize}
|
82
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
83
|
+
* @see {@link Game.initialize | `Game#initialize`}
|
63
84
|
*/
|
64
85
|
init: () => void;
|
65
86
|
|
66
87
|
/**
|
67
88
|
* A hook event that fires once Localization translations have been loaded and are ready for use.
|
68
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
69
|
-
* @see {@link Localization#initialize}
|
89
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
90
|
+
* @see {@link Localization.initialize | `Localization#initialize`}
|
70
91
|
*/
|
71
92
|
i18nInit: () => void;
|
72
93
|
|
@@ -74,15 +95,15 @@ declare global {
|
|
74
95
|
* A hook event that fires when Foundry has finished initializing but
|
75
96
|
* before the game state has been set up. Fires before any Documents, UI
|
76
97
|
* applications, or the Canvas have been initialized.
|
77
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
78
|
-
* @see {@link Game#setupGame}
|
98
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
99
|
+
* @see {@link Game.setupGame | `Game#setupGame`}
|
79
100
|
*/
|
80
101
|
setup: () => void;
|
81
102
|
|
82
103
|
/**
|
83
104
|
* A hook event that fires when the game is fully ready.
|
84
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
85
|
-
* @see {@link Game#setupGame}
|
105
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
106
|
+
* @see {@link Game.setupGame | `Game#setupGame`}
|
86
107
|
*/
|
87
108
|
ready: () => void;
|
88
109
|
|
@@ -93,8 +114,8 @@ declare global {
|
|
93
114
|
* @param err - The error.
|
94
115
|
* @param data - Additional data that might be provided, based on the nature of the error.
|
95
116
|
* (default: `{}`)
|
96
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
97
|
-
* @see {@link Hooks.onError}
|
117
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
118
|
+
* @see {@link Hooks.onError | `Hooks.onError`}
|
98
119
|
*/
|
99
120
|
error: (...args: ValueOf<ErrorCallbackParameters>) => void;
|
100
121
|
|
@@ -103,8 +124,8 @@ declare global {
|
|
103
124
|
/**
|
104
125
|
* A hook event that fires when the game is paused or un-paused.
|
105
126
|
* @param paused - Is the game now paused (true) or un-paused (false)
|
106
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
107
|
-
* @see {@link Game#togglePause}
|
127
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
128
|
+
* @see {@link Game.togglePause | `Game#togglePause`}
|
108
129
|
*/
|
109
130
|
pauseGame: (paused: boolean) => void;
|
110
131
|
|
@@ -112,8 +133,8 @@ declare global {
|
|
112
133
|
* A hook event that fires when the World time has been updated.
|
113
134
|
* @param worldTime - The new canonical World time
|
114
135
|
* @param delta - The time delta
|
115
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
116
|
-
* @see {@link GameTime#onUpdateWorldTime}
|
136
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
137
|
+
* @see {@link GameTime.onUpdateWorldTime | `GameTime#onUpdateWorldTime`}
|
117
138
|
*/
|
118
139
|
updateWorldTime: (worldTime: number, delta: number) => void;
|
119
140
|
|
@@ -122,15 +143,15 @@ declare global {
|
|
122
143
|
/**
|
123
144
|
* A hook event that fires immediately prior to PIXI Application construction with the configuration parameters.
|
124
145
|
* @param canvasConfig - Canvas configuration parameters that will be used to initialize the PIXI.Application
|
125
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
146
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
126
147
|
*/
|
127
148
|
canvasConfig: (canvasConfig: ConstructorParameters<typeof PIXI.Application>[0]) => void;
|
128
149
|
|
129
150
|
/**
|
130
151
|
* A hook event that fires when the Canvas is initialized.
|
131
152
|
* @param canvas - the Canvas instance being initialized
|
132
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
133
|
-
* @see {@link Canvas#draw}
|
153
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
154
|
+
* @see {@link Canvas.draw | `Canvas#draw`}
|
134
155
|
*/
|
135
156
|
canvasInit: (canvas: Canvas) => void;
|
136
157
|
|
@@ -139,31 +160,31 @@ declare global {
|
|
139
160
|
* @param canvas - The Canvas instance
|
140
161
|
* @param view - The applied camera position
|
141
162
|
* @remarks When called during animated panning, the callback is called on every tick.
|
142
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
143
|
-
* @see {@link Canvas#pan}
|
144
|
-
* @see {@link Canvas#animatePan}
|
163
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
164
|
+
* @see {@link Canvas.pan | `Canvas#pan`}
|
165
|
+
* @see {@link Canvas.animatePan | `Canvas#animatePan`}
|
145
166
|
*/
|
146
167
|
canvasPan: (canvas: Canvas, view: Canvas.ViewPosition) => void;
|
147
168
|
|
148
169
|
/**
|
149
170
|
* A hook event that fires when the Canvas is ready.
|
150
171
|
* @param canvas - The Canvas which is now ready for use
|
151
|
-
* @remarks This is called by {@link Hooks.call}.
|
152
|
-
* @see {@link Canvas#draw}
|
172
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
173
|
+
* @see {@link Canvas.draw | `Canvas#draw`}
|
153
174
|
*/
|
154
175
|
canvasReady: (canvas: Canvas) => boolean | void;
|
155
176
|
|
156
177
|
/**
|
157
178
|
* A hook event that fires when the Canvas is deactivated.
|
158
179
|
* @param canvas - The Canvas instance being deactivated
|
159
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
180
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
160
181
|
*/
|
161
182
|
canvasTearDown: (canvas: Canvas) => void;
|
162
183
|
|
163
184
|
/**
|
164
185
|
* A hook event that fires when the Canvas is beginning to draw the canvas groups.
|
165
186
|
* @param canvas - The Canvas instance being drawn
|
166
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
187
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
167
188
|
*/
|
168
189
|
canvasDraw: (canvas: Canvas) => void;
|
169
190
|
|
@@ -171,17 +192,20 @@ declare global {
|
|
171
192
|
* A hook event that fires when some useful data is dropped onto the Canvas.
|
172
193
|
* @param canvas - The Canvas
|
173
194
|
* @param data - The data that has been dropped onto the Canvas
|
174
|
-
* @remarks This is called by {@link Hooks.call}.
|
195
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
175
196
|
* @remarks An explicit return value of `false` prevents the Document being created.
|
176
|
-
* @see {@link Canvas#_onDrop}
|
197
|
+
* @see {@link Canvas._onDrop | `Canvas#_onDrop`}
|
177
198
|
*/
|
178
|
-
dropCanvasData: (
|
199
|
+
dropCanvasData: (
|
200
|
+
canvas: Canvas,
|
201
|
+
data: TokenLayer.DropData | NotesLayer.DropData | SoundsLayer.DropData | TilesLayer.DropData,
|
202
|
+
) => boolean | void;
|
179
203
|
|
180
204
|
/**
|
181
205
|
* A hook event that fires when objects are highlighted on the canvas.
|
182
206
|
* Callers may use this hook to apply their own modifications or enhancements to highlighted objects.
|
183
207
|
* @param active - Is the highlight state now active
|
184
|
-
* @see {@link Canvas#highlightObjects}
|
208
|
+
* @see {@link Canvas.highlightObjects | `Canvas#highlightObjects``}
|
185
209
|
*/
|
186
210
|
highlightObjects: (active: boolean) => void;
|
187
211
|
|
@@ -190,10 +214,10 @@ declare global {
|
|
190
214
|
/**
|
191
215
|
* A hook event that fires when the Scene controls are initialized.
|
192
216
|
* @param controls - The SceneControl configurations
|
193
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
194
|
-
* @see {@link SceneControls#_getControlButtons}
|
217
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
218
|
+
* @see {@link SceneControls._getControlButtons | `SceneControls#_getControlButtons`}
|
195
219
|
*/
|
196
|
-
getSceneControlButtons: (controls:
|
220
|
+
getSceneControlButtons: (controls: SceneControls.Control[]) => void;
|
197
221
|
|
198
222
|
/**
|
199
223
|
* A hook event that fires whenever data is dropped into a Hotbar slot.
|
@@ -202,19 +226,19 @@ declare global {
|
|
202
226
|
* @param hotbar - The Hotbar application instance
|
203
227
|
* @param data - The dropped data object
|
204
228
|
* @param slot - The target hotbar slot
|
205
|
-
* @remarks This is called by {@link Hooks.call}.
|
229
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
206
230
|
* @remarks An explicit return value of `false` prevents the Document being created.
|
207
|
-
* @see {@link Hotbar#_onDrop}
|
231
|
+
* @see {@link Hotbar._onDrop | `Hotbar#_onDrop`}
|
208
232
|
*/
|
209
|
-
hotbarDrop: (hotbar: Hotbar, data: Document.DropData<Macro.
|
233
|
+
hotbarDrop: (hotbar: Hotbar, data: Document.DropData<Macro.Implementation>, slot: number) => boolean | void;
|
210
234
|
|
211
235
|
/**
|
212
236
|
* A hook event that fires when the SceneNavigation menu is expanded or collapsed.
|
213
237
|
* @param nav - The SceneNavigation application
|
214
238
|
* @param collapsed - Whether the navigation is now collapsed or not
|
215
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
216
|
-
* @see {@link SceneNavigation#expand}
|
217
|
-
* @see {@link SceneNavigation#collapse}
|
239
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
240
|
+
* @see {@link SceneNavigation.expand | `SceneNavigation#expand`}
|
241
|
+
* @see {@link SceneNavigation.collapse | `SceneNavigation#collapse`}
|
218
242
|
*/
|
219
243
|
collapseSceneNavigation: (nav: SceneNavigation, collapsed: boolean) => void;
|
220
244
|
|
@@ -222,17 +246,17 @@ declare global {
|
|
222
246
|
* A hook event that fires when the Sidebar is collapsed or expanded.
|
223
247
|
* @param sidebar - The Sidebar application
|
224
248
|
* @param collapsed - Whether the Sidebar is now collapsed or not
|
225
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
226
|
-
* @see {@link Sidebar#expand}
|
227
|
-
* @see {@link Sidebar#collapse}
|
249
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
250
|
+
* @see {@link Sidebar.expand | `Sidebar#expand`}
|
251
|
+
* @see {@link Sidebar.collapse | `Sidebar#collapse`}
|
228
252
|
*/
|
229
253
|
collapseSidebar: (sidebar: Sidebar, collapsed: boolean) => void;
|
230
254
|
|
231
255
|
/**
|
232
256
|
* A hook event that fires when the Sidebar tab is changed.
|
233
257
|
* @param app - The SidebarTab application which is now active
|
234
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
235
|
-
* @see {@link Sidebar#_onChangeTab}
|
258
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
259
|
+
* @see {@link Sidebar._onChangeTab | `Sidebar#_onChangeTab`}
|
236
260
|
*/
|
237
261
|
changeSidebarTab: (app: SidebarTab) => void;
|
238
262
|
|
@@ -242,10 +266,10 @@ declare global {
|
|
242
266
|
* A hook event that fires when a custom active effect is applied.
|
243
267
|
* @param actor - The actor the active effect is being applied to
|
244
268
|
* @param change - The change data being applied
|
245
|
-
* @remarks This is called by {@link Hooks.call}.
|
246
|
-
* @see {@link ActiveEffect#_applyCustom}
|
269
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
270
|
+
* @see {@link ActiveEffect._applyCustom | `ActiveEffect#_applyCustom`}
|
247
271
|
*/
|
248
|
-
applyActiveEffect: (actor: Actor.
|
272
|
+
applyActiveEffect: (actor: Actor.Implementation, change: ActiveEffect.EffectChangeData) => boolean | void;
|
249
273
|
|
250
274
|
/** Compendium */
|
251
275
|
|
@@ -257,25 +281,25 @@ declare global {
|
|
257
281
|
* @param documents - The locally-cached Documents which were modified in the operation
|
258
282
|
* @param options - Additional options which modified the modification request
|
259
283
|
* @param userId - The ID of the User who triggered the modification workflow
|
260
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
261
|
-
* @see {@link CompendiumCollection#_onModifyContents}
|
284
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
285
|
+
* @see {@link CompendiumCollection._onModifyContents | `CompendiumCollection#_onModifyContents`}
|
262
286
|
*/
|
263
287
|
updateCompendium: (
|
264
288
|
pack: CompendiumCollection.Any,
|
265
289
|
documents: Document.Any[],
|
266
|
-
options: Document.
|
290
|
+
options: Document.Database.UpdateOptions<DatabaseUpdateOperation>,
|
267
291
|
userId: string,
|
268
292
|
) => void;
|
269
293
|
|
270
294
|
/** Token */
|
271
295
|
|
272
296
|
/**
|
273
|
-
* A hook event that fires when a token {@link Token} should apply a specific status effect.
|
297
|
+
* A hook event that fires when a token {@link Token | `Token`} should apply a specific status effect.
|
274
298
|
* @param token - The token affected
|
275
299
|
* @param statusId - The status effect ID being applied, from CONFIG.specialStatusEffects.
|
276
300
|
* @param active - Is the special status effect now active?
|
277
301
|
*/
|
278
|
-
applyTokenStatusEffect: (token: Token.
|
302
|
+
applyTokenStatusEffect: (token: Token.Implementation, statusId: string, active: boolean) => void;
|
279
303
|
|
280
304
|
/**
|
281
305
|
* A hook event that fires when a chat bubble is initially configured.
|
@@ -283,13 +307,13 @@ declare global {
|
|
283
307
|
* @param html - The HTML for the chat bubble
|
284
308
|
* @param message - The spoken message text
|
285
309
|
* @param options - additional options
|
286
|
-
* @remarks This is called when creating a {@link ChatBubble}, but before displaying it.
|
287
|
-
* @remarks This is called by {@link Hooks.call}.
|
310
|
+
* @remarks This is called when creating a {@link ChatBubble | `ChatBubble`}, but before displaying it.
|
311
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
288
312
|
* @remarks An explicit return value of `false` prevents the chat bubble being shown.
|
289
|
-
* @see {@link ChatBubbles#say}
|
313
|
+
* @see {@link ChatBubbles.say | `ChatBubbles#say`}
|
290
314
|
*/
|
291
315
|
chatBubble: (
|
292
|
-
token: Token,
|
316
|
+
token: Token.Implementation,
|
293
317
|
html: JQuery,
|
294
318
|
message: string,
|
295
319
|
options: {
|
@@ -303,9 +327,9 @@ declare global {
|
|
303
327
|
* @param data - A object describing the modification
|
304
328
|
* @param updates - The update delta that will be applied to the Token's actor
|
305
329
|
* @returns whether the Actor should be updated
|
306
|
-
* @remarks This is called by {@link Hooks.call}.
|
307
|
-
* @see {@link Actor#modifyTokenAttribute}
|
308
|
-
* @see {@link Actor#update}
|
330
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
331
|
+
* @see {@link Actor.modifyTokenAttribute | `Actor#modifyTokenAttribute`}
|
332
|
+
* @see {@link Actor.update | `Actor#update`}
|
309
333
|
*/
|
310
334
|
modifyTokenAttribute: (
|
311
335
|
data: {
|
@@ -329,26 +353,22 @@ declare global {
|
|
329
353
|
* @param user - The User doing the targeting
|
330
354
|
* @param token - The targeted Token
|
331
355
|
* @param targeted - Whether the Token has been targeted or untargeted
|
332
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
333
|
-
* @see {@link UserTargets#_hook}
|
356
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
357
|
+
* @see {@link UserTargets._hook | `UserTargets#_hook`}
|
334
358
|
*/
|
335
|
-
targetToken: (
|
336
|
-
user: User.ConfiguredInstance,
|
337
|
-
token: Document.ConfiguredObjectClassForName<"Token">,
|
338
|
-
targeted: boolean,
|
339
|
-
) => void;
|
359
|
+
targetToken: (user: User.Implementation, token: Document.ObjectClassFor<"Token">, targeted: boolean) => void;
|
340
360
|
|
341
361
|
/** Note */
|
342
362
|
|
343
363
|
/**
|
344
364
|
* A hook event that fires whenever a map note is double-clicked.
|
345
|
-
* The hook provides the note placeable and the arguments passed to the associated {@link JournalSheet} render call.
|
365
|
+
* The hook provides the note placeable and the arguments passed to the associated {@link JournalSheet | `JournalSheet`} render call.
|
346
366
|
* Hooked functions may modify the render arguments or cancel the render by returning false.
|
347
367
|
* @param note - The note that was activated
|
348
|
-
* @param options - Options for rendering the associated {@link JournalSheet}
|
349
|
-
* @remarks This is called by {@link Hooks.call}.
|
368
|
+
* @param options - Options for rendering the associated {@link JournalSheet | `JournalSheet`}
|
369
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
350
370
|
*/
|
351
|
-
activateNote: (note: Note.
|
371
|
+
activateNote: (note: Note.Implementation, options: JournalSheet.RenderOptions) => true | false;
|
352
372
|
|
353
373
|
/** Cards */
|
354
374
|
|
@@ -357,12 +377,12 @@ declare global {
|
|
357
377
|
* @param origin - The origin Cards document
|
358
378
|
* @param destinations - An array of destination Cards documents
|
359
379
|
* @param context - Additional context which describes the operation
|
360
|
-
* @remarks This is called by {@link Hooks.call}.
|
380
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
361
381
|
* @remarks An explicit return value of `false` prevents the operation.
|
362
382
|
*/
|
363
383
|
dealCards: (
|
364
|
-
origin: Cards.
|
365
|
-
destinations: Cards.
|
384
|
+
origin: Cards.Implementation,
|
385
|
+
destinations: Cards.Implementation[],
|
366
386
|
context: Cards.DealContext,
|
367
387
|
) => boolean | void;
|
368
388
|
|
@@ -371,12 +391,12 @@ declare global {
|
|
371
391
|
* @param origin - The origin Cards document
|
372
392
|
* @param destination - The destination Cards document
|
373
393
|
* @param context - Additional context which describes the operation
|
374
|
-
* @remarks This is called by {@link Hooks.call}.
|
394
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
375
395
|
* @remarks An explicit return value of `false` prevents the operation.
|
376
396
|
*/
|
377
397
|
passCards: (
|
378
|
-
origin: Cards.
|
379
|
-
destination: Cards.
|
398
|
+
origin: Cards.Implementation,
|
399
|
+
destination: Cards.Implementation,
|
380
400
|
context: Cards.DealContext,
|
381
401
|
) => boolean | void;
|
382
402
|
|
@@ -387,8 +407,8 @@ declare global {
|
|
387
407
|
* @param context - Additional context which describes the operation.
|
388
408
|
*/
|
389
409
|
returnCards: (
|
390
|
-
origin: Cards.
|
391
|
-
returned: Card.
|
410
|
+
origin: Cards.Implementation,
|
411
|
+
returned: Card.Implementation[],
|
392
412
|
context: Cards.ReturnContext,
|
393
413
|
) => boolean | void;
|
394
414
|
|
@@ -402,13 +422,13 @@ declare global {
|
|
402
422
|
* @param art - The art being applied.
|
403
423
|
* @remarks Called as part of _initializeSource, after data migration, cleaning, and shims
|
404
424
|
* @remarks Currently only called by Actor but comments are more generic
|
405
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
425
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
406
426
|
*/
|
407
427
|
applyCompendiumArt: (
|
408
|
-
documentClass: Actor.
|
409
|
-
source: foundry.documents.BaseActor.
|
428
|
+
documentClass: Actor.ImplementationClass,
|
429
|
+
source: foundry.documents.BaseActor.CreateData,
|
410
430
|
pack: CompendiumCollection.Any,
|
411
|
-
art:
|
431
|
+
art: CompendiumArt.Info,
|
412
432
|
) => void;
|
413
433
|
|
414
434
|
/** ActorSheet */
|
@@ -418,37 +438,33 @@ declare global {
|
|
418
438
|
* @param actor - The Actor
|
419
439
|
* @param sheet - The ActorSheet application
|
420
440
|
* @param data - The data that has been dropped onto the sheet
|
421
|
-
* @remarks This is called by {@link Hooks.call}.
|
441
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
422
442
|
* @remarks An explicit return value of `false` prevents the Document being created.
|
423
|
-
* @see {@link ActorSheet#_onDrop}
|
443
|
+
* @see {@link ActorSheet._onDrop | `ActorSheet#_onDrop`}
|
424
444
|
*/
|
425
|
-
dropActorSheetData: (
|
426
|
-
actor: Actor.ConfiguredInstance,
|
427
|
-
sheet: ActorSheet,
|
428
|
-
data: ActorSheet.DropData,
|
429
|
-
) => boolean | void;
|
445
|
+
dropActorSheetData: (actor: Actor.Implementation, sheet: ActorSheet, data: ActorSheet.DropData) => boolean | void;
|
430
446
|
|
431
447
|
/** CanvasVisibility */
|
432
448
|
|
433
449
|
/**
|
434
450
|
* A hook event that fires when the set of vision sources are initialized.
|
435
451
|
* @param sources - The collection of current vision sources
|
436
|
-
* @remarks This is called by {@link Hooks.call}.
|
452
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
437
453
|
*/
|
438
454
|
initializeVisionSources: (sources: Collection<PointVisionSource.Any>) => void;
|
439
455
|
|
440
456
|
/**
|
441
457
|
* A hook event that fires when the LightingLayer is refreshed.
|
442
458
|
* @param layer - the LightingLayer
|
443
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
444
|
-
* @see {@link LightingLayer#refresh}
|
459
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
460
|
+
* @see {@link LightingLayer.refresh | `LightingLayer#refresh`}
|
445
461
|
*/
|
446
462
|
lightingRefresh: (layer: LightingLayer) => void;
|
447
463
|
|
448
464
|
/**
|
449
465
|
* A hook event that fires when visibility is refreshed.
|
450
466
|
* @param visibility - The CanvasVisibility instance
|
451
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
467
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
452
468
|
*/
|
453
469
|
visibilityRefresh: (visibility: CanvasVisibility) => void;
|
454
470
|
|
@@ -456,8 +472,8 @@ declare global {
|
|
456
472
|
* A hook event that fires during light source initialization.
|
457
473
|
* This hook can be used to add programmatic light sources to the Scene.
|
458
474
|
* @param source - The EffectsCanvasGroup where light sources are initialized
|
459
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
460
|
-
* @see {@link EffectsCanvasGroup#initializeLightSources}
|
475
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
476
|
+
* @see {@link EffectsCanvasGroup.initializeLightSources | `EffectsCanvasGroup#initializeLightSources`}
|
461
477
|
*/
|
462
478
|
initializeLightSources: (group: EffectsCanvasGroup) => void;
|
463
479
|
|
@@ -465,15 +481,15 @@ declare global {
|
|
465
481
|
* A hook event that fires during darkness source initialization.
|
466
482
|
* This hook can be used to add programmatic darkness sources to the Scene.
|
467
483
|
* @param group - The EffectsCanvasGroup where darkness sources are initialized
|
468
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
484
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
469
485
|
*/
|
470
486
|
initializeDarknessSources: (group: EffectsCanvasGroup) => void;
|
471
487
|
|
472
488
|
/**
|
473
489
|
* A hook event that fires when the CanvasVisibility layer has been refreshed.
|
474
490
|
* @param visibility - The CanvasVisibility layer
|
475
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
476
|
-
* @see {@link CanvasVisibility#restrictVisibility}
|
491
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
492
|
+
* @see {@link CanvasVisibility.restrictVisibility | `CanvasVisibility#restrictVisibility`}
|
477
493
|
*/
|
478
494
|
sightRefresh: (visibility: CanvasVisibility) => void;
|
479
495
|
|
@@ -483,11 +499,11 @@ declare global {
|
|
483
499
|
* Initialize the weather container from a weather config object.
|
484
500
|
* @param weatherEffect - The weather effects canvas layer
|
485
501
|
* @param weatherEffectsConfig - The weather effects config object
|
486
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
502
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
487
503
|
*/
|
488
504
|
initializeWeatherEffects: (
|
489
505
|
weatherEffect: WeatherEffects,
|
490
|
-
weatherEffectsConfig?: WeatherEffects.
|
506
|
+
weatherEffectsConfig?: WeatherEffects.EffectConfiguration | null,
|
491
507
|
) => void;
|
492
508
|
|
493
509
|
/** Adventure */
|
@@ -500,13 +516,13 @@ declare global {
|
|
500
516
|
* @param toCreate - Adventure data which needs to be created in the World
|
501
517
|
* @param toUpdate - Adventure data which needs to be updated in the World
|
502
518
|
* @returns False to prevent the core software from handling the import
|
503
|
-
* @remarks This is called by {@link Hooks.call}.
|
519
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
504
520
|
*/
|
505
521
|
preImportAdventure: (
|
506
|
-
adventure: Adventure.
|
522
|
+
adventure: Adventure.Implementation,
|
507
523
|
formData: object, // TODO: Improve this. Also relevant to `AdventureImporter#_updateObject`
|
508
|
-
toCreate:
|
509
|
-
toUpdate:
|
524
|
+
toCreate: Adventure.ImportData["toCreate"],
|
525
|
+
toUpdate: Adventure.ImportData["toUpdate"],
|
510
526
|
) => boolean | void;
|
511
527
|
|
512
528
|
/**
|
@@ -516,13 +532,13 @@ declare global {
|
|
516
532
|
* @param toCreate - Adventure data which needs to be created in the World
|
517
533
|
* @param toUpdate - Adventure data which needs to be updated in the World
|
518
534
|
* @returns False to prevent the core software from handling the import
|
519
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
535
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
520
536
|
*/
|
521
537
|
importAdventure: (
|
522
|
-
adventure: Adventure.
|
538
|
+
adventure: Adventure.Implementation,
|
523
539
|
formData: object, // TODO: Improve this. Also relevant to `AdventureImporter#_updateObject`
|
524
|
-
toCreate:
|
525
|
-
toUpdate:
|
540
|
+
toCreate: Adventure.ImportData["toCreate"],
|
541
|
+
toUpdate: Adventure.ImportData["toUpdate"],
|
526
542
|
) => void;
|
527
543
|
|
528
544
|
/** Socket */
|
@@ -531,9 +547,9 @@ declare global {
|
|
531
547
|
* A hook event that fires whenever some other User joins or leaves the game session.
|
532
548
|
* @param user - The User who connected or disconnected
|
533
549
|
* @param connected - Is the user now connected (true) or disconnected (false)
|
534
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
550
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
535
551
|
*/
|
536
|
-
userConnected: (user: User.
|
552
|
+
userConnected: (user: User.Implementation, connected: boolean) => void;
|
537
553
|
|
538
554
|
/** Combat */
|
539
555
|
|
@@ -543,13 +559,9 @@ declare global {
|
|
543
559
|
* @param combat - The Combat encounter for which the turn order has changed
|
544
560
|
* @param prior - The prior turn state
|
545
561
|
* @param current - The new turn state
|
546
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
562
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
547
563
|
*/
|
548
|
-
combatTurnChange: (
|
549
|
-
combat: Combat.ConfiguredInstance,
|
550
|
-
prior: Combat.HistoryData,
|
551
|
-
current: Combat.HistoryData,
|
552
|
-
) => void;
|
564
|
+
combatTurnChange: (combat: Combat.Implementation, prior: Combat.HistoryData, current: Combat.HistoryData) => void;
|
553
565
|
|
554
566
|
/**
|
555
567
|
* A hook event that fires when a Combat encounter is started.
|
@@ -558,7 +570,7 @@ declare global {
|
|
558
570
|
* @param updateData - An object which contains Combat properties that will be updated. Can be mutated.
|
559
571
|
*/
|
560
572
|
combatStart: (
|
561
|
-
combat: Combat.
|
573
|
+
combat: Combat.Implementation,
|
562
574
|
updateData: {
|
563
575
|
/** The initial round */
|
564
576
|
round: number;
|
@@ -575,7 +587,7 @@ declare global {
|
|
575
587
|
* @param updateOptions - An object which contains options provided to the update method. Can be mutated.
|
576
588
|
*/
|
577
589
|
combatTurn: (
|
578
|
-
combat: Combat.
|
590
|
+
combat: Combat.Implementation,
|
579
591
|
updateData: {
|
580
592
|
/** The current round of combat */
|
581
593
|
round: number;
|
@@ -597,7 +609,7 @@ declare global {
|
|
597
609
|
* @param updateOptions - An object which contains options provided to the update method. Can be mutated.
|
598
610
|
*/
|
599
611
|
combatRound: (
|
600
|
-
combat: Combat.
|
612
|
+
combat: Combat.Implementation,
|
601
613
|
updateData: {
|
602
614
|
/** The new round of combat */
|
603
615
|
round: number;
|
@@ -620,7 +632,7 @@ declare global {
|
|
620
632
|
* Hooked functions may append their own drop-downs or append entries to existing drop-downs.
|
621
633
|
* @param menu - The ProseMirrorMenu instance.
|
622
634
|
* @param config - The drop-down config.
|
623
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
635
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
624
636
|
*/
|
625
637
|
getProseMirrorMenuDropdowns: (
|
626
638
|
menu: ProseMirrorMenu,
|
@@ -636,7 +648,7 @@ declare global {
|
|
636
648
|
* Hooked functions may append their own buttons to the list.
|
637
649
|
* @param menu - The ProseMirrorMenu instance
|
638
650
|
* @param config - The button configuration objects
|
639
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
651
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
640
652
|
*/
|
641
653
|
// TODO: Having trouble finding the appropriate typing for the menu items? Also, where is this even called?
|
642
654
|
getProseMirrorMenuItems: (menu: ProseMirrorMenu, config: unknown[]) => void;
|
@@ -651,8 +663,8 @@ declare global {
|
|
651
663
|
* @param uuid - A UUID that uniquely identifies this ProseMirror instance.
|
652
664
|
* @param plugins - A list of plugins that will be loaded.
|
653
665
|
* @param options - The provisional EditorState and ProseMirrorMenuPlugin.
|
654
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
655
|
-
* @see {@link ProseMirrorEditor.create}
|
666
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
667
|
+
* @see {@link ProseMirrorEditor.create | `ProseMirrorEditor.create`}
|
656
668
|
*/
|
657
669
|
createProseMirrorEditor: (uuid: string, plugins: Record<string, Plugin>, options: { state: EditorState }) => void;
|
658
670
|
|
@@ -663,7 +675,7 @@ declare global {
|
|
663
675
|
* The hook provides the hot reload data related to the file change.
|
664
676
|
* Hooked functions may intercept the hot reload and prevent the core software from handling it by returning false.
|
665
677
|
* @param data - The hot reload data
|
666
|
-
* @remarks This is called by {@link Hooks.call}.
|
678
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
667
679
|
*/
|
668
680
|
hotReload: (data: HotReloadData) => boolean | void;
|
669
681
|
|
@@ -674,9 +686,9 @@ declare global {
|
|
674
686
|
* @param chatLog - The ChatLog instance
|
675
687
|
* @param message - The trimmed message content
|
676
688
|
* @param chatData - The basic chat data
|
677
|
-
* @remarks This is called by {@link Hooks.call}.
|
689
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
678
690
|
* @remarks An explicit return value of `false` prevents the chat message from being created.
|
679
|
-
* @see {@link ChatLog#processMessage}
|
691
|
+
* @see {@link ChatLog.processMessage | `ChatLog#processMessage`}
|
680
692
|
*/
|
681
693
|
chatMessage: (
|
682
694
|
chatLog: ChatLog,
|
@@ -685,8 +697,8 @@ declare global {
|
|
685
697
|
/** The id of the User sending the message */
|
686
698
|
user: string;
|
687
699
|
|
688
|
-
/** The identified speaker data, see {@link ChatMessage.getSpeaker} */
|
689
|
-
speaker: ReturnType<ChatMessage.
|
700
|
+
/** The identified speaker data, see {@link ChatMessage.getSpeaker | `ChatMessage.getSpeaker`} */
|
701
|
+
speaker: ReturnType<ChatMessage.ImplementationClass["getSpeaker"]>;
|
690
702
|
},
|
691
703
|
) => boolean | void;
|
692
704
|
|
@@ -696,16 +708,16 @@ declare global {
|
|
696
708
|
* @param message - The ChatMessage document being rendered
|
697
709
|
* @param html - The pending HTML as a jQuery object
|
698
710
|
* @param messageData - The input data provided for template rendering
|
699
|
-
* @remarks This is called by {@link Hooks.call}.
|
700
|
-
* @see {@link ChatMessage#render}
|
711
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
712
|
+
* @see {@link ChatMessage.render | `ChatMessage#render`}
|
701
713
|
*/
|
702
714
|
renderChatMessage: (
|
703
|
-
message: ChatMessage,
|
715
|
+
message: ChatMessage.Implementation,
|
704
716
|
html: JQuery,
|
705
717
|
messageData: {
|
706
|
-
message:
|
718
|
+
message: ChatMessage.Source;
|
707
719
|
user: Game["user"];
|
708
|
-
author: User.
|
720
|
+
author: User.Implementation | null;
|
709
721
|
alias: string;
|
710
722
|
cssClass: string;
|
711
723
|
isWhisper: boolean;
|
@@ -722,22 +734,22 @@ declare global {
|
|
722
734
|
/**
|
723
735
|
* A hook event that fires when the user modifies a global volume slider.
|
724
736
|
* @param volume - The new volume level
|
725
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
726
|
-
* @see {@link AudioHelper#_onChangeGlobalVolume}
|
737
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
738
|
+
* @see {@link AudioHelper._onChangeGlobalVolume | `AudioHelper#_onChangeGlobalVolume`}
|
727
739
|
*/
|
728
740
|
globalAmbientVolumeChanged: (volume: number) => void;
|
729
741
|
/**
|
730
742
|
* A hook event that fires when the user modifies a global volume slider.
|
731
743
|
* @param volume - The new volume level
|
732
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
733
|
-
* @see {@link AudioHelper#_onChangeGlobalVolume}
|
744
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
745
|
+
* @see {@link AudioHelper._onChangeGlobalVolume | `AudioHelper#_onChangeGlobalVolume`}
|
734
746
|
*/
|
735
747
|
globalInterfaceVolumeChanged: (volume: number) => void;
|
736
748
|
/**
|
737
749
|
* A hook event that fires when the user modifies a global volume slider.
|
738
750
|
* @param volume - The new volume level
|
739
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
740
|
-
* @see {@link AudioHelper#_onChangeGlobalVolume}
|
751
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
752
|
+
* @see {@link AudioHelper._onChangeGlobalVolume | `AudioHelper#_onChangeGlobalVolume`}
|
741
753
|
*/
|
742
754
|
globalPlaylistVolumeChanged: (volume: number) => void;
|
743
755
|
|
@@ -745,8 +757,8 @@ declare global {
|
|
745
757
|
* A hook event that fires when the AV settings are changed.
|
746
758
|
* @param settings - The AVSettings manager
|
747
759
|
* @param changed - The delta of the settings that have been changed
|
748
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
749
|
-
* @see {@link AVSettings#_onSettingsChanged}
|
760
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
761
|
+
* @see {@link AVSettings._onSettingsChanged | `AVSettings#_onSettingsChanged`}
|
750
762
|
*/
|
751
763
|
rtcSettingsChanged: (settings: AVSettings, changed: DeepPartial<AVSettings.Settings>) => void;
|
752
764
|
|
@@ -757,12 +769,12 @@ declare global {
|
|
757
769
|
* @param table - The RollTable
|
758
770
|
* @param config - The RollTableConfig application
|
759
771
|
* @param data - The data dropped onto the RollTableConfig
|
760
|
-
* @remarks This is called by {@link Hooks.call}.
|
772
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
761
773
|
* @remarks An explicit return value of `false` prevents the Document being created.
|
762
|
-
* @see {@link RollTableConfig#_onDrop}
|
774
|
+
* @see {@link RollTableConfig._onDrop | `RollTableConfig#_onDrop`}
|
763
775
|
*/
|
764
776
|
dropRollTableSheetData: (
|
765
|
-
table: RollTable.
|
777
|
+
table: RollTable.Implementation,
|
766
778
|
config: RollTableConfig,
|
767
779
|
data: object,
|
768
780
|
) => boolean | void;
|
@@ -770,7 +782,7 @@ declare global {
|
|
770
782
|
/**
|
771
783
|
* A hook event that allows to pass custom dynamic ring configurations.
|
772
784
|
* @param ringConfig - The ring configuration instance
|
773
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
785
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
774
786
|
*/
|
775
787
|
initializeDynamicTokenRingConfig: (ringConfig: foundry.canvas.tokens.TokenRingConfig) => void;
|
776
788
|
|
@@ -780,8 +792,8 @@ declare global {
|
|
780
792
|
* A hook event that fires when the context menu for a SceneNavigation entry is constructed.
|
781
793
|
* @param app - The Application instance that the context menu is constructed in
|
782
794
|
* @param entryOptions - The context menu entries
|
783
|
-
* @remarks This is called by {@link Hooks.call}.
|
784
|
-
* @see {@link SceneNavigation#activateListeners}
|
795
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
796
|
+
* @see {@link SceneNavigation.activateListeners | `SceneNavigation#activateListeners`}
|
785
797
|
*/
|
786
798
|
getSceneNavigationContext: (
|
787
799
|
app: foundry.applications.ui.SceneNavigation,
|
@@ -792,8 +804,8 @@ declare global {
|
|
792
804
|
* A hook event that fires when the context menu for a PlayersList entry is constructed.
|
793
805
|
* @param app - The Application instance that the context menu is constructed in
|
794
806
|
* @param contextOptions - The context menu entries
|
795
|
-
* @remarks This is called by {@link Hooks.call}.
|
796
|
-
* @see {@link PlayerList#activateListeners}
|
807
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
808
|
+
* @see {@link PlayerList.activateListeners | `PlayerList#activateListeners`}
|
797
809
|
*/
|
798
810
|
getUserContextOptions: (
|
799
811
|
app: foundry.applications.ui.Players,
|
@@ -813,8 +825,8 @@ declare global {
|
|
813
825
|
* @param data - The object of data used when rendering the application
|
814
826
|
* @typeParam A - the type of the Application
|
815
827
|
* @remarks The name for this hook is dynamically created by joining "render" with the type name of the Application.
|
816
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
817
|
-
* @see {@link Application#_render}
|
828
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
829
|
+
* @see {@link Application._render | `Application#_render`}
|
818
830
|
*/
|
819
831
|
type RenderApplication<A extends Application.Any = Application.Any> = (
|
820
832
|
app: A,
|
@@ -829,8 +841,8 @@ declare global {
|
|
829
841
|
* @typeParam A - the type of the Application
|
830
842
|
* @remarks The name for this hook is dynamically created by joining "get" with the type name of the Application and
|
831
843
|
* "HeaderButtons".
|
832
|
-
* @remarks This is called by {@link Hooks.call}.
|
833
|
-
* @see {@link Application#_getHeaderButtons}
|
844
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
845
|
+
* @see {@link Application._getHeaderButtons | `Application#_getHeaderButtons`}
|
834
846
|
*/
|
835
847
|
type GetApplicationHeaderButtons<A extends Application.Any = Application.Any> = (
|
836
848
|
app: A,
|
@@ -843,8 +855,8 @@ declare global {
|
|
843
855
|
* @param html - The application HTML when it is closed
|
844
856
|
* @typeParam A - the type of the Application
|
845
857
|
* @remarks The name for this hook is dynamically created by joining "close" with the type name of the Application.
|
846
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
847
|
-
* @see {@link Application#close}
|
858
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
859
|
+
* @see {@link Application.close | `Application#close`}
|
848
860
|
*/
|
849
861
|
type CloseApplication<A extends Application.Any = Application.Any> = (app: A, html: JQuery) => void;
|
850
862
|
|
@@ -863,14 +875,14 @@ declare global {
|
|
863
875
|
/** EffectsCanvasGroup */
|
864
876
|
|
865
877
|
/**
|
866
|
-
* A hook event that fires when a {@link CanvasGroup} is drawn.
|
878
|
+
* A hook event that fires when a {@link CanvasGroup | `CanvasGroup`} is drawn.
|
867
879
|
* The dispatched event name replaces "Group" with the named CanvasGroup subclass, i.e. "drawPrimaryCanvasGroup".
|
868
880
|
* @param group - The group being drawn
|
869
881
|
*/
|
870
882
|
type DrawGroup<G extends CanvasGroupMixin.AnyMixed = CanvasGroupMixin.AnyMixed> = (group: G) => void;
|
871
883
|
|
872
884
|
/**
|
873
|
-
* A hook event that fires when a {@link CanvasGroup} is deconstructed.
|
885
|
+
* A hook event that fires when a {@link CanvasGroup | `CanvasGroup`} is deconstructed.
|
874
886
|
* The dispatched event name replaces "Group" with the named CanvasGroup subclass, i.e. "tearDownPrimaryCanvasGroup".
|
875
887
|
* @param group - The group being deconstructed
|
876
888
|
*/
|
@@ -879,7 +891,7 @@ declare global {
|
|
879
891
|
/** CanvasLayer */
|
880
892
|
|
881
893
|
/**
|
882
|
-
* A hook event that fires when a {@link CanvasLayer} is initially drawn.
|
894
|
+
* A hook event that fires when a {@link CanvasLayer | `CanvasLayer`} is initially drawn.
|
883
895
|
* The dispatched event name replaces "Layer" with the named CanvasLayer subclass, i.e. "drawTokensLayer".
|
884
896
|
* @param layer - The layer being drawn
|
885
897
|
* @typeParam L - the type of the CanvasLayer
|
@@ -887,7 +899,7 @@ declare global {
|
|
887
899
|
type DrawLayer<L extends CanvasLayer = CanvasLayer> = (layer: L) => void;
|
888
900
|
|
889
901
|
/**
|
890
|
-
* A hook event that fires when a {@link CanvasLayer} is deconstructed.
|
902
|
+
* A hook event that fires when a {@link CanvasLayer | `CanvasLayer`} is deconstructed.
|
891
903
|
* The dispatched event name replaces "Layer" with the named CanvasLayer subclass, i.e. "tearDownTokensLayer".
|
892
904
|
* @param layer - The layer being deconstructed
|
893
905
|
* @typeParam L - the type of the CanvasLayer
|
@@ -903,8 +915,8 @@ declare global {
|
|
903
915
|
* @typeParam P - the type of the PlaceableObject
|
904
916
|
* @remarks The name for this hook is dynamically created by joining "paste" with the type name of the
|
905
917
|
* PlaceableObject.
|
906
|
-
* @remarks This is called by {@link Hooks.call}.
|
907
|
-
* @see {@link PlaceablesLayer#pasteObjects}
|
918
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
919
|
+
* @see {@link PlaceablesLayer.pasteObjects | `PlaceablesLayer#pasteObjects`}
|
908
920
|
*/
|
909
921
|
type PastePlaceableObject<P extends PlaceableObject = PlaceableObject> = (
|
910
922
|
copied: P[],
|
@@ -915,29 +927,29 @@ declare global {
|
|
915
927
|
/** PlaceableObject */
|
916
928
|
|
917
929
|
/**
|
918
|
-
* A hook event that fires when a {@link PlaceableObject} is initially drawn.
|
930
|
+
* A hook event that fires when a {@link PlaceableObject | `PlaceableObject`} is initially drawn.
|
919
931
|
* The dispatched event name replaces "Object" with the named PlaceableObject subclass, i.e. "drawToken".
|
920
932
|
* @param object - The object instance being drawn
|
921
933
|
* @typeParam P - the type of the PlaceableObject
|
922
|
-
* @remarks This is called by {@link Hooks.callAll}
|
934
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}
|
923
935
|
*/
|
924
936
|
type DrawObject<P extends PlaceableObject = PlaceableObject> = (object: P) => void;
|
925
937
|
|
926
938
|
/**
|
927
|
-
* A hook event that fires when a {@link PlaceableObject} is incrementally refreshed.
|
939
|
+
* A hook event that fires when a {@link PlaceableObject | `PlaceableObject`} is incrementally refreshed.
|
928
940
|
* The dispatched event name replaces "Object" with the named PlaceableObject subclass, i.e. "refreshToken".
|
929
941
|
* @param object - The object instance being refreshed
|
930
942
|
* @typeParam P - the type of the PlaceableObject
|
931
|
-
* @remarks This is called by {@link Hooks.callAll}
|
943
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}
|
932
944
|
*/
|
933
945
|
type RefreshObject<P extends PlaceableObject = PlaceableObject> = (object: P) => void;
|
934
946
|
|
935
947
|
/**
|
936
|
-
* A hook event that fires when a {@link PlaceableObject} is destroyed.
|
948
|
+
* A hook event that fires when a {@link PlaceableObject | `PlaceableObject`} is destroyed.
|
937
949
|
* The dispatched event name replaces "Object" with the named PlaceableObject subclass, i.e. "destroyToken".
|
938
950
|
* @param object - The object instance being destroyed
|
939
951
|
* @typeParam P - the type of the PlaceableObject
|
940
|
-
* @remarks This is called by {@link Hooks.callAll}
|
952
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}
|
941
953
|
*/
|
942
954
|
type DestroyObject<P extends PlaceableObject = PlaceableObject> = (object: P) => void;
|
943
955
|
|
@@ -950,9 +962,9 @@ declare global {
|
|
950
962
|
* @typeParam P - the type of the PlaceableObject
|
951
963
|
* @remarks The name for this hook is dynamically created by joining "control" and the type name of the
|
952
964
|
* PlaceableObject.
|
953
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
954
|
-
* @see {@link PlaceableObject#control}
|
955
|
-
* @see {@link PlaceableObject#release}
|
965
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
966
|
+
* @see {@link PlaceableObject.control | `PlaceableObject#control`}
|
967
|
+
* @see {@link PlaceableObject.release | `PlaceableObject#release`}
|
956
968
|
*/
|
957
969
|
type ControlObject<P extends PlaceableObject = PlaceableObject> = (object: P, controlled: boolean) => void;
|
958
970
|
|
@@ -964,9 +976,9 @@ declare global {
|
|
964
976
|
* @param hover - Whether the PlaceableObject is hovered over or not
|
965
977
|
* @typeParam P - the type of the PlaceableObject
|
966
978
|
* @remarks The name for this hook is dynamically created by joining "hover" and the type name of the PlaceableObject.
|
967
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
968
|
-
* @see {@link PlaceableObject#_onHoverIn}
|
969
|
-
* @see {@link PlaceableObject#_onHoverOut}
|
979
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
980
|
+
* @see {@link PlaceableObject._onHoverIn | `PlaceableObject#_onHoverIn`}
|
981
|
+
* @see {@link PlaceableObject._onHoverOut | `PlaceableObject#_onHoverOut`}
|
970
982
|
*/
|
971
983
|
type HoverObject<P extends PlaceableObject = PlaceableObject> = (object: P, hover: boolean) => void;
|
972
984
|
|
@@ -987,14 +999,14 @@ declare global {
|
|
987
999
|
* @typeParam D - the type of the Document constructor
|
988
1000
|
* @returns Explicitly return false to prevent creation of this Document
|
989
1001
|
* @remarks The name for this hook is dynamically created by joining "preCreate" with the name of the Document.
|
990
|
-
* @remarks This is called by {@link Hooks.call}.
|
991
|
-
* @see {@link ClientDatabaseBackend#_preCreateDocumentArray}
|
992
|
-
* @see {@link TokenDocument#_preUpdateTokenActor}
|
1002
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
1003
|
+
* @see {@link ClientDatabaseBackend._preCreateDocumentArray | `ClientDatabaseBackend#_preCreateDocumentArray`}
|
1004
|
+
* @see {@link TokenDocument._preUpdateTokenActor | `TokenDocument#_preUpdateTokenActor`}
|
993
1005
|
*/
|
994
1006
|
type PreCreateDocument<D extends Document.AnyConstructor = Document.AnyConstructor> = (
|
995
1007
|
document: Document.ToConfiguredInstance<D>,
|
996
1008
|
data: ConstructorParameters<D>[0],
|
997
|
-
options: Document.PreCreateOptions<
|
1009
|
+
options: Document.Database.PreCreateOptions<DatabaseCreateOperation>,
|
998
1010
|
userId: string,
|
999
1011
|
) => boolean | void;
|
1000
1012
|
|
@@ -1013,14 +1025,16 @@ declare global {
|
|
1013
1025
|
* @typeParam D - the type of the Document constructor
|
1014
1026
|
* @returns Explicitly return false to prevent update of this Document
|
1015
1027
|
* @remarks The name for this hook is dynamically created by joining "preUpdate" with the type name of the Document.
|
1016
|
-
* @remarks This is called {@link Hooks.call}.
|
1017
|
-
* @see {@link ClientDatabaseBackend#_preUpdateDocumentArray}
|
1018
|
-
* @see {@link TokenDocument#_preUpdateTokenActor}
|
1028
|
+
* @remarks This is called {@link Hooks.call | `Hooks.call`}.
|
1029
|
+
* @see {@link ClientDatabaseBackend._preUpdateDocumentArray | `ClientDatabaseBackend#_preUpdateDocumentArray`}
|
1030
|
+
* @see {@link TokenDocument._preUpdateTokenActor | `TokenDocument#_preUpdateTokenActor`}
|
1019
1031
|
*/
|
1020
1032
|
type PreUpdateDocument<D extends Document.AnyConstructor = Document.AnyConstructor> = (
|
1021
1033
|
document: Document.ToConfiguredInstance<D>,
|
1022
|
-
changed: DeepPartial<
|
1023
|
-
|
1034
|
+
changed: DeepPartial<
|
1035
|
+
D extends abstract new (arg0: infer Data extends object, ...args: infer _1) => unknown ? Data : never
|
1036
|
+
>,
|
1037
|
+
options: Document.Database.PreUpdateOptions<DatabaseUpdateOperation>,
|
1024
1038
|
userId: string,
|
1025
1039
|
) => boolean | void;
|
1026
1040
|
|
@@ -1038,13 +1052,13 @@ declare global {
|
|
1038
1052
|
* @typeParam D - the type of the Document constructor
|
1039
1053
|
* @returns Explicitly return false to prevent deletion of this Document
|
1040
1054
|
* @remarks The name for this hook is dynamically created by joining "preDelete" with the type name of the Document.
|
1041
|
-
* @remarks This is called by {@link Hooks.call}.
|
1042
|
-
* @see {@link ClientDatabaseBackend#_preDeleteDocumentArray}.
|
1043
|
-
* @see {@link TokenDocument#_preUpdateTokenActor}
|
1055
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
1056
|
+
* @see {@link ClientDatabaseBackend._preDeleteDocumentArray | `ClientDatabaseBackend#_preDeleteDocumentArray`}.
|
1057
|
+
* @see {@link TokenDocument._preUpdateTokenActor | `TokenDocument#_preUpdateTokenActor`}
|
1044
1058
|
*/
|
1045
1059
|
type PreDeleteDocument<D extends Document.AnyConstructor = Document.AnyConstructor> = (
|
1046
1060
|
document: Document.ToConfiguredInstance<D>,
|
1047
|
-
options: Document.
|
1061
|
+
options: Document.Database.PreDeleteOperationInstance<DatabaseDeleteOperation>,
|
1048
1062
|
userId: string,
|
1049
1063
|
) => boolean | void;
|
1050
1064
|
|
@@ -1058,13 +1072,13 @@ declare global {
|
|
1058
1072
|
* @param userId - The ID of the User who triggered the creation workflow
|
1059
1073
|
* @typeParam D - the type of the Document constructor
|
1060
1074
|
* @remarks The name for this hook is dynamically created by joining "create" and the type name of the Document.
|
1061
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
1062
|
-
* @see {@link ClientDatabaseBackend#_postCreateDocumentCallbacks}
|
1063
|
-
* @see {@link TokenDocument#_onUpdateTokenActor}
|
1075
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
1076
|
+
* @see {@link ClientDatabaseBackend._postCreateDocumentCallbacks | `ClientDatabaseBackend#_postCreateDocumentCallbacks`}
|
1077
|
+
* @see {@link TokenDocument._onUpdateTokenActor | `TokenDocument#_onUpdateTokenActor`}
|
1064
1078
|
*/
|
1065
1079
|
type CreateDocument<D extends Document.AnyConstructor = Document.AnyConstructor> = (
|
1066
1080
|
document: Document.ToConfiguredInstance<D>,
|
1067
|
-
options: Document.
|
1081
|
+
options: Document.Database.CreateOptions<DatabaseCreateOperation>,
|
1068
1082
|
userId: string,
|
1069
1083
|
) => void;
|
1070
1084
|
|
@@ -1079,14 +1093,16 @@ declare global {
|
|
1079
1093
|
* @param userId - The ID of the User who triggered the update workflow
|
1080
1094
|
* @typeParam D - the type of the Document constructor
|
1081
1095
|
* @remarks The name for this hook is dynamically created by joining "update" with the type name of the Document.
|
1082
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
1083
|
-
* @see {@link ClientDatabaseBackend#_postUpdateDocumentCallbacks}
|
1084
|
-
* @see {@link TokenDocument#_onUpdateTokenActor}
|
1096
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
1097
|
+
* @see {@link ClientDatabaseBackend._postUpdateDocumentCallbacks | `ClientDatabaseBackend#_postUpdateDocumentCallbacks`}
|
1098
|
+
* @see {@link TokenDocument._onUpdateTokenActor | `TokenDocument#_onUpdateTokenActor`}
|
1085
1099
|
*/
|
1086
1100
|
type UpdateDocument<D extends Document.AnyConstructor = Document.AnyConstructor> = (
|
1087
1101
|
document: Document.ToConfiguredInstance<D>,
|
1088
|
-
change: DeepPartial<
|
1089
|
-
|
1102
|
+
change: DeepPartial<
|
1103
|
+
D extends abstract new (arg0: infer Data extends object, ...args: infer _1) => unknown ? Data : never
|
1104
|
+
>,
|
1105
|
+
options: Document.Database.UpdateOptions<DatabaseUpdateOperation>,
|
1090
1106
|
userId: string,
|
1091
1107
|
) => void;
|
1092
1108
|
|
@@ -1100,13 +1116,13 @@ declare global {
|
|
1100
1116
|
* @param userId - The ID of the User who triggered the deletion workflow
|
1101
1117
|
* @typeParam D - the type of the Document constructor
|
1102
1118
|
* @remarks The name for this hook is dynamically created by joining "delete" with the type name of the Document.
|
1103
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
1104
|
-
* @see {@link ClientDatabaseBackend#_postDeleteDocumentCallbacks}
|
1105
|
-
* @see {@link TokenDocument#_onUpdateTokenActor}
|
1119
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
1120
|
+
* @see {@link ClientDatabaseBackend._postDeleteDocumentCallbacks | `ClientDatabaseBackend#_postDeleteDocumentCallbacks`}
|
1121
|
+
* @see {@link TokenDocument._onUpdateTokenActor | `TokenDocument#_onUpdateTokenActor`}
|
1106
1122
|
*/
|
1107
1123
|
type DeleteDocument<D extends Document.AnyConstructor = Document.AnyConstructor> = (
|
1108
1124
|
document: Document.ToConfiguredInstance<D>,
|
1109
|
-
options: Document.
|
1125
|
+
options: Document.Database.DeleteOptions<DatabaseDeleteOperation>,
|
1110
1126
|
userId: string,
|
1111
1127
|
) => void;
|
1112
1128
|
|
@@ -1117,7 +1133,7 @@ declare global {
|
|
1117
1133
|
* @param source - The RenderedEffectSource instance being initialized
|
1118
1134
|
* @typeParam RPS - the type of the RenderedPointSource
|
1119
1135
|
* @remarks The name for this hook is dynamically created by wrapping the type name of the shader in `initialize` and `Shaders`.
|
1120
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
1136
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
1121
1137
|
*/
|
1122
1138
|
type InitializeRenderedEffectSourceShaders<RPS extends RenderedEffectSource.Any = RenderedEffectSource.Any> = (
|
1123
1139
|
source: RPS,
|
@@ -1126,18 +1142,18 @@ declare global {
|
|
1126
1142
|
/** InteractionLayer */
|
1127
1143
|
|
1128
1144
|
/**
|
1129
|
-
* A hook event that fires with a {@link InteractionLayer} becomes active.
|
1145
|
+
* A hook event that fires with a {@link InteractionLayer | `InteractionLayer`} becomes active.
|
1130
1146
|
* The dispatched event name replaces "Layer" with the named InteractionLayer subclass, i.e. "activateTokensLayer".
|
1131
1147
|
* @param layer - The layer becoming active
|
1132
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
1148
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
1133
1149
|
*/
|
1134
1150
|
type ActivateLayer<L extends InteractionLayer = InteractionLayer> = (layer: L) => void;
|
1135
1151
|
|
1136
1152
|
/**
|
1137
|
-
* A hook event that fires with a {@link InteractionLayer} becomes inactive.
|
1153
|
+
* A hook event that fires with a {@link InteractionLayer | `InteractionLayer`} becomes inactive.
|
1138
1154
|
* The dispatched event name replaces "Layer" with the named InteractionLayer subclass, i.e. "deactivateTokensLayer".
|
1139
1155
|
* @param layer - The layer becoming inactive
|
1140
|
-
* @remarks This is called by {@link Hooks.callAll}.
|
1156
|
+
* @remarks This is called by {@link Hooks.callAll | `Hooks.callAll`}.
|
1141
1157
|
*/
|
1142
1158
|
type DeactivateLayer<L extends InteractionLayer = InteractionLayer> = (layer: L) => void;
|
1143
1159
|
|
@@ -1147,8 +1163,8 @@ declare global {
|
|
1147
1163
|
* "getActorDirectoryEntryContext".
|
1148
1164
|
* @param app - The Application instance that the context menu is constructed in
|
1149
1165
|
* @param entryOptions - The context menu entries
|
1150
|
-
* @remarks This is called by {@link Hooks.call}.
|
1151
|
-
* @see {@link ContextMenu.create}
|
1166
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
1167
|
+
* @see {@link ContextMenu.create | `ContextMenu.create`}
|
1152
1168
|
*/
|
1153
1169
|
type GetEntryContext = (
|
1154
1170
|
app: Application.Any | foundry.applications.api.ApplicationV2.Any,
|
@@ -1161,8 +1177,8 @@ declare global {
|
|
1161
1177
|
* @param entryOptions - The context menu entries
|
1162
1178
|
* @remarks The name for this hook is dynamically created by joining "get" with the type name of the PlaylistDirectory
|
1163
1179
|
* and "SoundContext".
|
1164
|
-
* @remarks This is called by {@link Hooks.call}.
|
1165
|
-
* @see {@link PlaylistDirectory#_contextMenu}
|
1180
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
1181
|
+
* @see {@link PlaylistDirectory._contextMenu | `PlaylistDirectory#_contextMenu`}
|
1166
1182
|
*/
|
1167
1183
|
type GetSoundContextPlaylistDirectory = (
|
1168
1184
|
app: foundry.applications.sidebar.tabs.PlaylistDirectory,
|
@@ -1177,8 +1193,8 @@ declare global {
|
|
1177
1193
|
* @param entryOptions - The context menu entries
|
1178
1194
|
* @remarks The name for this hook is dynamically created by joining "get" with the type name of the SidebarDirectory
|
1179
1195
|
* and "FolderContext".
|
1180
|
-
* @remarks This is called by {@link Hooks.call}.
|
1181
|
-
* @see {@link SidebarDirectory#_contextMenu}
|
1196
|
+
* @remarks This is called by {@link Hooks.call | `Hooks.call`}.
|
1197
|
+
* @see {@link SidebarDirectory._contextMenu | `SidebarDirectory#_contextMenu`}
|
1182
1198
|
*/
|
1183
1199
|
type GetSidebarDirectoryFolderContext = (
|
1184
1200
|
app: foundry.applications.sidebar.DocumentDirectory,
|