@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (543) hide show
  1. package/README.md +6 -3
  2. package/package.json +40 -18
  3. package/src/configuration/configuration.d.mts +24 -23
  4. package/src/configuration/documents.d.mts +295 -0
  5. package/src/configuration/globals.d.mts +8 -2
  6. package/src/configuration/index.d.mts +1 -0
  7. package/src/foundry/client/apps/app.d.mts +121 -119
  8. package/src/foundry/client/apps/av/av-config.d.mts +13 -8
  9. package/src/foundry/client/apps/av/cameras.d.mts +11 -11
  10. package/src/foundry/client/apps/dice/dice-config.d.mts +22 -8
  11. package/src/foundry/client/apps/form.d.mts +112 -94
  12. package/src/foundry/client/apps/forms/actor.d.mts +22 -12
  13. package/src/foundry/client/apps/forms/adventure-exporter.d.mts +13 -8
  14. package/src/foundry/client/apps/forms/adventure-importer.d.mts +15 -7
  15. package/src/foundry/client/apps/forms/base-sheet.d.mts +14 -7
  16. package/src/foundry/client/apps/forms/card-config.d.mts +17 -9
  17. package/src/foundry/client/apps/forms/cards-config.d.mts +13 -14
  18. package/src/foundry/client/apps/forms/combat-config.d.mts +7 -7
  19. package/src/foundry/client/apps/forms/combatant-config.d.mts +4 -4
  20. package/src/foundry/client/apps/forms/default-sheets-config.d.mts +1 -1
  21. package/src/foundry/client/apps/forms/effect-config.d.mts +6 -6
  22. package/src/foundry/client/apps/forms/folder-config.d.mts +5 -5
  23. package/src/foundry/client/apps/forms/fonts.d.mts +42 -35
  24. package/src/foundry/client/apps/forms/grid-config.d.mts +11 -11
  25. package/src/foundry/client/apps/forms/image-popout.d.mts +28 -22
  26. package/src/foundry/client/apps/forms/item.d.mts +6 -6
  27. package/src/foundry/client/apps/forms/journal-page-sheet.d.mts +17 -15
  28. package/src/foundry/client/apps/forms/journal-sheet.d.mts +46 -37
  29. package/src/foundry/client/apps/forms/macro-config.d.mts +6 -6
  30. package/src/foundry/client/apps/forms/measure-template.d.mts +8 -8
  31. package/src/foundry/client/apps/forms/ownership.d.mts +5 -5
  32. package/src/foundry/client/apps/forms/playlist-config.d.mts +7 -9
  33. package/src/foundry/client/apps/forms/playlist-sound-config.d.mts +6 -6
  34. package/src/foundry/client/apps/forms/roll-table-config.d.mts +9 -10
  35. package/src/foundry/client/apps/forms/scene-config.d.mts +39 -39
  36. package/src/foundry/client/apps/forms/sheet-config.d.mts +8 -8
  37. package/src/foundry/client/apps/forms/user-config.d.mts +11 -11
  38. package/src/foundry/client/apps/hud/chatbubble.d.mts +14 -9
  39. package/src/foundry/client/apps/hud/container.d.mts +3 -3
  40. package/src/foundry/client/apps/hud/controls.d.mts +124 -84
  41. package/src/foundry/client/apps/hud/hotbar.d.mts +12 -12
  42. package/src/foundry/client/apps/hud/hud.d.mts +4 -4
  43. package/src/foundry/client/apps/hud/menu.d.mts +6 -6
  44. package/src/foundry/client/apps/hud/navigation.d.mts +11 -11
  45. package/src/foundry/client/apps/hud/pause.d.mts +7 -7
  46. package/src/foundry/client/apps/hud/players.d.mts +11 -11
  47. package/src/foundry/client/apps/i18n.d.mts +31 -27
  48. package/src/foundry/client/apps/placeables/drawing-config.d.mts +41 -33
  49. package/src/foundry/client/apps/placeables/drawing-hud.d.mts +4 -4
  50. package/src/foundry/client/apps/placeables/index.d.mts +0 -2
  51. package/src/foundry/client/apps/placeables/note-config.d.mts +27 -17
  52. package/src/foundry/client/apps/placeables/tile-config.d.mts +23 -10
  53. package/src/foundry/client/apps/placeables/tile-hud.d.mts +8 -8
  54. package/src/foundry/client/apps/placeables/token-config.d.mts +84 -63
  55. package/src/foundry/client/apps/placeables/token-hud.d.mts +10 -10
  56. package/src/foundry/client/apps/placeables/wall-config.d.mts +19 -16
  57. package/src/foundry/client/apps/sidebar/apps/chat-popout.d.mts +5 -5
  58. package/src/foundry/client/apps/sidebar/apps/client-settings.d.mts +2 -2
  59. package/src/foundry/client/apps/sidebar/apps/compendium.d.mts +13 -10
  60. package/src/foundry/client/apps/sidebar/apps/invitation-links.d.mts +3 -3
  61. package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts +1 -1
  62. package/src/foundry/client/apps/sidebar/apps/module-management.d.mts +6 -6
  63. package/src/foundry/client/apps/sidebar/apps/permission-config.d.mts +6 -6
  64. package/src/foundry/client/apps/sidebar/apps/support-details.d.mts +33 -28
  65. package/src/foundry/client/apps/sidebar/apps/tours-management.d.mts +1 -1
  66. package/src/foundry/client/apps/sidebar/apps/world-config.d.mts +12 -9
  67. package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts +40 -32
  68. package/src/foundry/client/apps/sidebar/document-directory.d.mts +44 -37
  69. package/src/foundry/client/apps/sidebar/package-configuration.d.mts +3 -3
  70. package/src/foundry/client/apps/sidebar/sidebar-tab.d.mts +3 -3
  71. package/src/foundry/client/apps/sidebar/sidebar.d.mts +7 -7
  72. package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts +4 -4
  73. package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts +4 -4
  74. package/src/foundry/client/apps/sidebar/tabs/chat-log.d.mts +34 -29
  75. package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.mts +15 -15
  76. package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.mts +21 -12
  77. package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts +4 -4
  78. package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.mts +4 -4
  79. package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts +8 -8
  80. package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts +21 -21
  81. package/src/foundry/client/apps/sidebar/tabs/roll-table-directory.d.mts +4 -4
  82. package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts +6 -6
  83. package/src/foundry/client/apps/sidebar/tabs/settings.d.mts +12 -12
  84. package/src/foundry/client/apps/templates.d.mts +2 -2
  85. package/src/foundry/client/av/clients/simplepeer.d.mts +4 -4
  86. package/src/foundry/client/av/settings.d.mts +16 -13
  87. package/src/foundry/client/config.d.mts +1982 -1823
  88. package/src/foundry/client/core/document-index.d.mts +12 -4
  89. package/src/foundry/client/core/hooks.d.mts +0 -2
  90. package/src/foundry/client/core/image.d.mts +13 -11
  91. package/src/foundry/client/core/issues.d.mts +11 -6
  92. package/src/foundry/client/core/keybindings.d.mts +3 -3
  93. package/src/foundry/client/core/nue.d.mts +1 -1
  94. package/src/foundry/client/core/packages.d.mts +393 -63
  95. package/src/foundry/client/core/settings.d.mts +34 -12
  96. package/src/foundry/client/core/socket.d.mts +2 -2
  97. package/src/foundry/client/core/sorting.d.mts +6 -6
  98. package/src/foundry/client/core/time.d.mts +6 -3
  99. package/src/foundry/client/core/tooltip.d.mts +1 -1
  100. package/src/foundry/client/core/tour.d.mts +58 -49
  101. package/src/foundry/client/core/tours.d.mts +1 -1
  102. package/src/foundry/client/core/utils.d.mts +3 -3
  103. package/src/foundry/client/core/workers.d.mts +24 -17
  104. package/src/foundry/client/data/abstract/canvas-document.d.mts +9 -15
  105. package/src/foundry/client/data/abstract/client-document.d.mts +133 -172
  106. package/src/foundry/client/data/abstract/directory-collection-mixin.d.mts +14 -36
  107. package/src/foundry/client/data/abstract/document-collection.d.mts +89 -65
  108. package/src/foundry/client/data/abstract/world-collection.d.mts +47 -53
  109. package/src/foundry/client/data/collections/actors.d.mts +24 -31
  110. package/src/foundry/client/data/collections/cards.d.mts +10 -6
  111. package/src/foundry/client/data/collections/combats.d.mts +12 -8
  112. package/src/foundry/client/data/collections/compendium-collection.d.mts +79 -66
  113. package/src/foundry/client/data/collections/compendium-folders.d.mts +6 -6
  114. package/src/foundry/client/data/collections/compendium-packs.d.mts +4 -4
  115. package/src/foundry/client/data/collections/fog.d.mts +10 -6
  116. package/src/foundry/client/data/collections/folder.d.mts +15 -10
  117. package/src/foundry/client/data/collections/items.d.mts +11 -7
  118. package/src/foundry/client/data/collections/journal.d.mts +16 -10
  119. package/src/foundry/client/data/collections/macros.d.mts +15 -22
  120. package/src/foundry/client/data/collections/messages.d.mts +14 -10
  121. package/src/foundry/client/data/collections/playlists.d.mts +12 -9
  122. package/src/foundry/client/data/collections/scenes.d.mts +19 -31
  123. package/src/foundry/client/data/collections/settings.d.mts +10 -6
  124. package/src/foundry/client/data/collections/tables.d.mts +11 -7
  125. package/src/foundry/client/data/collections/users.d.mts +14 -11
  126. package/src/foundry/client/data/documents/active-effect.d.mts +652 -88
  127. package/src/foundry/client/data/documents/actor-delta.d.mts +672 -28
  128. package/src/foundry/client/data/documents/actor.d.mts +722 -60
  129. package/src/foundry/client/data/documents/adventure.d.mts +482 -49
  130. package/src/foundry/client/data/documents/ambient-light.d.mts +426 -21
  131. package/src/foundry/client/data/documents/ambient-sound.d.mts +474 -15
  132. package/src/foundry/client/data/documents/card.d.mts +570 -39
  133. package/src/foundry/client/data/documents/cards.d.mts +742 -78
  134. package/src/foundry/client/data/documents/chat-message.d.mts +578 -45
  135. package/src/foundry/client/data/documents/combat.d.mts +701 -71
  136. package/src/foundry/client/data/documents/combatant.d.mts +510 -28
  137. package/src/foundry/client/data/documents/drawing.d.mts +543 -16
  138. package/src/foundry/client/data/documents/fog-exploration.d.mts +413 -27
  139. package/src/foundry/client/data/documents/folder.d.mts +461 -40
  140. package/src/foundry/client/data/documents/item.d.mts +679 -25
  141. package/src/foundry/client/data/documents/journal-entry-page.d.mts +587 -21
  142. package/src/foundry/client/data/documents/journal-entry.d.mts +621 -20
  143. package/src/foundry/client/data/documents/macro.d.mts +530 -25
  144. package/src/foundry/client/data/documents/measured-template.d.mts +480 -16
  145. package/src/foundry/client/data/documents/note.d.mts +495 -18
  146. package/src/foundry/client/data/documents/playlist-sound.d.mts +429 -27
  147. package/src/foundry/client/data/documents/playlist.d.mts +666 -75
  148. package/src/foundry/client/data/documents/region-behavior.d.mts +468 -38
  149. package/src/foundry/client/data/documents/region.d.mts +661 -35
  150. package/src/foundry/client/data/documents/scene.d.mts +986 -149
  151. package/src/foundry/client/data/documents/setting.d.mts +397 -15
  152. package/src/foundry/client/data/documents/table-result.d.mts +479 -17
  153. package/src/foundry/client/data/documents/table.d.mts +663 -80
  154. package/src/foundry/client/data/documents/tile.d.mts +502 -16
  155. package/src/foundry/client/data/documents/token.d.mts +1114 -90
  156. package/src/foundry/client/data/documents/user.d.mts +495 -27
  157. package/src/foundry/client/data/documents/wall.d.mts +550 -15
  158. package/src/foundry/client/game.d.mts +58 -92
  159. package/src/foundry/client/head.d.mts +5 -6
  160. package/src/foundry/client/hooks.d.mts +237 -221
  161. package/src/foundry/client/pixi/board.d.mts +95 -89
  162. package/src/foundry/client/pixi/core/containers/base-canvas-group.d.mts +6 -5
  163. package/src/foundry/client/pixi/core/containers/cached-container.d.mts +5 -5
  164. package/src/foundry/client/pixi/core/containers/full-canvas-container.d.mts +2 -2
  165. package/src/foundry/client/pixi/core/containers/point-source-mesh.d.mts +3 -3
  166. package/src/foundry/client/pixi/core/containers/quad-mesh.d.mts +3 -3
  167. package/src/foundry/client/pixi/core/containers/quadtree.d.mts +23 -21
  168. package/src/foundry/client/pixi/core/containers/sprite-mesh.d.mts +5 -5
  169. package/src/foundry/client/pixi/core/containers/unbound-container.d.mts +5 -5
  170. package/src/foundry/client/pixi/core/interaction/canvas-animation.d.mts +57 -51
  171. package/src/foundry/client/pixi/core/interaction/control-icon.d.mts +3 -3
  172. package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts +7 -7
  173. package/src/foundry/client/pixi/core/interaction/ping.d.mts +19 -11
  174. package/src/foundry/client/pixi/core/interaction/pings/chevron.d.mts +7 -2
  175. package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts +29 -23
  176. package/src/foundry/client/pixi/core/interaction/render-flags.d.mts +83 -38
  177. package/src/foundry/client/pixi/core/interaction/resize-handle.d.mts +3 -3
  178. package/src/foundry/client/pixi/core/interaction/targets.d.mts +9 -9
  179. package/src/foundry/client/pixi/core/loader.d.mts +8 -8
  180. package/src/foundry/client/pixi/core/shapes/limited-angle-polygon.d.mts +9 -4
  181. package/src/foundry/client/pixi/core/shapes/polygon-mesher.d.mts +3 -3
  182. package/src/foundry/client/pixi/core/shapes/precise-text.d.mts +3 -3
  183. package/src/foundry/client/pixi/core/shapes/ray.d.mts +23 -17
  184. package/src/foundry/client/pixi/core/shapes/source-polygon.d.mts +19 -14
  185. package/src/foundry/client/pixi/extensions/circle.d.mts +1 -1
  186. package/src/foundry/client/pixi/extensions/observable-transform.d.mts +3 -3
  187. package/src/foundry/client/pixi/groups/effects.d.mts +4 -4
  188. package/src/foundry/client/pixi/groups/environment.d.mts +5 -5
  189. package/src/foundry/client/pixi/groups/hidden.d.mts +3 -3
  190. package/src/foundry/client/pixi/groups/interface.d.mts +6 -6
  191. package/src/foundry/client/pixi/groups/overlay.d.mts +3 -3
  192. package/src/foundry/client/pixi/groups/primary.d.mts +11 -11
  193. package/src/foundry/client/pixi/groups/rendered.d.mts +3 -3
  194. package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts +3 -3
  195. package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts +13 -13
  196. package/src/foundry/client/pixi/layers/base/placeables-layer.d.mts +279 -233
  197. package/src/foundry/client/pixi/layers/controls/cursor.d.mts +17 -8
  198. package/src/foundry/client/pixi/layers/controls/door.d.mts +26 -14
  199. package/src/foundry/client/pixi/layers/controls/layer.d.mts +89 -79
  200. package/src/foundry/client/pixi/layers/controls/ruler.d.mts +121 -96
  201. package/src/foundry/client/pixi/layers/effects/background-effects.d.mts +4 -5
  202. package/src/foundry/client/pixi/layers/effects/coloration-effects.d.mts +6 -4
  203. package/src/foundry/client/pixi/layers/effects/darkness-effects.d.mts +7 -4
  204. package/src/foundry/client/pixi/layers/effects/illumination-effects.d.mts +19 -16
  205. package/src/foundry/client/pixi/layers/effects/visibility.d.mts +101 -84
  206. package/src/foundry/client/pixi/layers/effects/weather/particles/effect.d.mts +13 -4
  207. package/src/foundry/client/pixi/layers/effects/weather/particles/leaves.d.mts +31 -2
  208. package/src/foundry/client/pixi/layers/effects/weather-effects.d.mts +134 -59
  209. package/src/foundry/client/pixi/layers/grid/highlight.d.mts +13 -3
  210. package/src/foundry/client/pixi/layers/grid/layer.d.mts +89 -87
  211. package/src/foundry/client/pixi/layers/grid/mesh.d.mts +36 -15
  212. package/src/foundry/client/pixi/layers/masks/depth.d.mts +3 -3
  213. package/src/foundry/client/pixi/layers/masks/occlusion.d.mts +4 -4
  214. package/src/foundry/client/pixi/layers/masks/vision.d.mts +6 -6
  215. package/src/foundry/client/pixi/layers/placeables/drawings.d.mts +15 -11
  216. package/src/foundry/client/pixi/layers/placeables/lighting.d.mts +11 -10
  217. package/src/foundry/client/pixi/layers/placeables/notes.d.mts +47 -28
  218. package/src/foundry/client/pixi/layers/placeables/regions.d.mts +25 -12
  219. package/src/foundry/client/pixi/layers/placeables/sounds.d.mts +81 -63
  220. package/src/foundry/client/pixi/layers/placeables/templates.d.mts +10 -11
  221. package/src/foundry/client/pixi/layers/placeables/tiles.d.mts +28 -17
  222. package/src/foundry/client/pixi/layers/placeables/tokens.d.mts +67 -46
  223. package/src/foundry/client/pixi/layers/placeables/walls.d.mts +50 -51
  224. package/src/foundry/client/pixi/perception/clockwise-sweep.d.mts +22 -16
  225. package/src/foundry/client/pixi/perception/detection-mode.d.mts +123 -51
  226. package/src/foundry/client/pixi/perception/fog.d.mts +34 -19
  227. package/src/foundry/client/pixi/perception/perception-manager.d.mts +137 -137
  228. package/src/foundry/client/pixi/perception/vision-mode.d.mts +92 -67
  229. package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts +3 -3
  230. package/src/foundry/client/pixi/placeable.d.mts +241 -146
  231. package/src/foundry/client/pixi/placeables/drawing.d.mts +260 -134
  232. package/src/foundry/client/pixi/placeables/light.d.mts +204 -66
  233. package/src/foundry/client/pixi/placeables/note.d.mts +150 -55
  234. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts +7 -6
  235. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts +3 -3
  236. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts +2 -2
  237. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts +4 -4
  238. package/src/foundry/client/pixi/placeables/region.d.mts +219 -110
  239. package/src/foundry/client/pixi/placeables/sound.d.mts +211 -68
  240. package/src/foundry/client/pixi/placeables/template.d.mts +186 -100
  241. package/src/foundry/client/pixi/placeables/tile.d.mts +211 -142
  242. package/src/foundry/client/pixi/placeables/token.d.mts +911 -568
  243. package/src/foundry/client/pixi/placeables/wall.d.mts +253 -130
  244. package/src/foundry/client/pixi/webgl/extensions/batch-renderer.d.mts +27 -5
  245. package/src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.mts +3 -3
  246. package/src/foundry/client/pixi/webgl/helpers/framebuffer-snapshot.d.mts +3 -3
  247. package/src/foundry/client/pixi/webgl/helpers/smooth-noise.d.mts +13 -5
  248. package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts +6 -6
  249. package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts +2 -2
  250. package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts +5 -5
  251. package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts +4 -4
  252. package/src/foundry/client/pixi/webgl/shaders/filters/base-mask-filter.d.mts +3 -3
  253. package/src/foundry/client/pixi/webgl/shaders/filters/blur.d.mts +5 -5
  254. package/src/foundry/client/pixi/webgl/shaders/filters/effects-masking.d.mts +6 -3
  255. package/src/foundry/client/pixi/webgl/shaders/filters/environment.d.mts +3 -3
  256. package/src/foundry/client/pixi/webgl/shaders/filters/glow-overlay.d.mts +4 -4
  257. package/src/foundry/client/pixi/webgl/shaders/filters/invisibility.d.mts +3 -3
  258. package/src/foundry/client/pixi/webgl/shaders/filters/outline-overlay.d.mts +4 -4
  259. package/src/foundry/client/pixi/webgl/shaders/filters/transition.d.mts +6 -6
  260. package/src/foundry/client/pixi/webgl/shaders/filters/visibility.d.mts +8 -5
  261. package/src/foundry/client/pixi/webgl/shaders/filters/vision-mask-filter.d.mts +3 -3
  262. package/src/foundry/client/pixi/webgl/shaders/filters/void.d.mts +3 -3
  263. package/src/foundry/client/pixi/webgl/shaders/filters/weather-occlusion-masks.d.mts +4 -4
  264. package/src/foundry/client/pixi/webgl/shaders/fragment-channel-mixin.d.mts +1 -1
  265. package/src/foundry/client/pixi/webgl/shaders/grid/grid.d.mts +4 -4
  266. package/src/foundry/client/pixi/webgl/shaders/lighting/background-lighting.d.mts +3 -3
  267. package/src/foundry/client/pixi/webgl/shaders/lighting/base-lighting.d.mts +3 -3
  268. package/src/foundry/client/pixi/webgl/shaders/lighting/coloration-lighting.d.mts +3 -3
  269. package/src/foundry/client/pixi/webgl/shaders/lighting/darkness-lighting.d.mts +3 -3
  270. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/bewitching-wave.d.mts +5 -5
  271. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/black-hole.d.mts +3 -3
  272. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/chroma.d.mts +3 -3
  273. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/emanation.d.mts +3 -3
  274. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/energy-field.d.mts +3 -3
  275. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fairy-light.d.mts +6 -6
  276. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/flame.d.mts +5 -5
  277. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fog.d.mts +3 -3
  278. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/force-grid.d.mts +3 -3
  279. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/ghost-light.d.mts +5 -5
  280. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/hexa-dome.d.mts +3 -3
  281. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/light-dome.d.mts +3 -3
  282. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/magical-gloom.d.mts +3 -3
  283. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/pulse.d.mts +5 -5
  284. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/radial-rainbow.d.mts +3 -3
  285. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/revolving-light.d.mts +3 -3
  286. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/roiling-mass.d.mts +3 -3
  287. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/siren-light.d.mts +5 -5
  288. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/smoke-patch.d.mts +6 -5
  289. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/star-light.d.mts +3 -3
  290. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/sunburst.d.mts +5 -5
  291. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/swirling-rainbow.d.mts +4 -3
  292. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/torch.d.mts +5 -5
  293. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/vortex.d.mts +5 -5
  294. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/wave.d.mts +5 -5
  295. package/src/foundry/client/pixi/webgl/shaders/lighting/illumination-lighting.d.mts +3 -3
  296. package/src/foundry/client/pixi/webgl/shaders/region/adjust-darkness-level.d.mts +7 -7
  297. package/src/foundry/client/pixi/webgl/shaders/region/base.d.mts +4 -4
  298. package/src/foundry/client/pixi/webgl/shaders/region/highlight.d.mts +3 -3
  299. package/src/foundry/client/pixi/webgl/shaders/samplers/base-sampler.d.mts +4 -4
  300. package/src/foundry/client/pixi/webgl/shaders/samplers/baseline-illumination.d.mts +3 -3
  301. package/src/foundry/client/pixi/webgl/shaders/samplers/color-adjustment.d.mts +5 -5
  302. package/src/foundry/client/pixi/webgl/shaders/samplers/depth.d.mts +3 -3
  303. package/src/foundry/client/pixi/webgl/shaders/samplers/fog-of-war.d.mts +3 -3
  304. package/src/foundry/client/pixi/webgl/shaders/samplers/occlusion.d.mts +3 -3
  305. package/src/foundry/client/pixi/webgl/shaders/samplers/primary.d.mts +4 -4
  306. package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts +4 -6
  307. package/src/foundry/client/pixi/webgl/shaders/vision/background-vision.d.mts +3 -3
  308. package/src/foundry/client/pixi/webgl/shaders/vision/base-vision.d.mts +3 -3
  309. package/src/foundry/client/pixi/webgl/shaders/vision/coloration-vision.d.mts +3 -3
  310. package/src/foundry/client/pixi/webgl/shaders/vision/effects/amplification.d.mts +3 -3
  311. package/src/foundry/client/pixi/webgl/shaders/vision/effects/wave.d.mts +5 -5
  312. package/src/foundry/client/pixi/webgl/shaders/vision/illumination-vision.d.mts +3 -3
  313. package/src/foundry/client/pixi/webgl/shaders/weather/base-weather.d.mts +14 -15
  314. package/src/foundry/client/pixi/webgl/shaders/weather/effect.d.mts +20 -27
  315. package/src/foundry/client/pixi/webgl/shaders/weather/fog.d.mts +5 -5
  316. package/src/foundry/client/pixi/webgl/shaders/weather/rain.d.mts +5 -5
  317. package/src/foundry/client/pixi/webgl/shaders/weather/snow.d.mts +5 -5
  318. package/src/foundry/client/pixi/workers/texture-worker.d.mts +5 -5
  319. package/src/foundry/client/tours/setup-tour.d.mts +15 -10
  320. package/src/foundry/client/ui/dialog.d.mts +3 -3
  321. package/src/foundry/client/ui/dragdrop.d.mts +33 -27
  322. package/src/foundry/client/ui/editor.d.mts +29 -21
  323. package/src/foundry/client/ui/filepicker.d.mts +42 -37
  324. package/src/foundry/client/ui/filter.d.mts +60 -48
  325. package/src/foundry/client/ui/forms.d.mts +22 -22
  326. package/src/foundry/client/ui/prosemirror.d.mts +15 -7
  327. package/src/foundry/client/ui/secrets.d.mts +43 -28
  328. package/src/foundry/client/ui/tabs.d.mts +40 -33
  329. package/src/foundry/client-esm/_module.d.mts +5 -5
  330. package/src/foundry/client-esm/_types.d.mts +2 -1
  331. package/src/foundry/client-esm/applications/api/application.d.mts +93 -31
  332. package/src/foundry/client-esm/applications/api/dialog.d.mts +23 -23
  333. package/src/foundry/client-esm/applications/api/document-sheet.d.mts +85 -32
  334. package/src/foundry/client-esm/applications/api/handlebars-application.d.mts +1 -1
  335. package/src/foundry/client-esm/applications/apps/av/camera-popout.d.mts +1 -1
  336. package/src/foundry/client-esm/applications/apps/av/cameras.d.mts +2 -2
  337. package/src/foundry/client-esm/applications/apps/compendium-art-config.d.mts +4 -5
  338. package/src/foundry/client-esm/applications/apps/file-picker.d.mts +2 -2
  339. package/src/foundry/client-esm/applications/apps/grid-config.d.mts +3 -3
  340. package/src/foundry/client-esm/applications/apps/image-popout.d.mts +1 -1
  341. package/src/foundry/client-esm/applications/apps/permission-config.d.mts +1 -1
  342. package/src/foundry/client-esm/applications/dice/roll-resolver.d.mts +4 -4
  343. package/src/foundry/client-esm/applications/elements/file-picker.d.mts +1 -1
  344. package/src/foundry/client-esm/applications/elements/prosemirror-editor.d.mts +1 -1
  345. package/src/foundry/client-esm/applications/hud/drawing-hud.d.mts +1 -1
  346. package/src/foundry/client-esm/applications/hud/tile-hud.d.mts +1 -1
  347. package/src/foundry/client-esm/applications/hud/token-hud.d.mts +1 -1
  348. package/src/foundry/client-esm/applications/sheets/active-effect-config.d.mts +3 -3
  349. package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts +2 -2
  350. package/src/foundry/client-esm/applications/sheets/adventure-exporter.d.mts +3 -3
  351. package/src/foundry/client-esm/applications/sheets/adventure-importer.d.mts +3 -3
  352. package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts +5 -5
  353. package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts +4 -4
  354. package/src/foundry/client-esm/applications/sheets/card-config.d.mts +3 -3
  355. package/src/foundry/client-esm/applications/sheets/cards-config.d.mts +2 -2
  356. package/src/foundry/client-esm/applications/sheets/combatant-config.d.mts +3 -3
  357. package/src/foundry/client-esm/applications/sheets/drawing-config.d.mts +3 -3
  358. package/src/foundry/client-esm/applications/sheets/folder-config.d.mts +3 -3
  359. package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts +2 -2
  360. package/src/foundry/client-esm/applications/sheets/journal/journal-entry-category-config.d.mts +3 -3
  361. package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-sheet.d.mts +3 -3
  362. package/src/foundry/client-esm/applications/sheets/journal/journal-entry-sheet.d.mts +3 -3
  363. package/src/foundry/client-esm/applications/sheets/macro-config.d.mts +3 -3
  364. package/src/foundry/client-esm/applications/sheets/note-config.d.mts +3 -3
  365. package/src/foundry/client-esm/applications/sheets/playlist-config.d.mts +3 -3
  366. package/src/foundry/client-esm/applications/sheets/playlist-sound-config.d.mts +3 -3
  367. package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts +3 -3
  368. package/src/foundry/client-esm/applications/sheets/region-config.d.mts +3 -3
  369. package/src/foundry/client-esm/applications/sheets/roll-table-config.d.mts +3 -3
  370. package/src/foundry/client-esm/applications/sheets/roll-table-sheet.d.mts +3 -3
  371. package/src/foundry/client-esm/applications/sheets/scene-config.d.mts +3 -3
  372. package/src/foundry/client-esm/applications/sheets/table-result-config.d.mts +3 -3
  373. package/src/foundry/client-esm/applications/sheets/template-config.d.mts +3 -3
  374. package/src/foundry/client-esm/applications/sheets/tile-config.d.mts +3 -3
  375. package/src/foundry/client-esm/applications/sheets/token/mixin.d.mts +1 -0
  376. package/src/foundry/client-esm/applications/sheets/token/token-config.d.mts +3 -3
  377. package/src/foundry/client-esm/applications/sheets/user-config.d.mts +4 -4
  378. package/src/foundry/client-esm/applications/sheets/wall-config.d.mts +3 -3
  379. package/src/foundry/client-esm/applications/sidebar/apps/chat-popout.d.mts +1 -1
  380. package/src/foundry/client-esm/applications/sidebar/sidebar-tab.d.mts +2 -2
  381. package/src/foundry/client-esm/applications/sidebar/tabs/actor-directory.d.mts +1 -1
  382. package/src/foundry/client-esm/applications/sidebar/tabs/cards-directory.d.mts +1 -1
  383. package/src/foundry/client-esm/applications/sidebar/tabs/combat-tracker.d.mts +242 -1
  384. package/src/foundry/client-esm/applications/sidebar/tabs/item-directory.d.mts +1 -1
  385. package/src/foundry/client-esm/applications/sidebar/tabs/journal-directory.d.mts +1 -1
  386. package/src/foundry/client-esm/applications/sidebar/tabs/macro-directory.d.mts +1 -1
  387. package/src/foundry/client-esm/applications/sidebar/tabs/playlist-directory.d.mts +1 -1
  388. package/src/foundry/client-esm/applications/sidebar/tabs/roll-table-directory.d.mts +1 -1
  389. package/src/foundry/client-esm/applications/sidebar/tabs/scene-directory.d.mts +1 -1
  390. package/src/foundry/client-esm/applications/ui/region-legend.d.mts +2 -2
  391. package/src/foundry/client-esm/applications/ux/context-menu.d.mts +56 -36
  392. package/src/foundry/client-esm/audio/_types.d.mts +2 -0
  393. package/src/foundry/client-esm/audio/biquad.d.mts +76 -26
  394. package/src/foundry/client-esm/audio/cache.d.mts +31 -20
  395. package/src/foundry/client-esm/audio/convolver.d.mts +47 -25
  396. package/src/foundry/client-esm/audio/helper.d.mts +124 -80
  397. package/src/foundry/client-esm/audio/sound.d.mts +202 -97
  398. package/src/foundry/client-esm/audio/timeout.d.mts +28 -12
  399. package/src/foundry/client-esm/canvas/edges/collision.d.mts +12 -4
  400. package/src/foundry/client-esm/canvas/edges/edge.d.mts +13 -8
  401. package/src/foundry/client-esm/canvas/edges/edges.d.mts +3 -2
  402. package/src/foundry/client-esm/canvas/edges/vertex.d.mts +12 -10
  403. package/src/foundry/client-esm/canvas/regions/geometry.d.mts +14 -7
  404. package/src/foundry/client-esm/canvas/regions/mesh.d.mts +25 -14
  405. package/src/foundry/client-esm/canvas/regions/polygon-tree.d.mts +50 -19
  406. package/src/foundry/client-esm/canvas/regions/shape.d.mts +45 -34
  407. package/src/foundry/client-esm/canvas/scene-manager.d.mts +7 -6
  408. package/src/foundry/client-esm/canvas/smaa/blend.d.mts +14 -3
  409. package/src/foundry/client-esm/canvas/smaa/edges.d.mts +25 -3
  410. package/src/foundry/client-esm/canvas/smaa/smaa.d.mts +119 -20
  411. package/src/foundry/client-esm/canvas/smaa/weights.d.mts +26 -3
  412. package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts +69 -39
  413. package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts +66 -40
  414. package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts +78 -19
  415. package/src/foundry/client-esm/canvas/sources/point-darkness-source.d.mts +37 -20
  416. package/src/foundry/client-esm/canvas/sources/point-effect-source.d.mts +39 -20
  417. package/src/foundry/client-esm/canvas/sources/point-light-source.d.mts +41 -12
  418. package/src/foundry/client-esm/canvas/sources/point-movement-source.d.mts +15 -4
  419. package/src/foundry/client-esm/canvas/sources/point-sound-source.d.mts +29 -14
  420. package/src/foundry/client-esm/canvas/sources/point-vision-source.d.mts +84 -39
  421. package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts +115 -41
  422. package/src/foundry/client-esm/canvas/tokens/ring-config.d.mts +83 -21
  423. package/src/foundry/client-esm/canvas/tokens/ring-data.d.mts +66 -93
  424. package/src/foundry/client-esm/canvas/tokens/ring.d.mts +146 -51
  425. package/src/foundry/client-esm/client.d.mts +16 -16
  426. package/src/foundry/client-esm/data/_module.d.mts +1 -1
  427. package/src/foundry/client-esm/data/calendar.d.mts +26 -39
  428. package/src/foundry/client-esm/data/client-backend.d.mts +6 -6
  429. package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts +1 -1
  430. package/src/foundry/client-esm/data/region-behaviors/base.d.mts +5 -5
  431. package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts +2 -2
  432. package/src/foundry/client-esm/data/terrain-data.d.mts +1 -1
  433. package/src/foundry/client-esm/dice/parser.d.mts +5 -27
  434. package/src/foundry/client-esm/dice/roll.d.mts +63 -80
  435. package/src/foundry/client-esm/dice/terms/coin.d.mts +4 -8
  436. package/src/foundry/client-esm/dice/terms/dice.d.mts +85 -64
  437. package/src/foundry/client-esm/dice/terms/die.d.mts +7 -7
  438. package/src/foundry/client-esm/dice/terms/fate.d.mts +5 -5
  439. package/src/foundry/client-esm/dice/terms/function.d.mts +13 -16
  440. package/src/foundry/client-esm/dice/terms/numeric.d.mts +2 -4
  441. package/src/foundry/client-esm/dice/terms/operator.d.mts +1 -1
  442. package/src/foundry/client-esm/dice/terms/parenthetical.d.mts +8 -9
  443. package/src/foundry/client-esm/dice/terms/pool.d.mts +13 -28
  444. package/src/foundry/client-esm/dice/terms/string.d.mts +3 -3
  445. package/src/foundry/client-esm/dice/terms/term.d.mts +10 -5
  446. package/src/foundry/client-esm/dice/twister.d.mts +3 -3
  447. package/src/foundry/client-esm/documents/_module.d.mts +1 -1
  448. package/src/foundry/client-esm/helpers/_types.d.mts +12 -46
  449. package/src/foundry/client-esm/helpers/compendium-art.d.mts +57 -4
  450. package/src/foundry/client-esm/packages/_module.d.mts +1 -1
  451. package/src/foundry/client-esm/packages/_types.d.mts +2 -0
  452. package/src/foundry/client-esm/utils/_module.d.mts +1 -1
  453. package/src/foundry/client-esm/utils/_types.d.mts +2 -1
  454. package/src/foundry/common/_types.d.mts +1 -1
  455. package/src/foundry/common/abstract/_module.d.mts +1 -0
  456. package/src/foundry/common/abstract/_types.d.mts +60 -54
  457. package/src/foundry/common/abstract/backend.d.mts +28 -16
  458. package/src/foundry/common/abstract/data.d.mts +133 -116
  459. package/src/foundry/common/abstract/document.d.mts +1233 -440
  460. package/src/foundry/common/abstract/embedded-collection.d.mts +2 -2
  461. package/src/foundry/common/abstract/singleton-collection.d.mts +1 -1
  462. package/src/foundry/common/abstract/type-data.d.mts +35 -43
  463. package/src/foundry/common/config.d.mts +3 -3
  464. package/src/foundry/common/constants.d.mts +27 -26
  465. package/src/foundry/common/data/_types.d.mts +2 -0
  466. package/src/foundry/common/data/data.d.mts +189 -87
  467. package/src/foundry/common/data/fields.d.mts +579 -258
  468. package/src/foundry/common/data/validation-failure.d.mts +9 -4
  469. package/src/foundry/common/documents/_types.d.mts +16 -9
  470. package/src/foundry/common/documents/active-effect.d.mts +280 -180
  471. package/src/foundry/common/documents/actor-delta.d.mts +317 -70
  472. package/src/foundry/common/documents/actor.d.mts +304 -103
  473. package/src/foundry/common/documents/adventure.d.mts +254 -140
  474. package/src/foundry/common/documents/ambient-light.d.mts +267 -76
  475. package/src/foundry/common/documents/ambient-sound.d.mts +267 -110
  476. package/src/foundry/common/documents/card.d.mts +267 -176
  477. package/src/foundry/common/documents/cards.d.mts +299 -128
  478. package/src/foundry/common/documents/chat-message.d.mts +276 -160
  479. package/src/foundry/common/documents/combat.d.mts +300 -91
  480. package/src/foundry/common/documents/combatant.d.mts +283 -88
  481. package/src/foundry/common/documents/drawing.d.mts +286 -207
  482. package/src/foundry/common/documents/fog-exploration.d.mts +258 -72
  483. package/src/foundry/common/documents/folder.d.mts +248 -85
  484. package/src/foundry/common/documents/item.d.mts +305 -101
  485. package/src/foundry/common/documents/journal-entry-page.d.mts +279 -190
  486. package/src/foundry/common/documents/journal-entry.d.mts +294 -70
  487. package/src/foundry/common/documents/macro.d.mts +254 -134
  488. package/src/foundry/common/documents/measured-template.d.mts +293 -137
  489. package/src/foundry/common/documents/note.d.mts +274 -151
  490. package/src/foundry/common/documents/playlist-sound.d.mts +260 -96
  491. package/src/foundry/common/documents/playlist.d.mts +279 -122
  492. package/src/foundry/common/documents/region-behavior.d.mts +305 -64
  493. package/src/foundry/common/documents/region.d.mts +309 -90
  494. package/src/foundry/common/documents/roll-table.d.mts +286 -104
  495. package/src/foundry/common/documents/scene.d.mts +276 -344
  496. package/src/foundry/common/documents/setting.d.mts +229 -55
  497. package/src/foundry/common/documents/table-result.d.mts +267 -96
  498. package/src/foundry/common/documents/tile.d.mts +301 -172
  499. package/src/foundry/common/documents/token.d.mts +350 -452
  500. package/src/foundry/common/documents/user.d.mts +256 -146
  501. package/src/foundry/common/documents/wall.d.mts +272 -157
  502. package/src/foundry/common/grid/_types.d.mts +2 -0
  503. package/src/foundry/common/grid/base.d.mts +58 -37
  504. package/src/foundry/common/grid/hexagonal.d.mts +19 -19
  505. package/src/foundry/common/grid/square.d.mts +1 -1
  506. package/src/foundry/common/packages/_module.d.mts +5 -5
  507. package/src/foundry/common/packages/_types.d.mts +2 -0
  508. package/src/foundry/common/packages/base-module.d.mts +6 -24
  509. package/src/foundry/common/packages/base-package.d.mts +18 -16
  510. package/src/foundry/common/packages/base-system.d.mts +6 -78
  511. package/src/foundry/common/packages/base-world.d.mts +7 -60
  512. package/src/foundry/common/packages/sub-types.d.mts +1 -1
  513. package/src/foundry/common/primitives/array.d.mts +3 -3
  514. package/src/foundry/common/primitives/math.d.mts +7 -1
  515. package/src/foundry/common/primitives/number.d.mts +1 -1
  516. package/src/foundry/common/primitives/set.d.mts +17 -14
  517. package/src/foundry/common/prosemirror/_types.d.mts +2 -0
  518. package/src/foundry/common/prosemirror/dropdown.d.mts +1 -1
  519. package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts +1 -1
  520. package/src/foundry/common/prosemirror/menu.d.mts +3 -3
  521. package/src/foundry/common/prosemirror/plugin.d.mts +1 -1
  522. package/src/foundry/common/prosemirror/schema/index.d.mts +0 -1
  523. package/src/foundry/common/prosemirror/util.d.mts +1 -1
  524. package/src/foundry/common/utils/bitmask.d.mts +4 -1
  525. package/src/foundry/common/utils/collection.d.mts +59 -24
  526. package/src/foundry/common/utils/event-emitter.d.mts +46 -19
  527. package/src/foundry/common/utils/helpers.d.mts +13 -13
  528. package/src/foundry/common/utils/http.d.mts +2 -2
  529. package/src/foundry/common/utils/string-tree.d.mts +45 -39
  530. package/src/foundry/common/utils/word-tree.d.mts +10 -23
  531. package/src/tsconfig.json +1 -5
  532. package/src/types/augments/pixi.d.mts +28 -28
  533. package/src/types/config.d.mts +12 -12
  534. package/src/types/documentConfiguration.d.mts +282 -597
  535. package/src/types/lib.d.mts +4 -4
  536. package/src/types/workers/image-compressor.d.mts +1 -1
  537. package/src/utils/index.d.mts +255 -60
  538. package/tsconfig.json +29 -0
  539. package/tsconfig.main.json +8 -0
  540. package/tsconfig.miscellaneous.json +16 -0
  541. package/src/foundry/client/apps/placeables/light-config.d.mts +0 -100
  542. package/src/foundry/client/apps/placeables/sound-config.d.mts +0 -44
  543. package/src/foundry/common/documents/module.d.mts +0 -35
@@ -1,40 +1,489 @@
1
- import type { ValueOf } from "fvtt-types/utils";
2
- import type Document from "../../../common/abstract/document.d.mts";
3
- import type BaseCombatant from "../../../common/documents/combatant.d.mts";
1
+ import type { ConfiguredCombatant } from "fvtt-types/configuration";
2
+ import type { Merge, ValueOf } from "fvtt-types/utils";
3
+ import type { documents } from "#client-esm/client.d.mts";
4
+ import type Document from "#common/abstract/document.d.mts";
5
+ import type { DataSchema } from "#common/data/fields.d.mts";
6
+ import type BaseCombatant from "#common/documents/combatant.d.mts";
7
+
8
+ import fields = foundry.data.fields;
4
9
 
5
10
  declare global {
6
11
  namespace Combatant {
7
- type Metadata = Document.MetadataFor<Combatant>;
12
+ /**
13
+ * The document's name.
14
+ */
15
+ type Name = "Combatant";
16
+
17
+ /**
18
+ * The arguments to construct the document.
19
+ */
20
+ type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;
21
+
22
+ /**
23
+ * The documents embedded within `Combatant`.
24
+ */
25
+ type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;
26
+
27
+ /**
28
+ * The implementation of the `Combatant` document instance configured through `CONFIG.Combatant.documentClass` in Foundry and
29
+ * {@link DocumentClassConfig | `DocumentClassConfig`} or {@link ConfiguredCombatant | `fvtt-types/configuration/ConfiguredCombatant`} in fvtt-types.
30
+ */
31
+ type Implementation = Document.ImplementationFor<Name>;
32
+
33
+ /**
34
+ * The implementation of the `Combatant` document configured through `CONFIG.Combatant.documentClass` in Foundry and
35
+ * {@link DocumentClassConfig | `DocumentClassConfig`} in fvtt-types.
36
+ */
37
+ type ImplementationClass = Document.ImplementationClassFor<Name>;
38
+
39
+ /**
40
+ * A document's metadata is special information about the document ranging anywhere from its name,
41
+ * whether it's indexed, or to the permissions a user has over it.
42
+ */
43
+ interface Metadata
44
+ extends Merge<
45
+ Document.Metadata.Default,
46
+ Readonly<{
47
+ name: "Combatant";
48
+ collection: "combatants";
49
+ label: string;
50
+ labelPlural: string;
51
+ isEmbedded: true;
52
+ hasTypeData: true;
53
+ schemaVersion: string;
54
+ permissions: Metadata.Permissions;
55
+ }>
56
+ > {}
57
+
58
+ namespace Metadata {
59
+ /**
60
+ * The permissions for whether a certain user can create, update, or delete this document.
61
+ */
62
+ interface Permissions {
63
+ create(user: User.Internal.Implementation, doc: Implementation): boolean;
64
+ update(user: User.Internal.Implementation, doc: Implementation, data: UpdateData): boolean;
65
+ }
66
+ }
67
+
68
+ /**
69
+ * Allowed subtypes of `Combatant`. This is configured through various methods. Modern Foundry
70
+ * recommends registering using [Data Models](https://foundryvtt.com/article/system-data-models/)
71
+ * under {@link CONFIG.Combatant.dataModels | `CONFIG.Combatant.dataModels`}. This corresponds to
72
+ * fvtt-type's {@link DataModelConfig | `DataModelConfig`}.
73
+ *
74
+ * Subtypes can also be registered through a `template.json` though this is discouraged.
75
+ * The corresponding fvtt-type configs are {@link SourceConfig | `SourceConfig`} and
76
+ * {@link DataConfig | `DataConfig`}.
77
+ */
78
+ type SubType = Game.Model.TypeNames<"Combatant">;
79
+
80
+ /**
81
+ * `ConfiguredSubTypes` represents the subtypes a user explicitly registered. This excludes
82
+ * subtypes like the Foundry builtin subtype `"base"` and the catch-all subtype for arbitrary
83
+ * module subtypes `${string}.${string}`.
84
+ *
85
+ * @see {@link SubType} for more information.
86
+ */
87
+ type ConfiguredSubTypes = Document.ConfiguredSubTypesOf<"Combatant">;
88
+
89
+ /**
90
+ * `Known` represents the types of `Combatant` that a user explicitly registered.
91
+ *
92
+ * @see {@link ConfiguredSubTypes} for more information.
93
+ */
94
+ type Known = Combatant.OfType<Combatant.ConfiguredSubTypes>;
95
+
96
+ /**
97
+ * `OfType` returns an instance of `Combatant` with the corresponding type. This works with both the
98
+ * builtin `Combatant` class or a custom subclass if that is set up in
99
+ * {@link ConfiguredCombatant | `fvtt-types/configuration/ConfiguredCombatant`}.
100
+ */
101
+ // eslint-disable-next-line @typescript-eslint/no-restricted-types
102
+ type OfType<Type extends SubType> = Document.Internal.OfType<ConfiguredCombatant<Type>, Combatant<Type>>;
103
+
104
+ /**
105
+ * `SystemOfType` returns the system property for a specific `Combatant` subtype.
106
+ */
107
+ type SystemOfType<Type extends SubType> = Document.Internal.SystemOfType<_SystemMap, Type>;
108
+
109
+ /**
110
+ * @internal
111
+ */
112
+ interface _SystemMap extends Document.Internal.SystemMap<"Combatant"> {}
113
+
114
+ /**
115
+ * A document's parent is something that can contain it.
116
+ * For example an `Item` can be contained by an `Actor` which makes `Actor` one of its possible parents.
117
+ */
118
+ type Parent = Combat.Implementation | null;
119
+
120
+ /**
121
+ * A document's descendants are any child documents, grandchild documents, etc.
122
+ * This is a union of all instances, or never if the document doesn't have any descendants.
123
+ */
124
+ type Descendant = never;
125
+
126
+ /**
127
+ * A document's descendants are any child documents, grandchild documents, etc.
128
+ * This is a union of all classes, or never if the document doesn't have any descendants.
129
+ */
130
+ type DescendantClass = never;
131
+
132
+ /**
133
+ * Types of `CompendiumCollection` this document might be contained in.
134
+ * Note that `this.pack` will always return a string; this is the type for `game.packs.get(this.pack)`
135
+ */
136
+ // Note: Takes any document in the heritage chain (i.e. itself or any parent, transitive or not) that can be contained in a compendium.
137
+ type Pack = never;
138
+
139
+ /**
140
+ * An embedded document is a document contained in another.
141
+ * For example an `Item` can be contained by an `Actor` which means `Item` can be embedded in `Actor`.
142
+ *
143
+ * If this is `never` it is because there are no embeddable documents (or there's a bug!).
144
+ */
145
+ type Embedded = never;
146
+
147
+ /**
148
+ * The name of the world or embedded collection this document can find itself in.
149
+ * For example an `Item` is always going to be inside a collection with a key of `items`.
150
+ * This is a fixed string per document type and is primarily useful for {@link ClientDocumentMixin | `Descendant Document Events`}.
151
+ */
152
+ type ParentCollectionName = Metadata["collection"];
153
+
154
+ /**
155
+ * The world collection that contains this document type. Will be `never` if none exists.
156
+ */
157
+ type CollectionClass = never;
158
+
159
+ /**
160
+ * The world collection that contains this document type. Will be `never` if none exists.
161
+ */
162
+ type Collection = never;
163
+
164
+ /**
165
+ * An instance of `Combatant` that comes from the database but failed validation meaining that
166
+ * its `system` and `_source` could theoretically be anything.
167
+ */
168
+ interface Invalid<out SubType extends Combatant.SubType = Combatant.SubType>
169
+ extends Document.Invalid<OfType<SubType>> {}
170
+
171
+ /**
172
+ * An instance of `Combatant` that comes from the database.
173
+ */
174
+ interface Stored<out SubType extends Combatant.SubType = Combatant.SubType>
175
+ extends Document.Stored<OfType<SubType>> {}
176
+
177
+ /**
178
+ * The data put in {@link Combatant._source | `Combatant#_source`}. This data is what was
179
+ * persisted to the database and therefore it must be valid JSON.
180
+ *
181
+ * For example a {@link fields.SetField | `SetField`} is persisted to the database as an array
182
+ * but initialized as a {@link Set | `Set`}.
183
+ */
184
+ interface Source extends fields.SchemaField.SourceData<Schema> {}
185
+
186
+ /**
187
+ * @deprecated {@link Combatant.Source | `Combatant.Source`}
188
+ */
189
+ type PersistedData = Source;
190
+
191
+ /**
192
+ * The data necessary to create a document. Used in places like {@link Combatant.create | `Combatant.create`}
193
+ * and {@link Combatant | `new Combatant(...)`}.
194
+ *
195
+ * For example a {@link fields.SetField | `SetField`} can accept any {@link Iterable | `Iterable`}
196
+ * with the right values. This means you can pass a `Set` instance, an array of values,
197
+ * a generator, or any other iterable.
198
+ */
199
+ interface CreateData extends fields.SchemaField.CreateData<Schema> {}
200
+
201
+ /**
202
+ * The data after a {@link foundry.abstract.Document | `Document`} has been initialized, for example
203
+ * {@link Combatant.name | `Combatant#name`}.
204
+ *
205
+ * This is data transformed from {@link Combatant.Source | `Combatant.Source`} and turned into more
206
+ * convenient runtime data structures. For example a {@link fields.SetField | `SetField`} is
207
+ * persisted to the database as an array of values but at runtime it is a `Set` instance.
208
+ */
209
+ interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
210
+
211
+ /**
212
+ * The data used to update a document, for example {@link Combatant.update | `Combatant#update`}.
213
+ * It is a distinct type from {@link Combatant.CreateData | `DeepPartial<Combatant.CreateData>`} because
214
+ * it has different rules for `null` and `undefined`.
215
+ */
216
+ interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
217
+
218
+ /**
219
+ * The schema for {@link Combatant | `Combatant`}. This is the source of truth for how an Combatant document
220
+ * must be structured.
221
+ *
222
+ * Foundry uses this schema to validate the structure of the {@link Combatant | `Combatant`}. For example
223
+ * a {@link fields.StringField | `StringField`} will enforce that the value is a string. More
224
+ * complex fields like {@link fields.SetField | `SetField`} goes through various conversions
225
+ * starting as an array in the database, initialized as a set, and allows updates with any
226
+ * iterable.
227
+ */
228
+
229
+ interface Schema extends DataSchema {
230
+ /**
231
+ * The _id which uniquely identifies this Combatant embedded document
232
+ * @defaultValue `null`
233
+ */
234
+ _id: fields.DocumentIdField;
235
+
236
+ type: fields.DocumentTypeField<typeof BaseCombatant, { initial: typeof foundry.CONST.BASE_DOCUMENT_TYPE }>;
237
+
238
+ system: fields.TypeDataField<typeof BaseCombatant>;
239
+
240
+ /**
241
+ * The _id of an Actor associated with this Combatant
242
+ * @defaultValue `null`
243
+ */
244
+ actorId: fields.ForeignDocumentField<
245
+ typeof documents.BaseActor,
246
+ { label: "COMBAT.CombatantActor"; idOnly: true }
247
+ >;
248
+
249
+ /**
250
+ * The _id of a Token associated with this Combatant
251
+ * @defaultValue `null`
252
+ */
253
+ tokenId: fields.ForeignDocumentField<
254
+ typeof documents.BaseToken,
255
+ { label: "COMBAT.CombatantToken"; idOnly: true }
256
+ >;
257
+
258
+ /**
259
+ * @defaultValue `null`
260
+ */
261
+ sceneId: fields.ForeignDocumentField<
262
+ typeof documents.BaseScene,
263
+ { label: "COMBAT.CombatantScene"; idOnly: true }
264
+ >;
265
+
266
+ /**
267
+ * A customized name which replaces the name of the Token in the tracker
268
+ * @defaultValue `""`
269
+ */
270
+ name: fields.StringField<{ label: "COMBAT.CombatantName"; textSearch: true }>;
271
+
272
+ /**
273
+ * A customized image which replaces the Token image in the tracker
274
+ * @defaultValue `null`
275
+ */
276
+ img: fields.FilePathField<{ categories: "IMAGE"[]; label: "COMBAT.CombatantImage" }>;
277
+
278
+ /**
279
+ * The initiative score for the Combatant which determines its turn order
280
+ * @defaultValue `null`
281
+ */
282
+ initiative: fields.NumberField<{ label: "COMBAT.CombatantInitiative" }>;
283
+
284
+ /**
285
+ * Is this Combatant currently hidden?
286
+ * @defaultValue `false`
287
+ */
288
+ hidden: fields.BooleanField<{ label: "COMBAT.CombatantHidden" }>;
289
+
290
+ /**
291
+ * Has this Combatant been defeated?
292
+ * @defaultValue `false`
293
+ */
294
+ defeated: fields.BooleanField<{ label: "COMBAT.CombatantDefeated" }>;
295
+
296
+ /**
297
+ * An object of optional key/value flags
298
+ * @defaultValue `{}`
299
+ */
300
+ flags: fields.ObjectField.FlagsField<Name>;
301
+
302
+ _stats: fields.DocumentStatsField;
303
+ }
304
+
305
+ namespace Database {
306
+ /** Options passed along in Get operations for Combatants */
307
+ interface Get extends foundry.abstract.types.DatabaseGetOperation<Combatant.Parent> {}
308
+
309
+ /** Options passed along in Create operations for Combatants */
310
+ interface Create<Temporary extends boolean | undefined = boolean | undefined>
311
+ extends foundry.abstract.types.DatabaseCreateOperation<Combatant.CreateData, Combatant.Parent, Temporary> {
312
+ combatTurn?: number;
313
+ turnEvents?: boolean;
314
+ }
315
+
316
+ /** Options passed along in Delete operations for Combatants */
317
+ interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<Combatant.Parent> {
318
+ combatTurn?: number;
319
+ turnEvents?: boolean;
320
+ }
321
+
322
+ /** Options passed along in Update operations for Combatants */
323
+ interface Update extends foundry.abstract.types.DatabaseUpdateOperation<Combatant.UpdateData, Combatant.Parent> {
324
+ combatTurn?: number;
325
+ turnEvents?: boolean;
326
+ }
327
+
328
+ /** Operation for {@link Combatant.createDocuments | `Combatant.createDocuments`} */
329
+ interface CreateDocumentsOperation<Temporary extends boolean | undefined>
330
+ extends Document.Database.CreateOperation<Combatant.Database.Create<Temporary>> {}
331
+
332
+ /** Operation for {@link Combatant.updateDocuments | `Combatant.updateDocuments`} */
333
+ interface UpdateDocumentsOperation
334
+ extends Document.Database.UpdateDocumentsOperation<Combatant.Database.Update> {}
335
+
336
+ /** Operation for {@link Combatant.deleteDocuments | `Combatant.deleteDocuments`} */
337
+ interface DeleteDocumentsOperation
338
+ extends Document.Database.DeleteDocumentsOperation<Combatant.Database.Delete> {}
339
+
340
+ /** Operation for {@link Combatant.create | `Combatant.create`} */
341
+ interface CreateOperation<Temporary extends boolean | undefined>
342
+ extends Document.Database.CreateOperation<Combatant.Database.Create<Temporary>> {}
343
+
344
+ /** Operation for {@link Combatant.update | `Combatant#update`} */
345
+ interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}
346
+
347
+ interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}
348
+
349
+ /** Options for {@link Combatant.get | `Combatant.get`} */
350
+ interface GetOptions extends Document.Database.GetOptions {}
351
+
352
+ /** Options for {@link Combatant._preCreate | `Combatant#_preCreate`} */
353
+ interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}
354
+
355
+ /** Options for {@link Combatant._onCreate | `Combatant#_onCreate`} */
356
+ interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}
357
+
358
+ /** Operation for {@link Combatant._preCreateOperation | `Combatant._preCreateOperation`} */
359
+ interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<Combatant.Database.Create> {}
360
+
361
+ /** Operation for {@link Combatant._onCreateOperation | `Combatant#_onCreateOperation`} */
362
+ interface OnCreateOperation extends Combatant.Database.Create {}
363
+
364
+ /** Options for {@link Combatant._preUpdate | `Combatant#_preUpdate`} */
365
+ interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}
366
+
367
+ /** Options for {@link Combatant._onUpdate | `Combatant#_onUpdate`} */
368
+ interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}
369
+
370
+ /** Operation for {@link Combatant._preUpdateOperation | `Combatant._preUpdateOperation`} */
371
+ interface PreUpdateOperation extends Combatant.Database.Update {}
372
+
373
+ /** Operation for {@link Combatant._onUpdateOperation | `Combatant._preUpdateOperation`} */
374
+ interface OnUpdateOperation extends Combatant.Database.Update {}
375
+
376
+ /** Options for {@link Combatant._preDelete | `Combatant#_preDelete`} */
377
+ interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}
8
378
 
9
- type ConfiguredClass = Document.ConfiguredClassForName<"Combatant">;
10
- type ConfiguredInstance = Document.ConfiguredInstanceForName<"Combatant">;
379
+ /** Options for {@link Combatant._onDelete | `Combatant#_onDelete`} */
380
+ interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}
11
381
 
382
+ /** Options for {@link Combatant._preDeleteOperation | `Combatant#_preDeleteOperation`} */
383
+ interface PreDeleteOperation extends Combatant.Database.Delete {}
384
+
385
+ /** Options for {@link Combatant._onDeleteOperation | `Combatant#_onDeleteOperation`} */
386
+ interface OnDeleteOperation extends Combatant.Database.Delete {}
387
+
388
+ /** Context for {@link Combatant._onDeleteOperation | `Combatant._onDeleteOperation`} */
389
+ interface OnDeleteDocumentsContext extends Document.ModificationContext<Combatant.Parent> {}
390
+
391
+ /** Context for {@link Combatant._onCreateDocuments | `Combatant._onCreateDocuments`} */
392
+ interface OnCreateDocumentsContext extends Document.ModificationContext<Combatant.Parent> {}
393
+
394
+ /** Context for {@link Combatant._onUpdateDocuments | `Combatant._onUpdateDocuments`} */
395
+ interface OnUpdateDocumentsContext extends Document.ModificationContext<Combatant.Parent> {}
396
+
397
+ /**
398
+ * Options for {@link Combatant._preCreateDescendantDocuments | `Combatant#_preCreateDescendantDocuments`}
399
+ * and {@link Combatant._onCreateDescendantDocuments | `Combatant#_onCreateDescendantDocuments`}
400
+ */
401
+ interface CreateOptions extends Document.Database.CreateOptions<Combatant.Database.Create> {}
402
+
403
+ /**
404
+ * Options for {@link Combatant._preUpdateDescendantDocuments | `Combatant#_preUpdateDescendantDocuments`}
405
+ * and {@link Combatant._onUpdateDescendantDocuments | `Combatant#_onUpdateDescendantDocuments`}
406
+ */
407
+ interface UpdateOptions extends Document.Database.UpdateOptions<Combatant.Database.Update> {}
408
+
409
+ /**
410
+ * Options for {@link Combatant._preDeleteDescendantDocuments | `Combatant#_preDeleteDescendantDocuments`}
411
+ * and {@link Combatant._onDeleteDescendantDocuments | `Combatant#_onDeleteDescendantDocuments`}
412
+ */
413
+ interface DeleteOptions extends Document.Database.DeleteOptions<Combatant.Database.Delete> {}
414
+ }
415
+
416
+ /**
417
+ * The flags that are available for this document in the form `{ [scope: string]: { [key: string]: unknown } }`.
418
+ */
419
+ interface Flags extends Document.ConfiguredFlagsForName<Name> {}
420
+
421
+ namespace Flags {
422
+ /**
423
+ * The valid scopes for the flags on this document e.g. `"core"` or `"dnd5e"`.
424
+ */
425
+ type Scope = Document.FlagKeyOf<Flags>;
426
+
427
+ /**
428
+ * The valid keys for a certain scope for example if the scope is "core" then a valid key may be `"sheetLock"` or `"viewMode"`.
429
+ */
430
+ type Key<Scope extends Flags.Scope> = Document.FlagKeyOf<Document.FlagGetKey<Flags, Scope>>;
431
+
432
+ /**
433
+ * Gets the type of a particular flag given a `Scope` and a `Key`.
434
+ */
435
+ type Get<Scope extends Flags.Scope, Key extends Flags.Key<Scope>> = Document.GetFlag<Name, Scope, Key>;
436
+ }
437
+
438
+ type Resource = `${number}` | number | boolean | null;
439
+
440
+ /**
441
+ * @deprecated {@link Combatant.Database | `Combatant.DatabaseOperation`}
442
+ */
12
443
  interface DatabaseOperations
444
+ // eslint-disable-next-line @typescript-eslint/no-deprecated
13
445
  extends Document.Database.Operations<
14
- Combatant,
446
+ Combatant.Implementation,
15
447
  { combatTurn: number },
16
448
  { combatTurn: number },
17
449
  { combatTurn: number }
18
450
  > {}
19
451
 
20
- // Helpful aliases
21
- type TypeNames = BaseCombatant.TypeNames;
22
- type ConstructorData = BaseCombatant.ConstructorData;
23
- type UpdateData = BaseCombatant.UpdateData;
24
- type Schema = BaseCombatant.Schema;
25
- type Source = BaseCombatant.Source;
452
+ /**
453
+ * @deprecated {@link Combatant.SubType | `Combatant.SubType`}
454
+ */
455
+ type TypeNames = Combatant.SubType;
456
+
457
+ /**
458
+ * @deprecated {@link Combatant.CreateData | `Combatant.CreateData`}
459
+ */
460
+ interface ConstructorData extends Combatant.CreateData {}
461
+
462
+ /**
463
+ * @deprecated {@link Combatant.implementation | `Combatant.ImplementationClass`}
464
+ */
465
+ type ConfiguredClass = ImplementationClass;
466
+
467
+ /**
468
+ * @deprecated {@link Combatant.Implementation | `Combatant.Implementation`}
469
+ */
470
+ type ConfiguredInstance = Implementation;
26
471
  }
27
472
 
28
473
  /**
29
474
  * The client-side Combatant document which extends the common BaseCombatant model.
30
475
  *
31
- * @see {@link Combat} The Combat document which contains Combatant embedded documents
32
- * @see {@link CombatantConfig} The Combatant configuration application
476
+ * @see {@link Combat | `Combat`} The Combat document which contains Combatant embedded documents
477
+ * @see {@link CombatantConfig | `CombatantConfig`} The Combatant configuration application
33
478
  */
34
- class Combatant extends ClientDocumentMixin(foundry.documents.BaseCombatant) {
35
- static override metadata: Combatant.Metadata;
36
-
37
- static get implementation(): Combatant.ConfiguredClass;
479
+ class Combatant<out SubType extends Combatant.SubType = Combatant.SubType> extends ClientDocumentMixin(
480
+ foundry.documents.BaseCombatant,
481
+ )<SubType> {
482
+ /**
483
+ * @param data - Initial data from which to construct the `Combatant`
484
+ * @param context - Construction context options
485
+ */
486
+ constructor(...args: Combatant.ConstructorArgs);
38
487
 
39
488
  /**
40
489
  * The token video source image (if any)
@@ -42,12 +491,12 @@ declare global {
42
491
  _videoSrc: string | null;
43
492
 
44
493
  /** The current value of the special tracked resource which pertains to this Combatant */
45
- resource: `${number}` | number | boolean | null;
494
+ resource: Combatant.Resource;
46
495
 
47
496
  /**
48
497
  * A convenience alias of Combatant#parent which is more semantically intuitive
49
498
  */
50
- get combat(): Combat.ConfiguredInstance | null;
499
+ get combat(): Combat.Implementation | null;
51
500
 
52
501
  /** This is treated as a non-player combatant if it has no associated actor and no player users who can control it */
53
502
  get isNPC(): boolean;
@@ -60,13 +509,13 @@ declare global {
60
509
  override get visible(): boolean;
61
510
 
62
511
  /** A reference to the Actor document which this Combatant represents, if any */
63
- get actor(): Actor.ConfiguredInstance | null;
512
+ get actor(): Actor.Implementation | null;
64
513
 
65
514
  /** A reference to the Token document which this Combatant represents, if any */
66
- get token(): TokenDocument.ConfiguredInstance | null;
515
+ get token(): TokenDocument.Implementation | null;
67
516
 
68
517
  /** An array of User documents who have ownership of this Document */
69
- get players(): User.ConfiguredInstance[];
518
+ get players(): User.Implementation[];
70
519
 
71
520
  /**
72
521
  * Has this combatant been marked as defeated?
@@ -74,7 +523,7 @@ declare global {
74
523
  get isDefeated(): boolean;
75
524
 
76
525
  override testUserPermission(
77
- user: User,
526
+ user: User.Implementation,
78
527
  permission: keyof typeof foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS | foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS,
79
528
  { exact }?: { exact?: boolean },
80
529
  ): boolean;
@@ -98,7 +547,7 @@ declare global {
98
547
  /**
99
548
  * Update the value of the tracked resource for this Combatant.
100
549
  */
101
- updateResource(): this["resource"];
550
+ updateResource(): Combatant.Resource;
102
551
 
103
552
  /**
104
553
  * Acquire the default dice formula which should be used to roll initiative for this combatant.
@@ -108,8 +557,41 @@ declare global {
108
557
  protected _getInitiativeFormula(): string;
109
558
 
110
559
  /**
111
- * @deprecated since v9
560
+ * @privateRemarks DatabaseLifecycle Events are overridden but with no signature changes.
561
+ * These are already covered in BaseCombatant
562
+ */
563
+
564
+ /*
565
+ * After this point these are not really overridden methods.
566
+ * They are here because Foundry's documents are complex and have lots of edge cases.
567
+ * There are DRY ways of representing this but this ends up being harder to understand
568
+ * for end users extending these functions, especially for static methods. There are also a
569
+ * number of methods that don't make sense to call directly on `Document` like `createDocuments`,
570
+ * as there is no data that can safely construct every possible document. Finally keeping definitions
571
+ * separate like this helps against circularities.
112
572
  */
113
- get isVisible(): boolean;
573
+
574
+ // ClientDocument overrides
575
+
576
+ // Descendant Document operations have been left out because Combatant does not have any descendant documents.
577
+
578
+ static override defaultName(
579
+ context: Document.DefaultNameContext<Combatant.SubType, NonNullable<Combatant.Parent>>,
580
+ ): string;
581
+
582
+ static override createDialog(
583
+ data: Document.CreateDialogData<Combatant.CreateData>,
584
+ context: Document.CreateDialogContext<Combatant.SubType, NonNullable<Combatant.Parent>>,
585
+ ): Promise<Combatant.Stored | null | undefined>;
586
+
587
+ static override fromDropData(
588
+ data: Document.DropData<Combatant.Implementation>,
589
+ options?: Document.FromDropDataOptions,
590
+ ): Promise<Combatant.Implementation | undefined>;
591
+
592
+ static override fromImport(
593
+ source: Combatant.Source,
594
+ context?: Document.FromImportContext<Combatant.Parent>,
595
+ ): Promise<Combatant.Implementation>;
114
596
  }
115
597
  }