@league-of-foundry-developers/foundry-vtt-types 12.331.3-beta → 12.331.5
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 +17 -18
- package/package.json +91 -32
- package/src/configuration/configuration.d.mts +316 -0
- package/src/configuration/documents.d.mts +295 -0
- package/src/configuration/globals.d.mts +357 -0
- package/src/configuration/index.d.mts +5 -0
- package/src/foundry/client/apps/app.d.mts +129 -122
- package/src/foundry/client/apps/av/av-config.d.mts +12 -7
- package/src/foundry/client/apps/av/cameras.d.mts +12 -7
- package/src/foundry/client/apps/dice/dice-config.d.mts +59 -0
- package/src/foundry/client/apps/dice/index.d.mts +1 -0
- package/src/foundry/client/apps/form.d.mts +114 -86
- package/src/foundry/client/apps/forms/actor.d.mts +21 -11
- package/src/foundry/client/apps/forms/adventure-exporter.d.mts +12 -7
- package/src/foundry/client/apps/forms/adventure-importer.d.mts +14 -6
- package/src/foundry/client/apps/forms/base-sheet.d.mts +16 -8
- package/src/foundry/client/apps/forms/card-config.d.mts +16 -8
- package/src/foundry/client/apps/forms/cards-config.d.mts +15 -14
- package/src/foundry/client/apps/forms/combat-config.d.mts +7 -7
- package/src/foundry/client/apps/forms/combatant-config.d.mts +3 -3
- package/src/foundry/client/apps/forms/default-sheets-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/effect-config.d.mts +7 -7
- package/src/foundry/client/apps/forms/folder-config.d.mts +10 -5
- package/src/foundry/client/apps/forms/fonts.d.mts +42 -35
- package/src/foundry/client/apps/forms/grid-config.d.mts +12 -13
- package/src/foundry/client/apps/forms/image-popout.d.mts +29 -23
- package/src/foundry/client/apps/forms/item.d.mts +9 -9
- package/src/foundry/client/apps/forms/journal-page-sheet.d.mts +16 -14
- package/src/foundry/client/apps/forms/journal-sheet.d.mts +48 -38
- package/src/foundry/client/apps/forms/macro-config.d.mts +7 -7
- package/src/foundry/client/apps/forms/measure-template.d.mts +10 -12
- package/src/foundry/client/apps/forms/ownership.d.mts +5 -5
- package/src/foundry/client/apps/forms/playlist-config.d.mts +8 -10
- package/src/foundry/client/apps/forms/playlist-sound-config.d.mts +7 -7
- package/src/foundry/client/apps/forms/roll-table-config.d.mts +11 -10
- package/src/foundry/client/apps/forms/scene-config.d.mts +40 -41
- package/src/foundry/client/apps/forms/sheet-config.d.mts +9 -21
- package/src/foundry/client/apps/forms/user-config.d.mts +13 -12
- package/src/foundry/client/apps/hud/chatbubble.d.mts +18 -6
- package/src/foundry/client/apps/hud/container.d.mts +4 -4
- package/src/foundry/client/apps/hud/controls.d.mts +126 -81
- package/src/foundry/client/apps/hud/hotbar.d.mts +17 -12
- package/src/foundry/client/apps/hud/hud.d.mts +5 -5
- package/src/foundry/client/apps/hud/menu.d.mts +10 -3
- package/src/foundry/client/apps/hud/navigation.d.mts +14 -9
- package/src/foundry/client/apps/hud/pause.d.mts +9 -4
- package/src/foundry/client/apps/hud/players.d.mts +14 -9
- package/src/foundry/client/apps/i18n.d.mts +31 -27
- package/src/foundry/client/apps/index.d.mts +1 -0
- package/src/foundry/client/apps/placeables/drawing-config.d.mts +41 -33
- package/src/foundry/client/apps/placeables/drawing-hud.d.mts +5 -5
- package/src/foundry/client/apps/placeables/index.d.mts +0 -2
- package/src/foundry/client/apps/placeables/note-config.d.mts +28 -18
- package/src/foundry/client/apps/placeables/tile-config.d.mts +23 -10
- package/src/foundry/client/apps/placeables/tile-hud.d.mts +10 -5
- package/src/foundry/client/apps/placeables/token-config.d.mts +91 -58
- package/src/foundry/client/apps/placeables/token-hud.d.mts +12 -7
- package/src/foundry/client/apps/placeables/wall-config.d.mts +21 -17
- package/src/foundry/client/apps/sidebar/apps/chat-popout.d.mts +5 -5
- package/src/foundry/client/apps/sidebar/apps/client-settings.d.mts +3 -3
- package/src/foundry/client/apps/sidebar/apps/compendium.d.mts +15 -13
- package/src/foundry/client/apps/sidebar/apps/invitation-links.d.mts +3 -3
- package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts +3 -2
- 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 +34 -29
- package/src/foundry/client/apps/sidebar/apps/tours-management.d.mts +2 -2
- package/src/foundry/client/apps/sidebar/apps/world-config.d.mts +13 -10
- package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts +50 -35
- package/src/foundry/client/apps/sidebar/document-directory.d.mts +52 -38
- package/src/foundry/client/apps/sidebar/package-configuration.d.mts +4 -4
- package/src/foundry/client/apps/sidebar/sidebar-tab.d.mts +3 -3
- package/src/foundry/client/apps/sidebar/sidebar.d.mts +9 -4
- package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts +11 -2
- package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts +11 -2
- package/src/foundry/client/apps/sidebar/tabs/chat-log.d.mts +39 -27
- package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.mts +21 -12
- package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.mts +30 -15
- package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts +11 -2
- package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.mts +11 -2
- package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts +14 -5
- package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts +30 -22
- package/src/foundry/client/apps/sidebar/tabs/roll-table-directory.d.mts +11 -2
- package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts +14 -5
- package/src/foundry/client/apps/sidebar/tabs/settings.d.mts +23 -5
- package/src/foundry/client/apps/templates.d.mts +1 -1
- package/src/foundry/client/av/client.d.mts +1 -1
- package/src/foundry/client/av/clients/simplepeer.d.mts +11 -1
- package/src/foundry/client/av/master.d.mts +2 -2
- package/src/foundry/client/av/settings.d.mts +17 -15
- package/src/foundry/client/config.d.mts +444 -312
- package/src/foundry/client/core/document-index.d.mts +11 -3
- package/src/foundry/client/core/hooks.d.mts +2 -4
- package/src/foundry/client/core/image.d.mts +14 -13
- package/src/foundry/client/core/issues.d.mts +9 -4
- package/src/foundry/client/core/keybindings.d.mts +5 -5
- package/src/foundry/client/core/nue.d.mts +1 -1
- package/src/foundry/client/core/packages.d.mts +400 -62
- package/src/foundry/client/core/settings.d.mts +62 -38
- 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 +2 -2
- package/src/foundry/client/core/tour.d.mts +59 -50
- package/src/foundry/client/core/tours.d.mts +1 -1
- package/src/foundry/client/core/utils.d.mts +33 -10
- package/src/foundry/client/core/video.d.mts +1 -1
- package/src/foundry/client/core/workers.d.mts +24 -17
- package/src/foundry/client/data/abstract/canvas-document.d.mts +22 -28
- package/src/foundry/client/data/abstract/client-document.d.mts +238 -206
- package/src/foundry/client/data/abstract/directory-collection-mixin.d.mts +24 -40
- package/src/foundry/client/data/abstract/document-collection.d.mts +96 -68
- package/src/foundry/client/data/abstract/world-collection.d.mts +53 -54
- package/src/foundry/client/data/collections/actors.d.mts +30 -28
- package/src/foundry/client/data/collections/cards.d.mts +16 -3
- package/src/foundry/client/data/collections/combats.d.mts +18 -5
- package/src/foundry/client/data/collections/compendium-collection.d.mts +84 -101
- package/src/foundry/client/data/collections/compendium-folders.d.mts +6 -6
- package/src/foundry/client/data/collections/compendium-packs.d.mts +5 -5
- package/src/foundry/client/data/collections/fog.d.mts +16 -3
- package/src/foundry/client/data/collections/folder.d.mts +20 -6
- package/src/foundry/client/data/collections/items.d.mts +17 -4
- package/src/foundry/client/data/collections/journal.d.mts +22 -7
- package/src/foundry/client/data/collections/macros.d.mts +21 -19
- package/src/foundry/client/data/collections/messages.d.mts +19 -6
- package/src/foundry/client/data/collections/playlists.d.mts +17 -5
- package/src/foundry/client/data/collections/scenes.d.mts +24 -27
- package/src/foundry/client/data/collections/settings.d.mts +16 -3
- package/src/foundry/client/data/collections/tables.d.mts +18 -5
- package/src/foundry/client/data/collections/users.d.mts +22 -10
- package/src/foundry/client/data/documents/active-effect.d.mts +780 -112
- package/src/foundry/client/data/documents/actor-delta.d.mts +705 -31
- package/src/foundry/client/data/documents/actor.d.mts +806 -98
- package/src/foundry/client/data/documents/adventure.d.mts +522 -59
- package/src/foundry/client/data/documents/ambient-light.d.mts +427 -20
- package/src/foundry/client/data/documents/ambient-sound.d.mts +478 -14
- package/src/foundry/client/data/documents/card.d.mts +598 -44
- package/src/foundry/client/data/documents/cards.d.mts +862 -169
- package/src/foundry/client/data/documents/chat-message.d.mts +668 -77
- package/src/foundry/client/data/documents/combat.d.mts +757 -107
- package/src/foundry/client/data/documents/combatant.d.mts +545 -32
- package/src/foundry/client/data/documents/drawing.d.mts +545 -14
- package/src/foundry/client/data/documents/fog-exploration.d.mts +465 -30
- package/src/foundry/client/data/documents/folder.d.mts +567 -51
- package/src/foundry/client/data/documents/index.d.mts +2 -0
- package/src/foundry/client/data/documents/item.d.mts +691 -24
- package/src/foundry/client/data/documents/journal-entry-page.d.mts +654 -55
- package/src/foundry/client/data/documents/journal-entry.d.mts +631 -35
- package/src/foundry/client/data/documents/macro.d.mts +560 -31
- package/src/foundry/client/data/documents/measured-template.d.mts +484 -15
- package/src/foundry/client/data/documents/note.d.mts +498 -15
- package/src/foundry/client/data/documents/playlist-sound.d.mts +443 -45
- package/src/foundry/client/data/documents/playlist.d.mts +710 -99
- package/src/foundry/client/data/documents/region-behavior.d.mts +516 -0
- package/src/foundry/client/data/documents/region.d.mts +789 -0
- package/src/foundry/client/data/documents/scene.d.mts +1216 -159
- package/src/foundry/client/data/documents/setting.d.mts +406 -23
- package/src/foundry/client/data/documents/table-result.d.mts +488 -14
- package/src/foundry/client/data/documents/table.d.mts +667 -78
- package/src/foundry/client/data/documents/tile.d.mts +505 -14
- package/src/foundry/client/data/documents/token.d.mts +1191 -143
- package/src/foundry/client/data/documents/user.d.mts +613 -57
- package/src/foundry/client/data/documents/wall.d.mts +555 -14
- package/src/foundry/client/game.d.mts +60 -92
- package/src/foundry/client/head.d.mts +9 -9
- package/src/foundry/client/hooks.d.mts +259 -248
- package/src/foundry/client/pixi/board.d.mts +107 -94
- package/src/foundry/client/pixi/core/containers/base-canvas-group.d.mts +97 -25
- package/src/foundry/client/pixi/core/containers/cached-container.d.mts +37 -19
- package/src/foundry/client/pixi/core/containers/full-canvas-container.d.mts +7 -10
- package/src/foundry/client/pixi/core/containers/point-source-mesh.d.mts +25 -15
- package/src/foundry/client/pixi/core/containers/quad-mesh.d.mts +16 -6
- package/src/foundry/client/pixi/core/containers/quadtree.d.mts +113 -54
- package/src/foundry/client/pixi/core/containers/sprite-mesh.d.mts +69 -26
- package/src/foundry/client/pixi/core/containers/unbound-container.d.mts +20 -2
- package/src/foundry/client/pixi/core/interaction/canvas-animation.d.mts +164 -99
- package/src/foundry/client/pixi/core/interaction/control-icon.d.mts +61 -22
- package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts +120 -53
- package/src/foundry/client/pixi/core/interaction/ping.d.mts +62 -31
- package/src/foundry/client/pixi/core/interaction/pings/chevron.d.mts +23 -10
- package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts +91 -34
- package/src/foundry/client/pixi/core/interaction/render-flags.d.mts +69 -30
- package/src/foundry/client/pixi/core/interaction/resize-handle.d.mts +35 -5
- package/src/foundry/client/pixi/core/interaction/targets.d.mts +21 -18
- package/src/foundry/client/pixi/core/loader.d.mts +86 -76
- package/src/foundry/client/pixi/core/shapes/limited-angle-polygon.d.mts +42 -17
- package/src/foundry/client/pixi/core/shapes/polygon-mesher.d.mts +92 -64
- package/src/foundry/client/pixi/core/shapes/precise-text.d.mts +28 -10
- package/src/foundry/client/pixi/core/shapes/ray.d.mts +47 -23
- package/src/foundry/client/pixi/core/shapes/source-polygon.d.mts +170 -75
- package/src/foundry/client/pixi/extensions/circle.d.mts +128 -125
- package/src/foundry/client/pixi/extensions/graphics.d.mts +3 -1
- package/src/foundry/client/pixi/extensions/observable-transform.d.mts +5 -4
- package/src/foundry/client/pixi/extensions/polygon.d.mts +154 -134
- package/src/foundry/client/pixi/extensions/rectangle.d.mts +242 -259
- package/src/foundry/client/pixi/groups/effects.d.mts +75 -24
- package/src/foundry/client/pixi/groups/environment.d.mts +68 -19
- package/src/foundry/client/pixi/groups/hidden.d.mts +27 -11
- package/src/foundry/client/pixi/groups/interface.d.mts +62 -38
- package/src/foundry/client/pixi/groups/overlay.d.mts +19 -7
- package/src/foundry/client/pixi/groups/primary.d.mts +66 -44
- package/src/foundry/client/pixi/groups/rendered.d.mts +19 -7
- package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts +11 -15
- package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts +29 -28
- package/src/foundry/client/pixi/layers/base/placeables-layer.d.mts +306 -272
- package/src/foundry/client/pixi/layers/controls/cursor.d.mts +18 -9
- package/src/foundry/client/pixi/layers/controls/door.d.mts +32 -11
- package/src/foundry/client/pixi/layers/controls/layer.d.mts +89 -77
- package/src/foundry/client/pixi/layers/controls/ruler.d.mts +121 -96
- package/src/foundry/client/pixi/layers/effects/background-effects.d.mts +9 -12
- package/src/foundry/client/pixi/layers/effects/coloration-effects.d.mts +9 -10
- package/src/foundry/client/pixi/layers/effects/darkness-effects.d.mts +8 -8
- package/src/foundry/client/pixi/layers/effects/illumination-effects.d.mts +22 -22
- package/src/foundry/client/pixi/layers/effects/visibility.d.mts +106 -86
- package/src/foundry/client/pixi/layers/effects/weather/particles/effect.d.mts +14 -5
- 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 +137 -65
- package/src/foundry/client/pixi/layers/grid/highlight.d.mts +14 -4
- package/src/foundry/client/pixi/layers/grid/layer.d.mts +92 -92
- package/src/foundry/client/pixi/layers/grid/mesh.d.mts +37 -16
- package/src/foundry/client/pixi/layers/masks/depth.d.mts +12 -7
- package/src/foundry/client/pixi/layers/masks/occlusion.d.mts +19 -12
- package/src/foundry/client/pixi/layers/masks/vision.d.mts +104 -18
- package/src/foundry/client/pixi/layers/placeables/drawings.d.mts +16 -15
- package/src/foundry/client/pixi/layers/placeables/index.d.mts +1 -0
- package/src/foundry/client/pixi/layers/placeables/lighting.d.mts +12 -14
- package/src/foundry/client/pixi/layers/placeables/notes.d.mts +49 -32
- package/src/foundry/client/pixi/layers/placeables/regions.d.mts +113 -0
- package/src/foundry/client/pixi/layers/placeables/sounds.d.mts +81 -67
- package/src/foundry/client/pixi/layers/placeables/templates.d.mts +11 -15
- package/src/foundry/client/pixi/layers/placeables/tiles.d.mts +30 -21
- package/src/foundry/client/pixi/layers/placeables/tokens.d.mts +66 -52
- package/src/foundry/client/pixi/layers/placeables/walls.d.mts +54 -57
- package/src/foundry/client/pixi/perception/clockwise-sweep.d.mts +62 -27
- package/src/foundry/client/pixi/perception/detection-mode.d.mts +121 -47
- package/src/foundry/client/pixi/perception/fog.d.mts +38 -15
- package/src/foundry/client/pixi/perception/perception-manager.d.mts +136 -136
- package/src/foundry/client/pixi/perception/vision-mode.d.mts +91 -64
- package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts +44 -16
- package/src/foundry/client/pixi/placeable.d.mts +239 -137
- package/src/foundry/client/pixi/placeables/drawing.d.mts +255 -133
- package/src/foundry/client/pixi/placeables/index.d.mts +1 -0
- package/src/foundry/client/pixi/placeables/light.d.mts +193 -64
- package/src/foundry/client/pixi/placeables/note.d.mts +145 -54
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts +30 -8
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts +41 -11
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts +59 -18
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts +120 -37
- package/src/foundry/client/pixi/placeables/region.d.mts +280 -0
- package/src/foundry/client/pixi/placeables/sound.d.mts +205 -66
- package/src/foundry/client/pixi/placeables/template.d.mts +181 -100
- package/src/foundry/client/pixi/placeables/tile.d.mts +206 -140
- package/src/foundry/client/pixi/placeables/token.d.mts +916 -449
- package/src/foundry/client/pixi/placeables/wall.d.mts +249 -129
- package/src/foundry/client/pixi/webgl/extensions/batch-renderer.d.mts +72 -33
- package/src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/helpers/{framebugger-snapshot.d.mts → framebuffer-snapshot.d.mts} +10 -9
- package/src/foundry/client/pixi/webgl/helpers/index.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/helpers/smooth-noise.d.mts +38 -23
- package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts +82 -53
- package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts +12 -12
- package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts +45 -28
- package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts +12 -11
- package/src/foundry/client/pixi/webgl/shaders/filters/base-mask-filter.d.mts +12 -10
- package/src/foundry/client/pixi/webgl/shaders/filters/blur.d.mts +22 -20
- package/src/foundry/client/pixi/webgl/shaders/filters/effects-masking.d.mts +36 -32
- package/src/foundry/client/pixi/webgl/shaders/filters/environment.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/filters/glow-overlay.d.mts +12 -11
- package/src/foundry/client/pixi/webgl/shaders/filters/invisibility.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/filters/outline-overlay.d.mts +12 -11
- package/src/foundry/client/pixi/webgl/shaders/filters/transition.d.mts +67 -60
- package/src/foundry/client/pixi/webgl/shaders/filters/visibility.d.mts +24 -17
- package/src/foundry/client/pixi/webgl/shaders/filters/vision-mask-filter.d.mts +13 -10
- package/src/foundry/client/pixi/webgl/shaders/filters/void.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/filters/weather-occlusion-masks.d.mts +11 -10
- package/src/foundry/client/pixi/webgl/shaders/fragment-channel-mixin.d.mts +20 -14
- package/src/foundry/client/pixi/webgl/shaders/grid/grid.d.mts +12 -11
- package/src/foundry/client/pixi/webgl/shaders/lighting/background-lighting.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/base-lighting.d.mts +33 -33
- package/src/foundry/client/pixi/webgl/shaders/lighting/coloration-lighting.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/darkness-lighting.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/bewitching-wave.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/black-hole.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/chroma.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/emanation.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/energy-field.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fairy-light.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/flame.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fog.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/force-grid.d.mts +10 -8
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/ghost-light.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/hexa-dome.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/light-dome.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/magical-gloom.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/pulse.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/radial-rainbow.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/revolving-light.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/roiling-mass.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/siren-light.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/smoke-patch.d.mts +20 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/star-light.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/sunburst.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/swirling-rainbow.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/torch.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/vortex.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/wave.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/lighting/illumination-lighting.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/region/adjust-darkness-level.d.mts +71 -29
- package/src/foundry/client/pixi/webgl/shaders/region/base.d.mts +54 -10
- package/src/foundry/client/pixi/webgl/shaders/region/highlight.d.mts +69 -9
- package/src/foundry/client/pixi/webgl/shaders/samplers/base-sampler.d.mts +24 -25
- package/src/foundry/client/pixi/webgl/shaders/samplers/baseline-illumination.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/samplers/color-adjustment.d.mts +38 -29
- package/src/foundry/client/pixi/webgl/shaders/samplers/depth.d.mts +21 -17
- package/src/foundry/client/pixi/webgl/shaders/samplers/fog-of-war.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/samplers/occlusion.d.mts +20 -18
- package/src/foundry/client/pixi/webgl/shaders/samplers/primary.d.mts +11 -2
- package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts +28 -2
- package/src/foundry/client/pixi/webgl/shaders/vision/background-vision.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/vision/base-vision.d.mts +11 -9
- package/src/foundry/client/pixi/webgl/shaders/vision/coloration-vision.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/vision/effects/amplification.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/vision/effects/wave.d.mts +19 -17
- package/src/foundry/client/pixi/webgl/shaders/vision/illumination-vision.d.mts +10 -9
- package/src/foundry/client/pixi/webgl/shaders/weather/base-weather.d.mts +40 -36
- package/src/foundry/client/pixi/webgl/shaders/weather/effect.d.mts +27 -33
- package/src/foundry/client/pixi/webgl/shaders/weather/fog.d.mts +17 -16
- package/src/foundry/client/pixi/webgl/shaders/weather/rain.d.mts +19 -18
- package/src/foundry/client/pixi/webgl/shaders/weather/snow.d.mts +15 -14
- package/src/foundry/client/pixi/workers/texture-worker.d.mts +33 -53
- package/src/foundry/client/tours/setup-tour.d.mts +15 -10
- package/src/foundry/client/ui/context.d.mts +48 -40
- package/src/foundry/client/ui/dialog.d.mts +137 -126
- package/src/foundry/client/ui/drag.d.mts +1 -1
- package/src/foundry/client/ui/dragdrop.d.mts +34 -28
- package/src/foundry/client/ui/editor.d.mts +29 -21
- package/src/foundry/client/ui/filepicker.d.mts +43 -38
- package/src/foundry/client/ui/filter.d.mts +62 -50
- package/src/foundry/client/ui/forms.d.mts +22 -22
- package/src/foundry/client/ui/notifications.d.mts +10 -3
- package/src/foundry/client/ui/prosemirror.d.mts +15 -7
- package/src/foundry/client/ui/secrets.d.mts +42 -27
- package/src/foundry/client/ui/tabs.d.mts +40 -33
- package/src/foundry/client-esm/applications/_module.d.mts +3 -3
- package/src/foundry/client-esm/applications/_types.d.mts +0 -2
- package/src/foundry/client-esm/applications/api/_module.d.mts +2 -2
- package/src/foundry/client-esm/applications/api/application.d.mts +28 -19
- package/src/foundry/client-esm/applications/api/dialog.d.mts +20 -22
- package/src/foundry/client-esm/applications/api/document-sheet.d.mts +26 -12
- package/src/foundry/client-esm/applications/api/handlebars-application.d.mts +142 -126
- package/src/foundry/client-esm/applications/apps/_module.d.mts +2 -2
- package/src/foundry/client-esm/applications/apps/compendium-art-config.d.mts +10 -10
- package/src/foundry/client-esm/applications/apps/permission-config.d.mts +3 -3
- package/src/foundry/client-esm/applications/dice/_module.d.mts +2 -2
- package/src/foundry/client-esm/applications/dice/roll-resolver.d.mts +14 -2
- package/src/foundry/client-esm/applications/elements/_module.d.mts +2 -2
- package/src/foundry/client-esm/applications/elements/document-tags.d.mts +2 -0
- package/src/foundry/client-esm/applications/elements/file-picker.d.mts +1 -1
- package/src/foundry/client-esm/applications/elements/multi-select.d.mts +15 -5
- package/src/foundry/client-esm/applications/elements/string-tags.d.mts +1 -1
- package/src/foundry/client-esm/applications/forms/fields.d.mts +1 -1
- package/src/foundry/client-esm/applications/sheets/_module.d.mts +2 -2
- package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts +10 -8
- package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts +9 -7
- package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts +3 -3
- package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts +30 -5
- package/src/foundry/client-esm/applications/sheets/region-config.d.mts +36 -5
- package/src/foundry/client-esm/applications/sheets/user-config.d.mts +8 -7
- package/src/foundry/client-esm/applications/ui/_module.d.mts +2 -2
- package/src/foundry/client-esm/applications/ui/region-legend.d.mts +45 -3
- package/src/foundry/client-esm/audio/_module.d.mts +2 -3
- 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 +230 -126
- package/src/foundry/client-esm/audio/timeout.d.mts +28 -12
- package/src/foundry/client-esm/canvas/_module.d.mts +2 -2
- package/src/foundry/client-esm/canvas/edges/_module.d.mts +2 -2
- package/src/foundry/client-esm/canvas/edges/collision.d.mts +69 -18
- package/src/foundry/client-esm/canvas/edges/edge.d.mts +110 -41
- package/src/foundry/client-esm/canvas/edges/edges.d.mts +10 -0
- package/src/foundry/client-esm/canvas/edges/vertex.d.mts +56 -26
- package/src/foundry/client-esm/canvas/regions/_module.d.mts +6 -11
- package/src/foundry/client-esm/canvas/regions/geometry.d.mts +38 -0
- package/src/foundry/client-esm/canvas/regions/mesh.d.mts +72 -0
- package/src/foundry/client-esm/canvas/regions/polygon-tree.d.mts +130 -0
- package/src/foundry/client-esm/canvas/regions/shape.d.mts +129 -0
- package/src/foundry/client-esm/canvas/scene-manager.d.mts +13 -3
- 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 +121 -23
- package/src/foundry/client-esm/canvas/smaa/weights.d.mts +26 -3
- package/src/foundry/client-esm/canvas/sources/_module.d.mts +2 -2
- package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts +84 -40
- package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts +103 -39
- package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts +89 -15
- package/src/foundry/client-esm/canvas/sources/point-darkness-source.d.mts +71 -27
- package/src/foundry/client-esm/canvas/sources/point-effect-source.d.mts +49 -20
- package/src/foundry/client-esm/canvas/sources/point-light-source.d.mts +57 -16
- package/src/foundry/client-esm/canvas/sources/point-movement-source.d.mts +31 -4
- package/src/foundry/client-esm/canvas/sources/point-sound-source.d.mts +45 -12
- package/src/foundry/client-esm/canvas/sources/point-vision-source.d.mts +98 -52
- package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts +180 -69
- package/src/foundry/client-esm/canvas/tokens/_module.d.mts +2 -3
- package/src/foundry/client-esm/canvas/tokens/ring-config.d.mts +175 -2
- package/src/foundry/client-esm/canvas/tokens/ring-data.d.mts +142 -2
- package/src/foundry/client-esm/canvas/tokens/ring.d.mts +284 -2
- package/src/foundry/client-esm/client.d.mts +47 -54
- package/src/foundry/client-esm/data/_module.d.mts +2 -2
- package/src/foundry/client-esm/data/client-backend.d.mts +22 -23
- package/src/foundry/client-esm/data/region-behaviors/_module.d.mts +11 -14
- package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts +56 -0
- package/src/foundry/client-esm/data/region-behaviors/base.d.mts +59 -0
- package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts +64 -0
- package/src/foundry/client-esm/data/region-behaviors/execute-macro.d.mts +27 -0
- package/src/foundry/client-esm/data/region-behaviors/execute-script.d.mts +23 -0
- package/src/foundry/client-esm/data/region-behaviors/pause-game.d.mts +23 -0
- package/src/foundry/client-esm/data/region-behaviors/suppress-weather.d.mts +17 -0
- package/src/foundry/client-esm/data/region-behaviors/teleport-token.d.mts +32 -0
- package/src/foundry/client-esm/data/region-behaviors/toggle-behavior.d.mts +31 -0
- package/src/foundry/client-esm/dice/_module.d.mts +2 -3
- package/src/foundry/client-esm/dice/parser.d.mts +11 -25
- package/src/foundry/client-esm/dice/roll.d.mts +112 -89
- package/src/foundry/client-esm/dice/terms/_module.d.mts +2 -3
- package/src/foundry/client-esm/dice/terms/coin.d.mts +8 -5
- package/src/foundry/client-esm/dice/terms/dice.d.mts +93 -63
- package/src/foundry/client-esm/dice/terms/die.d.mts +11 -4
- package/src/foundry/client-esm/dice/terms/fate.d.mts +9 -2
- package/src/foundry/client-esm/dice/terms/function.d.mts +18 -18
- package/src/foundry/client-esm/dice/terms/numeric.d.mts +3 -5
- package/src/foundry/client-esm/dice/terms/operator.d.mts +2 -2
- package/src/foundry/client-esm/dice/terms/parenthetical.d.mts +9 -10
- package/src/foundry/client-esm/dice/terms/pool.d.mts +25 -31
- package/src/foundry/client-esm/dice/terms/string.d.mts +4 -4
- package/src/foundry/client-esm/dice/terms/term.d.mts +18 -4
- package/src/foundry/client-esm/dice/twister.d.mts +3 -3
- package/src/foundry/client-esm/helpers/_module.d.mts +2 -2
- package/src/foundry/client-esm/helpers/_types.d.mts +12 -46
- package/src/foundry/client-esm/helpers/compendium-art.d.mts +56 -4
- package/src/foundry/common/abstract/_types.d.mts +60 -54
- package/src/foundry/common/abstract/backend.d.mts +51 -45
- package/src/foundry/common/abstract/data.d.mts +265 -236
- package/src/foundry/common/abstract/document.d.mts +1449 -464
- package/src/foundry/common/abstract/embedded-collection-delta.d.mts +1 -1
- package/src/foundry/common/abstract/embedded-collection.d.mts +37 -7
- package/src/foundry/common/abstract/module.d.mts +3 -2
- package/src/foundry/common/abstract/singleton-collection.d.mts +1 -1
- package/src/foundry/common/abstract/socket.d.mts +1 -1
- package/src/foundry/common/abstract/type-data.d.mts +61 -55
- package/src/foundry/common/config.d.mts +11 -3
- package/src/foundry/common/constants.d.mts +261 -231
- package/src/foundry/common/data/data.d.mts +238 -102
- package/src/foundry/common/data/fields.d.mts +1334 -874
- package/src/foundry/common/data/module.d.mts +2 -2
- package/src/foundry/common/data/validation-failure.d.mts +12 -9
- package/src/foundry/common/documents/_module.d.mts +4 -2
- package/src/foundry/common/documents/_types.d.mts +22 -56
- package/src/foundry/common/documents/active-effect.d.mts +358 -194
- package/src/foundry/common/documents/actor-delta.d.mts +403 -73
- package/src/foundry/common/documents/actor.d.mts +359 -117
- package/src/foundry/common/documents/adventure.d.mts +312 -142
- package/src/foundry/common/documents/ambient-light.d.mts +296 -75
- package/src/foundry/common/documents/ambient-sound.d.mts +296 -109
- package/src/foundry/common/documents/card.d.mts +321 -187
- package/src/foundry/common/documents/cards.d.mts +353 -125
- package/src/foundry/common/documents/chat-message.d.mts +338 -167
- package/src/foundry/common/documents/combat.d.mts +358 -94
- package/src/foundry/common/documents/combatant.d.mts +323 -92
- package/src/foundry/common/documents/drawing.d.mts +327 -206
- package/src/foundry/common/documents/fog-exploration.d.mts +303 -69
- package/src/foundry/common/documents/folder.d.mts +307 -82
- package/src/foundry/common/documents/item.d.mts +377 -100
- package/src/foundry/common/documents/journal-entry-page.d.mts +327 -187
- package/src/foundry/common/documents/journal-entry.d.mts +345 -68
- package/src/foundry/common/documents/macro.d.mts +325 -139
- package/src/foundry/common/documents/measured-template.d.mts +328 -138
- package/src/foundry/common/documents/note.d.mts +312 -151
- package/src/foundry/common/documents/playlist-sound.d.mts +309 -102
- package/src/foundry/common/documents/playlist.d.mts +341 -131
- package/src/foundry/common/documents/region-behavior.d.mts +360 -0
- package/src/foundry/common/documents/region.d.mts +355 -0
- package/src/foundry/common/documents/roll-table.d.mts +320 -102
- package/src/foundry/common/documents/scene.d.mts +437 -350
- package/src/foundry/common/documents/setting.d.mts +285 -54
- package/src/foundry/common/documents/table-result.d.mts +326 -103
- package/src/foundry/common/documents/tile.d.mts +337 -172
- package/src/foundry/common/documents/token.d.mts +396 -447
- package/src/foundry/common/documents/user.d.mts +296 -173
- package/src/foundry/common/documents/wall.d.mts +303 -156
- package/src/foundry/common/grid/_module.d.mts +3 -3
- package/src/foundry/common/grid/base.d.mts +66 -49
- package/src/foundry/common/grid/gridless.d.mts +2 -2
- package/src/foundry/common/grid/hexagonal.d.mts +35 -28
- package/src/foundry/common/grid/square.d.mts +3 -3
- package/src/foundry/common/packages/base-module.d.mts +6 -24
- package/src/foundry/common/packages/base-package.d.mts +56 -31
- package/src/foundry/common/packages/base-system.d.mts +45 -63
- package/src/foundry/common/packages/base-world.d.mts +15 -61
- package/src/foundry/common/packages/module.d.mts +7 -7
- package/src/foundry/common/packages/sub-types.d.mts +4 -6
- package/src/foundry/common/primitives/array.d.mts +4 -4
- package/src/foundry/common/primitives/math.d.mts +7 -1
- package/src/foundry/common/primitives/number.d.mts +2 -2
- package/src/foundry/common/primitives/set.d.mts +17 -14
- package/src/foundry/common/primitives/string.d.mts +1 -1
- package/src/foundry/common/prosemirror/_module.d.mts +15 -15
- package/src/foundry/common/prosemirror/dirty-plugin.d.mts +1 -1
- package/src/foundry/common/prosemirror/dom-parser.d.mts +2 -1
- package/src/foundry/common/prosemirror/dropdown.d.mts +1 -1
- package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts +2 -2
- package/src/foundry/common/prosemirror/image-plugin.d.mts +1 -1
- package/src/foundry/common/prosemirror/menu.d.mts +3 -3
- package/src/foundry/common/prosemirror/paste-transformer.d.mts +1 -1
- package/src/foundry/common/prosemirror/plugin.d.mts +2 -2
- package/src/foundry/common/prosemirror/schema/index.d.mts +0 -1
- package/src/foundry/common/prosemirror/schema/lists.d.mts +2 -0
- package/src/foundry/common/prosemirror/util.d.mts +1 -1
- package/src/foundry/common/types.d.mts +3 -3
- package/src/foundry/common/utils/bitmask.d.mts +23 -11
- package/src/foundry/common/utils/collection.d.mts +61 -38
- package/src/foundry/common/utils/color.d.mts +20 -2
- package/src/foundry/common/utils/event-emitter.d.mts +32 -17
- package/src/foundry/common/utils/helpers.d.mts +36 -26
- package/src/foundry/common/utils/http.d.mts +2 -2
- package/src/foundry/common/utils/module.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/foundry/index.d.mts +0 -1
- package/src/foundry/{clipper → public/scripts/clipper}/clipper.d.mts +58 -16
- package/src/foundry/public/scripts/index.d.mts +1 -0
- package/src/foundry/public/scripts/workers/image-compressor.d.mts +23 -0
- package/src/foundry/public/scripts/workers/index.d.mts +1 -0
- package/{index-lenient.d.mts → src/index-lenient.d.mts} +2 -0
- package/src/index.d.mts +6 -0
- package/src/tsconfig.json +15 -0
- package/src/types/augments/particles.d.mts +29 -0
- package/src/types/augments/pixi.d.mts +1024 -21
- package/src/types/augments/smooth.d.mts +31 -0
- package/src/types/augments/tinyMCE.d.mts +1 -1
- package/src/types/config.d.mts +18 -313
- package/src/types/documentConfiguration.d.mts +286 -542
- package/src/types/index.d.mts +1 -1
- package/src/types/lib.d.mts +12 -0
- package/src/types/workers/image-compressor.d.mts +176 -0
- package/src/utils/index.d.mts +1279 -0
- package/tsconfig.json +29 -0
- package/tsconfig.main.json +8 -0
- package/tsconfig.miscellaneous.json +16 -0
- package/index.d.mts +0 -5
- package/src/foundry/client/apps/placeables/light-config.d.mts +0 -100
- package/src/foundry/client/apps/placeables/sound-config.d.mts +0 -43
- package/src/foundry/common/documents/module.d.mts +0 -35
- package/src/foundry/common/primitives/regex.d.mts +0 -12
- package/src/types/helperTypes.d.mts +0 -583
- package/src/types/utils.d.mts +0 -539
- /package/src/foundry/{clipper → public/scripts/clipper}/index.d.mts +0 -0
@@ -1,30 +1,571 @@
|
|
1
|
+
import type { AnyObject, Merge } from "#utils";
|
1
2
|
import type Document from "../../../common/abstract/document.d.mts";
|
2
|
-
import type {
|
3
|
-
import type
|
3
|
+
import type { DataSchema } from "../../../common/data/fields.d.mts";
|
4
|
+
import type { fields } from "../../../common/data/module.d.mts";
|
4
5
|
|
5
6
|
declare global {
|
6
7
|
namespace WallDocument {
|
7
|
-
|
8
|
+
/**
|
9
|
+
* The document's name.
|
10
|
+
*/
|
11
|
+
type Name = "Wall";
|
8
12
|
|
9
|
-
|
10
|
-
|
13
|
+
/**
|
14
|
+
* The arguments to construct the document.
|
15
|
+
*/
|
16
|
+
type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;
|
11
17
|
|
12
|
-
|
18
|
+
/**
|
19
|
+
* The documents embedded within `WallDocument`.
|
20
|
+
*/
|
21
|
+
type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;
|
13
22
|
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
type
|
23
|
+
/**
|
24
|
+
* The implementation of the `WallDocument` document instance configured through `CONFIG.Wall.documentClass` in Foundry and
|
25
|
+
* {@link DocumentClassConfig | `DocumentClassConfig`} or {@link ConfiguredWallDocument | `fvtt-types/configuration/ConfiguredWallDocument`} in fvtt-types.
|
26
|
+
*/
|
27
|
+
type Implementation = Document.ImplementationFor<Name>;
|
28
|
+
|
29
|
+
/**
|
30
|
+
* The implementation of the `WallDocument` document configured through `CONFIG.Wall.documentClass` in Foundry and
|
31
|
+
* {@link DocumentClassConfig | `DocumentClassConfig`} in fvtt-types.
|
32
|
+
*/
|
33
|
+
type ImplementationClass = Document.ImplementationClassFor<Name>;
|
34
|
+
|
35
|
+
/**
|
36
|
+
* A document's metadata is special information about the document ranging anywhere from its name,
|
37
|
+
* whether it's indexed, or to the permissions a user has over it.
|
38
|
+
*/
|
39
|
+
interface Metadata
|
40
|
+
extends Merge<
|
41
|
+
Document.Metadata.Default,
|
42
|
+
Readonly<{
|
43
|
+
name: "Wall";
|
44
|
+
collection: "walls";
|
45
|
+
label: string;
|
46
|
+
labelPlural: string;
|
47
|
+
permissions: Metadata.Permissions;
|
48
|
+
schemaVersion: string;
|
49
|
+
}>
|
50
|
+
> {}
|
51
|
+
|
52
|
+
namespace Metadata {
|
53
|
+
/**
|
54
|
+
* The permissions for whether a certain user can create, update, or delete this document.
|
55
|
+
*/
|
56
|
+
interface Permissions {
|
57
|
+
update(user: User.Internal.Implementation, doc: Implementation, data: UpdateData): boolean;
|
58
|
+
}
|
59
|
+
}
|
60
|
+
|
61
|
+
/**
|
62
|
+
* A document's parent is something that can contain it.
|
63
|
+
* For example an `Item` can be contained by an `Actor` which makes `Actor` one of its possible parents.
|
64
|
+
*/
|
65
|
+
type Parent = Scene.Implementation | null;
|
66
|
+
|
67
|
+
/**
|
68
|
+
* A document's descendants are any child documents, grandchild documents, etc.
|
69
|
+
* This is a union of all instances, or never if the document doesn't have any descendants.
|
70
|
+
*/
|
71
|
+
type Descendant = never;
|
72
|
+
|
73
|
+
/**
|
74
|
+
* A document's descendants are any child documents, grandchild documents, etc.
|
75
|
+
* This is a union of all classes, or never if the document doesn't have any descendants.
|
76
|
+
*/
|
77
|
+
type DescendantClass = never;
|
78
|
+
|
79
|
+
/**
|
80
|
+
* Types of `CompendiumCollection` this document might be contained in.
|
81
|
+
* Note that `this.pack` will always return a string; this is the type for `game.packs.get(this.pack)`
|
82
|
+
*/
|
83
|
+
// Note: Takes any document in the heritage chain (i.e. itself or any parent, transitive or not) that can be contained in a compendium.
|
84
|
+
type Pack = CompendiumCollection.ForDocument<"Scene">;
|
85
|
+
|
86
|
+
/**
|
87
|
+
* An embedded document is a document contained in another.
|
88
|
+
* For example an `Item` can be contained by an `Actor` which means `Item` can be embedded in `Actor`.
|
89
|
+
*
|
90
|
+
* If this is `never` it is because there are no embeddable documents (or there's a bug!).
|
91
|
+
*/
|
92
|
+
type Embedded = never;
|
93
|
+
|
94
|
+
/**
|
95
|
+
* The name of the world or embedded collection this document can find itself in.
|
96
|
+
* For example an `Item` is always going to be inside a collection with a key of `items`.
|
97
|
+
* This is a fixed string per document type and is primarily useful for {@link ClientDocumentMixin | `Descendant Document Events`}.
|
98
|
+
*/
|
99
|
+
type ParentCollectionName = Metadata["collection"];
|
100
|
+
|
101
|
+
/**
|
102
|
+
* The world collection that contains this document type. Will be `never` if none exists.
|
103
|
+
*/
|
104
|
+
type CollectionClass = never;
|
105
|
+
|
106
|
+
/**
|
107
|
+
* The world collection that contains this document type. Will be `never` if none exists.
|
108
|
+
*/
|
109
|
+
type Collection = never;
|
110
|
+
|
111
|
+
/**
|
112
|
+
* An instance of `WallDocument` that comes from the database but failed validation meaning that
|
113
|
+
* its `system` and `_source` could theoretically be anything.
|
114
|
+
*/
|
115
|
+
interface Invalid extends Document.Invalid<WallDocument.Implementation> {}
|
116
|
+
|
117
|
+
/**
|
118
|
+
* An instance of `WallDocument` that comes from the database.
|
119
|
+
*/
|
120
|
+
interface Stored extends Document.Stored<WallDocument.Implementation> {}
|
121
|
+
|
122
|
+
/**
|
123
|
+
* The data put in {@link foundry.abstract.DataModel._source | `DataModel#_source`}. This data is what was
|
124
|
+
* persisted to the database and therefore it must be valid JSON.
|
125
|
+
*
|
126
|
+
* For example a {@link fields.SetField | `SetField`} is persisted to the database as an array
|
127
|
+
* but initialized as a {@link Set | `Set`}.
|
128
|
+
*/
|
129
|
+
interface Source extends fields.SchemaField.SourceData<Schema> {}
|
130
|
+
|
131
|
+
/**
|
132
|
+
* @deprecated {@link WallDocument.Source | `WallDocument.Source`}
|
133
|
+
*/
|
134
|
+
type PersistedData = Source;
|
135
|
+
|
136
|
+
/**
|
137
|
+
* The data necessary to create a document. Used in places like {@link WallDocument.create | `WallDocument.create`}
|
138
|
+
* and {@link WallDocument | `new WallDocument(...)`}.
|
139
|
+
*
|
140
|
+
* For example a {@link fields.SetField | `SetField`} can accept any {@link Iterable | `Iterable`}
|
141
|
+
* with the right values. This means you can pass a `Set` instance, an array of values,
|
142
|
+
* a generator, or any other iterable.
|
143
|
+
*/
|
144
|
+
// TODO: ensure `c` is required for creation
|
145
|
+
interface CreateData extends fields.SchemaField.CreateData<Schema> {}
|
146
|
+
|
147
|
+
/**
|
148
|
+
* The data after a {@link foundry.abstract.Document | `Document`} has been initialized, for example
|
149
|
+
* {@link WallDocument.name | `WallDocument#name`}.
|
150
|
+
*
|
151
|
+
* This is data transformed from {@link WallDocument.Source | `WallDocument.Source`} and turned into more
|
152
|
+
* convenient runtime data structures. For example a {@link fields.SetField | `SetField`} is
|
153
|
+
* persisted to the database as an array of values but at runtime it is a `Set` instance.
|
154
|
+
*/
|
155
|
+
interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
|
156
|
+
|
157
|
+
/**
|
158
|
+
* The data used to update a document, for example {@link WallDocument.update | `WallDocument#update`}.
|
159
|
+
* It is a distinct type from {@link WallDocument.CreateData | `DeepPartial<WallDocument.CreateData>`} because
|
160
|
+
* it has different rules for `null` and `undefined`.
|
161
|
+
*/
|
162
|
+
interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
|
163
|
+
|
164
|
+
/**
|
165
|
+
* The wall coordinates, a length-4 array of finite numbers [x0,y0,x1,y1]
|
166
|
+
*/
|
167
|
+
type Coordinates = [x0: number, y0: number, x1: number, y1: number];
|
168
|
+
|
169
|
+
interface ThresholdSchema extends DataSchema {
|
170
|
+
/**
|
171
|
+
* Minimum distance from a light source for which this wall blocks light
|
172
|
+
*/
|
173
|
+
light: fields.NumberField<{ required: true; nullable: true; initial: null; positive: true }>;
|
174
|
+
|
175
|
+
/**
|
176
|
+
* Minimum distance from a vision source for which this wall blocks vision
|
177
|
+
*/
|
178
|
+
sight: fields.NumberField<{ required: true; nullable: true; initial: null; positive: true }>;
|
179
|
+
|
180
|
+
/**
|
181
|
+
* Minimum distance from a sound source for which this wall blocks sound
|
182
|
+
*/
|
183
|
+
sound: fields.NumberField<{ required: true; nullable: true; initial: null; positive: true }>;
|
184
|
+
|
185
|
+
/**
|
186
|
+
* Whether to attenuate the source radius when passing through the wall
|
187
|
+
*/
|
188
|
+
attenuation: fields.BooleanField;
|
189
|
+
}
|
190
|
+
|
191
|
+
/**
|
192
|
+
* The schema for {@link WallDocument | `WallDocument`}. This is the source of truth for how an WallDocument document
|
193
|
+
* must be structured.
|
194
|
+
*
|
195
|
+
* Foundry uses this schema to validate the structure of the {@link WallDocument | `WallDocument`}. For example
|
196
|
+
* a {@link fields.StringField | `StringField`} will enforce that the value is a string. More
|
197
|
+
* complex fields like {@link fields.SetField | `SetField`} goes through various conversions
|
198
|
+
* starting as an array in the database, initialized as a set, and allows updates with any
|
199
|
+
* iterable.
|
200
|
+
*/
|
201
|
+
interface Schema extends DataSchema {
|
202
|
+
/**
|
203
|
+
* The _id which uniquely identifies this BaseWall embedded document
|
204
|
+
* @defaultValue `null`
|
205
|
+
*/
|
206
|
+
_id: fields.DocumentIdField;
|
207
|
+
|
208
|
+
/**
|
209
|
+
* The wall coordinates, a length-4 array of finite numbers [x0,y0,x1,y1]
|
210
|
+
*/
|
211
|
+
c: fields.ArrayField<
|
212
|
+
fields.NumberField<{ required: true; integer: true; nullable: false }>,
|
213
|
+
{
|
214
|
+
validate: (c: unknown) => c is Coordinates;
|
215
|
+
validationError: "must be a length-4 array of integer coordinates";
|
216
|
+
},
|
217
|
+
// TODO(LukeAbby): Make the array shape easier to override.
|
218
|
+
fields.ArrayField.AssignmentElementType<fields.NumberField<{ required: true; integer: true; nullable: false }>>,
|
219
|
+
fields.ArrayField.InitializedElementType<
|
220
|
+
fields.NumberField<{ required: true; integer: true; nullable: false }>
|
221
|
+
>,
|
222
|
+
// FIXME: This field is `required` with no `initial`, so actually required for construction; Currently an AssignmentType override is required to enforce this
|
223
|
+
Coordinates,
|
224
|
+
Coordinates,
|
225
|
+
fields.ArrayField.PersistedElementType<fields.NumberField<{ required: true; integer: true; nullable: false }>>,
|
226
|
+
Coordinates
|
227
|
+
>;
|
228
|
+
|
229
|
+
/**
|
230
|
+
* The illumination restriction type of this wall
|
231
|
+
* @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL` (`20`)
|
232
|
+
*/
|
233
|
+
light: fields.NumberField<
|
234
|
+
{
|
235
|
+
required: true;
|
236
|
+
choices: CONST.WALL_SENSE_TYPES[];
|
237
|
+
initial: typeof CONST.WALL_SENSE_TYPES.NORMAL;
|
238
|
+
validationError: "must be a value in CONST.WALL_SENSE_TYPES";
|
239
|
+
},
|
240
|
+
// FIXME: Without these overrides, the branded type from `choices` is not respected, and the field types as `number`
|
241
|
+
CONST.WALL_SENSE_TYPES | null | undefined,
|
242
|
+
CONST.WALL_SENSE_TYPES | null,
|
243
|
+
CONST.WALL_SENSE_TYPES | null
|
244
|
+
>;
|
245
|
+
|
246
|
+
/**
|
247
|
+
* The movement restriction type of this wall
|
248
|
+
* @defaultValue `CONST.WALL_MOVEMENT_TYPES.NORMAL` (`20`)
|
249
|
+
*/
|
250
|
+
move: fields.NumberField<
|
251
|
+
{
|
252
|
+
required: true;
|
253
|
+
choices: CONST.WALL_MOVEMENT_TYPES[];
|
254
|
+
initial: typeof CONST.WALL_MOVEMENT_TYPES.NORMAL;
|
255
|
+
validationError: "must be a value in CONST.WALL_MOVEMENT_TYPES";
|
256
|
+
},
|
257
|
+
// FIXME: Without these overrides, the branded type from `choices` is not respected, and the field types as `number`
|
258
|
+
CONST.WALL_MOVEMENT_TYPES | null | undefined,
|
259
|
+
CONST.WALL_MOVEMENT_TYPES | null,
|
260
|
+
CONST.WALL_MOVEMENT_TYPES | null
|
261
|
+
>;
|
262
|
+
|
263
|
+
/**
|
264
|
+
* The visual restriction type of this wall
|
265
|
+
* @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL` (`20`)
|
266
|
+
*/
|
267
|
+
sight: fields.NumberField<
|
268
|
+
{
|
269
|
+
required: true;
|
270
|
+
choices: CONST.WALL_SENSE_TYPES[];
|
271
|
+
initial: typeof CONST.WALL_SENSE_TYPES.NORMAL;
|
272
|
+
validationError: "must be a value in CONST.WALL_SENSE_TYPES";
|
273
|
+
},
|
274
|
+
// FIXME: Without these overrides, the branded type from `choices` is not respected, and the field types as `number`
|
275
|
+
CONST.WALL_SENSE_TYPES | null | undefined,
|
276
|
+
CONST.WALL_SENSE_TYPES | null,
|
277
|
+
CONST.WALL_SENSE_TYPES | null
|
278
|
+
>;
|
279
|
+
|
280
|
+
/**
|
281
|
+
* The auditory restriction type of this wall
|
282
|
+
* @defaultValue `CONST.WALL_SENSE_TYPES.NORMAL` (`20`)
|
283
|
+
*/
|
284
|
+
sound: fields.NumberField<
|
285
|
+
{
|
286
|
+
required: true;
|
287
|
+
choices: CONST.WALL_SENSE_TYPES[];
|
288
|
+
initial: typeof CONST.WALL_SENSE_TYPES.NORMAL;
|
289
|
+
validationError: "must be a value in CONST.WALL_SENSE_TYPES";
|
290
|
+
},
|
291
|
+
// FIXME: Without these overrides, the branded type from `choices` is not respected, and the field types as `number`
|
292
|
+
CONST.WALL_SENSE_TYPES | null | undefined,
|
293
|
+
CONST.WALL_SENSE_TYPES | null,
|
294
|
+
CONST.WALL_SENSE_TYPES | null
|
295
|
+
>;
|
296
|
+
|
297
|
+
/**
|
298
|
+
* The direction of effect imposed by this wall
|
299
|
+
* @defaultValue `CONST.WALL_DIRECTIONS.BOTH`
|
300
|
+
*/
|
301
|
+
dir: fields.NumberField<
|
302
|
+
{
|
303
|
+
required: true;
|
304
|
+
choices: CONST.WALL_DIRECTIONS[];
|
305
|
+
initial: typeof CONST.WALL_DIRECTIONS.BOTH;
|
306
|
+
validationError: "must be a value in CONST.WALL_DIRECTIONS";
|
307
|
+
},
|
308
|
+
// FIXME: Without these overrides, the branded type from `choices` is not respected, and the field types as `number`
|
309
|
+
CONST.WALL_DIRECTIONS | null | undefined,
|
310
|
+
CONST.WALL_DIRECTIONS | null,
|
311
|
+
CONST.WALL_DIRECTIONS | null
|
312
|
+
>;
|
313
|
+
|
314
|
+
/**
|
315
|
+
* The type of door which this wall contains, if any
|
316
|
+
* @defaultValue `CONST.WALL_DOOR_TYPES.NONE`
|
317
|
+
*/
|
318
|
+
door: fields.NumberField<
|
319
|
+
{
|
320
|
+
required: true;
|
321
|
+
choices: CONST.WALL_DOOR_TYPES[];
|
322
|
+
initial: typeof CONST.WALL_DOOR_TYPES.NONE;
|
323
|
+
validationError: "must be a value in CONST.WALL_DOOR_TYPES";
|
324
|
+
},
|
325
|
+
// FIXME: Without these overrides, the branded type from `choices` is not respected, and the field types as `number`
|
326
|
+
CONST.WALL_DOOR_TYPES | null | undefined,
|
327
|
+
CONST.WALL_DOOR_TYPES | null,
|
328
|
+
CONST.WALL_DOOR_TYPES | null
|
329
|
+
>;
|
330
|
+
|
331
|
+
/**
|
332
|
+
* The state of the door this wall contains, if any
|
333
|
+
* @defaultValue `CONST.WALL_DOOR_STATES.CLOSED`
|
334
|
+
*/
|
335
|
+
ds: fields.NumberField<
|
336
|
+
{
|
337
|
+
required: true;
|
338
|
+
choices: CONST.WALL_DOOR_STATES[];
|
339
|
+
initial: typeof CONST.WALL_DOOR_STATES.CLOSED;
|
340
|
+
validationError: "must be a value in CONST.WALL_DOOR_STATES";
|
341
|
+
},
|
342
|
+
// FIXME: Without these overrides, the branded type from `choices` is not respected, and the field types as `number`
|
343
|
+
CONST.WALL_DOOR_STATES | null | undefined,
|
344
|
+
CONST.WALL_DOOR_STATES | null,
|
345
|
+
CONST.WALL_DOOR_STATES | null
|
346
|
+
>;
|
347
|
+
|
348
|
+
/**
|
349
|
+
* @remarks TThis isn't enforced by the field, but should be in `keyof CONFIG.Wall.doorSounds`
|
350
|
+
* @defaultValue `undefined`
|
351
|
+
*/
|
352
|
+
doorSound: fields.StringField<{ required: false; blank: true; initial: undefined }>;
|
353
|
+
|
354
|
+
/**
|
355
|
+
* Configuration of threshold data for this wall
|
356
|
+
* @defaultValue see properties
|
357
|
+
*/
|
358
|
+
threshold: fields.SchemaField<ThresholdSchema>;
|
359
|
+
|
360
|
+
/**
|
361
|
+
* An object of optional key/value flags
|
362
|
+
* @defaultValue `{}`
|
363
|
+
*/
|
364
|
+
flags: fields.ObjectField.FlagsField<Name>;
|
365
|
+
}
|
366
|
+
|
367
|
+
namespace Database {
|
368
|
+
/** Options passed along in Get operations for WallDocuments */
|
369
|
+
interface Get extends foundry.abstract.types.DatabaseGetOperation<WallDocument.Parent> {}
|
370
|
+
|
371
|
+
/** Options passed along in Create operations for WallDocuments */
|
372
|
+
interface Create<Temporary extends boolean | undefined = boolean | undefined>
|
373
|
+
extends foundry.abstract.types.DatabaseCreateOperation<
|
374
|
+
WallDocument.CreateData,
|
375
|
+
WallDocument.Parent,
|
376
|
+
Temporary
|
377
|
+
> {}
|
378
|
+
|
379
|
+
/** Options passed along in Delete operations for WallDocuments */
|
380
|
+
interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<WallDocument.Parent> {}
|
381
|
+
|
382
|
+
/** Options passed along in Update operations for WallDocuments */
|
383
|
+
interface Update
|
384
|
+
extends foundry.abstract.types.DatabaseUpdateOperation<WallDocument.UpdateData, WallDocument.Parent> {}
|
385
|
+
|
386
|
+
/** Operation for {@link WallDocument.createDocuments | `WallDocument.createDocuments`} */
|
387
|
+
interface CreateDocumentsOperation<Temporary extends boolean | undefined>
|
388
|
+
extends Document.Database.CreateOperation<WallDocument.Database.Create<Temporary>> {}
|
389
|
+
|
390
|
+
/** Operation for {@link WallDocument.updateDocuments | `WallDocument.updateDocuments`} */
|
391
|
+
interface UpdateDocumentsOperation
|
392
|
+
extends Document.Database.UpdateDocumentsOperation<WallDocument.Database.Update> {}
|
393
|
+
|
394
|
+
/** Operation for {@link WallDocument.deleteDocuments | `WallDocument.deleteDocuments`} */
|
395
|
+
interface DeleteDocumentsOperation
|
396
|
+
extends Document.Database.DeleteDocumentsOperation<WallDocument.Database.Delete> {}
|
397
|
+
|
398
|
+
/** Operation for {@link WallDocument.create | `WallDocument.create`} */
|
399
|
+
interface CreateOperation<Temporary extends boolean | undefined>
|
400
|
+
extends Document.Database.CreateOperation<WallDocument.Database.Create<Temporary>> {}
|
401
|
+
|
402
|
+
/** Operation for {@link WallDocument.update | `WallDocument#update`} */
|
403
|
+
interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}
|
404
|
+
|
405
|
+
interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}
|
406
|
+
|
407
|
+
/** Options for {@link WallDocument.get | `WallDocument.get`} */
|
408
|
+
interface GetOptions extends Document.Database.GetOptions {}
|
409
|
+
|
410
|
+
/** Options for {@link WallDocument._preCreate | `WallDocument#_preCreate`} */
|
411
|
+
interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}
|
412
|
+
|
413
|
+
/** Options for {@link WallDocument._onCreate | `WallDocument#_onCreate`} */
|
414
|
+
interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}
|
415
|
+
|
416
|
+
/** Operation for {@link WallDocument._preCreateOperation | `WallDocument._preCreateOperation`} */
|
417
|
+
interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<WallDocument.Database.Create> {}
|
418
|
+
|
419
|
+
/** Operation for {@link WallDocument._onCreateOperation | `WallDocument#_onCreateOperation`} */
|
420
|
+
interface OnCreateOperation extends WallDocument.Database.Create {}
|
421
|
+
|
422
|
+
/** Options for {@link WallDocument._preUpdate | `WallDocument#_preUpdate`} */
|
423
|
+
interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}
|
424
|
+
|
425
|
+
/** Options for {@link WallDocument._onUpdate | `WallDocument#_onUpdate`} */
|
426
|
+
interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}
|
427
|
+
|
428
|
+
/** Operation for {@link WallDocument._preUpdateOperation | `WallDocument._preUpdateOperation`} */
|
429
|
+
interface PreUpdateOperation extends WallDocument.Database.Update {}
|
430
|
+
|
431
|
+
/** Operation for {@link WallDocument._onUpdateOperation | `WallDocument._preUpdateOperation`} */
|
432
|
+
interface OnUpdateOperation extends WallDocument.Database.Update {}
|
433
|
+
|
434
|
+
/** Options for {@link WallDocument._preDelete | `WallDocument#_preDelete`} */
|
435
|
+
interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}
|
436
|
+
|
437
|
+
/** Options for {@link WallDocument._onDelete | `WallDocument#_onDelete`} */
|
438
|
+
interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}
|
439
|
+
|
440
|
+
/** Options for {@link WallDocument._preDeleteOperation | `WallDocument#_preDeleteOperation`} */
|
441
|
+
interface PreDeleteOperation extends WallDocument.Database.Delete {}
|
442
|
+
|
443
|
+
/** Options for {@link WallDocument._onDeleteOperation | `WallDocument#_onDeleteOperation`} */
|
444
|
+
interface OnDeleteOperation extends WallDocument.Database.Delete {}
|
445
|
+
|
446
|
+
/** Context for {@link WallDocument._onDeleteOperation | `WallDocument._onDeleteOperation`} */
|
447
|
+
interface OnDeleteDocumentsContext extends Document.ModificationContext<WallDocument.Parent> {}
|
448
|
+
|
449
|
+
/** Context for {@link WallDocument._onCreateDocuments | `WallDocument._onCreateDocuments`} */
|
450
|
+
interface OnCreateDocumentsContext extends Document.ModificationContext<WallDocument.Parent> {}
|
451
|
+
|
452
|
+
/** Context for {@link WallDocument._onUpdateDocuments | `WallDocument._onUpdateDocuments`} */
|
453
|
+
interface OnUpdateDocumentsContext extends Document.ModificationContext<WallDocument.Parent> {}
|
454
|
+
|
455
|
+
/**
|
456
|
+
* Options for {@link WallDocument._preCreateDescendantDocuments | `WallDocument#_preCreateDescendantDocuments`}
|
457
|
+
* and {@link WallDocument._onCreateDescendantDocuments | `WallDocument#_onCreateDescendantDocuments`}
|
458
|
+
*/
|
459
|
+
interface CreateOptions extends Document.Database.CreateOptions<WallDocument.Database.Create> {}
|
460
|
+
|
461
|
+
/**
|
462
|
+
* Options for {@link WallDocument._preUpdateDescendantDocuments | `WallDocument#_preUpdateDescendantDocuments`}
|
463
|
+
* and {@link WallDocument._onUpdateDescendantDocuments | `WallDocument#_onUpdateDescendantDocuments`}
|
464
|
+
*/
|
465
|
+
interface UpdateOptions extends Document.Database.UpdateOptions<WallDocument.Database.Update> {}
|
466
|
+
|
467
|
+
/**
|
468
|
+
* Options for {@link WallDocument._preDeleteDescendantDocuments | `WallDocument#_preDeleteDescendantDocuments`}
|
469
|
+
* and {@link WallDocument._onDeleteDescendantDocuments | `WallDocument#_onDeleteDescendantDocuments`}
|
470
|
+
*/
|
471
|
+
interface DeleteOptions extends Document.Database.DeleteOptions<WallDocument.Database.Delete> {}
|
472
|
+
}
|
473
|
+
|
474
|
+
/**
|
475
|
+
* The flags that are available for this document in the form `{ [scope: string]: { [key: string]: unknown } }`.
|
476
|
+
*/
|
477
|
+
interface Flags extends Document.ConfiguredFlagsForName<Name> {}
|
478
|
+
|
479
|
+
namespace Flags {
|
480
|
+
/**
|
481
|
+
* The valid scopes for the flags on this document e.g. `"core"` or `"dnd5e"`.
|
482
|
+
*/
|
483
|
+
type Scope = Document.FlagKeyOf<Flags>;
|
484
|
+
|
485
|
+
/**
|
486
|
+
* The valid keys for a certain scope for example if the scope is "core" then a valid key may be `"sheetLock"` or `"viewMode"`.
|
487
|
+
*/
|
488
|
+
type Key<Scope extends Flags.Scope> = Document.FlagKeyOf<Document.FlagGetKey<Flags, Scope>>;
|
489
|
+
|
490
|
+
/**
|
491
|
+
* Gets the type of a particular flag given a `Scope` and a `Key`.
|
492
|
+
*/
|
493
|
+
type Get<Scope extends Flags.Scope, Key extends Flags.Key<Scope>> = Document.GetFlag<Name, Scope, Key>;
|
494
|
+
}
|
495
|
+
|
496
|
+
/**
|
497
|
+
* @deprecated {@link WallDocument.Database | `WallDocument.DatabaseOperation`}
|
498
|
+
*/
|
499
|
+
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
500
|
+
interface DatabaseOperations extends Document.Database.Operations<WallDocument.Implementation> {}
|
501
|
+
|
502
|
+
/**
|
503
|
+
* @deprecated {@link WallDocument.CreateData | `WallDocument.CreateData`}
|
504
|
+
*/
|
505
|
+
interface ConstructorData extends WallDocument.CreateData {}
|
506
|
+
|
507
|
+
/**
|
508
|
+
* @deprecated {@link WallDocument.implementation | `WallDocument.ImplementationClass`}
|
509
|
+
*/
|
510
|
+
type ConfiguredClass = ImplementationClass;
|
511
|
+
|
512
|
+
/**
|
513
|
+
* @deprecated {@link WallDocument.Implementation | `WallDocument.Implementation`}
|
514
|
+
*/
|
515
|
+
type ConfiguredInstance = Implementation;
|
19
516
|
}
|
20
517
|
|
21
518
|
/**
|
22
519
|
* The client-side Wall document which extends the common BaseWall model.
|
23
520
|
*
|
24
|
-
* @see {@link Scene} The Scene document type which contains Wall embedded documents
|
25
|
-
* @see {@link WallConfig} The Wall configuration application
|
521
|
+
* @see {@link Scene | `Scene`} The Scene document type which contains Wall embedded documents
|
522
|
+
* @see {@link WallConfig | `WallConfig`} The Wall configuration application
|
26
523
|
*/
|
27
524
|
class WallDocument extends CanvasDocumentMixin(foundry.documents.BaseWall) {
|
28
|
-
|
525
|
+
/**
|
526
|
+
* @param data - Initial data from which to construct the `WallDocument`
|
527
|
+
* @param context - Construction context options
|
528
|
+
*/
|
529
|
+
constructor(...args: WallDocument.ConstructorArgs);
|
530
|
+
|
531
|
+
/*
|
532
|
+
* After this point these are not really overridden methods.
|
533
|
+
* They are here because Foundry's documents are complex and have lots of edge cases.
|
534
|
+
* There are DRY ways of representing this but this ends up being harder to understand
|
535
|
+
* for end users extending these functions, especially for static methods. There are also a
|
536
|
+
* number of methods that don't make sense to call directly on `Document` like `createDocuments`,
|
537
|
+
* as there is no data that can safely construct every possible document. Finally keeping definitions
|
538
|
+
* separate like this helps against circularities.
|
539
|
+
*/
|
540
|
+
|
541
|
+
// ClientDocument overrides
|
542
|
+
|
543
|
+
// Descendant Document operations have been left out because Wall does not have any descendant documents.
|
544
|
+
|
545
|
+
// context: not null (destructured)
|
546
|
+
static override defaultName(
|
547
|
+
context?: Document.DefaultNameContext<"Wall", NonNullable<WallDocument.Parent>>,
|
548
|
+
): string;
|
549
|
+
|
550
|
+
/** @remarks `context.parent` is required as creation requires one */
|
551
|
+
static override createDialog(
|
552
|
+
data: Document.CreateDialogData<WallDocument.CreateData> | undefined,
|
553
|
+
context: Document.CreateDialogContext<"Wall", NonNullable<WallDocument.Parent>>,
|
554
|
+
): Promise<WallDocument.Stored | null | undefined>;
|
555
|
+
|
556
|
+
// options: not null (parameter default only)
|
557
|
+
static override fromDropData(
|
558
|
+
data: Document.DropData<WallDocument.Implementation>,
|
559
|
+
options?: AnyObject,
|
560
|
+
): Promise<WallDocument.Implementation | undefined>;
|
561
|
+
|
562
|
+
static override fromImport(
|
563
|
+
source: WallDocument.Source,
|
564
|
+
context?: Document.FromImportContext<WallDocument.Parent> | null,
|
565
|
+
): Promise<WallDocument.Implementation>;
|
566
|
+
|
567
|
+
override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
|
568
|
+
|
569
|
+
// Embedded document operations have been left out because Wall does not have any embedded documents.
|
29
570
|
}
|
30
571
|
}
|