@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.
Files changed (377) hide show
  1. package/package.json +18 -1
  2. package/src/configuration/configuration.d.mts +1 -1
  3. package/src/foundry/client/apps/app.d.mts +1 -1
  4. package/src/foundry/client/apps/av/av-config.d.mts +1 -1
  5. package/src/foundry/client/apps/av/cameras.d.mts +1 -1
  6. package/src/foundry/client/apps/dice/dice-config.d.mts +1 -1
  7. package/src/foundry/client/apps/form.d.mts +1 -1
  8. package/src/foundry/client/apps/forms/actor.d.mts +1 -1
  9. package/src/foundry/client/apps/forms/adventure-exporter.d.mts +1 -1
  10. package/src/foundry/client/apps/forms/adventure-importer.d.mts +1 -1
  11. package/src/foundry/client/apps/forms/base-sheet.d.mts +1 -1
  12. package/src/foundry/client/apps/forms/card-config.d.mts +1 -1
  13. package/src/foundry/client/apps/forms/cards-config.d.mts +1 -1
  14. package/src/foundry/client/apps/forms/combat-config.d.mts +1 -1
  15. package/src/foundry/client/apps/forms/effect-config.d.mts +1 -1
  16. package/src/foundry/client/apps/forms/folder-config.d.mts +7 -2
  17. package/src/foundry/client/apps/forms/fonts.d.mts +1 -1
  18. package/src/foundry/client/apps/forms/grid-config.d.mts +1 -1
  19. package/src/foundry/client/apps/forms/image-popout.d.mts +1 -1
  20. package/src/foundry/client/apps/forms/item.d.mts +1 -1
  21. package/src/foundry/client/apps/forms/journal-page-sheet.d.mts +1 -1
  22. package/src/foundry/client/apps/forms/journal-sheet.d.mts +1 -1
  23. package/src/foundry/client/apps/forms/macro-config.d.mts +1 -1
  24. package/src/foundry/client/apps/forms/measure-template.d.mts +1 -1
  25. package/src/foundry/client/apps/forms/ownership.d.mts +1 -1
  26. package/src/foundry/client/apps/forms/playlist-config.d.mts +1 -1
  27. package/src/foundry/client/apps/forms/playlist-sound-config.d.mts +1 -1
  28. package/src/foundry/client/apps/forms/roll-table-config.d.mts +1 -1
  29. package/src/foundry/client/apps/forms/scene-config.d.mts +1 -1
  30. package/src/foundry/client/apps/forms/sheet-config.d.mts +1 -1
  31. package/src/foundry/client/apps/forms/user-config.d.mts +1 -1
  32. package/src/foundry/client/apps/hud/chatbubble.d.mts +1 -1
  33. package/src/foundry/client/apps/hud/container.d.mts +1 -1
  34. package/src/foundry/client/apps/hud/controls.d.mts +1 -1
  35. package/src/foundry/client/apps/hud/hotbar.d.mts +1 -1
  36. package/src/foundry/client/apps/hud/hud.d.mts +1 -1
  37. package/src/foundry/client/apps/hud/menu.d.mts +1 -1
  38. package/src/foundry/client/apps/hud/navigation.d.mts +1 -1
  39. package/src/foundry/client/apps/hud/pause.d.mts +1 -1
  40. package/src/foundry/client/apps/hud/players.d.mts +1 -1
  41. package/src/foundry/client/apps/placeables/drawing-config.d.mts +1 -1
  42. package/src/foundry/client/apps/placeables/drawing-hud.d.mts +1 -1
  43. package/src/foundry/client/apps/placeables/note-config.d.mts +1 -1
  44. package/src/foundry/client/apps/placeables/tile-config.d.mts +1 -1
  45. package/src/foundry/client/apps/placeables/tile-hud.d.mts +1 -1
  46. package/src/foundry/client/apps/placeables/token-config.d.mts +1 -1
  47. package/src/foundry/client/apps/placeables/token-hud.d.mts +1 -1
  48. package/src/foundry/client/apps/placeables/wall-config.d.mts +1 -1
  49. package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts +1 -1
  50. package/src/foundry/client/apps/sidebar/apps/module-management.d.mts +1 -1
  51. package/src/foundry/client/apps/sidebar/apps/support-details.d.mts +1 -1
  52. package/src/foundry/client/apps/sidebar/apps/tours-management.d.mts +1 -1
  53. package/src/foundry/client/apps/sidebar/apps/world-config.d.mts +1 -1
  54. package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts +1 -1
  55. package/src/foundry/client/apps/sidebar/package-configuration.d.mts +1 -1
  56. package/src/foundry/client/apps/sidebar/sidebar.d.mts +1 -1
  57. package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts +1 -1
  58. package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts +1 -1
  59. package/src/foundry/client/apps/sidebar/tabs/chat-log.d.mts +1 -1
  60. package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.mts +1 -1
  61. package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.mts +1 -1
  62. package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts +1 -1
  63. package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.mts +1 -1
  64. package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts +1 -1
  65. package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts +1 -1
  66. package/src/foundry/client/apps/sidebar/tabs/roll-table-directory.d.mts +1 -1
  67. package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts +1 -1
  68. package/src/foundry/client/apps/sidebar/tabs/settings.d.mts +1 -1
  69. package/src/foundry/client/av/client.d.mts +1 -1
  70. package/src/foundry/client/av/clients/simplepeer.d.mts +1 -1
  71. package/src/foundry/client/av/master.d.mts +1 -1
  72. package/src/foundry/client/av/settings.d.mts +1 -1
  73. package/src/foundry/client/config.d.mts +1 -1
  74. package/src/foundry/client/core/hooks.d.mts +1 -1
  75. package/src/foundry/client/core/image.d.mts +1 -1
  76. package/src/foundry/client/core/keybindings.d.mts +1 -1
  77. package/src/foundry/client/core/packages.d.mts +4 -2
  78. package/src/foundry/client/core/settings.d.mts +1 -1
  79. package/src/foundry/client/core/socket.d.mts +1 -1
  80. package/src/foundry/client/core/tooltip.d.mts +1 -1
  81. package/src/foundry/client/core/tour.d.mts +1 -1
  82. package/src/foundry/client/core/utils.d.mts +1 -1
  83. package/src/foundry/client/core/workers.d.mts +1 -1
  84. package/src/foundry/client/data/abstract/canvas-document.d.mts +9 -20
  85. package/src/foundry/client/data/abstract/client-document.d.mts +133 -71
  86. package/src/foundry/client/data/abstract/directory-collection-mixin.d.mts +2 -2
  87. package/src/foundry/client/data/abstract/document-collection.d.mts +1 -1
  88. package/src/foundry/client/data/abstract/world-collection.d.mts +8 -1
  89. package/src/foundry/client/data/collections/actors.d.mts +1 -1
  90. package/src/foundry/client/data/collections/cards.d.mts +1 -1
  91. package/src/foundry/client/data/collections/combats.d.mts +1 -1
  92. package/src/foundry/client/data/collections/compendium-collection.d.mts +5 -4
  93. package/src/foundry/client/data/collections/fog.d.mts +1 -1
  94. package/src/foundry/client/data/collections/folder.d.mts +1 -1
  95. package/src/foundry/client/data/collections/items.d.mts +1 -1
  96. package/src/foundry/client/data/collections/journal.d.mts +1 -1
  97. package/src/foundry/client/data/collections/macros.d.mts +1 -1
  98. package/src/foundry/client/data/collections/messages.d.mts +1 -1
  99. package/src/foundry/client/data/collections/playlists.d.mts +1 -1
  100. package/src/foundry/client/data/collections/scenes.d.mts +1 -1
  101. package/src/foundry/client/data/collections/settings.d.mts +1 -1
  102. package/src/foundry/client/data/collections/tables.d.mts +1 -1
  103. package/src/foundry/client/data/collections/users.d.mts +4 -4
  104. package/src/foundry/client/data/documents/active-effect.d.mts +124 -48
  105. package/src/foundry/client/data/documents/actor-delta.d.mts +53 -22
  106. package/src/foundry/client/data/documents/actor.d.mts +147 -93
  107. package/src/foundry/client/data/documents/adventure.d.mts +74 -45
  108. package/src/foundry/client/data/documents/ambient-light.d.mts +13 -10
  109. package/src/foundry/client/data/documents/ambient-sound.d.mts +12 -7
  110. package/src/foundry/client/data/documents/card.d.mts +57 -34
  111. package/src/foundry/client/data/documents/cards.d.mts +171 -135
  112. package/src/foundry/client/data/documents/chat-message.d.mts +131 -72
  113. package/src/foundry/client/data/documents/combat.d.mts +80 -60
  114. package/src/foundry/client/data/documents/combatant.d.mts +53 -20
  115. package/src/foundry/client/data/documents/drawing.d.mts +12 -7
  116. package/src/foundry/client/data/documents/fog-exploration.d.mts +57 -17
  117. package/src/foundry/client/data/documents/folder.d.mts +114 -31
  118. package/src/foundry/client/data/documents/item.d.mts +31 -21
  119. package/src/foundry/client/data/documents/journal-entry-page.d.mts +90 -57
  120. package/src/foundry/client/data/documents/journal-entry.d.mts +29 -34
  121. package/src/foundry/client/data/documents/macro.d.mts +60 -34
  122. package/src/foundry/client/data/documents/measured-template.d.mts +13 -8
  123. package/src/foundry/client/data/documents/note.d.mts +14 -7
  124. package/src/foundry/client/data/documents/playlist-sound.d.mts +29 -33
  125. package/src/foundry/client/data/documents/playlist.d.mts +74 -54
  126. package/src/foundry/client/data/documents/region-behavior.d.mts +16 -7
  127. package/src/foundry/client/data/documents/region.d.mts +53 -48
  128. package/src/foundry/client/data/documents/scene.d.mts +310 -89
  129. package/src/foundry/client/data/documents/setting.d.mts +24 -23
  130. package/src/foundry/client/data/documents/table-result.d.mts +20 -8
  131. package/src/foundry/client/data/documents/table.d.mts +19 -13
  132. package/src/foundry/client/data/documents/tile.d.mts +13 -7
  133. package/src/foundry/client/data/documents/token.d.mts +148 -117
  134. package/src/foundry/client/data/documents/user.d.mts +141 -53
  135. package/src/foundry/client/data/documents/wall.d.mts +17 -10
  136. package/src/foundry/client/game.d.mts +1 -1
  137. package/src/foundry/client/head.d.mts +1 -1
  138. package/src/foundry/client/hooks.d.mts +9 -18
  139. package/src/foundry/client/pixi/board.d.mts +3 -2
  140. package/src/foundry/client/pixi/core/containers/base-canvas-group.d.mts +1 -1
  141. package/src/foundry/client/pixi/core/containers/cached-container.d.mts +1 -1
  142. package/src/foundry/client/pixi/core/containers/full-canvas-container.d.mts +1 -1
  143. package/src/foundry/client/pixi/core/containers/point-source-mesh.d.mts +1 -1
  144. package/src/foundry/client/pixi/core/containers/quad-mesh.d.mts +1 -1
  145. package/src/foundry/client/pixi/core/containers/quadtree.d.mts +1 -1
  146. package/src/foundry/client/pixi/core/containers/sprite-mesh.d.mts +1 -1
  147. package/src/foundry/client/pixi/core/containers/unbound-container.d.mts +1 -1
  148. package/src/foundry/client/pixi/core/interaction/canvas-animation.d.mts +1 -1
  149. package/src/foundry/client/pixi/core/interaction/control-icon.d.mts +1 -1
  150. package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts +1 -1
  151. package/src/foundry/client/pixi/core/interaction/ping.d.mts +1 -1
  152. package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts +1 -1
  153. package/src/foundry/client/pixi/core/interaction/render-flags.d.mts +1 -8
  154. package/src/foundry/client/pixi/core/interaction/resize-handle.d.mts +1 -1
  155. package/src/foundry/client/pixi/core/interaction/targets.d.mts +1 -1
  156. package/src/foundry/client/pixi/core/loader.d.mts +1 -1
  157. package/src/foundry/client/pixi/core/shapes/limited-angle-polygon.d.mts +1 -1
  158. package/src/foundry/client/pixi/core/shapes/polygon-mesher.d.mts +1 -1
  159. package/src/foundry/client/pixi/core/shapes/precise-text.d.mts +1 -1
  160. package/src/foundry/client/pixi/core/shapes/ray.d.mts +1 -1
  161. package/src/foundry/client/pixi/core/shapes/source-polygon.d.mts +1 -1
  162. package/src/foundry/client/pixi/extensions/circle.d.mts +1 -1
  163. package/src/foundry/client/pixi/extensions/observable-transform.d.mts +1 -1
  164. package/src/foundry/client/pixi/extensions/polygon.d.mts +1 -1
  165. package/src/foundry/client/pixi/extensions/rectangle.d.mts +1 -1
  166. package/src/foundry/client/pixi/groups/effects.d.mts +1 -1
  167. package/src/foundry/client/pixi/groups/environment.d.mts +1 -1
  168. package/src/foundry/client/pixi/groups/hidden.d.mts +1 -1
  169. package/src/foundry/client/pixi/groups/interface.d.mts +1 -1
  170. package/src/foundry/client/pixi/groups/overlay.d.mts +1 -1
  171. package/src/foundry/client/pixi/groups/primary.d.mts +1 -1
  172. package/src/foundry/client/pixi/groups/rendered.d.mts +1 -1
  173. package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts +1 -1
  174. package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts +1 -1
  175. package/src/foundry/client/pixi/layers/base/placeables-layer.d.mts +1 -1
  176. package/src/foundry/client/pixi/layers/controls/cursor.d.mts +1 -1
  177. package/src/foundry/client/pixi/layers/controls/door.d.mts +1 -1
  178. package/src/foundry/client/pixi/layers/controls/layer.d.mts +1 -1
  179. package/src/foundry/client/pixi/layers/controls/ruler.d.mts +1 -1
  180. package/src/foundry/client/pixi/layers/effects/background-effects.d.mts +1 -1
  181. package/src/foundry/client/pixi/layers/effects/coloration-effects.d.mts +1 -1
  182. package/src/foundry/client/pixi/layers/effects/darkness-effects.d.mts +1 -1
  183. package/src/foundry/client/pixi/layers/effects/illumination-effects.d.mts +1 -1
  184. package/src/foundry/client/pixi/layers/effects/visibility.d.mts +1 -1
  185. package/src/foundry/client/pixi/layers/effects/weather/particles/effect.d.mts +1 -1
  186. package/src/foundry/client/pixi/layers/effects/weather/particles/leaves.d.mts +1 -1
  187. package/src/foundry/client/pixi/layers/effects/weather-effects.d.mts +1 -1
  188. package/src/foundry/client/pixi/layers/grid/highlight.d.mts +1 -1
  189. package/src/foundry/client/pixi/layers/grid/layer.d.mts +1 -1
  190. package/src/foundry/client/pixi/layers/grid/mesh.d.mts +1 -1
  191. package/src/foundry/client/pixi/layers/masks/depth.d.mts +1 -1
  192. package/src/foundry/client/pixi/layers/masks/occlusion.d.mts +1 -1
  193. package/src/foundry/client/pixi/layers/masks/vision.d.mts +1 -1
  194. package/src/foundry/client/pixi/layers/placeables/drawings.d.mts +1 -1
  195. package/src/foundry/client/pixi/layers/placeables/lighting.d.mts +1 -1
  196. package/src/foundry/client/pixi/layers/placeables/notes.d.mts +1 -1
  197. package/src/foundry/client/pixi/layers/placeables/regions.d.mts +1 -1
  198. package/src/foundry/client/pixi/layers/placeables/sounds.d.mts +1 -1
  199. package/src/foundry/client/pixi/layers/placeables/templates.d.mts +1 -1
  200. package/src/foundry/client/pixi/layers/placeables/tiles.d.mts +1 -1
  201. package/src/foundry/client/pixi/layers/placeables/tokens.d.mts +1 -1
  202. package/src/foundry/client/pixi/layers/placeables/walls.d.mts +1 -1
  203. package/src/foundry/client/pixi/perception/clockwise-sweep.d.mts +1 -1
  204. package/src/foundry/client/pixi/perception/detection-mode.d.mts +1 -1
  205. package/src/foundry/client/pixi/perception/fog.d.mts +1 -1
  206. package/src/foundry/client/pixi/perception/perception-manager.d.mts +1 -1
  207. package/src/foundry/client/pixi/perception/vision-mode.d.mts +1 -1
  208. package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts +1 -1
  209. package/src/foundry/client/pixi/placeable.d.mts +2 -1
  210. package/src/foundry/client/pixi/placeables/drawing.d.mts +1 -1
  211. package/src/foundry/client/pixi/placeables/light.d.mts +1 -7
  212. package/src/foundry/client/pixi/placeables/note.d.mts +1 -1
  213. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts +1 -1
  214. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts +1 -1
  215. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts +1 -1
  216. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts +1 -1
  217. package/src/foundry/client/pixi/placeables/region.d.mts +1 -1
  218. package/src/foundry/client/pixi/placeables/sound.d.mts +1 -1
  219. package/src/foundry/client/pixi/placeables/template.d.mts +1 -1
  220. package/src/foundry/client/pixi/placeables/tile.d.mts +1 -1
  221. package/src/foundry/client/pixi/placeables/token.d.mts +1 -1
  222. package/src/foundry/client/pixi/placeables/wall.d.mts +1 -1
  223. package/src/foundry/client/pixi/webgl/extensions/batch-renderer.d.mts +1 -1
  224. package/src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.mts +1 -1
  225. package/src/foundry/client/pixi/webgl/helpers/framebuffer-snapshot.d.mts +1 -1
  226. package/src/foundry/client/pixi/webgl/helpers/smooth-noise.d.mts +1 -1
  227. package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts +1 -1
  228. package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts +1 -1
  229. package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts +1 -1
  230. package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts +1 -1
  231. package/src/foundry/client/pixi/webgl/shaders/filters/effects-masking.d.mts +1 -1
  232. package/src/foundry/client/pixi/webgl/shaders/filters/glow-overlay.d.mts +1 -1
  233. package/src/foundry/client/pixi/webgl/shaders/filters/outline-overlay.d.mts +1 -1
  234. package/src/foundry/client/pixi/webgl/shaders/filters/transition.d.mts +1 -1
  235. package/src/foundry/client/pixi/webgl/shaders/filters/visibility.d.mts +1 -1
  236. package/src/foundry/client/pixi/webgl/shaders/filters/vision-mask-filter.d.mts +1 -1
  237. package/src/foundry/client/pixi/webgl/shaders/fragment-channel-mixin.d.mts +1 -1
  238. package/src/foundry/client/pixi/webgl/shaders/grid/grid.d.mts +1 -1
  239. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fairy-light.d.mts +1 -1
  240. package/src/foundry/client/pixi/webgl/shaders/samplers/base-sampler.d.mts +1 -1
  241. package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts +1 -1
  242. package/src/foundry/client/pixi/webgl/shaders/weather/base-weather.d.mts +1 -1
  243. package/src/foundry/client/pixi/webgl/shaders/weather/effect.d.mts +1 -1
  244. package/src/foundry/client/pixi/workers/texture-worker.d.mts +1 -1
  245. package/src/foundry/client/ui/context.d.mts +1 -1
  246. package/src/foundry/client/ui/dialog.d.mts +1 -1
  247. package/src/foundry/client/ui/dragdrop.d.mts +1 -1
  248. package/src/foundry/client/ui/editor.d.mts +1 -1
  249. package/src/foundry/client/ui/filepicker.d.mts +1 -1
  250. package/src/foundry/client/ui/filter.d.mts +1 -1
  251. package/src/foundry/client-esm/applications/api/application.d.mts +1 -9
  252. package/src/foundry/client-esm/applications/api/dialog.d.mts +1 -1
  253. package/src/foundry/client-esm/applications/api/document-sheet.d.mts +1 -1
  254. package/src/foundry/client-esm/applications/api/handlebars-application.d.mts +1 -1
  255. package/src/foundry/client-esm/applications/apps/compendium-art-config.d.mts +1 -1
  256. package/src/foundry/client-esm/applications/apps/permission-config.d.mts +1 -1
  257. package/src/foundry/client-esm/applications/dice/roll-resolver.d.mts +1 -1
  258. package/src/foundry/client-esm/applications/forms/fields.d.mts +1 -1
  259. package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts +1 -1
  260. package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts +1 -1
  261. package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts +1 -1
  262. package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts +1 -1
  263. package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts +1 -1
  264. package/src/foundry/client-esm/applications/sheets/region-config.d.mts +1 -1
  265. package/src/foundry/client-esm/applications/sheets/user-config.d.mts +1 -1
  266. package/src/foundry/client-esm/applications/ui/region-legend.d.mts +1 -1
  267. package/src/foundry/client-esm/audio/biquad.d.mts +1 -1
  268. package/src/foundry/client-esm/audio/convolver.d.mts +1 -1
  269. package/src/foundry/client-esm/audio/helper.d.mts +1 -1
  270. package/src/foundry/client-esm/audio/sound.d.mts +2 -2
  271. package/src/foundry/client-esm/canvas/edges/collision.d.mts +1 -1
  272. package/src/foundry/client-esm/canvas/edges/edge.d.mts +1 -1
  273. package/src/foundry/client-esm/canvas/edges/vertex.d.mts +1 -1
  274. package/src/foundry/client-esm/canvas/scene-manager.d.mts +1 -1
  275. package/src/foundry/client-esm/canvas/smaa/smaa.d.mts +1 -1
  276. package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts +1 -1
  277. package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts +1 -1
  278. package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts +1 -1
  279. package/src/foundry/client-esm/canvas/sources/point-darkness-source.d.mts +1 -1
  280. package/src/foundry/client-esm/canvas/sources/point-effect-source.d.mts +1 -1
  281. package/src/foundry/client-esm/canvas/sources/point-light-source.d.mts +1 -1
  282. package/src/foundry/client-esm/canvas/sources/point-sound-source.d.mts +1 -1
  283. package/src/foundry/client-esm/canvas/sources/point-vision-source.d.mts +1 -1
  284. package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts +1 -1
  285. package/src/foundry/client-esm/canvas/tokens/ring-data.d.mts +3 -2
  286. package/src/foundry/client-esm/canvas/tokens/ring.d.mts +1 -1
  287. package/src/foundry/client-esm/data/client-backend.d.mts +1 -1
  288. package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts +4 -5
  289. package/src/foundry/client-esm/data/region-behaviors/base.d.mts +1 -1
  290. package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts +1 -1
  291. package/src/foundry/client-esm/data/region-behaviors/toggle-behavior.d.mts +4 -4
  292. package/src/foundry/client-esm/dice/roll.d.mts +5 -8
  293. package/src/foundry/client-esm/dice/terms/coin.d.mts +1 -1
  294. package/src/foundry/client-esm/dice/terms/dice.d.mts +1 -1
  295. package/src/foundry/client-esm/dice/terms/die.d.mts +1 -1
  296. package/src/foundry/client-esm/dice/terms/fate.d.mts +1 -1
  297. package/src/foundry/client-esm/dice/terms/function.d.mts +1 -1
  298. package/src/foundry/client-esm/dice/terms/numeric.d.mts +1 -1
  299. package/src/foundry/client-esm/dice/terms/operator.d.mts +1 -1
  300. package/src/foundry/client-esm/dice/terms/parenthetical.d.mts +1 -1
  301. package/src/foundry/client-esm/dice/terms/pool.d.mts +1 -1
  302. package/src/foundry/client-esm/dice/terms/string.d.mts +1 -1
  303. package/src/foundry/client-esm/dice/terms/term.d.mts +1 -1
  304. package/src/foundry/common/abstract/backend.d.mts +1 -1
  305. package/src/foundry/common/abstract/data.d.mts +197 -146
  306. package/src/foundry/common/abstract/document.d.mts +198 -81
  307. package/src/foundry/common/abstract/embedded-collection-delta.d.mts +1 -1
  308. package/src/foundry/common/abstract/embedded-collection.d.mts +1 -1
  309. package/src/foundry/common/abstract/socket.d.mts +1 -1
  310. package/src/foundry/common/abstract/type-data.d.mts +4 -1
  311. package/src/foundry/common/config.d.mts +7 -1
  312. package/src/foundry/common/constants.d.mts +1 -1
  313. package/src/foundry/common/data/data.d.mts +42 -12
  314. package/src/foundry/common/data/fields.d.mts +656 -252
  315. package/src/foundry/common/documents/_types.d.mts +0 -6
  316. package/src/foundry/common/documents/active-effect.d.mts +116 -53
  317. package/src/foundry/common/documents/actor-delta.d.mts +139 -58
  318. package/src/foundry/common/documents/actor.d.mts +105 -51
  319. package/src/foundry/common/documents/adventure.d.mts +84 -39
  320. package/src/foundry/common/documents/ambient-light.d.mts +66 -38
  321. package/src/foundry/common/documents/ambient-sound.d.mts +66 -38
  322. package/src/foundry/common/documents/card.d.mts +100 -59
  323. package/src/foundry/common/documents/cards.d.mts +97 -42
  324. package/src/foundry/common/documents/chat-message.d.mts +105 -52
  325. package/src/foundry/common/documents/combat.d.mts +101 -48
  326. package/src/foundry/common/documents/combatant.d.mts +94 -50
  327. package/src/foundry/common/documents/drawing.d.mts +87 -46
  328. package/src/foundry/common/documents/fog-exploration.d.mts +87 -41
  329. package/src/foundry/common/documents/folder.d.mts +100 -46
  330. package/src/foundry/common/documents/item.d.mts +116 -45
  331. package/src/foundry/common/documents/journal-entry-page.d.mts +90 -40
  332. package/src/foundry/common/documents/journal-entry.d.mts +90 -39
  333. package/src/foundry/common/documents/macro.d.mts +116 -52
  334. package/src/foundry/common/documents/measured-template.d.mts +80 -44
  335. package/src/foundry/common/documents/note.d.mts +75 -39
  336. package/src/foundry/common/documents/playlist-sound.d.mts +88 -47
  337. package/src/foundry/common/documents/playlist.d.mts +101 -50
  338. package/src/foundry/common/documents/region-behavior.d.mts +71 -40
  339. package/src/foundry/common/documents/region.d.mts +68 -40
  340. package/src/foundry/common/documents/roll-table.d.mts +43 -9
  341. package/src/foundry/common/documents/scene.d.mts +190 -43
  342. package/src/foundry/common/documents/setting.d.mts +98 -42
  343. package/src/foundry/common/documents/table-result.d.mts +98 -48
  344. package/src/foundry/common/documents/tile.d.mts +77 -43
  345. package/src/foundry/common/documents/token.d.mts +95 -52
  346. package/src/foundry/common/documents/user.d.mts +100 -89
  347. package/src/foundry/common/documents/wall.d.mts +47 -17
  348. package/src/foundry/common/grid/base.d.mts +1 -1
  349. package/src/foundry/common/grid/gridless.d.mts +1 -1
  350. package/src/foundry/common/grid/hexagonal.d.mts +1 -1
  351. package/src/foundry/common/grid/square.d.mts +1 -1
  352. package/src/foundry/common/packages/base-package.d.mts +37 -14
  353. package/src/foundry/common/packages/base-system.d.mts +39 -0
  354. package/src/foundry/common/packages/base-world.d.mts +8 -1
  355. package/src/foundry/common/packages/sub-types.d.mts +3 -5
  356. package/src/foundry/common/primitives/array.d.mts +1 -1
  357. package/src/foundry/common/primitives/string.d.mts +1 -1
  358. package/src/foundry/common/prosemirror/dirty-plugin.d.mts +1 -1
  359. package/src/foundry/common/prosemirror/dom-parser.d.mts +1 -1
  360. package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts +1 -1
  361. package/src/foundry/common/prosemirror/image-plugin.d.mts +1 -1
  362. package/src/foundry/common/prosemirror/paste-transformer.d.mts +1 -1
  363. package/src/foundry/common/prosemirror/plugin.d.mts +1 -1
  364. package/src/foundry/common/types.d.mts +1 -1
  365. package/src/foundry/common/utils/bitmask.d.mts +1 -1
  366. package/src/foundry/common/utils/collection.d.mts +1 -1
  367. package/src/foundry/common/utils/event-emitter.d.mts +1 -1
  368. package/src/foundry/common/utils/helpers.d.mts +1 -1
  369. package/src/foundry/public/scripts/clipper/clipper.d.mts +1 -1
  370. package/src/types/augments/particles.d.mts +1 -1
  371. package/src/types/augments/pixi.d.mts +1 -1
  372. package/src/types/augments/smooth.d.mts +1 -1
  373. package/src/types/augments/tinyMCE.d.mts +1 -1
  374. package/src/types/config.d.mts +2 -5
  375. package/src/types/documentConfiguration.d.mts +1 -1
  376. package/src/types/lib.d.mts +1 -1
  377. package/src/types/workers/image-compressor.d.mts +1 -1
@@ -1,9 +1,9 @@
1
+ import type { AnyObject, Identity, Merge, NullishProps, RequiredProps } from "#utils";
1
2
  import type { DataSchema } from "../../../common/data/fields.d.mts";
2
3
  import type { BaseActorDelta } from "../../../common/documents/_module.d.mts";
3
4
  import type Document from "../../../common/abstract/document.d.mts";
4
5
  import type { fields } from "../../../common/data/module.d.mts";
5
6
  import type { ConfiguredActorDelta } from "../../../../configuration/index.d.mts";
6
- import type { Merge } from "../../../../utils/index.d.mts";
7
7
  import type DataModel from "../../../common/abstract/data.d.mts";
8
8
 
9
9
  declare global {
@@ -15,8 +15,16 @@ declare global {
15
15
 
16
16
  /**
17
17
  * The arguments to construct the document.
18
- */
19
- type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;
18
+ * @privateRemarks This is off-template, as ActorDelta throws if not provided a valid TokenDocument
19
+ * parent in the construction context for any construction, not just `.create`ion
20
+ */
21
+ interface ConstructorArgs
22
+ extends Identity<
23
+ [
24
+ data: CreateData | undefined,
25
+ context: RequiredProps<Document.ConstructionContext<TokenDocument.Implementation>, "parent">,
26
+ ]
27
+ > {}
20
28
 
21
29
  /**
22
30
  * The documents embedded within `ActorDelta`.
@@ -211,7 +219,7 @@ declare global {
211
219
  type Collection = never;
212
220
 
213
221
  /**
214
- * An instance of `ActorDelta` that comes from the database but failed validation meaining that
222
+ * An instance of `ActorDelta` that comes from the database but failed validation meaning that
215
223
  * its `system` and `_source` could theoretically be anything.
216
224
  */
217
225
  interface Invalid extends Document.Invalid<ActorDelta.Implementation> {}
@@ -280,16 +288,19 @@ declare global {
280
288
 
281
289
  /**
282
290
  * The name override, if any.
291
+ * @defaultValue `null`
283
292
  */
284
293
  name: fields.StringField<{ required: false; nullable: true; initial: null }>;
285
294
 
286
295
  /**
287
296
  * The type override, if any.
297
+ * @defaultValue `null`
288
298
  */
289
299
  type: fields.StringField<{ required: false; nullable: true; initial: null }>;
290
300
 
291
301
  /**
292
302
  * The image override, if any.
303
+ * @defaultValue `null`
293
304
  */
294
305
  img: fields.FilePathField<{ categories: ["IMAGE"]; nullable: true; initial: null; required: false }>;
295
306
 
@@ -313,6 +324,7 @@ declare global {
313
324
 
314
325
  /**
315
326
  * Ownership overrides.
327
+ * @defaultValue `null`
316
328
  */
317
329
  ownership: fields.DocumentOwnershipField<{ required: false; nullable: true; initial: null }>;
318
330
 
@@ -520,6 +532,17 @@ declare global {
520
532
  * @deprecated {@link ActorDelta.Implementation | `ActorDelta.Implementation`}
521
533
  */
522
534
  type ConfiguredInstance = Implementation;
535
+
536
+ /** @internal */
537
+ type _InitializeOptions = NullishProps<{
538
+ /**
539
+ * @remarks Is this initialization part of a {@link Scene.reset | `Scene#reset`} call? (skips further initialization if truthy)
540
+ * @defaultValue `false`
541
+ */
542
+ sceneReset: boolean;
543
+ }>;
544
+
545
+ interface InitializeOptions extends Document.InitializeOptions, _InitializeOptions {}
523
546
  }
524
547
 
525
548
  /**
@@ -535,9 +558,11 @@ declare global {
535
558
  */
536
559
  constructor(...args: ActorDelta.ConstructorArgs);
537
560
 
538
- protected override _configure(options?: { pack?: string | null }): void;
561
+ // options: not null (parameter default only, destructured in super)
562
+ protected override _configure(options?: Document.ConfigureOptions): void;
539
563
 
540
- protected override _initialize(options?: any): void;
564
+ // options: not null (destructured)
565
+ protected override _initialize(options?: ActorDelta.InitializeOptions): void;
541
566
 
542
567
  /** Pass-through the type from the synthetic Actor, if it exists. */
543
568
  _type: string;
@@ -545,17 +570,20 @@ declare global {
545
570
  /**
546
571
  * Apply this ActorDelta to the base Actor and return a synthetic Actor.
547
572
  * @param context - Context to supply to synthetic Actor instantiation.
573
+ * @remarks Forwards `context` to {@link BaseActorDelta.applyDelta | `this.constructor.applyDelta(this, this.parent.baseActor, context)`}
548
574
  */
549
- apply(context: unknown): Actor.Implementation;
575
+ apply(context?: BaseActorDelta.ApplyDeltaContext | null): Actor.Implementation | null;
550
576
 
551
577
  /** @remarks `"The synthetic actor prepares its items in the appropriate context of an actor. The actor delta does not need to prepare its items, and would do so in the incorrect context."` */
552
578
  override prepareEmbeddedDocuments(): void;
553
579
 
580
+ // TODO: accurately type changes and return type
581
+ // changes, options: not null (parameter default only)
554
582
  override updateSource(
555
583
  // Note(LukeAbby): This must be valid for both `new ActorDelta.implementation(actorChanges, { parent: this.parent });` and `super.updateSource`.
556
584
  // However it's likely the overlap between these two types is pretty high.
557
585
  changes?: ActorDelta.Source,
558
- options?: DataModel.UpdateSourceOptions,
586
+ options?: DataModel.UpdateOptions,
559
587
  ): object;
560
588
 
561
589
  override reset(): void;
@@ -589,9 +617,7 @@ declare global {
589
617
  */
590
618
  _handleDeltaCollectionUpdates(doc: Document.Any): void;
591
619
 
592
- /**
593
- * @privateRemarks _onUpdate and _onDelete are all overridden but with no signature changes from BaseActorDelta.
594
- */
620
+ // _onUpdate and _onDelete are all overridden but with no signature changes from BaseActorDelta.
595
621
 
596
622
  protected override _dispatchDescendantDocumentEvents(
597
623
  event: ClientDocument.LifeCycleEventName,
@@ -614,7 +640,7 @@ declare global {
614
640
 
615
641
  /**
616
642
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
617
- * this method must be overriden like so:
643
+ * this method must be overridden like so:
618
644
  * ```typescript
619
645
  * class SwadeActorDelta extends ActorDelta {
620
646
  * protected override _preCreateDescendantDocuments(...args: ActorDelta.PreCreateDescendantDocumentsArgs) {
@@ -632,7 +658,7 @@ declare global {
632
658
 
633
659
  /**
634
660
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
635
- * this method must be overriden like so:
661
+ * this method must be overridden like so:
636
662
  * ```typescript
637
663
  * class GurpsActorDelta extends ActorDelta {
638
664
  * protected override _onCreateDescendantDocuments(...args: ActorDelta.OnCreateDescendantDocumentsArgs) {
@@ -650,7 +676,7 @@ declare global {
650
676
 
651
677
  /**
652
678
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
653
- * this method must be overriden like so:
679
+ * this method must be overridden like so:
654
680
  * ```typescript
655
681
  * class LancerActorDelta extends ActorDelta {
656
682
  * protected override _preUpdateDescendantDocuments(...args: ActorDelta.OnUpdateDescendantDocuments) {
@@ -668,7 +694,7 @@ declare global {
668
694
 
669
695
  /**
670
696
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
671
- * this method must be overriden like so:
697
+ * this method must be overridden like so:
672
698
  * ```typescript
673
699
  * class Ptr2eActorDelta extends ActorDelta {
674
700
  * protected override _onUpdateDescendantDocuments(...args: ActorDelta.OnUpdateDescendantDocumentsArgs) {
@@ -686,7 +712,7 @@ declare global {
686
712
 
687
713
  /**
688
714
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
689
- * this method must be overriden like so:
715
+ * this method must be overridden like so:
690
716
  * ```typescript
691
717
  * class KultActorDelta extends ActorDelta {
692
718
  * protected override _preDeleteDescendantDocuments(...args: ActorDelta.PreDeleteDescendantDocumentsArgs) {
@@ -704,7 +730,7 @@ declare global {
704
730
 
705
731
  /**
706
732
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
707
- * this method must be overriden like so:
733
+ * this method must be overridden like so:
708
734
  * ```typescript
709
735
  * class BladesActorDelta extends ActorDelta {
710
736
  * protected override _onDeleteDescendantDocuments(...args: ActorDelta.OnUpdateDescendantDocuments) {
@@ -720,23 +746,28 @@ declare global {
720
746
  */
721
747
  protected override _onDeleteDescendantDocuments(...args: ActorDelta.OnDeleteDescendantDocumentsArgs): void;
722
748
 
749
+ // context: not null (destructured)
723
750
  static override defaultName(
724
- context: Document.DefaultNameContext<ActorDelta.SubType, NonNullable<ActorDelta.Parent>>,
751
+ context?: Document.DefaultNameContext<"ActorDelta", NonNullable<ActorDelta.Parent>>,
725
752
  ): string;
726
753
 
754
+ /** @remarks `context.parent` is required as creation requires one */
727
755
  static override createDialog(
728
- data: Document.CreateDialogData<ActorDelta.CreateData>,
729
- context: Document.CreateDialogContext<ActorDelta.SubType, NonNullable<ActorDelta.Parent>>,
756
+ data: Document.CreateDialogData<ActorDelta.CreateData> | undefined,
757
+ context: Document.CreateDialogContext<"ActorDelta", NonNullable<ActorDelta.Parent>>,
730
758
  ): Promise<ActorDelta.Stored | null | undefined>;
731
759
 
760
+ // options: not null (parameter default only)
732
761
  static override fromDropData(
733
762
  data: Document.DropData<ActorDelta.Implementation>,
734
- options?: Document.FromDropDataOptions,
763
+ options?: AnyObject,
735
764
  ): Promise<ActorDelta.Implementation | undefined>;
736
765
 
737
766
  static override fromImport(
738
767
  source: ActorDelta.Source,
739
- context?: Document.FromImportContext<ActorDelta.Parent>,
768
+ context?: Document.FromImportContext<ActorDelta.Parent> | null,
740
769
  ): Promise<ActorDelta.Implementation>;
770
+
771
+ override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
741
772
  }
742
773
  }
@@ -1,7 +1,6 @@
1
- import type { AnyObject, InexactPartial, NullishProps, Merge } from "fvtt-types/utils";
1
+ import type { AnyObject, InexactPartial, NullishProps, Merge } from "#utils";
2
2
  import type { documents } from "../../../client-esm/client.d.mts";
3
3
  import type Document from "../../../common/abstract/document.d.mts";
4
- import type EmbeddedCollection from "../../../common/abstract/embedded-collection.d.mts";
5
4
  import type BaseActor from "../../../common/documents/actor.d.mts";
6
5
  import type { fields, PrototypeToken } from "../../../common/data/module.d.mts";
7
6
  import type { ConfiguredActor } from "../../../../configuration/index.d.mts";
@@ -227,7 +226,7 @@ declare global {
227
226
  type Collection = Actors.Configured;
228
227
 
229
228
  /**
230
- * An instance of `Actor` that comes from the database but failed validation meaining that
229
+ * An instance of `Actor` that comes from the database but failed validation meaning that
231
230
  * its `system` and `_source` could theoretically be anything.
232
231
  */
233
232
  interface Invalid<out SubType extends Actor.SubType = Actor.SubType> extends Document.Invalid<OfType<SubType>> {}
@@ -296,16 +295,18 @@ declare global {
296
295
  _id: fields.DocumentIdField;
297
296
 
298
297
  /** The name of this Actor */
299
- name: fields.StringField<{ required: true; blank: false; textSearch: true }>;
298
+ // FIXME: required with no initial, assignment type override required
299
+ name: fields.StringField<{ required: true; blank: false; textSearch: true }, string>;
300
300
 
301
301
  /** An Actor subtype which configures the system data model applied */
302
+ // TODO: required with no initial, needs assignment type override
302
303
  type: fields.DocumentTypeField<typeof BaseActor>;
303
304
 
304
305
  /**
305
306
  * An image file path which provides the artwork for this Actor
306
- * @defaultValue `null`
307
+ * @defaultValue `Actor.DEFAULT_ICON`
307
308
  */
308
- img: fields.FilePathField<{ categories: "IMAGE"[]; initial: (data: unknown) => string }>;
309
+ img: fields.FilePathField<{ categories: ["IMAGE"]; initial: (data: unknown) => string }>;
309
310
 
310
311
  /**
311
312
  * The system data object which is defined by the system template.json model
@@ -315,7 +316,7 @@ declare global {
315
316
 
316
317
  /**
317
318
  * Default Token settings which are used for Tokens created from this Actor
318
- * @defaultValue see {@link PrototypeToken | `PrototypeToken`}
319
+ * @defaultValue see {@linkcode PrototypeToken.Schema}
319
320
  */
320
321
  prototypeToken: fields.EmbeddedDataField<typeof PrototypeToken>;
321
322
 
@@ -508,55 +509,47 @@ declare global {
508
509
  | Document.OnDeleteDescendantDocumentsArgs<Actor.Stored, Actor.DirectDescendant, Actor.Metadata.Embedded>
509
510
  | Item.OnDeleteDescendantDocumentsArgs;
510
511
 
511
- /**
512
- * @deprecated {@link Actor.Database | `Actor.DatabaseOperation`}
513
- */
514
- // eslint-disable-next-line @typescript-eslint/no-deprecated
515
- interface DatabaseOperations extends Document.Database.Operations<Actor.Implementation> {}
516
-
517
- /**
518
- * @deprecated {@link Actor.SubType | `Actor.SubType`}
519
- */
520
- type TypeNames = Actor.SubType;
521
-
522
- /**
523
- * @deprecated {@link Actor.CreateData | `Actor.CreateData`}
524
- */
525
- interface ConstructorData extends Actor.CreateData {}
526
-
527
- /**
528
- * @deprecated {@link Actor.implementation | `Actor.ImplementationClass`}
529
- */
530
- type ConfiguredClass = ImplementationClass;
512
+ interface GetDefaultArtworkReturn {
513
+ img: string;
514
+ texture: GetDefaultArtworkTextureReturn;
515
+ }
531
516
 
532
- /**
533
- * @deprecated {@link Actor.Implementation | `Actor.Implementation`}
534
- */
535
- type ConfiguredInstance = Implementation;
517
+ interface GetDefaultArtworkTextureReturn {
518
+ src: string;
519
+ }
536
520
 
537
521
  type ItemTypes = {
538
- [SubType in Game.Model.TypeNames<"Item">]: Array<Item.OfType<SubType>>;
522
+ [SubType in Item.SubType]: Array<Item.OfType<SubType>>;
539
523
  };
540
524
 
541
- interface RollInitiativeOptions {
525
+ type GetActiveTokensReturn<Document extends boolean | null | undefined> = Document extends true
526
+ ? TokenDocument.Implementation[]
527
+ : Token.Object[];
528
+
529
+ /** @internal */
530
+ type _RollInitiativeOptions = NullishProps<{
542
531
  /**
543
532
  * Create new Combatant entries for Tokens associated with this actor.
544
533
  * @defaultValue `false`
545
534
  */
546
- createCombatants?: boolean;
535
+ createCombatants: boolean;
547
536
 
548
537
  /**
549
538
  * Re-roll the initiative for this Actor if it has already been rolled.
550
539
  * @defaultValue `false`
551
540
  */
552
- rerollInitiative?: boolean;
541
+ rerollInitiative: boolean;
542
+ }> &
543
+ InexactPartial<{
544
+ /**
545
+ * Additional options passed to the Combat#rollInitiative method.
546
+ * @defaultValue `{}`
547
+ * @remarks Can't be `null` as it only has a parameter default
548
+ */
549
+ initiativeOptions: Combat.InitiativeOptions;
550
+ }>;
553
551
 
554
- /**
555
- * Additional options passed to the Combat#rollInitiative method.
556
- * @defaultValue `{}`
557
- */
558
- initiativeOptions?: Combat.InitiativeOptions;
559
- }
552
+ interface RollInitiativeOptions extends _RollInitiativeOptions {}
560
553
 
561
554
  /** @internal */
562
555
  type _ToggleStatusEffectOptions = NullishProps<{
@@ -574,7 +567,63 @@ declare global {
574
567
  */
575
568
  overlay: boolean;
576
569
  }>;
570
+
577
571
  interface ToggleStatusEffectOptions extends _ToggleStatusEffectOptions {}
572
+
573
+ /** @internal */
574
+ type _RequestTokenImagesOptions = NullishProps<{
575
+ /**
576
+ * The name of the compendium the actor is in.
577
+ * @defaultValue `null`
578
+ * @remarks The default comes from the `"requestTokenImages"` socket handler in `dist/database/documents/actor.mjs` where it's the parameter default
579
+ */
580
+ pack: string;
581
+ }>;
582
+
583
+ interface RequestTokenImagesOptions extends _RequestTokenImagesOptions {}
584
+
585
+ /** @internal */
586
+ type _GetDependentTokensOptions = NullishProps<{
587
+ /**
588
+ * A single Scene, or list of Scenes to filter by.
589
+ * @defaultValue `Array.from(this._dependentTokens.keys())`
590
+ */
591
+ scenes: Scene.Implementation | Scene.Implementation[];
592
+
593
+ /**
594
+ * Limit the results to tokens that are linked to the actor.
595
+ * @defaultValue `false`
596
+ */
597
+ linked: boolean;
598
+ }>;
599
+
600
+ interface GetDependentTokensOptions extends _GetDependentTokensOptions {}
601
+
602
+ /**
603
+ * @deprecated {@link Actor.Database | `Actor.DatabaseOperation`}
604
+ */
605
+ // eslint-disable-next-line @typescript-eslint/no-deprecated
606
+ interface DatabaseOperations extends Document.Database.Operations<Actor.Implementation> {}
607
+
608
+ /**
609
+ * @deprecated {@link Actor.SubType | `Actor.SubType`}
610
+ */
611
+ type TypeNames = Actor.SubType;
612
+
613
+ /**
614
+ * @deprecated {@link Actor.CreateData | `Actor.CreateData`}
615
+ */
616
+ interface ConstructorData extends Actor.CreateData {}
617
+
618
+ /**
619
+ * @deprecated {@link Actor.implementation | `Actor.ImplementationClass`}
620
+ */
621
+ type ConfiguredClass = ImplementationClass;
622
+
623
+ /**
624
+ * @deprecated {@link Actor.Implementation | `Actor.Implementation`}
625
+ */
626
+ type ConfiguredInstance = Implementation;
578
627
  }
579
628
 
580
629
  /**
@@ -609,18 +658,23 @@ declare global {
609
658
  */
610
659
  constructor(...args: Actor.ConstructorArgs);
611
660
 
612
- static override metadata: Actor.Metadata;
613
-
614
- protected override _configure(options?: { pack?: string | null }): void;
661
+ // options: not null (parameter default only, destructured in super)
662
+ protected override _configure(options?: Document.ConfigureOptions): void;
615
663
 
616
664
  /**
617
665
  * Maintain a list of Token Documents that represent this Actor, stored by Scene.
666
+ * @remarks Doesn't exist prior to being `defineProperty`'d in {@link Actor._configure | `Actor#_configure`}
618
667
  */
619
- protected _dependentTokens: foundry.utils.IterableWeakMap<Scene.Implementation, TokenDocument.Implementation>;
668
+ protected _dependentTokens?: foundry.utils.IterableWeakMap<
669
+ Scene.Implementation,
670
+ foundry.utils.IterableWeakSet<TokenDocument.Implementation>
671
+ >;
620
672
 
673
+ /** @remarks `||=`s the `prototypeToken`'s `name` and `texture.src` fields with the main actor's values */
674
+ // options: not null (parameter default only)
621
675
  protected override _initializeSource(
622
676
  data: this | Actor.CreateData,
623
- options?: Omit<foundry.abstract.DataModel.DataValidationOptions, "parent">,
677
+ options?: Document.InitializeSourceOptions,
624
678
  ): Actor.Source;
625
679
 
626
680
  /**
@@ -638,6 +692,7 @@ declare global {
638
692
  * A cached array of image paths which can be used for this Actor's token.
639
693
  * Null if the list has not yet been populated.
640
694
  * @defaultValue `null`
695
+ * @private
641
696
  */
642
697
  protected _tokenImages: string[] | null;
643
698
 
@@ -650,7 +705,7 @@ declare global {
650
705
  /**
651
706
  * Provide a thumbnail image path used to represent this document.
652
707
  */
653
- get thumbnail(): this["img"];
708
+ get thumbnail(): string;
654
709
 
655
710
  /**
656
711
  * Provide an object which organizes all embedded Item instances by their type
@@ -670,7 +725,7 @@ declare global {
670
725
  /**
671
726
  * An array of ActiveEffect instances which are present on the Actor which have a limited duration.
672
727
  */
673
- get temporaryEffects(): EmbeddedCollection<ActiveEffect.Implementation, Actor.Implementation>;
728
+ get temporaryEffects(): ActiveEffect.Implementation[];
674
729
 
675
730
  /**
676
731
  * Return a reference to the TokenDocument which owns this Actor as a synthetic override
@@ -694,13 +749,14 @@ declare global {
694
749
  *
695
750
  * @param linked - Limit results to Tokens which are linked to the Actor. Otherwise return all
696
751
  * Tokens even those which are not linked. (default: `false`)
697
- * @param document - Return the Document instance rather than the PlaceableObject (default: `false`)
752
+ * @param document - Return the Document instance rather than the PlaceableObject
753
+ * (default: `false`)
698
754
  * @returns An array of Token instances in the current Scene which reference this Actor.
699
755
  */
700
- getActiveTokens<ReturnDocument extends boolean | undefined = undefined>(
701
- linked?: boolean,
756
+ getActiveTokens<ReturnDocument extends boolean | null | undefined = false>(
757
+ linked?: boolean | null,
702
758
  document?: ReturnDocument,
703
- ): ReturnDocument extends true ? TokenDocument.Implementation[] : Token.Object[];
759
+ ): Actor.GetActiveTokensReturn<ReturnDocument>;
704
760
 
705
761
  /**
706
762
  * Get all ActiveEffects that may apply to this Actor.
@@ -721,7 +777,11 @@ declare global {
721
777
  * @param data - Additional data, such as x, y, rotation, etc. for the created token data (default: `{}`)
722
778
  * @returns The created TokenData instance
723
779
  */
724
- getTokenDocument(data?: TokenDocument.CreateData): Promise<TokenDocument.Implementation>;
780
+ // data, options: not null (parameter defaults only)
781
+ getTokenDocument(
782
+ data?: TokenDocument.CreateData,
783
+ options?: Document.ConstructionContext<TokenDocument.Parent>,
784
+ ): Promise<TokenDocument.Implementation>;
725
785
 
726
786
  /**
727
787
  * Get an Array of Token images which could represent this Actor
@@ -737,7 +797,13 @@ declare global {
737
797
  * @param isBar - Whether the new value is part of an attribute bar, or just a direct value (default: `true`)
738
798
  * @returns The updated Actor document
739
799
  */
740
- modifyTokenAttribute(attribute: string, value: number, isDelta: boolean, isBar: boolean): Promise<this | undefined>;
800
+ modifyTokenAttribute(
801
+ attribute: string,
802
+ // TODO: tighten Combatant.Resource with the justification of this being simply `number`
803
+ value: number,
804
+ isDelta?: boolean,
805
+ isBar?: boolean,
806
+ ): Promise<this | undefined>;
741
807
 
742
808
  override prepareData(): void;
743
809
 
@@ -751,6 +817,7 @@ declare global {
751
817
  * @param options - Configuration for how initiative for this Actor is rolled.
752
818
  * @returns A promise which resolves to the Combat document once rolls are complete.
753
819
  */
820
+ // options: not null (destructured)
754
821
  rollInitiative(options?: Actor.RollInitiativeOptions): Promise<void>;
755
822
 
756
823
  /**
@@ -772,59 +839,44 @@ declare global {
772
839
  /**
773
840
  * Request wildcard token images from the server and return them.
774
841
  * @param actorId - The actor whose prototype token contains the wildcard image path.
775
- * @internal
842
+ * @private
776
843
  */
777
- protected static _requestTokenImages(
778
- actorId: string,
779
- options?: {
780
- /** The name of the compendium the actor is in. */
781
- pack: string;
782
- },
783
- ): Promise<string[]>;
844
+ // options: not null (parameter default only)
845
+ protected static _requestTokenImages(actorId: string, options?: Actor.RequestTokenImagesOptions): Promise<string[]>;
784
846
 
785
847
  /**
786
848
  * Get this actor's dependent tokens.
787
849
  * If the actor is a synthetic token actor, only the exact Token which it represents will be returned.
788
850
  */
789
- getDependentTokens(
790
- options?: InexactPartial<{
791
- /**
792
- * A single Scene, or list of Scenes to filter by.
793
- */
794
- scenes: Scene.Implementation | Scene.Implementation[];
795
- /**
796
- * Limit the results to tokens that are linked to the actor.
797
- * @defaultValue `false`
798
- */
799
- linked: boolean;
800
- }>,
801
- ): TokenDocument.Implementation[];
851
+ // options: not null (destructured)
852
+ getDependentTokens(options?: Actor.GetDependentTokensOptions): TokenDocument.Implementation[];
802
853
 
803
854
  /**
804
855
  * Register a token as a dependent of this actor.
805
856
  * @param token - The Token
857
+ * @internal
806
858
  */
807
859
  protected _registerDependantToken(token: TokenDocument.Implementation): void;
808
860
 
809
861
  /**
810
862
  * Remove a token from this actor's dependents.
811
863
  * @param token - The Token
864
+ * @internal
812
865
  */
813
866
  protected _unregisterDependentToken(token: TokenDocument.Implementation): void;
814
867
 
815
868
  /**
816
869
  * Prune a whole scene from this actor's dependent tokens.
817
870
  * @param scene - The scene
871
+ * @internal
818
872
  */
819
873
  protected _unregisterDependentScene(scene: Scene.Implementation): void;
820
874
 
821
- /**
822
- * @privateRemarks _preCreate and _onUpdate are all overridden but with no signature changes from BaseActor.
823
- */
875
+ // _onUpdate is overridden but with no signature changes from BaseActor.
824
876
 
825
877
  /**
826
878
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
827
- * this method must be overriden like so:
879
+ * this method must be overridden like so:
828
880
  * ```typescript
829
881
  * class GurpsActor extends Actor {
830
882
  * protected override _onCreateDescendantDocuments(...args: Actor.OnCreateDescendantDocumentsArgs) {
@@ -842,7 +894,7 @@ declare global {
842
894
 
843
895
  /**
844
896
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
845
- * this method must be overriden like so:
897
+ * this method must be overridden like so:
846
898
  * ```typescript
847
899
  * class Ptr2eActor extends Actor {
848
900
  * protected override _onUpdateDescendantDocuments(...args: Actor.OnUpdateDescendantDocumentsArgs) {
@@ -860,7 +912,7 @@ declare global {
860
912
 
861
913
  /**
862
914
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
863
- * this method must be overriden like so:
915
+ * this method must be overridden like so:
864
916
  * ```typescript
865
917
  * class BladesActor extends Actor {
866
918
  * protected override _onDeleteDescendantDocuments(...args: Actor.OnUpdateDescendantDocuments) {
@@ -878,7 +930,6 @@ declare global {
878
930
 
879
931
  /**
880
932
  * Additional workflows to perform when any descendant document within this Actor changes.
881
- * @internal
882
933
  */
883
934
  protected _onEmbeddedDocumentChange(): void;
884
935
 
@@ -886,11 +937,9 @@ declare global {
886
937
  * Update the active TokenDocument instances which represent this Actor.
887
938
  * @param update - The update delta.
888
939
  * @param options - The update context.
940
+ * @remarks Forwards to {@link Token._onUpdateBaseActor | `Token#_onUpdateBaseActor`}
889
941
  */
890
- protected _updateDependentTokens(
891
- update: TokenDocument.UpdateData,
892
- options: TokenDocument.Database.UpdateOperation,
893
- ): void;
942
+ protected _updateDependentTokens(update: Actor.UpdateData, options: Actor.Database.UpdateOperation): void;
894
943
 
895
944
  /*
896
945
  * After this point these are not really overridden methods.
@@ -906,7 +955,7 @@ declare global {
906
955
 
907
956
  /**
908
957
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
909
- * this method must be overriden like so:
958
+ * this method must be overridden like so:
910
959
  * ```typescript
911
960
  * class SwadeActor extends Actor {
912
961
  * protected override _preCreateDescendantDocuments(...args: Actor.PreCreateDescendantDocumentsArgs) {
@@ -924,7 +973,7 @@ declare global {
924
973
 
925
974
  /**
926
975
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
927
- * this method must be overriden like so:
976
+ * this method must be overridden like so:
928
977
  * ```typescript
929
978
  * class LancerActor extends Actor {
930
979
  * protected override _preUpdateDescendantDocuments(...args: Actor.OnUpdateDescendantDocuments) {
@@ -942,7 +991,7 @@ declare global {
942
991
 
943
992
  /**
944
993
  * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
945
- * this method must be overriden like so:
994
+ * this method must be overridden like so:
946
995
  * ```typescript
947
996
  * class KultActor extends Actor {
948
997
  * protected override _preDeleteDescendantDocuments(...args: Actor.PreDeleteDescendantDocumentsArgs) {
@@ -958,21 +1007,26 @@ declare global {
958
1007
  */
959
1008
  protected override _preDeleteDescendantDocuments(...args: Actor.PreDeleteDescendantDocumentsArgs): void;
960
1009
 
961
- static override defaultName(context?: Document.DefaultNameContext<Actor.SubType, Actor.Parent>): string;
1010
+ // context: not null (destructured)
1011
+ static override defaultName(context?: Document.DefaultNameContext<"Actor", Actor.Parent>): string;
962
1012
 
1013
+ // data: not null (parameter default only), context: not null (destructured)
963
1014
  static override createDialog(
964
1015
  data?: Document.CreateDialogData<Actor.CreateData>,
965
- context?: Document.CreateDialogContext<Actor.SubType, Actor.Parent>,
1016
+ context?: Document.CreateDialogContext<"Actor", Actor.Parent>,
966
1017
  ): Promise<Actor.Stored | null | undefined>;
967
1018
 
1019
+ // options: not null (parameter default only)
968
1020
  static override fromDropData(
969
1021
  data: Document.DropData<Actor.Implementation>,
970
- options?: Document.FromDropDataOptions,
1022
+ options?: AnyObject,
971
1023
  ): Promise<Actor.Implementation | undefined>;
972
1024
 
973
1025
  static override fromImport(
974
1026
  source: Actor.Source,
975
- context?: Document.FromImportContext<Actor.Parent>,
1027
+ context?: Document.FromImportContext<Actor.Parent> | null,
976
1028
  ): Promise<Actor.Implementation>;
1029
+
1030
+ override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
977
1031
  }
978
1032
  }