@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,29 +1,455 @@
|
|
1
|
-
import type {
|
2
|
-
import type
|
3
|
-
import type
|
1
|
+
import type { ConfiguredMacro } from "fvtt-types/configuration";
|
2
|
+
import type { InexactPartial, Merge } from "fvtt-types/utils";
|
3
|
+
import type { documents } from "#client-esm/client.d.mts";
|
4
|
+
import type Document from "#common/abstract/document.d.mts";
|
5
|
+
import type { DataSchema } from "#common/data/fields.d.mts";
|
6
|
+
import type BaseMacro from "#common/documents/macro.d.mts";
|
7
|
+
|
8
|
+
import fields = foundry.data.fields;
|
4
9
|
|
5
10
|
declare global {
|
6
11
|
namespace Macro {
|
7
|
-
|
12
|
+
/**
|
13
|
+
* The document's name.
|
14
|
+
*/
|
15
|
+
type Name = "Macro";
|
16
|
+
|
17
|
+
/**
|
18
|
+
* The arguments to construct the document.
|
19
|
+
*/
|
20
|
+
type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;
|
21
|
+
|
22
|
+
/**
|
23
|
+
* The documents embedded within `Macro`.
|
24
|
+
*/
|
25
|
+
type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;
|
26
|
+
|
27
|
+
/**
|
28
|
+
* The implementation of the `Macro` document instance configured through `CONFIG.Macro.documentClass` in Foundry and
|
29
|
+
* {@link DocumentClassConfig | `DocumentClassConfig`} or {@link ConfiguredMacro | `fvtt-types/configuration/ConfiguredMacro`} in fvtt-types.
|
30
|
+
*/
|
31
|
+
type Implementation = Document.ImplementationFor<Name>;
|
32
|
+
|
33
|
+
/**
|
34
|
+
* The implementation of the `Macro` document configured through `CONFIG.Macro.documentClass` in Foundry and
|
35
|
+
* {@link DocumentClassConfig | `DocumentClassConfig`} in fvtt-types.
|
36
|
+
*/
|
37
|
+
type ImplementationClass = Document.ImplementationClassFor<Name>;
|
38
|
+
|
39
|
+
/**
|
40
|
+
* A document's metadata is special information about the document ranging anywhere from its name,
|
41
|
+
* whether it's indexed, or to the permissions a user has over it.
|
42
|
+
*/
|
43
|
+
interface Metadata
|
44
|
+
extends Merge<
|
45
|
+
Document.Metadata.Default,
|
46
|
+
Readonly<{
|
47
|
+
name: "Macro";
|
48
|
+
collection: "macros";
|
49
|
+
indexed: true;
|
50
|
+
compendiumIndexFields: ["_id", "name", "img", "sort", "folder"];
|
51
|
+
label: string;
|
52
|
+
labelPlural: string;
|
53
|
+
coreTypes: CONST.MACRO_TYPES[];
|
54
|
+
permissions: Metadata.Permissions;
|
55
|
+
schemaVersion: string;
|
56
|
+
}>
|
57
|
+
> {}
|
58
|
+
|
59
|
+
namespace Metadata {
|
60
|
+
/**
|
61
|
+
* The permissions for whether a certain user can create, update, or delete this document.
|
62
|
+
*/
|
63
|
+
interface Permissions {
|
64
|
+
create(user: User.Internal.Implementation, doc: Implementation): boolean;
|
65
|
+
update(user: User.Internal.Implementation, doc: Implementation): boolean;
|
66
|
+
}
|
67
|
+
}
|
68
|
+
|
69
|
+
/**
|
70
|
+
* The subtypes of `Macro` that Foundry provides. `Macro` does not have `system` and therefore
|
71
|
+
* there is no way for a user to configure custom subtypes. Nevertheless Foundry has a number of
|
72
|
+
* built in subtypes usable for `Macro`.
|
73
|
+
*
|
74
|
+
* `Macro` has two subtypes `"chat"` and `"script"`. A `Macro` with type `"chat"` will create a
|
75
|
+
* `ChatMessage` whereas a `"script"` allows executing arbitrary JavaScript code
|
76
|
+
*/
|
77
|
+
type SubType = Game.Model.TypeNames<Name>;
|
78
|
+
|
79
|
+
/**
|
80
|
+
* @deprecated `Macro` does not have `system` and therefore there is no way for a user to
|
81
|
+
* configure custom subtypes.
|
82
|
+
*
|
83
|
+
* This type exists only to be informative.
|
84
|
+
*/
|
85
|
+
type ConfiguredSubTypes = never;
|
86
|
+
|
87
|
+
/**
|
88
|
+
* @deprecated `Macro` does not have `system` and therefore there is no way for a user to
|
89
|
+
* configure custom subtypes. This means `Known` as a concept does not apply to it.
|
90
|
+
*
|
91
|
+
* This type exists only to be informative.
|
92
|
+
*/
|
93
|
+
type Known = never;
|
94
|
+
|
95
|
+
/**
|
96
|
+
* `OfType` returns an instance of `Macro` with the corresponding type. This works with both the
|
97
|
+
* builtin `Macro` class or a custom subclass if that is set up in
|
98
|
+
* {@link ConfiguredMacro | `fvtt-types/configuration/ConfiguredMacro`}.
|
99
|
+
*
|
100
|
+
* Note that `Macro` does not have a `system` property and therefore there is no way for a user
|
101
|
+
* to configure custom subtypes. See {@link Macro.SubType | `Macro.SubType`} for more information.
|
102
|
+
*/
|
103
|
+
// eslint-disable-next-line @typescript-eslint/no-restricted-types
|
104
|
+
type OfType<Type extends SubType> = Document.Internal.OfType<ConfiguredMacro<Type>, Macro<Type>>;
|
105
|
+
|
106
|
+
/**
|
107
|
+
* A document's parent is something that can contain it.
|
108
|
+
* For example an `Item` can be contained by an `Actor` which makes `Actor` one of its possible parents.
|
109
|
+
*/
|
110
|
+
type Parent = null;
|
111
|
+
|
112
|
+
/**
|
113
|
+
* A document's descendants are any child documents, grandchild documents, etc.
|
114
|
+
* This is a union of all instances, or never if the document doesn't have any descendants.
|
115
|
+
*/
|
116
|
+
type Descendant = never;
|
117
|
+
|
118
|
+
/**
|
119
|
+
* A document's descendants are any child documents, grandchild documents, etc.
|
120
|
+
* This is a union of all classes, or never if the document doesn't have any descendants.
|
121
|
+
*/
|
122
|
+
type DescendantClass = never;
|
123
|
+
|
124
|
+
/**
|
125
|
+
* Types of `CompendiumCollection` this document might be contained in.
|
126
|
+
* Note that `this.pack` will always return a string; this is the type for `game.packs.get(this.pack)`
|
127
|
+
*/
|
128
|
+
// Note: Takes any document in the heritage chain (i.e. itself or any parent, transitive or not) that can be contained in a compendium.
|
129
|
+
type Pack = CompendiumCollection.ForDocument<"Scene">;
|
130
|
+
|
131
|
+
/**
|
132
|
+
* An embedded document is a document contained in another.
|
133
|
+
* For example an `Item` can be contained by an `Actor` which means `Item` can be embedded in `Actor`.
|
134
|
+
*
|
135
|
+
* If this is `never` it is because there are no embeddable documents (or there's a bug!).
|
136
|
+
*/
|
137
|
+
type Embedded = never;
|
138
|
+
|
139
|
+
/**
|
140
|
+
* The name of the world or embedded collection this document can find itself in.
|
141
|
+
* For example an `Item` is always going to be inside a collection with a key of `items`.
|
142
|
+
* This is a fixed string per document type and is primarily useful for {@link ClientDocumentMixin | `Descendant Document Events`}.
|
143
|
+
*/
|
144
|
+
type ParentCollectionName = Metadata["collection"];
|
145
|
+
|
146
|
+
/**
|
147
|
+
* The world collection that contains `Macro`s. Will be `never` if none exists.
|
148
|
+
*/
|
149
|
+
type CollectionClass = Macros.ConfiguredClass;
|
150
|
+
|
151
|
+
/**
|
152
|
+
* The world collection that contains `Folder`s. Will be `never` if none exists.
|
153
|
+
*/
|
154
|
+
type Collection = Macros.Configured;
|
155
|
+
|
156
|
+
/**
|
157
|
+
* An instance of `Macro` that comes from the database but failed validation meaining that
|
158
|
+
* its `system` and `_source` could theoretically be anything.
|
159
|
+
*/
|
160
|
+
interface Invalid<out SubType extends Macro.SubType = Macro.SubType> extends Document.Invalid<OfType<SubType>> {}
|
161
|
+
|
162
|
+
/**
|
163
|
+
* An instance of `Macro` that comes from the database.
|
164
|
+
*/
|
165
|
+
interface Stored<out SubType extends Macro.SubType = Macro.SubType> extends Document.Stored<OfType<SubType>> {}
|
166
|
+
|
167
|
+
/**
|
168
|
+
* The data put in {@link Macro._source | `Macro#_source`}. This data is what was
|
169
|
+
* persisted to the database and therefore it must be valid JSON.
|
170
|
+
*
|
171
|
+
* For example a {@link fields.SetField | `SetField`} is persisted to the database as an array
|
172
|
+
* but initialized as a {@link Set | `Set`}.
|
173
|
+
*/
|
174
|
+
interface Source extends fields.SchemaField.SourceData<Schema> {}
|
175
|
+
|
176
|
+
/**
|
177
|
+
* @deprecated {@link Macro.Source | `Macro.Source`}
|
178
|
+
*/
|
179
|
+
type PersistedData = Source;
|
180
|
+
|
181
|
+
/**
|
182
|
+
* The data necessary to create a document. Used in places like {@link Macro.create | `Macro.create`}
|
183
|
+
* and {@link Macro | `new Macro(...)`}.
|
184
|
+
*
|
185
|
+
* For example a {@link fields.SetField | `SetField`} can accept any {@link Iterable | `Iterable`}
|
186
|
+
* with the right values. This means you can pass a `Set` instance, an array of values,
|
187
|
+
* a generator, or any other iterable.
|
188
|
+
*/
|
189
|
+
interface CreateData extends fields.SchemaField.CreateData<Schema> {}
|
190
|
+
|
191
|
+
/**
|
192
|
+
* The data after a {@link foundry.abstract.Document | `Document`} has been initialized, for example
|
193
|
+
* {@link Macro.name | `Macro#name`}.
|
194
|
+
*
|
195
|
+
* This is data transformed from {@link Macro.Source | `Macro.Source`} and turned into more
|
196
|
+
* convenient runtime data structures. For example a {@link fields.SetField | `SetField`} is
|
197
|
+
* persisted to the database as an array of values but at runtime it is a `Set` instance.
|
198
|
+
*/
|
199
|
+
interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
|
8
200
|
|
9
|
-
|
10
|
-
|
201
|
+
/**
|
202
|
+
* The data used to update a document, for example {@link Macro.update | `Macro#update`}.
|
203
|
+
* It is a distinct type from {@link Macro.CreateData | `DeepPartial<Macro.CreateData>`} because
|
204
|
+
* it has different rules for `null` and `undefined`.
|
205
|
+
*/
|
206
|
+
interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
|
11
207
|
|
12
|
-
|
208
|
+
/**
|
209
|
+
* The schema for {@link Macro | `Macro`}. This is the source of truth for how an Macro document
|
210
|
+
* must be structured.
|
211
|
+
*
|
212
|
+
* Foundry uses this schema to validate the structure of the {@link Macro | `Macro`}. For example
|
213
|
+
* a {@link fields.StringField | `StringField`} will enforce that the value is a string. More
|
214
|
+
* complex fields like {@link fields.SetField | `SetField`} goes through various conversions
|
215
|
+
* starting as an array in the database, initialized as a set, and allows updates with any
|
216
|
+
* iterable.
|
217
|
+
*/
|
218
|
+
interface Schema extends DataSchema {
|
219
|
+
/**
|
220
|
+
* The _id which uniquely identifies this Macro document
|
221
|
+
* @defaultValue `null`
|
222
|
+
*/
|
223
|
+
_id: fields.DocumentIdField;
|
13
224
|
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
225
|
+
/**
|
226
|
+
* The name of this Macro
|
227
|
+
* @defaultValue `""`
|
228
|
+
*/
|
229
|
+
name: fields.StringField<{
|
230
|
+
required: true;
|
231
|
+
blank: false;
|
232
|
+
label: "Name";
|
233
|
+
textSearch: true;
|
234
|
+
}>;
|
235
|
+
|
236
|
+
/**
|
237
|
+
* A Macro subtype from CONST.MACRO_TYPES
|
238
|
+
* @defaultValue `CONST.MACRO_TYPES.CHAT`
|
239
|
+
*/
|
240
|
+
type: fields.DocumentTypeField<
|
241
|
+
typeof BaseMacro,
|
242
|
+
{
|
243
|
+
initial: typeof CONST.MACRO_TYPES.CHAT;
|
244
|
+
label: "Type";
|
245
|
+
}
|
246
|
+
>;
|
20
247
|
|
21
|
-
|
248
|
+
/**
|
249
|
+
* The _id of a User document which created this Macro *
|
250
|
+
* @defaultValue `game?.user?.id`
|
251
|
+
*/
|
252
|
+
author: fields.ForeignDocumentField<typeof documents.BaseUser, { initial: () => string }>;
|
253
|
+
|
254
|
+
/**
|
255
|
+
* An image file path which provides the thumbnail artwork for this Macro
|
256
|
+
* @defaultValue `BaseMacro.DEFAULT_ICON`
|
257
|
+
*/
|
258
|
+
img: fields.FilePathField<{
|
259
|
+
categories: ["IMAGE"];
|
260
|
+
initial: () => typeof BaseMacro.DEFAULT_ICON;
|
261
|
+
label: "Image";
|
262
|
+
}>;
|
263
|
+
|
264
|
+
/**
|
265
|
+
* The scope of this Macro application from CONST.MACRO_SCOPES
|
266
|
+
* @defaultValue `"global"`
|
267
|
+
*/
|
268
|
+
scope: fields.StringField<{
|
269
|
+
required: true;
|
270
|
+
choices: CONST.MACRO_SCOPES[];
|
271
|
+
initial: (typeof CONST.MACRO_SCOPES)[0];
|
272
|
+
validationError: "must be a value in CONST.MACRO_SCOPES";
|
273
|
+
label: "Scope";
|
274
|
+
}>;
|
275
|
+
|
276
|
+
/**
|
277
|
+
* The string content of the macro command
|
278
|
+
* @defaultValue `""`
|
279
|
+
*/
|
280
|
+
command: fields.StringField<{
|
281
|
+
required: true;
|
282
|
+
blank: true;
|
283
|
+
label: "Command";
|
284
|
+
}>;
|
285
|
+
|
286
|
+
/**
|
287
|
+
* The _id of a Folder which contains this Macro
|
288
|
+
* @defaultValue `null`
|
289
|
+
*/
|
290
|
+
folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
|
291
|
+
|
292
|
+
/**
|
293
|
+
* The numeric sort value which orders this Macro relative to its siblings
|
294
|
+
* @defaultValue `0`
|
295
|
+
*/
|
296
|
+
sort: fields.IntegerSortField;
|
297
|
+
|
298
|
+
/**
|
299
|
+
* An object which configures ownership of this Macro
|
300
|
+
* @defaultValue see {@link fields.DocumentOwnershipField | `fields.DocumentOwnershipField`}
|
301
|
+
*/
|
302
|
+
ownership: fields.DocumentOwnershipField;
|
303
|
+
|
304
|
+
/**
|
305
|
+
* An object of optional key/value flags
|
306
|
+
* @defaultValue `{}`
|
307
|
+
*/
|
308
|
+
flags: fields.ObjectField.FlagsField<Name>;
|
309
|
+
|
310
|
+
/**
|
311
|
+
* An object of creation and access information
|
312
|
+
* @defaultValue see {@link fields.DocumentStatsField | `fields.DocumentStatsField`}
|
313
|
+
*/
|
314
|
+
_stats: fields.DocumentStatsField;
|
315
|
+
}
|
316
|
+
|
317
|
+
namespace Database {
|
318
|
+
/** Options passed along in Get operations for Macros */
|
319
|
+
interface Get extends foundry.abstract.types.DatabaseGetOperation<Macro.Parent> {}
|
320
|
+
|
321
|
+
/** Options passed along in Create operations for Macros */
|
322
|
+
interface Create<Temporary extends boolean | undefined = boolean | undefined>
|
323
|
+
extends foundry.abstract.types.DatabaseCreateOperation<Macro.CreateData, Macro.Parent, Temporary> {}
|
324
|
+
|
325
|
+
/** Options passed along in Delete operations for Macros */
|
326
|
+
interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<Macro.Parent> {}
|
327
|
+
|
328
|
+
/** Options passed along in Update operations for Macros */
|
329
|
+
interface Update extends foundry.abstract.types.DatabaseUpdateOperation<Macro.UpdateData, Macro.Parent> {}
|
330
|
+
|
331
|
+
/** Operation for {@link Macro.createDocuments | `Macro.createDocuments`} */
|
332
|
+
interface CreateDocumentsOperation<Temporary extends boolean | undefined>
|
333
|
+
extends Document.Database.CreateOperation<Macro.Database.Create<Temporary>> {}
|
334
|
+
|
335
|
+
/** Operation for {@link Macro.updateDocuments | `Macro.updateDocuments`} */
|
336
|
+
interface UpdateDocumentsOperation extends Document.Database.UpdateDocumentsOperation<Macro.Database.Update> {}
|
337
|
+
|
338
|
+
/** Operation for {@link Macro.deleteDocuments | `Macro.deleteDocuments`} */
|
339
|
+
interface DeleteDocumentsOperation extends Document.Database.DeleteDocumentsOperation<Macro.Database.Delete> {}
|
340
|
+
|
341
|
+
/** Operation for {@link Macro.create | `Macro.create`} */
|
342
|
+
interface CreateOperation<Temporary extends boolean | undefined>
|
343
|
+
extends Document.Database.CreateOperation<Macro.Database.Create<Temporary>> {}
|
344
|
+
|
345
|
+
/** Operation for {@link Macro.update | `Macro#update`} */
|
346
|
+
interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}
|
347
|
+
|
348
|
+
interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}
|
349
|
+
|
350
|
+
/** Options for {@link Macro.get | `Macro.get`} */
|
351
|
+
interface GetOptions extends Document.Database.GetOptions {}
|
352
|
+
|
353
|
+
/** Options for {@link Macro._preCreate | `Macro#_preCreate`} */
|
354
|
+
interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}
|
355
|
+
|
356
|
+
/** Options for {@link Macro._onCreate | `Macro#_onCreate`} */
|
357
|
+
interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}
|
358
|
+
|
359
|
+
/** Operation for {@link Macro._preCreateOperation | `Macro._preCreateOperation`} */
|
360
|
+
interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<Macro.Database.Create> {}
|
361
|
+
|
362
|
+
/** Operation for {@link Macro._onCreateOperation | `Macro#_onCreateOperation`} */
|
363
|
+
interface OnCreateOperation extends Macro.Database.Create {}
|
364
|
+
|
365
|
+
/** Options for {@link Macro._preUpdate | `Macro#_preUpdate`} */
|
366
|
+
interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}
|
367
|
+
|
368
|
+
/** Options for {@link Macro._onUpdate | `Macro#_onUpdate`} */
|
369
|
+
interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}
|
370
|
+
|
371
|
+
/** Operation for {@link Macro._preUpdateOperation | `Macro._preUpdateOperation`} */
|
372
|
+
interface PreUpdateOperation extends Macro.Database.Update {}
|
373
|
+
|
374
|
+
/** Operation for {@link Macro._onUpdateOperation | `Macro._preUpdateOperation`} */
|
375
|
+
interface OnUpdateOperation extends Macro.Database.Update {}
|
376
|
+
|
377
|
+
/** Options for {@link Macro._preDelete | `Macro#_preDelete`} */
|
378
|
+
interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}
|
379
|
+
|
380
|
+
/** Options for {@link Macro._onDelete | `Macro#_onDelete`} */
|
381
|
+
interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}
|
382
|
+
|
383
|
+
/** Options for {@link Macro._preDeleteOperation | `Macro#_preDeleteOperation`} */
|
384
|
+
interface PreDeleteOperation extends Macro.Database.Delete {}
|
385
|
+
|
386
|
+
/** Options for {@link Macro._onDeleteOperation | `Macro#_onDeleteOperation`} */
|
387
|
+
interface OnDeleteOperation extends Macro.Database.Delete {}
|
388
|
+
|
389
|
+
/** Context for {@link Macro._onDeleteOperation | `Macro._onDeleteOperation`} */
|
390
|
+
interface OnDeleteDocumentsContext extends Document.ModificationContext<Macro.Parent> {}
|
391
|
+
|
392
|
+
/** Context for {@link Macro._onCreateDocuments | `Macro._onCreateDocuments`} */
|
393
|
+
interface OnCreateDocumentsContext extends Document.ModificationContext<Macro.Parent> {}
|
394
|
+
|
395
|
+
/** Context for {@link Macro._onUpdateDocuments | `Macro._onUpdateDocuments`} */
|
396
|
+
interface OnUpdateDocumentsContext extends Document.ModificationContext<Macro.Parent> {}
|
397
|
+
|
398
|
+
/**
|
399
|
+
* Options for {@link Macro._preCreateDescendantDocuments | `Macro#_preCreateDescendantDocuments`}
|
400
|
+
* and {@link Macro._onCreateDescendantDocuments | `Macro#_onCreateDescendantDocuments`}
|
401
|
+
*/
|
402
|
+
interface CreateOptions extends Document.Database.CreateOptions<Macro.Database.Create> {}
|
403
|
+
|
404
|
+
/**
|
405
|
+
* Options for {@link Macro._preUpdateDescendantDocuments | `Macro#_preUpdateDescendantDocuments`}
|
406
|
+
* and {@link Macro._onUpdateDescendantDocuments | `Macro#_onUpdateDescendantDocuments`}
|
407
|
+
*/
|
408
|
+
interface UpdateOptions extends Document.Database.UpdateOptions<Macro.Database.Update> {}
|
409
|
+
|
410
|
+
/**
|
411
|
+
* Options for {@link Macro._preDeleteDescendantDocuments | `Macro#_preDeleteDescendantDocuments`}
|
412
|
+
* and {@link Macro._onDeleteDescendantDocuments | `Macro#_onDeleteDescendantDocuments`}
|
413
|
+
*/
|
414
|
+
interface DeleteOptions extends Document.Database.DeleteOptions<Macro.Database.Delete> {}
|
415
|
+
}
|
416
|
+
|
417
|
+
/**
|
418
|
+
* The flags that are available for this document in the form `{ [scope: string]: { [key: string]: unknown } }`.
|
419
|
+
*/
|
420
|
+
interface Flags extends Document.ConfiguredFlagsForName<Name> {}
|
421
|
+
|
422
|
+
namespace Flags {
|
423
|
+
/**
|
424
|
+
* The valid scopes for the flags on this document e.g. `"core"` or `"dnd5e"`.
|
425
|
+
*/
|
426
|
+
type Scope = Document.FlagKeyOf<Flags>;
|
427
|
+
|
428
|
+
/**
|
429
|
+
* The valid keys for a certain scope for example if the scope is "core" then a valid key may be `"sheetLock"` or `"viewMode"`.
|
430
|
+
*/
|
431
|
+
type Key<Scope extends Flags.Scope> = Document.FlagKeyOf<Document.FlagGetKey<Flags, Scope>>;
|
432
|
+
|
433
|
+
/**
|
434
|
+
* Gets the type of a particular flag given a `Scope` and a `Key`.
|
435
|
+
*/
|
436
|
+
type Get<Scope extends Flags.Scope, Key extends Flags.Key<Scope>> = Document.GetFlag<Name, Scope, Key>;
|
437
|
+
}
|
438
|
+
|
439
|
+
/**
|
440
|
+
* @deprecated This type always required properties for both a `"script"` and a `"chat"` message
|
441
|
+
* even when necessary. It has been superceded by {@link ScriptScope | `ScriptScope`},
|
442
|
+
* {@link ChatScope | `ChatScope`}, and {@link UnknownScope | `UnknownScope`}
|
443
|
+
*/
|
444
|
+
type Scope = ScriptScope;
|
445
|
+
|
446
|
+
/** @internal */
|
447
|
+
interface _ScriptScope {
|
22
448
|
/** An Actor who is the protagonist of the executed action. */
|
23
|
-
actor: Actor;
|
449
|
+
actor: Actor.Implementation;
|
24
450
|
|
25
451
|
/** A Token which is the protagonist of the executed action. */
|
26
|
-
token: Token;
|
452
|
+
token: Token.Implementation;
|
27
453
|
|
28
454
|
/** An optional event passed to the executed macro. */
|
29
455
|
event: Event | RegionDocument.RegionEvent;
|
@@ -33,20 +459,68 @@ declare global {
|
|
33
459
|
*/
|
34
460
|
[arg: string]: unknown;
|
35
461
|
}
|
462
|
+
|
463
|
+
interface ScriptScope extends InexactPartial<_ScriptScope> {}
|
464
|
+
|
465
|
+
interface ChatScope {
|
466
|
+
speaker?: ChatMessage.SpeakerData | undefined;
|
467
|
+
}
|
468
|
+
|
469
|
+
interface UnknownScope extends ScriptScope, ChatScope {}
|
470
|
+
|
471
|
+
type ExecuteScope<SubType extends Macro.SubType> = SubType extends "chat" | "script"
|
472
|
+
? UnknownScope
|
473
|
+
: (SubType extends "script" ? ScriptScope : never) | (SubType extends "chat" ? ScriptScope : never);
|
474
|
+
|
475
|
+
// Note: If extra types ever get added this will need to be updated to account for them, even if
|
476
|
+
// just to return `undefined`.
|
477
|
+
type ExecuteReturn<SubType extends Macro.SubType> =
|
478
|
+
| (SubType extends "chat" ? Promise<ChatMessage.Implementation | void> : never)
|
479
|
+
| (SubType extends "script" ? Promise<unknown> | void : never);
|
480
|
+
|
481
|
+
/**
|
482
|
+
* @deprecated {@link Macro.Database | `Macro.DatabaseOperation`}
|
483
|
+
*/
|
484
|
+
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
485
|
+
interface DatabaseOperations extends Document.Database.Operations<Macro.Implementation> {}
|
486
|
+
|
487
|
+
/**
|
488
|
+
* @deprecated {@link Macro.SubType | `Macro.SubType`}
|
489
|
+
*/
|
490
|
+
type TypeNames = Macro.SubType;
|
491
|
+
|
492
|
+
/**
|
493
|
+
* @deprecated {@link Macro.CreateData | `Macro.CreateData`}
|
494
|
+
*/
|
495
|
+
interface ConstructorData extends Macro.CreateData {}
|
496
|
+
|
497
|
+
/**
|
498
|
+
* @deprecated {@link Macro.implementation | `Macro.ImplementationClass`}
|
499
|
+
*/
|
500
|
+
type ConfiguredClass = ImplementationClass;
|
501
|
+
|
502
|
+
/**
|
503
|
+
* @deprecated {@link Macro.Implementation | `Macro.Implementation`}
|
504
|
+
*/
|
505
|
+
type ConfiguredInstance = Implementation;
|
36
506
|
}
|
37
507
|
|
38
508
|
/**
|
39
509
|
* The client-side Macro document which extends the common BaseMacro model.
|
40
510
|
*
|
41
|
-
* @see {@link Macros} The world-level collection of Macro documents
|
42
|
-
* @see {@link MacroConfig} The Macro configuration application
|
511
|
+
* @see {@link Macros | `Macros`} The world-level collection of Macro documents
|
512
|
+
* @see {@link MacroConfig | `MacroConfig`} The Macro configuration application
|
43
513
|
*
|
44
514
|
* @param data - Initial data provided to construct the Macro document
|
45
515
|
*/
|
46
|
-
class Macro extends
|
47
|
-
|
48
|
-
|
49
|
-
|
516
|
+
class Macro<out SubType extends Macro.SubType = Macro.SubType> extends ClientDocumentMixin(
|
517
|
+
foundry.documents.BaseMacro,
|
518
|
+
)<SubType> {
|
519
|
+
/**
|
520
|
+
* @param data - Initial data from which to construct the `Macro`
|
521
|
+
* @param context - Construction context options
|
522
|
+
*/
|
523
|
+
constructor(...args: Macro.ConstructorArgs);
|
50
524
|
|
51
525
|
/**
|
52
526
|
* Is the current User the author of this macro?
|
@@ -68,19 +542,50 @@ declare global {
|
|
68
542
|
* @param user - The User to test.
|
69
543
|
* @returns Can this User execute this Macro?
|
70
544
|
*/
|
71
|
-
canUserExecute(user: User): boolean;
|
545
|
+
canUserExecute(user: User.Implementation): boolean;
|
72
546
|
|
73
547
|
/**
|
74
548
|
* Execute the Macro command.
|
75
549
|
* @param scope - Macro execution scope which is passed to script macros
|
76
|
-
* @returns A promising containing a created {@link ChatMessage} (or `undefined`) if a chat
|
550
|
+
* @returns A promising containing a created {@link ChatMessage | `ChatMessage`} (or `undefined`) if a chat
|
77
551
|
* macro or the return value if a script macro. A void return is possible if the user
|
78
552
|
* is not permitted to execute macros or a script macro execution fails.
|
79
553
|
*/
|
80
|
-
execute(scope?:
|
554
|
+
execute(scope?: Macro.ExecuteScope<SubType>): Macro.ExecuteReturn<SubType>;
|
81
555
|
|
82
556
|
#executeScript();
|
83
557
|
|
84
558
|
_onClickDocumentLink(event: MouseEvent): ReturnType<this["execute"]>;
|
559
|
+
|
560
|
+
/*
|
561
|
+
* After this point these are not really overridden methods.
|
562
|
+
* They are here because Foundry's documents are complex and have lots of edge cases.
|
563
|
+
* There are DRY ways of representing this but this ends up being harder to understand
|
564
|
+
* for end users extending these functions, especially for static methods. There are also a
|
565
|
+
* number of methods that don't make sense to call directly on `Document` like `createDocuments`,
|
566
|
+
* as there is no data that can safely construct every possible document. Finally keeping definitions
|
567
|
+
* separate like this helps against circularities.
|
568
|
+
*/
|
569
|
+
|
570
|
+
// ClientDocument overrides
|
571
|
+
|
572
|
+
// Descendant Document operations have been left out because Macro does not have any descendant documents.
|
573
|
+
|
574
|
+
static override defaultName(context?: Document.DefaultNameContext<Macro.SubType, Macro.Parent>): string;
|
575
|
+
|
576
|
+
static override createDialog(
|
577
|
+
data?: Macro.CreateData,
|
578
|
+
context?: Document.CreateDialogContext<Macro.SubType, Macro.Parent>,
|
579
|
+
): Promise<Macro.Stored | null | undefined>;
|
580
|
+
|
581
|
+
static override fromDropData(
|
582
|
+
data: Document.DropData<Macro.Implementation>,
|
583
|
+
options?: Document.FromDropDataOptions,
|
584
|
+
): Promise<Macro.Implementation | undefined>;
|
585
|
+
|
586
|
+
static override fromImport(
|
587
|
+
source: Macro.Source,
|
588
|
+
context?: Document.FromImportContext<Macro.Parent>,
|
589
|
+
): Promise<Macro.Implementation>;
|
85
590
|
}
|
86
591
|
}
|