@league-of-foundry-developers/foundry-vtt-types 12.331.4-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/package.json +18 -1
- package/src/configuration/configuration.d.mts +1 -1
- package/src/foundry/client/apps/app.d.mts +1 -1
- package/src/foundry/client/apps/av/av-config.d.mts +1 -1
- package/src/foundry/client/apps/av/cameras.d.mts +1 -1
- package/src/foundry/client/apps/dice/dice-config.d.mts +1 -1
- package/src/foundry/client/apps/form.d.mts +1 -1
- package/src/foundry/client/apps/forms/actor.d.mts +1 -1
- package/src/foundry/client/apps/forms/adventure-exporter.d.mts +1 -1
- package/src/foundry/client/apps/forms/adventure-importer.d.mts +1 -1
- package/src/foundry/client/apps/forms/base-sheet.d.mts +1 -1
- package/src/foundry/client/apps/forms/card-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/cards-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/combat-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/effect-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/folder-config.d.mts +7 -2
- package/src/foundry/client/apps/forms/fonts.d.mts +1 -1
- package/src/foundry/client/apps/forms/grid-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/image-popout.d.mts +1 -1
- package/src/foundry/client/apps/forms/item.d.mts +1 -1
- package/src/foundry/client/apps/forms/journal-page-sheet.d.mts +1 -1
- package/src/foundry/client/apps/forms/journal-sheet.d.mts +1 -1
- package/src/foundry/client/apps/forms/macro-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/measure-template.d.mts +1 -1
- package/src/foundry/client/apps/forms/ownership.d.mts +1 -1
- package/src/foundry/client/apps/forms/playlist-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/playlist-sound-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/roll-table-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/scene-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/sheet-config.d.mts +1 -1
- package/src/foundry/client/apps/forms/user-config.d.mts +1 -1
- package/src/foundry/client/apps/hud/chatbubble.d.mts +1 -1
- package/src/foundry/client/apps/hud/container.d.mts +1 -1
- package/src/foundry/client/apps/hud/controls.d.mts +1 -1
- package/src/foundry/client/apps/hud/hotbar.d.mts +1 -1
- package/src/foundry/client/apps/hud/hud.d.mts +1 -1
- package/src/foundry/client/apps/hud/menu.d.mts +1 -1
- package/src/foundry/client/apps/hud/navigation.d.mts +1 -1
- package/src/foundry/client/apps/hud/pause.d.mts +1 -1
- package/src/foundry/client/apps/hud/players.d.mts +1 -1
- package/src/foundry/client/apps/placeables/drawing-config.d.mts +1 -1
- package/src/foundry/client/apps/placeables/drawing-hud.d.mts +1 -1
- package/src/foundry/client/apps/placeables/note-config.d.mts +1 -1
- package/src/foundry/client/apps/placeables/tile-config.d.mts +1 -1
- package/src/foundry/client/apps/placeables/tile-hud.d.mts +1 -1
- package/src/foundry/client/apps/placeables/token-config.d.mts +1 -1
- package/src/foundry/client/apps/placeables/token-hud.d.mts +1 -1
- package/src/foundry/client/apps/placeables/wall-config.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/apps/module-management.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/apps/support-details.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/apps/tours-management.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/apps/world-config.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/package-configuration.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/sidebar.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/chat-log.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/roll-table-directory.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts +1 -1
- package/src/foundry/client/apps/sidebar/tabs/settings.d.mts +1 -1
- package/src/foundry/client/av/client.d.mts +1 -1
- package/src/foundry/client/av/clients/simplepeer.d.mts +1 -1
- package/src/foundry/client/av/master.d.mts +1 -1
- package/src/foundry/client/av/settings.d.mts +1 -1
- package/src/foundry/client/config.d.mts +1 -1
- package/src/foundry/client/core/hooks.d.mts +1 -1
- package/src/foundry/client/core/image.d.mts +1 -1
- package/src/foundry/client/core/keybindings.d.mts +1 -1
- package/src/foundry/client/core/packages.d.mts +4 -2
- package/src/foundry/client/core/settings.d.mts +1 -1
- package/src/foundry/client/core/socket.d.mts +1 -1
- package/src/foundry/client/core/tooltip.d.mts +1 -1
- package/src/foundry/client/core/tour.d.mts +1 -1
- package/src/foundry/client/core/utils.d.mts +1 -1
- package/src/foundry/client/core/workers.d.mts +1 -1
- package/src/foundry/client/data/abstract/canvas-document.d.mts +9 -20
- package/src/foundry/client/data/abstract/client-document.d.mts +133 -71
- package/src/foundry/client/data/abstract/directory-collection-mixin.d.mts +2 -2
- package/src/foundry/client/data/abstract/document-collection.d.mts +1 -1
- package/src/foundry/client/data/abstract/world-collection.d.mts +8 -1
- package/src/foundry/client/data/collections/actors.d.mts +1 -1
- package/src/foundry/client/data/collections/cards.d.mts +1 -1
- package/src/foundry/client/data/collections/combats.d.mts +1 -1
- package/src/foundry/client/data/collections/compendium-collection.d.mts +5 -4
- package/src/foundry/client/data/collections/fog.d.mts +1 -1
- package/src/foundry/client/data/collections/folder.d.mts +1 -1
- package/src/foundry/client/data/collections/items.d.mts +1 -1
- package/src/foundry/client/data/collections/journal.d.mts +1 -1
- package/src/foundry/client/data/collections/macros.d.mts +1 -1
- package/src/foundry/client/data/collections/messages.d.mts +1 -1
- package/src/foundry/client/data/collections/playlists.d.mts +1 -1
- package/src/foundry/client/data/collections/scenes.d.mts +1 -1
- package/src/foundry/client/data/collections/settings.d.mts +1 -1
- package/src/foundry/client/data/collections/tables.d.mts +1 -1
- package/src/foundry/client/data/collections/users.d.mts +4 -4
- package/src/foundry/client/data/documents/active-effect.d.mts +124 -48
- package/src/foundry/client/data/documents/actor-delta.d.mts +53 -22
- package/src/foundry/client/data/documents/actor.d.mts +147 -93
- package/src/foundry/client/data/documents/adventure.d.mts +74 -45
- package/src/foundry/client/data/documents/ambient-light.d.mts +13 -10
- package/src/foundry/client/data/documents/ambient-sound.d.mts +12 -7
- package/src/foundry/client/data/documents/card.d.mts +57 -34
- package/src/foundry/client/data/documents/cards.d.mts +171 -135
- package/src/foundry/client/data/documents/chat-message.d.mts +131 -72
- package/src/foundry/client/data/documents/combat.d.mts +80 -60
- package/src/foundry/client/data/documents/combatant.d.mts +53 -20
- package/src/foundry/client/data/documents/drawing.d.mts +12 -7
- package/src/foundry/client/data/documents/fog-exploration.d.mts +57 -17
- package/src/foundry/client/data/documents/folder.d.mts +114 -31
- package/src/foundry/client/data/documents/item.d.mts +31 -21
- package/src/foundry/client/data/documents/journal-entry-page.d.mts +90 -57
- package/src/foundry/client/data/documents/journal-entry.d.mts +29 -34
- package/src/foundry/client/data/documents/macro.d.mts +60 -34
- package/src/foundry/client/data/documents/measured-template.d.mts +13 -8
- package/src/foundry/client/data/documents/note.d.mts +14 -7
- package/src/foundry/client/data/documents/playlist-sound.d.mts +29 -33
- package/src/foundry/client/data/documents/playlist.d.mts +74 -54
- package/src/foundry/client/data/documents/region-behavior.d.mts +16 -7
- package/src/foundry/client/data/documents/region.d.mts +53 -48
- package/src/foundry/client/data/documents/scene.d.mts +310 -89
- package/src/foundry/client/data/documents/setting.d.mts +24 -23
- package/src/foundry/client/data/documents/table-result.d.mts +20 -8
- package/src/foundry/client/data/documents/table.d.mts +19 -13
- package/src/foundry/client/data/documents/tile.d.mts +13 -7
- package/src/foundry/client/data/documents/token.d.mts +148 -117
- package/src/foundry/client/data/documents/user.d.mts +141 -53
- package/src/foundry/client/data/documents/wall.d.mts +17 -10
- package/src/foundry/client/game.d.mts +1 -1
- package/src/foundry/client/head.d.mts +1 -1
- package/src/foundry/client/hooks.d.mts +9 -18
- package/src/foundry/client/pixi/board.d.mts +3 -2
- package/src/foundry/client/pixi/core/containers/base-canvas-group.d.mts +1 -1
- package/src/foundry/client/pixi/core/containers/cached-container.d.mts +1 -1
- package/src/foundry/client/pixi/core/containers/full-canvas-container.d.mts +1 -1
- package/src/foundry/client/pixi/core/containers/point-source-mesh.d.mts +1 -1
- package/src/foundry/client/pixi/core/containers/quad-mesh.d.mts +1 -1
- package/src/foundry/client/pixi/core/containers/quadtree.d.mts +1 -1
- package/src/foundry/client/pixi/core/containers/sprite-mesh.d.mts +1 -1
- package/src/foundry/client/pixi/core/containers/unbound-container.d.mts +1 -1
- package/src/foundry/client/pixi/core/interaction/canvas-animation.d.mts +1 -1
- package/src/foundry/client/pixi/core/interaction/control-icon.d.mts +1 -1
- package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts +1 -1
- package/src/foundry/client/pixi/core/interaction/ping.d.mts +1 -1
- package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts +1 -1
- package/src/foundry/client/pixi/core/interaction/render-flags.d.mts +1 -8
- package/src/foundry/client/pixi/core/interaction/resize-handle.d.mts +1 -1
- package/src/foundry/client/pixi/core/interaction/targets.d.mts +1 -1
- package/src/foundry/client/pixi/core/loader.d.mts +1 -1
- package/src/foundry/client/pixi/core/shapes/limited-angle-polygon.d.mts +1 -1
- package/src/foundry/client/pixi/core/shapes/polygon-mesher.d.mts +1 -1
- package/src/foundry/client/pixi/core/shapes/precise-text.d.mts +1 -1
- package/src/foundry/client/pixi/core/shapes/ray.d.mts +1 -1
- package/src/foundry/client/pixi/core/shapes/source-polygon.d.mts +1 -1
- package/src/foundry/client/pixi/extensions/circle.d.mts +1 -1
- package/src/foundry/client/pixi/extensions/observable-transform.d.mts +1 -1
- package/src/foundry/client/pixi/extensions/polygon.d.mts +1 -1
- package/src/foundry/client/pixi/extensions/rectangle.d.mts +1 -1
- package/src/foundry/client/pixi/groups/effects.d.mts +1 -1
- package/src/foundry/client/pixi/groups/environment.d.mts +1 -1
- package/src/foundry/client/pixi/groups/hidden.d.mts +1 -1
- package/src/foundry/client/pixi/groups/interface.d.mts +1 -1
- package/src/foundry/client/pixi/groups/overlay.d.mts +1 -1
- package/src/foundry/client/pixi/groups/primary.d.mts +1 -1
- package/src/foundry/client/pixi/groups/rendered.d.mts +1 -1
- package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts +1 -1
- package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts +1 -1
- package/src/foundry/client/pixi/layers/base/placeables-layer.d.mts +1 -1
- package/src/foundry/client/pixi/layers/controls/cursor.d.mts +1 -1
- package/src/foundry/client/pixi/layers/controls/door.d.mts +1 -1
- package/src/foundry/client/pixi/layers/controls/layer.d.mts +1 -1
- package/src/foundry/client/pixi/layers/controls/ruler.d.mts +1 -1
- package/src/foundry/client/pixi/layers/effects/background-effects.d.mts +1 -1
- package/src/foundry/client/pixi/layers/effects/coloration-effects.d.mts +1 -1
- package/src/foundry/client/pixi/layers/effects/darkness-effects.d.mts +1 -1
- package/src/foundry/client/pixi/layers/effects/illumination-effects.d.mts +1 -1
- package/src/foundry/client/pixi/layers/effects/visibility.d.mts +1 -1
- package/src/foundry/client/pixi/layers/effects/weather/particles/effect.d.mts +1 -1
- package/src/foundry/client/pixi/layers/effects/weather/particles/leaves.d.mts +1 -1
- package/src/foundry/client/pixi/layers/effects/weather-effects.d.mts +1 -1
- package/src/foundry/client/pixi/layers/grid/highlight.d.mts +1 -1
- package/src/foundry/client/pixi/layers/grid/layer.d.mts +1 -1
- package/src/foundry/client/pixi/layers/grid/mesh.d.mts +1 -1
- package/src/foundry/client/pixi/layers/masks/depth.d.mts +1 -1
- package/src/foundry/client/pixi/layers/masks/occlusion.d.mts +1 -1
- package/src/foundry/client/pixi/layers/masks/vision.d.mts +1 -1
- package/src/foundry/client/pixi/layers/placeables/drawings.d.mts +1 -1
- package/src/foundry/client/pixi/layers/placeables/lighting.d.mts +1 -1
- package/src/foundry/client/pixi/layers/placeables/notes.d.mts +1 -1
- package/src/foundry/client/pixi/layers/placeables/regions.d.mts +1 -1
- package/src/foundry/client/pixi/layers/placeables/sounds.d.mts +1 -1
- package/src/foundry/client/pixi/layers/placeables/templates.d.mts +1 -1
- package/src/foundry/client/pixi/layers/placeables/tiles.d.mts +1 -1
- package/src/foundry/client/pixi/layers/placeables/tokens.d.mts +1 -1
- package/src/foundry/client/pixi/layers/placeables/walls.d.mts +1 -1
- package/src/foundry/client/pixi/perception/clockwise-sweep.d.mts +1 -1
- package/src/foundry/client/pixi/perception/detection-mode.d.mts +1 -1
- package/src/foundry/client/pixi/perception/fog.d.mts +1 -1
- package/src/foundry/client/pixi/perception/perception-manager.d.mts +1 -1
- package/src/foundry/client/pixi/perception/vision-mode.d.mts +1 -1
- package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts +1 -1
- package/src/foundry/client/pixi/placeable.d.mts +2 -1
- package/src/foundry/client/pixi/placeables/drawing.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/light.d.mts +1 -7
- package/src/foundry/client/pixi/placeables/note.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/region.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/sound.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/template.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/tile.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/token.d.mts +1 -1
- package/src/foundry/client/pixi/placeables/wall.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/extensions/batch-renderer.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/helpers/framebuffer-snapshot.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/helpers/smooth-noise.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/filters/effects-masking.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/filters/glow-overlay.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/filters/outline-overlay.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/filters/transition.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/filters/visibility.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/filters/vision-mask-filter.d.mts +1 -1
- 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 +1 -1
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fairy-light.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/samplers/base-sampler.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/weather/base-weather.d.mts +1 -1
- package/src/foundry/client/pixi/webgl/shaders/weather/effect.d.mts +1 -1
- package/src/foundry/client/pixi/workers/texture-worker.d.mts +1 -1
- package/src/foundry/client/ui/context.d.mts +1 -1
- package/src/foundry/client/ui/dialog.d.mts +1 -1
- package/src/foundry/client/ui/dragdrop.d.mts +1 -1
- package/src/foundry/client/ui/editor.d.mts +1 -1
- package/src/foundry/client/ui/filepicker.d.mts +1 -1
- package/src/foundry/client/ui/filter.d.mts +1 -1
- package/src/foundry/client-esm/applications/api/application.d.mts +1 -9
- package/src/foundry/client-esm/applications/api/dialog.d.mts +1 -1
- package/src/foundry/client-esm/applications/api/document-sheet.d.mts +1 -1
- package/src/foundry/client-esm/applications/api/handlebars-application.d.mts +1 -1
- package/src/foundry/client-esm/applications/apps/compendium-art-config.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 +1 -1
- package/src/foundry/client-esm/applications/forms/fields.d.mts +1 -1
- package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts +1 -1
- package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts +1 -1
- package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts +1 -1
- package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts +1 -1
- package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts +1 -1
- package/src/foundry/client-esm/applications/sheets/region-config.d.mts +1 -1
- package/src/foundry/client-esm/applications/sheets/user-config.d.mts +1 -1
- package/src/foundry/client-esm/applications/ui/region-legend.d.mts +1 -1
- package/src/foundry/client-esm/audio/biquad.d.mts +1 -1
- package/src/foundry/client-esm/audio/convolver.d.mts +1 -1
- package/src/foundry/client-esm/audio/helper.d.mts +1 -1
- package/src/foundry/client-esm/audio/sound.d.mts +2 -2
- package/src/foundry/client-esm/canvas/edges/collision.d.mts +1 -1
- package/src/foundry/client-esm/canvas/edges/edge.d.mts +1 -1
- package/src/foundry/client-esm/canvas/edges/vertex.d.mts +1 -1
- package/src/foundry/client-esm/canvas/scene-manager.d.mts +1 -1
- package/src/foundry/client-esm/canvas/smaa/smaa.d.mts +1 -1
- package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts +1 -1
- package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts +1 -1
- package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts +1 -1
- package/src/foundry/client-esm/canvas/sources/point-darkness-source.d.mts +1 -1
- package/src/foundry/client-esm/canvas/sources/point-effect-source.d.mts +1 -1
- package/src/foundry/client-esm/canvas/sources/point-light-source.d.mts +1 -1
- package/src/foundry/client-esm/canvas/sources/point-sound-source.d.mts +1 -1
- package/src/foundry/client-esm/canvas/sources/point-vision-source.d.mts +1 -1
- package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts +1 -1
- package/src/foundry/client-esm/canvas/tokens/ring-data.d.mts +3 -2
- package/src/foundry/client-esm/canvas/tokens/ring.d.mts +1 -1
- package/src/foundry/client-esm/data/client-backend.d.mts +1 -1
- package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts +4 -5
- package/src/foundry/client-esm/data/region-behaviors/base.d.mts +1 -1
- package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts +1 -1
- package/src/foundry/client-esm/data/region-behaviors/toggle-behavior.d.mts +4 -4
- package/src/foundry/client-esm/dice/roll.d.mts +5 -8
- package/src/foundry/client-esm/dice/terms/coin.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/dice.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/die.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/fate.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/function.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/numeric.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/operator.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/parenthetical.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/pool.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/string.d.mts +1 -1
- package/src/foundry/client-esm/dice/terms/term.d.mts +1 -1
- package/src/foundry/common/abstract/backend.d.mts +1 -1
- package/src/foundry/common/abstract/data.d.mts +197 -146
- package/src/foundry/common/abstract/document.d.mts +198 -81
- package/src/foundry/common/abstract/embedded-collection-delta.d.mts +1 -1
- package/src/foundry/common/abstract/embedded-collection.d.mts +1 -1
- package/src/foundry/common/abstract/socket.d.mts +1 -1
- package/src/foundry/common/abstract/type-data.d.mts +4 -1
- package/src/foundry/common/config.d.mts +7 -1
- package/src/foundry/common/constants.d.mts +1 -1
- package/src/foundry/common/data/data.d.mts +42 -12
- package/src/foundry/common/data/fields.d.mts +656 -252
- package/src/foundry/common/documents/_types.d.mts +0 -6
- package/src/foundry/common/documents/active-effect.d.mts +116 -53
- package/src/foundry/common/documents/actor-delta.d.mts +139 -58
- package/src/foundry/common/documents/actor.d.mts +105 -51
- package/src/foundry/common/documents/adventure.d.mts +84 -39
- package/src/foundry/common/documents/ambient-light.d.mts +66 -38
- package/src/foundry/common/documents/ambient-sound.d.mts +66 -38
- package/src/foundry/common/documents/card.d.mts +100 -59
- package/src/foundry/common/documents/cards.d.mts +97 -42
- package/src/foundry/common/documents/chat-message.d.mts +105 -52
- package/src/foundry/common/documents/combat.d.mts +101 -48
- package/src/foundry/common/documents/combatant.d.mts +94 -50
- package/src/foundry/common/documents/drawing.d.mts +87 -46
- package/src/foundry/common/documents/fog-exploration.d.mts +87 -41
- package/src/foundry/common/documents/folder.d.mts +100 -46
- package/src/foundry/common/documents/item.d.mts +116 -45
- package/src/foundry/common/documents/journal-entry-page.d.mts +90 -40
- package/src/foundry/common/documents/journal-entry.d.mts +90 -39
- package/src/foundry/common/documents/macro.d.mts +116 -52
- package/src/foundry/common/documents/measured-template.d.mts +80 -44
- package/src/foundry/common/documents/note.d.mts +75 -39
- package/src/foundry/common/documents/playlist-sound.d.mts +88 -47
- package/src/foundry/common/documents/playlist.d.mts +101 -50
- package/src/foundry/common/documents/region-behavior.d.mts +71 -40
- package/src/foundry/common/documents/region.d.mts +68 -40
- package/src/foundry/common/documents/roll-table.d.mts +43 -9
- package/src/foundry/common/documents/scene.d.mts +190 -43
- package/src/foundry/common/documents/setting.d.mts +98 -42
- package/src/foundry/common/documents/table-result.d.mts +98 -48
- package/src/foundry/common/documents/tile.d.mts +77 -43
- package/src/foundry/common/documents/token.d.mts +95 -52
- package/src/foundry/common/documents/user.d.mts +100 -89
- package/src/foundry/common/documents/wall.d.mts +47 -17
- package/src/foundry/common/grid/base.d.mts +1 -1
- package/src/foundry/common/grid/gridless.d.mts +1 -1
- package/src/foundry/common/grid/hexagonal.d.mts +1 -1
- package/src/foundry/common/grid/square.d.mts +1 -1
- package/src/foundry/common/packages/base-package.d.mts +37 -14
- package/src/foundry/common/packages/base-system.d.mts +39 -0
- package/src/foundry/common/packages/base-world.d.mts +8 -1
- package/src/foundry/common/packages/sub-types.d.mts +3 -5
- package/src/foundry/common/primitives/array.d.mts +1 -1
- package/src/foundry/common/primitives/string.d.mts +1 -1
- package/src/foundry/common/prosemirror/dirty-plugin.d.mts +1 -1
- package/src/foundry/common/prosemirror/dom-parser.d.mts +1 -1
- package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts +1 -1
- package/src/foundry/common/prosemirror/image-plugin.d.mts +1 -1
- package/src/foundry/common/prosemirror/paste-transformer.d.mts +1 -1
- package/src/foundry/common/prosemirror/plugin.d.mts +1 -1
- package/src/foundry/common/types.d.mts +1 -1
- package/src/foundry/common/utils/bitmask.d.mts +1 -1
- package/src/foundry/common/utils/collection.d.mts +1 -1
- package/src/foundry/common/utils/event-emitter.d.mts +1 -1
- package/src/foundry/common/utils/helpers.d.mts +1 -1
- package/src/foundry/public/scripts/clipper/clipper.d.mts +1 -1
- package/src/types/augments/particles.d.mts +1 -1
- package/src/types/augments/pixi.d.mts +1 -1
- package/src/types/augments/smooth.d.mts +1 -1
- package/src/types/augments/tinyMCE.d.mts +1 -1
- package/src/types/config.d.mts +2 -5
- package/src/types/documentConfiguration.d.mts +1 -1
- package/src/types/lib.d.mts +1 -1
- package/src/types/workers/image-compressor.d.mts +1 -1
@@ -1,10 +1,11 @@
|
|
1
|
-
import type { AnyMutableObject
|
1
|
+
import type { AnyMutableObject } from "#utils";
|
2
2
|
import type Document from "../abstract/document.mts";
|
3
3
|
import type { fields } from "../data/module.d.mts";
|
4
|
-
import type {
|
4
|
+
import type { documents } from "../../client-esm/client.d.mts";
|
5
5
|
import type { DataField, SchemaField } from "../data/fields.d.mts";
|
6
6
|
import type DataModel from "../abstract/data.d.mts";
|
7
7
|
import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
|
8
|
+
import type EmbeddedCollection from "../abstract/embedded-collection.d.mts";
|
8
9
|
|
9
10
|
/**
|
10
11
|
* The ActorDelta Document.
|
@@ -30,45 +31,80 @@ declare abstract class BaseActorDelta<
|
|
30
31
|
*/
|
31
32
|
constructor(...args: ActorDelta.ConstructorArgs);
|
32
33
|
|
34
|
+
/**
|
35
|
+
* @defaultValue
|
36
|
+
* ```js
|
37
|
+
* mergeObject(super.metadata, {
|
38
|
+
* name: "ActorDelta",
|
39
|
+
* collection: "delta",
|
40
|
+
* label: "DOCUMENT.ActorDelta",
|
41
|
+
* labelPlural: "DOCUMENT.ActorDeltas",
|
42
|
+
* isEmbedded: true,
|
43
|
+
* embedded: {
|
44
|
+
* Item: "items",
|
45
|
+
* ActiveEffect: "effects"
|
46
|
+
* },
|
47
|
+
* schemaVersion: "12.324"
|
48
|
+
* });
|
49
|
+
* ```
|
50
|
+
*/
|
33
51
|
static override metadata: BaseActorDelta.Metadata;
|
34
52
|
|
35
53
|
static override defineSchema(): BaseActorDelta.Schema;
|
36
54
|
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
55
|
+
/**
|
56
|
+
* @remarks Forwards to `this.parent.canUserModify`. Core's `TokenDocument` implementation doesn't override this method,
|
57
|
+
* so without further extension that's equivalent to {@link Document.canUserModify | `Document#canUserModify`}
|
58
|
+
*/
|
59
|
+
// data: not null (parameter default only)
|
60
|
+
override canUserModify<Action extends "create" | "update" | "delete">(
|
61
|
+
user: User.Implementation,
|
62
|
+
action: Action,
|
63
|
+
data?: Document.CanUserModifyData<TokenDocument.Schema, Action>,
|
41
64
|
): boolean;
|
42
65
|
|
66
|
+
/** @remarks Forwards to {@link TokenDocument.testUserPermission | `this.parent.testUserPermission`} */
|
67
|
+
// options: not null (destructured)
|
43
68
|
override testUserPermission(
|
44
|
-
user: User.
|
45
|
-
permission:
|
46
|
-
options?:
|
47
|
-
/**
|
48
|
-
* Require the exact permission level requested?
|
49
|
-
* @defaultValue `false`
|
50
|
-
*/
|
51
|
-
exact: boolean;
|
52
|
-
}>,
|
69
|
+
user: User.Implementation,
|
70
|
+
permission: Document.ActionPermission,
|
71
|
+
options?: Document.TestUserPermissionOptions,
|
53
72
|
): boolean;
|
54
73
|
|
55
74
|
/**
|
56
75
|
* Retrieve the base actor's collection, if it exists.
|
57
76
|
* @param collectionName - The collection name.
|
77
|
+
* @remarks Passes `collectionName` to the token's `baseActor`'s {@link Actor.getEmbeddedCollection | `#getEmbeddedCollection`}
|
58
78
|
*/
|
59
|
-
getBaseCollection
|
79
|
+
getBaseCollection<DocType extends Actor.Embedded.Name>(
|
80
|
+
collectionName: DocType,
|
81
|
+
): EmbeddedCollection<Document.ImplementationFor<DocType>, Actor.Implementation> | undefined;
|
60
82
|
|
83
|
+
/**
|
84
|
+
* Apply an ActorDelta to an Actor and return the resultant synthetic Actor.
|
85
|
+
* @param delta - The ActorDelta.
|
86
|
+
* @param baseActor - The base Actor.
|
87
|
+
* @param context - Context to supply to synthetic Actor instantiation.
|
88
|
+
* @remarks `context` is spread into an object, so it being `null` is effectively the same as omitted
|
89
|
+
*/
|
61
90
|
static applyDelta(
|
62
91
|
delta: BaseActorDelta,
|
63
92
|
baseActor: documents.BaseActor,
|
64
|
-
context
|
65
|
-
):
|
93
|
+
context?: BaseActorDelta.ApplyDeltaContext | null,
|
94
|
+
): Actor.Implementation | null;
|
66
95
|
|
96
|
+
/**
|
97
|
+
* @remarks
|
98
|
+
* Migrations:
|
99
|
+
* - {@link documents.BaseActor.migrateData | `BaseActor`}'s
|
100
|
+
*
|
101
|
+
* Simply forwards to `BaseActor`
|
102
|
+
*/
|
67
103
|
static migrateData(source: AnyMutableObject): AnyMutableObject;
|
68
104
|
|
69
|
-
|
70
|
-
|
71
|
-
toObject(source?: boolean):
|
105
|
+
/** @remarks Strips optional (`required: false`) fields from the object before returning */
|
106
|
+
// TODO: Properly type this override
|
107
|
+
override toObject(source?: boolean | null): SchemaField.SourceData<ActorDelta.Schema>;
|
72
108
|
|
73
109
|
/*
|
74
110
|
* After this point these are not really overridden methods.
|
@@ -87,39 +123,39 @@ declare abstract class BaseActorDelta<
|
|
87
123
|
// Same as Document for now
|
88
124
|
protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
|
89
125
|
|
90
|
-
readonly parentCollection: ActorDelta.ParentCollectionName | null;
|
126
|
+
override readonly parentCollection: ActorDelta.ParentCollectionName | null;
|
91
127
|
|
92
|
-
readonly pack: string | null;
|
128
|
+
override readonly pack: string | null;
|
93
129
|
|
94
130
|
static override get implementation(): ActorDelta.ImplementationClass;
|
95
131
|
|
96
|
-
static get baseDocument(): typeof BaseActorDelta;
|
132
|
+
static override get baseDocument(): typeof BaseActorDelta;
|
97
133
|
|
98
|
-
static get collectionName(): ActorDelta.ParentCollectionName;
|
134
|
+
static override get collectionName(): ActorDelta.ParentCollectionName;
|
99
135
|
|
100
|
-
static get documentName(): ActorDelta.Name;
|
136
|
+
static override get documentName(): ActorDelta.Name;
|
101
137
|
|
102
|
-
static get TYPES(): BaseActorDelta.SubType[];
|
138
|
+
static override get TYPES(): BaseActorDelta.SubType[];
|
103
139
|
|
104
|
-
static get hasTypeData(): true;
|
140
|
+
static override get hasTypeData(): true;
|
105
141
|
|
106
|
-
static get hierarchy(): ActorDelta.Hierarchy;
|
142
|
+
static override get hierarchy(): ActorDelta.Hierarchy;
|
107
143
|
|
108
144
|
override system: ActorDelta.SystemOfType<SubType>;
|
109
145
|
|
110
146
|
override parent: BaseActorDelta.Parent;
|
111
147
|
|
112
|
-
static createDocuments<Temporary extends boolean | undefined = false>(
|
148
|
+
static override createDocuments<Temporary extends boolean | undefined = false>(
|
113
149
|
data: Array<ActorDelta.Implementation | ActorDelta.CreateData> | undefined,
|
114
150
|
operation?: Document.Database.CreateOperation<ActorDelta.Database.Create<Temporary>>,
|
115
151
|
): Promise<Array<Document.TemporaryIf<ActorDelta.Implementation, Temporary>>>;
|
116
152
|
|
117
|
-
static updateDocuments(
|
153
|
+
static override updateDocuments(
|
118
154
|
updates: ActorDelta.UpdateData[] | undefined,
|
119
155
|
operation?: Document.Database.UpdateDocumentsOperation<ActorDelta.Database.Update>,
|
120
156
|
): Promise<ActorDelta.Implementation[]>;
|
121
157
|
|
122
|
-
static deleteDocuments(
|
158
|
+
static override deleteDocuments(
|
123
159
|
ids: readonly string[] | undefined,
|
124
160
|
operation?: Document.Database.DeleteDocumentsOperation<ActorDelta.Database.Delete>,
|
125
161
|
): Promise<ActorDelta.Implementation[]>;
|
@@ -192,121 +228,151 @@ declare abstract class BaseActorDelta<
|
|
192
228
|
key: Key,
|
193
229
|
): Promise<this>;
|
194
230
|
|
195
|
-
protected _preCreate(
|
231
|
+
protected override _preCreate(
|
196
232
|
data: ActorDelta.CreateData,
|
197
233
|
options: ActorDelta.Database.PreCreateOptions,
|
198
234
|
user: User.Implementation,
|
199
235
|
): Promise<boolean | void>;
|
200
236
|
|
201
|
-
protected _onCreate(
|
237
|
+
protected override _onCreate(
|
202
238
|
data: ActorDelta.CreateData,
|
203
239
|
options: ActorDelta.Database.OnCreateOperation,
|
204
240
|
userId: string,
|
205
241
|
): void;
|
206
242
|
|
207
|
-
protected static _preCreateOperation(
|
243
|
+
protected static override _preCreateOperation(
|
208
244
|
documents: ActorDelta.Implementation[],
|
209
245
|
operation: Document.Database.PreCreateOperationStatic<ActorDelta.Database.Create>,
|
210
246
|
user: User.Implementation,
|
211
247
|
): Promise<boolean | void>;
|
212
248
|
|
213
|
-
protected static _onCreateOperation(
|
249
|
+
protected static override _onCreateOperation(
|
214
250
|
documents: ActorDelta.Implementation[],
|
215
251
|
operation: ActorDelta.Database.Create,
|
216
252
|
user: User.Implementation,
|
217
253
|
): Promise<void>;
|
218
254
|
|
219
|
-
protected _preUpdate(
|
255
|
+
protected override _preUpdate(
|
220
256
|
changed: ActorDelta.UpdateData,
|
221
257
|
options: ActorDelta.Database.PreUpdateOptions,
|
222
258
|
user: User.Implementation,
|
223
259
|
): Promise<boolean | void>;
|
224
260
|
|
225
|
-
protected _onUpdate(
|
261
|
+
protected override _onUpdate(
|
226
262
|
changed: ActorDelta.UpdateData,
|
227
263
|
options: ActorDelta.Database.OnUpdateOperation,
|
228
264
|
userId: string,
|
229
265
|
): void;
|
230
266
|
|
231
|
-
protected static _preUpdateOperation(
|
267
|
+
protected static override _preUpdateOperation(
|
232
268
|
documents: ActorDelta.Implementation[],
|
233
269
|
operation: ActorDelta.Database.Update,
|
234
270
|
user: User.Implementation,
|
235
271
|
): Promise<boolean | void>;
|
236
272
|
|
237
|
-
protected static _onUpdateOperation(
|
273
|
+
protected static override _onUpdateOperation(
|
238
274
|
documents: ActorDelta.Implementation[],
|
239
275
|
operation: ActorDelta.Database.Update,
|
240
276
|
user: User.Implementation,
|
241
277
|
): Promise<void>;
|
242
278
|
|
243
|
-
protected _preDelete(
|
279
|
+
protected override _preDelete(
|
244
280
|
options: ActorDelta.Database.PreDeleteOptions,
|
245
281
|
user: User.Implementation,
|
246
282
|
): Promise<boolean | void>;
|
247
283
|
|
248
|
-
protected _onDelete(options: ActorDelta.Database.OnDeleteOperation, userId: string): void;
|
284
|
+
protected override _onDelete(options: ActorDelta.Database.OnDeleteOperation, userId: string): void;
|
249
285
|
|
250
|
-
protected static _preDeleteOperation(
|
286
|
+
protected static override _preDeleteOperation(
|
251
287
|
documents: ActorDelta.Implementation[],
|
252
288
|
operation: ActorDelta.Database.Delete,
|
253
289
|
user: User.Implementation,
|
254
290
|
): Promise<boolean | void>;
|
255
291
|
|
256
|
-
protected static _onDeleteOperation(
|
292
|
+
protected static override _onDeleteOperation(
|
257
293
|
documents: ActorDelta.Implementation[],
|
258
294
|
operation: ActorDelta.Database.Delete,
|
259
295
|
user: User.Implementation,
|
260
296
|
): Promise<void>;
|
261
297
|
|
262
|
-
static get hasSystemData(): true;
|
298
|
+
static override get hasSystemData(): true;
|
263
299
|
|
264
300
|
// These data field things have been ticketed but will probably go into backlog hell for a while.
|
265
301
|
// We'll end up copy and pasting without modification for now I think. It makes it a tiny bit easier to update though.
|
266
|
-
protected static _addDataFieldShims(data: AnyObject, shims: AnyObject, options?: Document.DataFieldShimOptions): void;
|
267
302
|
|
268
|
-
|
269
|
-
|
303
|
+
// options: not null (parameter default only in _addDataFieldShim)
|
304
|
+
protected static override _addDataFieldShims(
|
305
|
+
data: AnyMutableObject,
|
306
|
+
shims: Record<string, string>,
|
307
|
+
options?: Document.DataFieldShimOptions,
|
308
|
+
): void;
|
309
|
+
|
310
|
+
// options: not null (parameter default only)
|
311
|
+
protected static override _addDataFieldShim(
|
312
|
+
data: AnyMutableObject,
|
270
313
|
oldKey: string,
|
271
314
|
newKey: string,
|
272
|
-
|
273
|
-
):
|
315
|
+
options?: Document.DataFieldShimOptions,
|
316
|
+
): void;
|
274
317
|
|
275
|
-
protected static
|
318
|
+
protected static override _addDataFieldMigration(
|
319
|
+
data: AnyMutableObject,
|
320
|
+
oldKey: string,
|
321
|
+
newKey: string,
|
322
|
+
apply?: ((data: AnyMutableObject) => unknown) | null,
|
323
|
+
): boolean;
|
324
|
+
|
325
|
+
// options: not null (destructured where forwarded)
|
326
|
+
protected static override _logDataFieldMigration(
|
276
327
|
oldKey: string,
|
277
328
|
newKey: string,
|
278
329
|
options?: LogCompatibilityWarningOptions,
|
279
330
|
): void;
|
280
331
|
|
281
|
-
|
332
|
+
/**
|
333
|
+
* @deprecated since v12, will be removed in v14
|
334
|
+
* @remarks "The `Document._onCreateDocuments` static method is deprecated in favor of {@link Document._onCreateOperation | `Document._onCreateOperation`}"
|
335
|
+
*/
|
336
|
+
protected static override _onCreateDocuments(
|
282
337
|
documents: ActorDelta.Implementation[],
|
283
338
|
context: Document.ModificationContext<ActorDelta.Parent>,
|
284
339
|
): Promise<void>;
|
285
340
|
|
286
|
-
|
341
|
+
/**
|
342
|
+
* @deprecated since v12, will be removed in v14
|
343
|
+
* @remarks "The `Document._onUpdateDocuments` static method is deprecated in favor of {@link Document._onUpdateOperation | `Document._onUpdateOperation`}"
|
344
|
+
*/
|
345
|
+
protected static override _onUpdateDocuments(
|
287
346
|
documents: ActorDelta.Implementation[],
|
288
347
|
context: Document.ModificationContext<ActorDelta.Parent>,
|
289
348
|
): Promise<void>;
|
290
349
|
|
291
|
-
|
350
|
+
/**
|
351
|
+
* @deprecated since v12, will be removed in v14
|
352
|
+
* @remarks "The `Document._onDeleteDocuments` static method is deprecated in favor of {@link Document._onDeleteOperation | `Document._onDeleteOperation`}"
|
353
|
+
*/
|
354
|
+
protected static override _onDeleteDocuments(
|
292
355
|
documents: ActorDelta.Implementation[],
|
293
356
|
context: Document.ModificationContext<ActorDelta.Parent>,
|
294
357
|
): Promise<void>;
|
295
358
|
|
296
359
|
/* DataModel overrides */
|
297
360
|
|
298
|
-
protected static _schema: SchemaField<ActorDelta.Schema>;
|
361
|
+
protected static override _schema: SchemaField<ActorDelta.Schema>;
|
299
362
|
|
300
|
-
static get schema(): SchemaField<ActorDelta.Schema>;
|
363
|
+
static override get schema(): SchemaField<ActorDelta.Schema>;
|
301
364
|
|
302
|
-
static validateJoint(data: ActorDelta.Source): void;
|
365
|
+
static override validateJoint(data: ActorDelta.Source): void;
|
303
366
|
|
367
|
+
// options: not null (parameter default only, destructured in super)
|
304
368
|
static override fromSource(
|
305
369
|
source: ActorDelta.CreateData,
|
306
|
-
|
370
|
+
context?: DataModel.FromSourceOptions,
|
307
371
|
): ActorDelta.Implementation;
|
308
372
|
|
309
373
|
static override fromJSON(json: string): ActorDelta.Implementation;
|
374
|
+
|
375
|
+
static #BaseActorDelta: true;
|
310
376
|
}
|
311
377
|
|
312
378
|
export default BaseActorDelta;
|
@@ -340,6 +406,21 @@ declare namespace BaseActorDelta {
|
|
340
406
|
export import DatabaseOperation = ActorDelta.Database;
|
341
407
|
export import Flags = ActorDelta.Flags;
|
342
408
|
|
409
|
+
/**
|
410
|
+
* @internal
|
411
|
+
* This interface is spread into an object that already has `parent` defined, and as this is ActorDelta logic,
|
412
|
+
* let's assume that overwriting the parent is contraindicated.
|
413
|
+
*/
|
414
|
+
type _ApplyDeltaContext = Omit<Document.ConstructionContext<TokenDocument.Implementation>, "parent">;
|
415
|
+
|
416
|
+
interface ApplyDeltaContext extends _ApplyDeltaContext {
|
417
|
+
/**
|
418
|
+
* @deprecated This context is spread into an `Actor` creation context for the synthetic actor,
|
419
|
+
* overriding the provided default of `parent: delta.parent` is nonsensical
|
420
|
+
*/
|
421
|
+
parent?: never;
|
422
|
+
}
|
423
|
+
|
343
424
|
// The document subclasses override `system` anyways.
|
344
425
|
// There's no point in doing expensive computation work comparing the base class system.
|
345
426
|
/** @internal */
|
@@ -1,4 +1,4 @@
|
|
1
|
-
import type { AnyMutableObject
|
1
|
+
import type { AnyMutableObject } from "#utils";
|
2
2
|
import type DataModel from "../abstract/data.d.mts";
|
3
3
|
import type Document from "../abstract/document.mts";
|
4
4
|
import type { DataField, SchemaField } from "../data/fields.d.mts";
|
@@ -29,6 +29,26 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
|
|
29
29
|
*/
|
30
30
|
constructor(...args: Actor.ConstructorArgs);
|
31
31
|
|
32
|
+
/**
|
33
|
+
* @defaultValue
|
34
|
+
* ```js
|
35
|
+
* mergeObject(super.metadata, {
|
36
|
+
* name: "Actor",
|
37
|
+
* collection: "actors",
|
38
|
+
* indexed: true,
|
39
|
+
* compendiumIndexFields: ["_id", "name", "img", "type", "sort", "folder"],
|
40
|
+
* embedded: {ActiveEffect: "effects", Item: "items"},
|
41
|
+
* hasTypeData: true,
|
42
|
+
* label: "DOCUMENT.Actor",
|
43
|
+
* labelPlural: "DOCUMENT.Actors",
|
44
|
+
* permissions: {
|
45
|
+
* create: this.#canCreate,
|
46
|
+
* update: this.#canUpdate
|
47
|
+
* },
|
48
|
+
* schemaVersion: "12.324"
|
49
|
+
* })
|
50
|
+
* ```
|
51
|
+
*/
|
32
52
|
static override metadata: BaseActor.Metadata;
|
33
53
|
|
34
54
|
static override defineSchema(): BaseActor.Schema;
|
@@ -42,24 +62,24 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
|
|
42
62
|
/**
|
43
63
|
* Determine default artwork based on the provided actor data
|
44
64
|
* @param actorData - The source actor data
|
65
|
+
* @remarks Core's implementation does not use `actorData`
|
45
66
|
*/
|
46
|
-
static getDefaultArtwork(actorData
|
47
|
-
img: string;
|
48
|
-
texture: { src: string };
|
49
|
-
};
|
67
|
+
static getDefaultArtwork(actorData?: BaseActor.CreateData): BaseActor.GetDefaultArtworkReturn;
|
50
68
|
|
69
|
+
// options: not null (parameter default only)
|
51
70
|
protected override _initializeSource(
|
52
71
|
data: BaseActor.CreateData | this,
|
53
|
-
options?:
|
72
|
+
options?: Document.InitializeSourceOptions,
|
54
73
|
): BaseActor.Source;
|
55
74
|
|
75
|
+
/** @remarks Returns `user.hasPermission("ACTOR_CREATE")` */
|
56
76
|
static override canUserCreate(user: User.Implementation): boolean;
|
57
77
|
|
58
78
|
/**
|
59
|
-
* @
|
60
|
-
*
|
79
|
+
* @remarks
|
80
|
+
* Migrations:
|
81
|
+
* - `flags.core.sourceId` to `_stats.compendiumSource` (since v12, no specified end)
|
61
82
|
*/
|
62
|
-
|
63
83
|
static override migrateData(source: AnyMutableObject): AnyMutableObject;
|
64
84
|
|
65
85
|
/*
|
@@ -79,39 +99,39 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
|
|
79
99
|
// Same as Document for now
|
80
100
|
protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
|
81
101
|
|
82
|
-
readonly parentCollection: Actor.ParentCollectionName | null;
|
102
|
+
override readonly parentCollection: Actor.ParentCollectionName | null;
|
83
103
|
|
84
|
-
readonly pack: string | null;
|
104
|
+
override readonly pack: string | null;
|
85
105
|
|
86
|
-
static get implementation(): Actor.ImplementationClass;
|
106
|
+
static override get implementation(): Actor.ImplementationClass;
|
87
107
|
|
88
|
-
static get baseDocument(): typeof BaseActor;
|
108
|
+
static override get baseDocument(): typeof BaseActor;
|
89
109
|
|
90
|
-
static get collectionName(): Actor.ParentCollectionName;
|
110
|
+
static override get collectionName(): Actor.ParentCollectionName;
|
91
111
|
|
92
|
-
static get documentName(): Actor.Name;
|
112
|
+
static override get documentName(): Actor.Name;
|
93
113
|
|
94
|
-
static get TYPES(): BaseActor.SubType[];
|
114
|
+
static override get TYPES(): BaseActor.SubType[];
|
95
115
|
|
96
|
-
static get hasTypeData(): true;
|
116
|
+
static override get hasTypeData(): true;
|
97
117
|
|
98
|
-
static get hierarchy(): Actor.Hierarchy;
|
118
|
+
static override get hierarchy(): Actor.Hierarchy;
|
99
119
|
|
100
120
|
override system: Actor.SystemOfType<SubType>;
|
101
121
|
|
102
122
|
override parent: BaseActor.Parent;
|
103
123
|
|
104
|
-
static createDocuments<Temporary extends boolean | undefined = false>(
|
124
|
+
static override createDocuments<Temporary extends boolean | undefined = false>(
|
105
125
|
data: Array<Actor.Implementation | Actor.CreateData> | undefined,
|
106
126
|
operation?: Document.Database.CreateOperation<Actor.Database.Create<Temporary>>,
|
107
127
|
): Promise<Array<Document.TemporaryIf<Actor.Implementation, Temporary>>>;
|
108
128
|
|
109
|
-
static updateDocuments(
|
129
|
+
static override updateDocuments(
|
110
130
|
updates: Actor.UpdateData[] | undefined,
|
111
131
|
operation?: Document.Database.UpdateDocumentsOperation<Actor.Database.Update>,
|
112
132
|
): Promise<Actor.Implementation[]>;
|
113
133
|
|
114
|
-
static deleteDocuments(
|
134
|
+
static override deleteDocuments(
|
115
135
|
ids: readonly string[] | undefined,
|
116
136
|
operation?: Document.Database.DeleteDocumentsOperation<Actor.Database.Delete>,
|
117
137
|
): Promise<Actor.Implementation[]>;
|
@@ -184,112 +204,144 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
|
|
184
204
|
key: Key,
|
185
205
|
): Promise<this>;
|
186
206
|
|
187
|
-
protected _preCreate(
|
207
|
+
protected override _preCreate(
|
188
208
|
data: Actor.CreateData,
|
189
209
|
options: Actor.Database.PreCreateOptions,
|
190
210
|
user: User.Implementation,
|
191
211
|
): Promise<boolean | void>;
|
192
212
|
|
193
|
-
protected _onCreate(data: Actor.CreateData, options: Actor.Database.OnCreateOperation, userId: string): void;
|
213
|
+
protected override _onCreate(data: Actor.CreateData, options: Actor.Database.OnCreateOperation, userId: string): void;
|
194
214
|
|
195
|
-
protected static _preCreateOperation(
|
215
|
+
protected static override _preCreateOperation(
|
196
216
|
documents: Actor.Implementation[],
|
197
217
|
operation: Document.Database.PreCreateOperationStatic<Actor.Database.Create>,
|
198
218
|
user: User.Implementation,
|
199
219
|
): Promise<boolean | void>;
|
200
220
|
|
201
|
-
protected static _onCreateOperation(
|
221
|
+
protected static override _onCreateOperation(
|
202
222
|
documents: Actor.Implementation[],
|
203
223
|
operation: Actor.Database.Create,
|
204
224
|
user: User.Implementation,
|
205
225
|
): Promise<void>;
|
206
226
|
|
207
|
-
protected _preUpdate(
|
227
|
+
protected override _preUpdate(
|
208
228
|
changed: Actor.UpdateData,
|
209
229
|
options: Actor.Database.PreUpdateOptions,
|
210
230
|
user: User.Implementation,
|
211
231
|
): Promise<boolean | void>;
|
212
232
|
|
213
|
-
protected _onUpdate(
|
233
|
+
protected override _onUpdate(
|
234
|
+
changed: Actor.UpdateData,
|
235
|
+
options: Actor.Database.OnUpdateOperation,
|
236
|
+
userId: string,
|
237
|
+
): void;
|
214
238
|
|
215
|
-
protected static _preUpdateOperation(
|
239
|
+
protected static override _preUpdateOperation(
|
216
240
|
documents: Actor.Implementation[],
|
217
241
|
operation: Actor.Database.Update,
|
218
242
|
user: User.Implementation,
|
219
243
|
): Promise<boolean | void>;
|
220
244
|
|
221
|
-
protected static _onUpdateOperation(
|
245
|
+
protected static override _onUpdateOperation(
|
222
246
|
documents: Actor.Implementation[],
|
223
247
|
operation: Actor.Database.Update,
|
224
248
|
user: User.Implementation,
|
225
249
|
): Promise<void>;
|
226
250
|
|
227
|
-
protected _preDelete(
|
251
|
+
protected override _preDelete(
|
252
|
+
options: Actor.Database.PreDeleteOptions,
|
253
|
+
user: User.Implementation,
|
254
|
+
): Promise<boolean | void>;
|
228
255
|
|
229
|
-
protected _onDelete(options: Actor.Database.OnDeleteOperation, userId: string): void;
|
256
|
+
protected override _onDelete(options: Actor.Database.OnDeleteOperation, userId: string): void;
|
230
257
|
|
231
|
-
protected static _preDeleteOperation(
|
258
|
+
protected static override _preDeleteOperation(
|
232
259
|
documents: Actor.Implementation[],
|
233
260
|
operation: Actor.Database.Delete,
|
234
261
|
user: User.Implementation,
|
235
262
|
): Promise<boolean | void>;
|
236
263
|
|
237
|
-
protected static _onDeleteOperation(
|
264
|
+
protected static override _onDeleteOperation(
|
238
265
|
documents: Actor.Implementation[],
|
239
266
|
operation: Actor.Database.Delete,
|
240
267
|
user: User.Implementation,
|
241
268
|
): Promise<void>;
|
242
269
|
|
243
|
-
static get hasSystemData(): true;
|
270
|
+
static override get hasSystemData(): true;
|
244
271
|
|
245
272
|
// These data field things have been ticketed but will probably go into backlog hell for a while.
|
246
273
|
// We'll end up copy and pasting without modification for now I think. It makes it a tiny bit easier to update though.
|
247
|
-
protected static _addDataFieldShims(data: AnyObject, shims: AnyObject, options?: Document.DataFieldShimOptions): void;
|
248
274
|
|
249
|
-
|
250
|
-
|
275
|
+
// options: not null (parameter default only in _addDataFieldShim)
|
276
|
+
protected static override _addDataFieldShims(
|
277
|
+
data: AnyMutableObject,
|
278
|
+
shims: Record<string, string>,
|
279
|
+
options?: Document.DataFieldShimOptions,
|
280
|
+
): void;
|
281
|
+
|
282
|
+
// options: not null (parameter default only)
|
283
|
+
protected static override _addDataFieldShim(
|
284
|
+
data: AnyMutableObject,
|
251
285
|
oldKey: string,
|
252
286
|
newKey: string,
|
253
|
-
|
254
|
-
):
|
287
|
+
options?: Document.DataFieldShimOptions,
|
288
|
+
): void;
|
255
289
|
|
256
|
-
protected static
|
290
|
+
protected static override _addDataFieldMigration(
|
291
|
+
data: AnyMutableObject,
|
292
|
+
oldKey: string,
|
293
|
+
newKey: string,
|
294
|
+
apply?: ((data: AnyMutableObject) => unknown) | null,
|
295
|
+
): boolean;
|
296
|
+
|
297
|
+
// options: not null (destructured where forwarded)
|
298
|
+
protected static override _logDataFieldMigration(
|
257
299
|
oldKey: string,
|
258
300
|
newKey: string,
|
259
301
|
options?: LogCompatibilityWarningOptions,
|
260
302
|
): void;
|
261
303
|
|
262
|
-
|
304
|
+
/**
|
305
|
+
* @deprecated since v12, will be removed in v14
|
306
|
+
* @remarks "The `Document._onCreateDocuments` static method is deprecated in favor of {@link Document._onCreateOperation | `Document._onCreateOperation`}"
|
307
|
+
*/
|
308
|
+
protected static override _onCreateDocuments(
|
263
309
|
documents: Actor.Implementation[],
|
264
310
|
context: Document.ModificationContext<Actor.Parent>,
|
265
311
|
): Promise<void>;
|
266
312
|
|
267
|
-
|
313
|
+
/**
|
314
|
+
* @deprecated since v12, will be removed in v14
|
315
|
+
* @remarks "The `Document._onUpdateDocuments` static method is deprecated in favor of {@link Document._onUpdateOperation | `Document._onUpdateOperation`}"
|
316
|
+
*/
|
317
|
+
protected static override _onUpdateDocuments(
|
268
318
|
documents: Actor.Implementation[],
|
269
319
|
context: Document.ModificationContext<Actor.Parent>,
|
270
320
|
): Promise<void>;
|
271
321
|
|
272
|
-
|
322
|
+
/**
|
323
|
+
* @deprecated since v12, will be removed in v14
|
324
|
+
* @remarks "The `Document._onDeleteDocuments` static method is deprecated in favor of {@link Document._onDeleteOperation | `Document._onDeleteOperation`}"
|
325
|
+
*/
|
326
|
+
protected static override _onDeleteDocuments(
|
273
327
|
documents: Actor.Implementation[],
|
274
328
|
context: Document.ModificationContext<Actor.Parent>,
|
275
329
|
): Promise<void>;
|
276
330
|
|
277
331
|
/* DataModel overrides */
|
278
332
|
|
279
|
-
protected static _schema: SchemaField<Actor.Schema>;
|
333
|
+
protected static override _schema: SchemaField<Actor.Schema>;
|
280
334
|
|
281
|
-
static get schema(): SchemaField<Actor.Schema>;
|
335
|
+
static override get schema(): SchemaField<Actor.Schema>;
|
282
336
|
|
283
|
-
static validateJoint(data: Actor.Source): void;
|
337
|
+
static override validateJoint(data: Actor.Source): void;
|
284
338
|
|
285
|
-
|
286
|
-
|
287
|
-
{ strict, ...context }?: DataModel.FromSourceOptions,
|
288
|
-
): Actor.Implementation;
|
339
|
+
// options: not null (parameter default only, destructured in super)
|
340
|
+
static override fromSource(source: Actor.CreateData, context?: DataModel.FromSourceOptions): Actor.Implementation;
|
289
341
|
|
290
342
|
static override fromJSON(json: string): Actor.Implementation;
|
291
343
|
|
292
|
-
#
|
344
|
+
static #BaseActor: true;
|
293
345
|
}
|
294
346
|
|
295
347
|
declare namespace BaseActor {
|
@@ -320,6 +372,8 @@ declare namespace BaseActor {
|
|
320
372
|
export import Schema = Actor.Schema;
|
321
373
|
export import DatabaseOperation = Actor.Database;
|
322
374
|
export import Flags = Actor.Flags;
|
375
|
+
export import GetDefaultArtworkReturn = Actor.GetDefaultArtworkReturn;
|
376
|
+
export import GetDefaultArtworkTextureReturn = Actor.GetDefaultArtworkTextureReturn;
|
323
377
|
|
324
378
|
// The document subclasses override `system` anyways.
|
325
379
|
// There's no point in doing expensive computation work comparing the base class system.
|