@league-of-foundry-developers/foundry-vtt-types 12.331.2-beta → 12.331.4-beta

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 (560) hide show
  1. package/README.md +17 -18
  2. package/package.json +73 -32
  3. package/src/configuration/configuration.d.mts +316 -0
  4. package/src/configuration/documents.d.mts +295 -0
  5. package/src/configuration/globals.d.mts +357 -0
  6. package/src/configuration/index.d.mts +5 -0
  7. package/src/foundry/client/apps/app.d.mts +129 -122
  8. package/src/foundry/client/apps/av/av-config.d.mts +12 -7
  9. package/src/foundry/client/apps/av/cameras.d.mts +12 -7
  10. package/src/foundry/client/apps/dice/dice-config.d.mts +59 -0
  11. package/src/foundry/client/apps/dice/index.d.mts +1 -0
  12. package/src/foundry/client/apps/form.d.mts +114 -86
  13. package/src/foundry/client/apps/forms/actor.d.mts +21 -11
  14. package/src/foundry/client/apps/forms/adventure-exporter.d.mts +12 -7
  15. package/src/foundry/client/apps/forms/adventure-importer.d.mts +14 -6
  16. package/src/foundry/client/apps/forms/base-sheet.d.mts +16 -8
  17. package/src/foundry/client/apps/forms/card-config.d.mts +16 -8
  18. package/src/foundry/client/apps/forms/cards-config.d.mts +15 -14
  19. package/src/foundry/client/apps/forms/combat-config.d.mts +7 -7
  20. package/src/foundry/client/apps/forms/combatant-config.d.mts +3 -3
  21. package/src/foundry/client/apps/forms/default-sheets-config.d.mts +1 -1
  22. package/src/foundry/client/apps/forms/effect-config.d.mts +7 -7
  23. package/src/foundry/client/apps/forms/folder-config.d.mts +5 -5
  24. package/src/foundry/client/apps/forms/fonts.d.mts +42 -35
  25. package/src/foundry/client/apps/forms/grid-config.d.mts +12 -17
  26. package/src/foundry/client/apps/forms/image-popout.d.mts +29 -23
  27. package/src/foundry/client/apps/forms/item.d.mts +9 -9
  28. package/src/foundry/client/apps/forms/journal-page-sheet.d.mts +16 -14
  29. package/src/foundry/client/apps/forms/journal-sheet.d.mts +48 -38
  30. package/src/foundry/client/apps/forms/macro-config.d.mts +7 -7
  31. package/src/foundry/client/apps/forms/measure-template.d.mts +10 -12
  32. package/src/foundry/client/apps/forms/ownership.d.mts +5 -5
  33. package/src/foundry/client/apps/forms/playlist-config.d.mts +8 -10
  34. package/src/foundry/client/apps/forms/playlist-sound-config.d.mts +7 -7
  35. package/src/foundry/client/apps/forms/roll-table-config.d.mts +11 -10
  36. package/src/foundry/client/apps/forms/scene-config.d.mts +40 -41
  37. package/src/foundry/client/apps/forms/sheet-config.d.mts +9 -21
  38. package/src/foundry/client/apps/forms/user-config.d.mts +13 -12
  39. package/src/foundry/client/apps/hud/chatbubble.d.mts +18 -6
  40. package/src/foundry/client/apps/hud/container.d.mts +4 -4
  41. package/src/foundry/client/apps/hud/controls.d.mts +126 -81
  42. package/src/foundry/client/apps/hud/hotbar.d.mts +17 -12
  43. package/src/foundry/client/apps/hud/hud.d.mts +5 -5
  44. package/src/foundry/client/apps/hud/menu.d.mts +10 -3
  45. package/src/foundry/client/apps/hud/navigation.d.mts +14 -9
  46. package/src/foundry/client/apps/hud/pause.d.mts +9 -4
  47. package/src/foundry/client/apps/hud/players.d.mts +14 -9
  48. package/src/foundry/client/apps/i18n.d.mts +34 -27
  49. package/src/foundry/client/apps/index.d.mts +1 -0
  50. package/src/foundry/client/apps/placeables/drawing-config.d.mts +41 -33
  51. package/src/foundry/client/apps/placeables/drawing-hud.d.mts +5 -5
  52. package/src/foundry/client/apps/placeables/index.d.mts +0 -2
  53. package/src/foundry/client/apps/placeables/note-config.d.mts +28 -18
  54. package/src/foundry/client/apps/placeables/tile-config.d.mts +23 -10
  55. package/src/foundry/client/apps/placeables/tile-hud.d.mts +10 -5
  56. package/src/foundry/client/apps/placeables/token-config.d.mts +91 -58
  57. package/src/foundry/client/apps/placeables/token-hud.d.mts +12 -7
  58. package/src/foundry/client/apps/placeables/wall-config.d.mts +21 -17
  59. package/src/foundry/client/apps/sidebar/apps/chat-popout.d.mts +5 -5
  60. package/src/foundry/client/apps/sidebar/apps/client-settings.d.mts +3 -3
  61. package/src/foundry/client/apps/sidebar/apps/compendium.d.mts +15 -13
  62. package/src/foundry/client/apps/sidebar/apps/invitation-links.d.mts +3 -3
  63. package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts +3 -2
  64. package/src/foundry/client/apps/sidebar/apps/module-management.d.mts +6 -6
  65. package/src/foundry/client/apps/sidebar/apps/permission-config.d.mts +6 -6
  66. package/src/foundry/client/apps/sidebar/apps/support-details.d.mts +34 -29
  67. package/src/foundry/client/apps/sidebar/apps/tours-management.d.mts +2 -2
  68. package/src/foundry/client/apps/sidebar/apps/world-config.d.mts +13 -10
  69. package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts +50 -35
  70. package/src/foundry/client/apps/sidebar/document-directory.d.mts +52 -38
  71. package/src/foundry/client/apps/sidebar/package-configuration.d.mts +4 -4
  72. package/src/foundry/client/apps/sidebar/sidebar-tab.d.mts +3 -3
  73. package/src/foundry/client/apps/sidebar/sidebar.d.mts +9 -4
  74. package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts +11 -2
  75. package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts +11 -2
  76. package/src/foundry/client/apps/sidebar/tabs/chat-log.d.mts +39 -27
  77. package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.mts +21 -12
  78. package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.mts +30 -15
  79. package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts +11 -2
  80. package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.mts +11 -2
  81. package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts +14 -5
  82. package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts +30 -22
  83. package/src/foundry/client/apps/sidebar/tabs/roll-table-directory.d.mts +11 -2
  84. package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts +14 -5
  85. package/src/foundry/client/apps/sidebar/tabs/settings.d.mts +23 -5
  86. package/src/foundry/client/apps/templates.d.mts +6 -2
  87. package/src/foundry/client/av/client.d.mts +1 -1
  88. package/src/foundry/client/av/clients/simplepeer.d.mts +11 -1
  89. package/src/foundry/client/av/master.d.mts +2 -2
  90. package/src/foundry/client/av/settings.d.mts +17 -15
  91. package/src/foundry/client/config.d.mts +444 -314
  92. package/src/foundry/client/core/document-index.d.mts +11 -3
  93. package/src/foundry/client/core/hooks.d.mts +2 -4
  94. package/src/foundry/client/core/image.d.mts +92 -42
  95. package/src/foundry/client/core/issues.d.mts +9 -4
  96. package/src/foundry/client/core/keybindings.d.mts +5 -5
  97. package/src/foundry/client/core/nue.d.mts +1 -1
  98. package/src/foundry/client/core/packages.d.mts +397 -61
  99. package/src/foundry/client/core/settings.d.mts +62 -38
  100. package/src/foundry/client/core/socket.d.mts +2 -2
  101. package/src/foundry/client/core/sorting.d.mts +6 -6
  102. package/src/foundry/client/core/time.d.mts +6 -3
  103. package/src/foundry/client/core/tooltip.d.mts +2 -2
  104. package/src/foundry/client/core/tour.d.mts +59 -50
  105. package/src/foundry/client/core/tours.d.mts +1 -1
  106. package/src/foundry/client/core/utils.d.mts +33 -10
  107. package/src/foundry/client/core/video.d.mts +1 -1
  108. package/src/foundry/client/core/workers.d.mts +24 -17
  109. package/src/foundry/client/data/abstract/canvas-document.d.mts +21 -17
  110. package/src/foundry/client/data/abstract/client-document.d.mts +153 -183
  111. package/src/foundry/client/data/abstract/directory-collection-mixin.d.mts +23 -39
  112. package/src/foundry/client/data/abstract/document-collection.d.mts +96 -68
  113. package/src/foundry/client/data/abstract/world-collection.d.mts +48 -56
  114. package/src/foundry/client/data/collections/actors.d.mts +30 -28
  115. package/src/foundry/client/data/collections/cards.d.mts +16 -3
  116. package/src/foundry/client/data/collections/combats.d.mts +18 -5
  117. package/src/foundry/client/data/collections/compendium-collection.d.mts +85 -101
  118. package/src/foundry/client/data/collections/compendium-folders.d.mts +6 -6
  119. package/src/foundry/client/data/collections/compendium-packs.d.mts +6 -6
  120. package/src/foundry/client/data/collections/fog.d.mts +16 -3
  121. package/src/foundry/client/data/collections/folder.d.mts +20 -6
  122. package/src/foundry/client/data/collections/items.d.mts +17 -4
  123. package/src/foundry/client/data/collections/journal.d.mts +22 -7
  124. package/src/foundry/client/data/collections/macros.d.mts +21 -19
  125. package/src/foundry/client/data/collections/messages.d.mts +19 -6
  126. package/src/foundry/client/data/collections/playlists.d.mts +17 -5
  127. package/src/foundry/client/data/collections/scenes.d.mts +24 -27
  128. package/src/foundry/client/data/collections/settings.d.mts +16 -3
  129. package/src/foundry/client/data/collections/tables.d.mts +18 -5
  130. package/src/foundry/client/data/collections/users.d.mts +19 -7
  131. package/src/foundry/client/data/documents/active-effect.d.mts +677 -85
  132. package/src/foundry/client/data/documents/actor-delta.d.mts +670 -27
  133. package/src/foundry/client/data/documents/actor.d.mts +718 -55
  134. package/src/foundry/client/data/documents/adventure.d.mts +480 -46
  135. package/src/foundry/client/data/documents/ambient-light.d.mts +423 -19
  136. package/src/foundry/client/data/documents/ambient-sound.d.mts +473 -14
  137. package/src/foundry/client/data/documents/card.d.mts +567 -36
  138. package/src/foundry/client/data/documents/cards.d.mts +744 -85
  139. package/src/foundry/client/data/documents/chat-message.d.mts +574 -42
  140. package/src/foundry/client/data/documents/combat.d.mts +699 -69
  141. package/src/foundry/client/data/documents/combatant.d.mts +504 -24
  142. package/src/foundry/client/data/documents/drawing.d.mts +540 -14
  143. package/src/foundry/client/data/documents/fog-exploration.d.mts +416 -21
  144. package/src/foundry/client/data/documents/folder.d.mts +468 -30
  145. package/src/foundry/client/data/documents/index.d.mts +2 -0
  146. package/src/foundry/client/data/documents/item.d.mts +677 -20
  147. package/src/foundry/client/data/documents/journal-entry-page.d.mts +585 -19
  148. package/src/foundry/client/data/documents/journal-entry.d.mts +619 -18
  149. package/src/foundry/client/data/documents/macro.d.mts +528 -25
  150. package/src/foundry/client/data/documents/measured-template.d.mts +478 -14
  151. package/src/foundry/client/data/documents/note.d.mts +491 -15
  152. package/src/foundry/client/data/documents/playlist-sound.d.mts +426 -24
  153. package/src/foundry/client/data/documents/playlist.d.mts +665 -74
  154. package/src/foundry/client/data/documents/region-behavior.d.mts +507 -0
  155. package/src/foundry/client/data/documents/region.d.mts +784 -0
  156. package/src/foundry/client/data/documents/scene.d.mts +983 -140
  157. package/src/foundry/client/data/documents/setting.d.mts +395 -13
  158. package/src/foundry/client/data/documents/table-result.d.mts +476 -14
  159. package/src/foundry/client/data/documents/table.d.mts +661 -78
  160. package/src/foundry/client/data/documents/tile.d.mts +499 -14
  161. package/src/foundry/client/data/documents/token.d.mts +1110 -97
  162. package/src/foundry/client/data/documents/user.d.mts +493 -25
  163. package/src/foundry/client/data/documents/wall.d.mts +548 -14
  164. package/src/foundry/client/game.d.mts +62 -89
  165. package/src/foundry/client/head.d.mts +9 -9
  166. package/src/foundry/client/hooks.d.mts +257 -237
  167. package/src/foundry/client/pixi/board.d.mts +111 -104
  168. package/src/foundry/client/pixi/core/containers/base-canvas-group.d.mts +97 -25
  169. package/src/foundry/client/pixi/core/containers/cached-container.d.mts +37 -19
  170. package/src/foundry/client/pixi/core/containers/full-canvas-container.d.mts +7 -10
  171. package/src/foundry/client/pixi/core/containers/point-source-mesh.d.mts +25 -15
  172. package/src/foundry/client/pixi/core/containers/quad-mesh.d.mts +16 -6
  173. package/src/foundry/client/pixi/core/containers/quadtree.d.mts +113 -54
  174. package/src/foundry/client/pixi/core/containers/sprite-mesh.d.mts +69 -26
  175. package/src/foundry/client/pixi/core/containers/unbound-container.d.mts +20 -2
  176. package/src/foundry/client/pixi/core/interaction/canvas-animation.d.mts +164 -99
  177. package/src/foundry/client/pixi/core/interaction/control-icon.d.mts +61 -22
  178. package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts +120 -53
  179. package/src/foundry/client/pixi/core/interaction/ping.d.mts +62 -31
  180. package/src/foundry/client/pixi/core/interaction/pings/chevron.d.mts +23 -10
  181. package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts +91 -34
  182. package/src/foundry/client/pixi/core/interaction/render-flags.d.mts +76 -31
  183. package/src/foundry/client/pixi/core/interaction/resize-handle.d.mts +35 -5
  184. package/src/foundry/client/pixi/core/interaction/targets.d.mts +21 -18
  185. package/src/foundry/client/pixi/core/loader.d.mts +86 -76
  186. package/src/foundry/client/pixi/core/shapes/limited-angle-polygon.d.mts +42 -17
  187. package/src/foundry/client/pixi/core/shapes/polygon-mesher.d.mts +92 -64
  188. package/src/foundry/client/pixi/core/shapes/precise-text.d.mts +28 -10
  189. package/src/foundry/client/pixi/core/shapes/ray.d.mts +47 -23
  190. package/src/foundry/client/pixi/core/shapes/source-polygon.d.mts +170 -75
  191. package/src/foundry/client/pixi/extensions/circle.d.mts +133 -122
  192. package/src/foundry/client/pixi/extensions/graphics.d.mts +3 -1
  193. package/src/foundry/client/pixi/extensions/observable-transform.d.mts +10 -2
  194. package/src/foundry/client/pixi/extensions/polygon.d.mts +155 -134
  195. package/src/foundry/client/pixi/extensions/rectangle.d.mts +266 -240
  196. package/src/foundry/client/pixi/groups/effects.d.mts +75 -24
  197. package/src/foundry/client/pixi/groups/environment.d.mts +68 -19
  198. package/src/foundry/client/pixi/groups/hidden.d.mts +27 -11
  199. package/src/foundry/client/pixi/groups/interface.d.mts +62 -38
  200. package/src/foundry/client/pixi/groups/overlay.d.mts +19 -7
  201. package/src/foundry/client/pixi/groups/primary.d.mts +66 -44
  202. package/src/foundry/client/pixi/groups/rendered.d.mts +19 -7
  203. package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts +11 -15
  204. package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts +29 -28
  205. package/src/foundry/client/pixi/layers/base/placeables-layer.d.mts +306 -272
  206. package/src/foundry/client/pixi/layers/controls/cursor.d.mts +18 -9
  207. package/src/foundry/client/pixi/layers/controls/door.d.mts +32 -11
  208. package/src/foundry/client/pixi/layers/controls/layer.d.mts +89 -77
  209. package/src/foundry/client/pixi/layers/controls/ruler.d.mts +121 -96
  210. package/src/foundry/client/pixi/layers/effects/background-effects.d.mts +9 -12
  211. package/src/foundry/client/pixi/layers/effects/coloration-effects.d.mts +9 -10
  212. package/src/foundry/client/pixi/layers/effects/darkness-effects.d.mts +8 -8
  213. package/src/foundry/client/pixi/layers/effects/illumination-effects.d.mts +22 -22
  214. package/src/foundry/client/pixi/layers/effects/visibility.d.mts +106 -86
  215. package/src/foundry/client/pixi/layers/effects/weather/particles/effect.d.mts +14 -5
  216. package/src/foundry/client/pixi/layers/effects/weather/particles/leaves.d.mts +31 -2
  217. package/src/foundry/client/pixi/layers/effects/weather-effects.d.mts +137 -65
  218. package/src/foundry/client/pixi/layers/grid/highlight.d.mts +14 -4
  219. package/src/foundry/client/pixi/layers/grid/layer.d.mts +92 -92
  220. package/src/foundry/client/pixi/layers/grid/mesh.d.mts +37 -16
  221. package/src/foundry/client/pixi/layers/masks/depth.d.mts +12 -7
  222. package/src/foundry/client/pixi/layers/masks/occlusion.d.mts +19 -12
  223. package/src/foundry/client/pixi/layers/masks/vision.d.mts +104 -18
  224. package/src/foundry/client/pixi/layers/placeables/drawings.d.mts +16 -15
  225. package/src/foundry/client/pixi/layers/placeables/index.d.mts +1 -0
  226. package/src/foundry/client/pixi/layers/placeables/lighting.d.mts +12 -14
  227. package/src/foundry/client/pixi/layers/placeables/notes.d.mts +49 -32
  228. package/src/foundry/client/pixi/layers/placeables/regions.d.mts +113 -0
  229. package/src/foundry/client/pixi/layers/placeables/sounds.d.mts +81 -67
  230. package/src/foundry/client/pixi/layers/placeables/templates.d.mts +11 -15
  231. package/src/foundry/client/pixi/layers/placeables/tiles.d.mts +30 -21
  232. package/src/foundry/client/pixi/layers/placeables/tokens.d.mts +66 -52
  233. package/src/foundry/client/pixi/layers/placeables/walls.d.mts +54 -57
  234. package/src/foundry/client/pixi/perception/clockwise-sweep.d.mts +62 -27
  235. package/src/foundry/client/pixi/perception/detection-mode.d.mts +121 -47
  236. package/src/foundry/client/pixi/perception/fog.d.mts +38 -15
  237. package/src/foundry/client/pixi/perception/perception-manager.d.mts +136 -136
  238. package/src/foundry/client/pixi/perception/vision-mode.d.mts +108 -66
  239. package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts +77 -39
  240. package/src/foundry/client/pixi/placeable.d.mts +238 -137
  241. package/src/foundry/client/pixi/placeables/drawing.d.mts +255 -133
  242. package/src/foundry/client/pixi/placeables/index.d.mts +1 -0
  243. package/src/foundry/client/pixi/placeables/light.d.mts +199 -64
  244. package/src/foundry/client/pixi/placeables/note.d.mts +145 -54
  245. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts +30 -8
  246. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts +41 -11
  247. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts +59 -18
  248. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts +120 -37
  249. package/src/foundry/client/pixi/placeables/region.d.mts +280 -0
  250. package/src/foundry/client/pixi/placeables/sound.d.mts +205 -66
  251. package/src/foundry/client/pixi/placeables/template.d.mts +181 -99
  252. package/src/foundry/client/pixi/placeables/tile.d.mts +206 -140
  253. package/src/foundry/client/pixi/placeables/token.d.mts +916 -448
  254. package/src/foundry/client/pixi/placeables/wall.d.mts +249 -129
  255. package/src/foundry/client/pixi/webgl/extensions/batch-renderer.d.mts +72 -33
  256. package/src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.mts +10 -9
  257. package/src/foundry/client/pixi/webgl/helpers/{framebugger-snapshot.d.mts → framebuffer-snapshot.d.mts} +10 -9
  258. package/src/foundry/client/pixi/webgl/helpers/index.d.mts +1 -1
  259. package/src/foundry/client/pixi/webgl/helpers/smooth-noise.d.mts +38 -23
  260. package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts +82 -53
  261. package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts +12 -12
  262. package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts +45 -28
  263. package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts +12 -11
  264. package/src/foundry/client/pixi/webgl/shaders/filters/base-mask-filter.d.mts +12 -10
  265. package/src/foundry/client/pixi/webgl/shaders/filters/blur.d.mts +22 -20
  266. package/src/foundry/client/pixi/webgl/shaders/filters/effects-masking.d.mts +36 -32
  267. package/src/foundry/client/pixi/webgl/shaders/filters/environment.d.mts +10 -9
  268. package/src/foundry/client/pixi/webgl/shaders/filters/glow-overlay.d.mts +12 -11
  269. package/src/foundry/client/pixi/webgl/shaders/filters/invisibility.d.mts +10 -9
  270. package/src/foundry/client/pixi/webgl/shaders/filters/outline-overlay.d.mts +12 -11
  271. package/src/foundry/client/pixi/webgl/shaders/filters/transition.d.mts +67 -60
  272. package/src/foundry/client/pixi/webgl/shaders/filters/visibility.d.mts +24 -17
  273. package/src/foundry/client/pixi/webgl/shaders/filters/vision-mask-filter.d.mts +13 -10
  274. package/src/foundry/client/pixi/webgl/shaders/filters/void.d.mts +10 -9
  275. package/src/foundry/client/pixi/webgl/shaders/filters/weather-occlusion-masks.d.mts +11 -10
  276. package/src/foundry/client/pixi/webgl/shaders/fragment-channel-mixin.d.mts +20 -14
  277. package/src/foundry/client/pixi/webgl/shaders/grid/grid.d.mts +12 -11
  278. package/src/foundry/client/pixi/webgl/shaders/lighting/background-lighting.d.mts +10 -9
  279. package/src/foundry/client/pixi/webgl/shaders/lighting/base-lighting.d.mts +33 -33
  280. package/src/foundry/client/pixi/webgl/shaders/lighting/coloration-lighting.d.mts +10 -9
  281. package/src/foundry/client/pixi/webgl/shaders/lighting/darkness-lighting.d.mts +10 -9
  282. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/bewitching-wave.d.mts +19 -17
  283. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/black-hole.d.mts +10 -9
  284. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/chroma.d.mts +10 -9
  285. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/emanation.d.mts +10 -9
  286. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/energy-field.d.mts +10 -9
  287. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fairy-light.d.mts +19 -17
  288. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/flame.d.mts +19 -17
  289. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fog.d.mts +10 -9
  290. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/force-grid.d.mts +10 -8
  291. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/ghost-light.d.mts +19 -17
  292. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/hexa-dome.d.mts +10 -9
  293. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/light-dome.d.mts +10 -9
  294. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/magical-gloom.d.mts +10 -9
  295. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/pulse.d.mts +19 -17
  296. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/radial-rainbow.d.mts +10 -9
  297. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/revolving-light.d.mts +10 -9
  298. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/roiling-mass.d.mts +10 -9
  299. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/siren-light.d.mts +19 -17
  300. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/smoke-patch.d.mts +20 -17
  301. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/star-light.d.mts +10 -9
  302. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/sunburst.d.mts +19 -17
  303. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/swirling-rainbow.d.mts +10 -9
  304. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/torch.d.mts +19 -17
  305. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/vortex.d.mts +19 -17
  306. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/wave.d.mts +19 -17
  307. package/src/foundry/client/pixi/webgl/shaders/lighting/illumination-lighting.d.mts +10 -9
  308. package/src/foundry/client/pixi/webgl/shaders/region/adjust-darkness-level.d.mts +71 -29
  309. package/src/foundry/client/pixi/webgl/shaders/region/base.d.mts +54 -10
  310. package/src/foundry/client/pixi/webgl/shaders/region/highlight.d.mts +69 -9
  311. package/src/foundry/client/pixi/webgl/shaders/samplers/base-sampler.d.mts +24 -25
  312. package/src/foundry/client/pixi/webgl/shaders/samplers/baseline-illumination.d.mts +10 -9
  313. package/src/foundry/client/pixi/webgl/shaders/samplers/color-adjustment.d.mts +38 -29
  314. package/src/foundry/client/pixi/webgl/shaders/samplers/depth.d.mts +21 -17
  315. package/src/foundry/client/pixi/webgl/shaders/samplers/fog-of-war.d.mts +10 -9
  316. package/src/foundry/client/pixi/webgl/shaders/samplers/occlusion.d.mts +20 -18
  317. package/src/foundry/client/pixi/webgl/shaders/samplers/primary.d.mts +11 -2
  318. package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts +28 -2
  319. package/src/foundry/client/pixi/webgl/shaders/vision/background-vision.d.mts +10 -9
  320. package/src/foundry/client/pixi/webgl/shaders/vision/base-vision.d.mts +11 -9
  321. package/src/foundry/client/pixi/webgl/shaders/vision/coloration-vision.d.mts +10 -9
  322. package/src/foundry/client/pixi/webgl/shaders/vision/effects/amplification.d.mts +10 -9
  323. package/src/foundry/client/pixi/webgl/shaders/vision/effects/wave.d.mts +19 -17
  324. package/src/foundry/client/pixi/webgl/shaders/vision/illumination-vision.d.mts +10 -9
  325. package/src/foundry/client/pixi/webgl/shaders/weather/base-weather.d.mts +40 -36
  326. package/src/foundry/client/pixi/webgl/shaders/weather/effect.d.mts +27 -33
  327. package/src/foundry/client/pixi/webgl/shaders/weather/fog.d.mts +17 -16
  328. package/src/foundry/client/pixi/webgl/shaders/weather/rain.d.mts +19 -18
  329. package/src/foundry/client/pixi/webgl/shaders/weather/snow.d.mts +15 -14
  330. package/src/foundry/client/pixi/workers/texture-worker.d.mts +33 -53
  331. package/src/foundry/client/tours/setup-tour.d.mts +15 -10
  332. package/src/foundry/client/ui/context.d.mts +48 -40
  333. package/src/foundry/client/ui/dialog.d.mts +137 -126
  334. package/src/foundry/client/ui/drag.d.mts +1 -1
  335. package/src/foundry/client/ui/dragdrop.d.mts +34 -28
  336. package/src/foundry/client/ui/editor.d.mts +29 -21
  337. package/src/foundry/client/ui/filepicker.d.mts +43 -38
  338. package/src/foundry/client/ui/filter.d.mts +62 -50
  339. package/src/foundry/client/ui/forms.d.mts +22 -22
  340. package/src/foundry/client/ui/notifications.d.mts +10 -3
  341. package/src/foundry/client/ui/prosemirror.d.mts +15 -7
  342. package/src/foundry/client/ui/secrets.d.mts +42 -27
  343. package/src/foundry/client/ui/tabs.d.mts +40 -33
  344. package/src/foundry/client-esm/applications/_module.d.mts +3 -3
  345. package/src/foundry/client-esm/applications/_types.d.mts +0 -2
  346. package/src/foundry/client-esm/applications/api/_module.d.mts +2 -2
  347. package/src/foundry/client-esm/applications/api/application.d.mts +51 -39
  348. package/src/foundry/client-esm/applications/api/dialog.d.mts +20 -22
  349. package/src/foundry/client-esm/applications/api/document-sheet.d.mts +26 -12
  350. package/src/foundry/client-esm/applications/api/handlebars-application.d.mts +142 -126
  351. package/src/foundry/client-esm/applications/apps/_module.d.mts +2 -2
  352. package/src/foundry/client-esm/applications/apps/compendium-art-config.d.mts +10 -10
  353. package/src/foundry/client-esm/applications/apps/permission-config.d.mts +3 -3
  354. package/src/foundry/client-esm/applications/dice/_module.d.mts +2 -2
  355. package/src/foundry/client-esm/applications/dice/roll-resolver.d.mts +14 -2
  356. package/src/foundry/client-esm/applications/elements/_module.d.mts +2 -2
  357. package/src/foundry/client-esm/applications/elements/document-tags.d.mts +2 -0
  358. package/src/foundry/client-esm/applications/elements/file-picker.d.mts +1 -1
  359. package/src/foundry/client-esm/applications/elements/multi-select.d.mts +15 -5
  360. package/src/foundry/client-esm/applications/elements/string-tags.d.mts +1 -1
  361. package/src/foundry/client-esm/applications/forms/fields.d.mts +6 -1
  362. package/src/foundry/client-esm/applications/sheets/_module.d.mts +2 -2
  363. package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts +3 -3
  364. package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts +16 -11
  365. package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts +9 -7
  366. package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts +3 -3
  367. package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts +30 -5
  368. package/src/foundry/client-esm/applications/sheets/region-config.d.mts +36 -5
  369. package/src/foundry/client-esm/applications/sheets/user-config.d.mts +8 -7
  370. package/src/foundry/client-esm/applications/ui/_module.d.mts +2 -2
  371. package/src/foundry/client-esm/applications/ui/region-legend.d.mts +45 -3
  372. package/src/foundry/client-esm/audio/_module.d.mts +2 -3
  373. package/src/foundry/client-esm/audio/_types.d.mts +3 -1
  374. package/src/foundry/client-esm/audio/biquad.d.mts +76 -26
  375. package/src/foundry/client-esm/audio/cache.d.mts +31 -20
  376. package/src/foundry/client-esm/audio/convolver.d.mts +47 -25
  377. package/src/foundry/client-esm/audio/helper.d.mts +123 -78
  378. package/src/foundry/client-esm/audio/sound.d.mts +230 -126
  379. package/src/foundry/client-esm/audio/timeout.d.mts +30 -11
  380. package/src/foundry/client-esm/canvas/_module.d.mts +2 -2
  381. package/src/foundry/client-esm/canvas/edges/_module.d.mts +2 -2
  382. package/src/foundry/client-esm/canvas/edges/collision.d.mts +69 -18
  383. package/src/foundry/client-esm/canvas/edges/edge.d.mts +110 -41
  384. package/src/foundry/client-esm/canvas/edges/edges.d.mts +10 -0
  385. package/src/foundry/client-esm/canvas/edges/vertex.d.mts +56 -26
  386. package/src/foundry/client-esm/canvas/regions/_module.d.mts +2 -3
  387. package/src/foundry/client-esm/canvas/regions/geometry.d.mts +38 -0
  388. package/src/foundry/client-esm/canvas/regions/mesh.d.mts +72 -0
  389. package/src/foundry/client-esm/canvas/regions/polygon-tree.d.mts +130 -0
  390. package/src/foundry/client-esm/canvas/regions/shape.d.mts +129 -0
  391. package/src/foundry/client-esm/canvas/scene-manager.d.mts +16 -6
  392. package/src/foundry/client-esm/canvas/smaa/blend.d.mts +14 -3
  393. package/src/foundry/client-esm/canvas/smaa/edges.d.mts +25 -3
  394. package/src/foundry/client-esm/canvas/smaa/smaa.d.mts +121 -23
  395. package/src/foundry/client-esm/canvas/smaa/weights.d.mts +26 -3
  396. package/src/foundry/client-esm/canvas/sources/_module.d.mts +2 -2
  397. package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts +84 -40
  398. package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts +103 -39
  399. package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts +89 -15
  400. package/src/foundry/client-esm/canvas/sources/point-darkness-source.d.mts +71 -30
  401. package/src/foundry/client-esm/canvas/sources/point-effect-source.d.mts +49 -20
  402. package/src/foundry/client-esm/canvas/sources/point-light-source.d.mts +57 -16
  403. package/src/foundry/client-esm/canvas/sources/point-movement-source.d.mts +31 -4
  404. package/src/foundry/client-esm/canvas/sources/point-sound-source.d.mts +45 -12
  405. package/src/foundry/client-esm/canvas/sources/point-vision-source.d.mts +98 -52
  406. package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts +180 -69
  407. package/src/foundry/client-esm/canvas/tokens/_module.d.mts +2 -3
  408. package/src/foundry/client-esm/canvas/tokens/ring-config.d.mts +174 -2
  409. package/src/foundry/client-esm/canvas/tokens/ring-data.d.mts +141 -2
  410. package/src/foundry/client-esm/canvas/tokens/ring.d.mts +284 -2
  411. package/src/foundry/client-esm/client.d.mts +47 -54
  412. package/src/foundry/client-esm/data/_module.d.mts +2 -2
  413. package/src/foundry/client-esm/data/client-backend.d.mts +22 -23
  414. package/src/foundry/client-esm/data/region-behaviors/_module.d.mts +3 -3
  415. package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts +57 -0
  416. package/src/foundry/client-esm/data/region-behaviors/base.d.mts +59 -0
  417. package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts +64 -0
  418. package/src/foundry/client-esm/data/region-behaviors/execute-macro.d.mts +27 -0
  419. package/src/foundry/client-esm/data/region-behaviors/execute-script.d.mts +23 -0
  420. package/src/foundry/client-esm/data/region-behaviors/pause-game.d.mts +23 -0
  421. package/src/foundry/client-esm/data/region-behaviors/suppress-weather.d.mts +17 -0
  422. package/src/foundry/client-esm/data/region-behaviors/teleport-token.d.mts +32 -0
  423. package/src/foundry/client-esm/data/region-behaviors/toggle-behavior.d.mts +31 -0
  424. package/src/foundry/client-esm/dice/_module.d.mts +2 -3
  425. package/src/foundry/client-esm/dice/parser.d.mts +11 -25
  426. package/src/foundry/client-esm/dice/roll.d.mts +115 -89
  427. package/src/foundry/client-esm/dice/terms/_module.d.mts +2 -3
  428. package/src/foundry/client-esm/dice/terms/coin.d.mts +8 -5
  429. package/src/foundry/client-esm/dice/terms/dice.d.mts +93 -63
  430. package/src/foundry/client-esm/dice/terms/die.d.mts +11 -4
  431. package/src/foundry/client-esm/dice/terms/fate.d.mts +9 -2
  432. package/src/foundry/client-esm/dice/terms/function.d.mts +18 -18
  433. package/src/foundry/client-esm/dice/terms/numeric.d.mts +3 -5
  434. package/src/foundry/client-esm/dice/terms/operator.d.mts +2 -2
  435. package/src/foundry/client-esm/dice/terms/parenthetical.d.mts +9 -10
  436. package/src/foundry/client-esm/dice/terms/pool.d.mts +25 -31
  437. package/src/foundry/client-esm/dice/terms/string.d.mts +4 -4
  438. package/src/foundry/client-esm/dice/terms/term.d.mts +18 -4
  439. package/src/foundry/client-esm/dice/twister.d.mts +3 -3
  440. package/src/foundry/client-esm/helpers/_module.d.mts +2 -2
  441. package/src/foundry/client-esm/helpers/_types.d.mts +12 -46
  442. package/src/foundry/client-esm/helpers/compendium-art.d.mts +56 -4
  443. package/src/foundry/common/abstract/_types.d.mts +60 -54
  444. package/src/foundry/common/abstract/backend.d.mts +51 -45
  445. package/src/foundry/common/abstract/data.d.mts +140 -154
  446. package/src/foundry/common/abstract/document.d.mts +1305 -421
  447. package/src/foundry/common/abstract/embedded-collection-delta.d.mts +1 -1
  448. package/src/foundry/common/abstract/embedded-collection.d.mts +37 -7
  449. package/src/foundry/common/abstract/module.d.mts +3 -2
  450. package/src/foundry/common/abstract/singleton-collection.d.mts +1 -1
  451. package/src/foundry/common/abstract/socket.d.mts +1 -1
  452. package/src/foundry/common/abstract/type-data.d.mts +62 -54
  453. package/src/foundry/common/config.d.mts +5 -3
  454. package/src/foundry/common/constants.d.mts +261 -231
  455. package/src/foundry/common/data/data.d.mts +200 -94
  456. package/src/foundry/common/data/fields.d.mts +746 -585
  457. package/src/foundry/common/data/module.d.mts +2 -2
  458. package/src/foundry/common/data/validation-failure.d.mts +12 -9
  459. package/src/foundry/common/documents/_module.d.mts +4 -2
  460. package/src/foundry/common/documents/_types.d.mts +22 -50
  461. package/src/foundry/common/documents/active-effect.d.mts +280 -177
  462. package/src/foundry/common/documents/actor-delta.d.mts +318 -69
  463. package/src/foundry/common/documents/actor.d.mts +305 -117
  464. package/src/foundry/common/documents/adventure.d.mts +266 -141
  465. package/src/foundry/common/documents/ambient-light.d.mts +268 -75
  466. package/src/foundry/common/documents/ambient-sound.d.mts +268 -109
  467. package/src/foundry/common/documents/card.d.mts +267 -174
  468. package/src/foundry/common/documents/cards.d.mts +299 -126
  469. package/src/foundry/common/documents/chat-message.d.mts +276 -158
  470. package/src/foundry/common/documents/combat.d.mts +300 -89
  471. package/src/foundry/common/documents/combatant.d.mts +275 -88
  472. package/src/foundry/common/documents/drawing.d.mts +286 -206
  473. package/src/foundry/common/documents/fog-exploration.d.mts +258 -70
  474. package/src/foundry/common/documents/folder.d.mts +252 -81
  475. package/src/foundry/common/documents/item.d.mts +305 -99
  476. package/src/foundry/common/documents/journal-entry-page.d.mts +279 -189
  477. package/src/foundry/common/documents/journal-entry.d.mts +294 -68
  478. package/src/foundry/common/documents/macro.d.mts +254 -132
  479. package/src/foundry/common/documents/measured-template.d.mts +293 -139
  480. package/src/foundry/common/documents/note.d.mts +274 -149
  481. package/src/foundry/common/documents/playlist-sound.d.mts +260 -94
  482. package/src/foundry/common/documents/playlist.d.mts +279 -120
  483. package/src/foundry/common/documents/region-behavior.d.mts +329 -0
  484. package/src/foundry/common/documents/region.d.mts +327 -0
  485. package/src/foundry/common/documents/roll-table.d.mts +286 -102
  486. package/src/foundry/common/documents/scene.d.mts +276 -336
  487. package/src/foundry/common/documents/setting.d.mts +229 -54
  488. package/src/foundry/common/documents/table-result.d.mts +267 -96
  489. package/src/foundry/common/documents/tile.d.mts +301 -170
  490. package/src/foundry/common/documents/token.d.mts +351 -445
  491. package/src/foundry/common/documents/user.d.mts +256 -144
  492. package/src/foundry/common/documents/wall.d.mts +273 -161
  493. package/src/foundry/common/grid/_module.d.mts +3 -3
  494. package/src/foundry/common/grid/base.d.mts +66 -49
  495. package/src/foundry/common/grid/gridless.d.mts +2 -2
  496. package/src/foundry/common/grid/hexagonal.d.mts +40 -29
  497. package/src/foundry/common/grid/square.d.mts +3 -3
  498. package/src/foundry/common/packages/base-module.d.mts +6 -24
  499. package/src/foundry/common/packages/base-package.d.mts +23 -21
  500. package/src/foundry/common/packages/base-system.d.mts +6 -63
  501. package/src/foundry/common/packages/base-world.d.mts +8 -61
  502. package/src/foundry/common/packages/module.d.mts +7 -7
  503. package/src/foundry/common/packages/sub-types.d.mts +2 -2
  504. package/src/foundry/common/primitives/array.d.mts +4 -4
  505. package/src/foundry/common/primitives/math.d.mts +7 -1
  506. package/src/foundry/common/primitives/number.d.mts +2 -2
  507. package/src/foundry/common/primitives/set.d.mts +17 -14
  508. package/src/foundry/common/primitives/string.d.mts +1 -1
  509. package/src/foundry/common/prosemirror/_module.d.mts +15 -15
  510. package/src/foundry/common/prosemirror/dirty-plugin.d.mts +1 -1
  511. package/src/foundry/common/prosemirror/dom-parser.d.mts +2 -1
  512. package/src/foundry/common/prosemirror/dropdown.d.mts +1 -1
  513. package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts +2 -2
  514. package/src/foundry/common/prosemirror/image-plugin.d.mts +1 -1
  515. package/src/foundry/common/prosemirror/menu.d.mts +3 -3
  516. package/src/foundry/common/prosemirror/paste-transformer.d.mts +1 -1
  517. package/src/foundry/common/prosemirror/plugin.d.mts +2 -2
  518. package/src/foundry/common/prosemirror/schema/index.d.mts +0 -1
  519. package/src/foundry/common/prosemirror/schema/lists.d.mts +2 -0
  520. package/src/foundry/common/prosemirror/util.d.mts +1 -1
  521. package/src/foundry/common/types.d.mts +3 -3
  522. package/src/foundry/common/utils/bitmask.d.mts +23 -11
  523. package/src/foundry/common/utils/collection.d.mts +61 -38
  524. package/src/foundry/common/utils/color.d.mts +20 -2
  525. package/src/foundry/common/utils/event-emitter.d.mts +32 -17
  526. package/src/foundry/common/utils/geometry.d.mts +12 -2
  527. package/src/foundry/common/utils/helpers.d.mts +36 -26
  528. package/src/foundry/common/utils/http.d.mts +2 -2
  529. package/src/foundry/common/utils/module.d.mts +2 -2
  530. package/src/foundry/common/utils/string-tree.d.mts +45 -39
  531. package/src/foundry/common/utils/word-tree.d.mts +10 -23
  532. package/src/foundry/index.d.mts +0 -1
  533. package/src/foundry/{clipper → public/scripts/clipper}/clipper.d.mts +52 -43
  534. package/src/foundry/public/scripts/index.d.mts +1 -0
  535. package/src/foundry/public/scripts/workers/image-compressor.d.mts +23 -0
  536. package/src/foundry/public/scripts/workers/index.d.mts +1 -0
  537. package/{index-lenient.d.mts → src/index-lenient.d.mts} +2 -0
  538. package/src/index.d.mts +6 -0
  539. package/src/tsconfig.json +15 -0
  540. package/src/types/augments/particles.d.mts +29 -0
  541. package/src/types/augments/pixi.d.mts +1024 -21
  542. package/src/types/augments/smooth.d.mts +31 -0
  543. package/src/types/augments/tinyMCE.d.mts +1 -1
  544. package/src/types/config.d.mts +20 -311
  545. package/src/types/documentConfiguration.d.mts +286 -542
  546. package/src/types/index.d.mts +1 -1
  547. package/src/types/lib.d.mts +12 -0
  548. package/src/types/workers/image-compressor.d.mts +176 -0
  549. package/src/utils/index.d.mts +1279 -0
  550. package/tsconfig.json +29 -0
  551. package/tsconfig.main.json +8 -0
  552. package/tsconfig.miscellaneous.json +16 -0
  553. package/index.d.mts +0 -5
  554. package/src/foundry/client/apps/placeables/light-config.d.mts +0 -100
  555. package/src/foundry/client/apps/placeables/sound-config.d.mts +0 -43
  556. package/src/foundry/common/documents/module.d.mts +0 -35
  557. package/src/foundry/common/primitives/regex.d.mts +0 -12
  558. package/src/types/helperTypes.d.mts +0 -389
  559. package/src/types/utils.d.mts +0 -520
  560. /package/src/foundry/{clipper → public/scripts/clipper}/index.d.mts +0 -0
@@ -1,4 +1,4 @@
1
- import type { ValueOf } from "../../types/utils.d.mts";
1
+ import type { Brand, ValueOf } from "fvtt-types/utils";
2
2
 
3
3
  /**
4
4
  * The shortened software name
@@ -39,14 +39,14 @@ export declare const ACTIVE_EFFECT_MODES: Readonly<{
39
39
  /**
40
40
  * Used to denote that the handling of the effect is programmatically provided by a system or module.
41
41
  */
42
- CUSTOM: 0;
42
+ CUSTOM: 0 & ACTIVE_EFFECT_MODES;
43
43
 
44
44
  /**
45
45
  * Multiplies a numeric base value by the numeric effect value
46
46
  * @example
47
47
  * 2 (base value) * 3 (effect value) = 6 (derived value)
48
48
  */
49
- MULTIPLY: 1;
49
+ MULTIPLY: 1 & ACTIVE_EFFECT_MODES;
50
50
 
51
51
  /**
52
52
  * Adds a numeric base value to a numeric effect value, or concatenates strings
@@ -55,7 +55,7 @@ export declare const ACTIVE_EFFECT_MODES: Readonly<{
55
55
  * @example
56
56
  * "Hello" (base value) + " World" (effect value) = "Hello World"
57
57
  */
58
- ADD: 2;
58
+ ADD: 2 & ACTIVE_EFFECT_MODES;
59
59
 
60
60
  /**
61
61
  * Keeps the lower value of the base value and the effect value
@@ -64,7 +64,7 @@ export declare const ACTIVE_EFFECT_MODES: Readonly<{
64
64
  * @example
65
65
  * 2 (base value), 3 (effect value) = 2 (derived value)
66
66
  */
67
- DOWNGRADE: 3;
67
+ DOWNGRADE: 3 & ACTIVE_EFFECT_MODES;
68
68
 
69
69
  /**
70
70
  * Keeps the greater value of the base value and the effect value
@@ -73,21 +73,22 @@ export declare const ACTIVE_EFFECT_MODES: Readonly<{
73
73
  * @example
74
74
  * 2 (base value), 1 (effect value) = 2 (derived value)
75
75
  */
76
- UPGRADE: 4;
76
+ UPGRADE: 4 & ACTIVE_EFFECT_MODES;
77
77
 
78
78
  /**
79
79
  * Directly replaces the base value with the effect value
80
80
  * @example
81
81
  * 2 (base value), 4 (effect value) = 4 (derived value)
82
82
  */
83
- OVERRIDE: 5;
83
+ OVERRIDE: 5 & ACTIVE_EFFECT_MODES;
84
84
  }>;
85
- export type ACTIVE_EFFECT_MODES = ValueOf<typeof ACTIVE_EFFECT_MODES>;
85
+ export type ACTIVE_EFFECT_MODES = Brand<number, "constants.ACTIVE_EFFECT_MODES">;
86
86
 
87
87
  /**
88
88
  * Define the string name used for the base document type when specific sub-types are not defined by the system
89
89
  */
90
90
  export declare const BASE_DOCUMENT_TYPE: "base";
91
+ export type BASE_DOCUMENT_TYPE = "base";
91
92
 
92
93
  /**
93
94
  * Define the methods by which a Card can be drawn from a Cards stack
@@ -96,45 +97,45 @@ export declare const BASE_DOCUMENT_TYPE: "base";
96
97
  export declare const CARD_DRAW_MODES: Readonly<{
97
98
  /**
98
99
  * Draw the first card from the stack
99
- * Synonymous with @see CARD_DRAW_MODES.TOP
100
+ * Synonymous with @see {@link CARD_DRAW_MODES.TOP | `CARD_DRAW_MODES.TOP`}
100
101
  */
101
- FIRST: 0;
102
+ FIRST: 0 & CARD_DRAW_MODES;
102
103
 
103
104
  /**
104
105
  * Draw the top card from the stack
105
- * Synonymous with @see CARD_DRAW_MODES.FIRST
106
+ * Synonymous with @see {@link CARD_DRAW_MODES.FIRST | `CARD_DRAW_MODES.FIRST`}
106
107
  */
107
- TOP: 0;
108
+ TOP: 0 & CARD_DRAW_MODES;
108
109
 
109
110
  /**
110
111
  * Draw the last card from the stack
111
- * Synonymous with @see CARD_DRAW_MODES.BOTTOM
112
+ * Synonymous with @see {@link CARD_DRAW_MODES.BOTTOM | `CARD_DRAW_MODES.BOTTOM`}
112
113
  */
113
- LAST: 1;
114
+ LAST: 1 & CARD_DRAW_MODES;
114
115
 
115
116
  /**
116
117
  * Draw the bottom card from the stack
117
- * Synonymous with @see CARD_DRAW_MODES.LAST
118
+ * Synonymous with @see {@link CARD_DRAW_MODES.LAST | `CARD_DRAW_MODES.LAST`}
118
119
  */
119
- BOTTOM: 1;
120
+ BOTTOM: 1 & CARD_DRAW_MODES;
120
121
 
121
122
  /**
122
123
  * Draw a random card from the stack
123
124
  */
124
- RANDOM: 2;
125
+ RANDOM: 2 & CARD_DRAW_MODES;
125
126
  }>;
126
- export type CARD_DRAW_MODES = ValueOf<typeof CARD_DRAW_MODES>;
127
+ export type CARD_DRAW_MODES = Brand<number, "constants.CARD_DRAW_MODES">;
127
128
 
128
129
  /**
129
130
  * An enumeration of canvas performance modes.
130
131
  */
131
132
  export declare const CANVAS_PERFORMANCE_MODES: Readonly<{
132
- LOW: 0;
133
- MED: 1;
134
- HIGH: 2;
135
- MAX: 3;
133
+ LOW: 0 & CANVAS_PERFORMANCE_MODES;
134
+ MED: 1 & CANVAS_PERFORMANCE_MODES;
135
+ HIGH: 2 & CANVAS_PERFORMANCE_MODES;
136
+ MAX: 3 & CANVAS_PERFORMANCE_MODES;
136
137
  }>;
137
- export type CANVAS_PERFORMANCE_MODES = ValueOf<typeof CANVAS_PERFORMANCE_MODES>;
138
+ export type CANVAS_PERFORMANCE_MODES = Brand<number, "constants.CANVAS_PERFORMANCE_MODES">;
138
139
 
139
140
  /**
140
141
  * Valid Chat Message styles which affect how the message is presented in the chat log.
@@ -143,40 +144,40 @@ export declare const CHAT_MESSAGE_STYLES: Readonly<{
143
144
  /**
144
145
  * An uncategorized chat message
145
146
  */
146
- OTHER: 0;
147
+ OTHER: 0 & CHAT_MESSAGE_STYLES;
147
148
 
148
149
  /**
149
150
  * The message is spoken out of character (OOC).
150
151
  * OOC messages will be outlined by the player's color to make them more easily recognizable.
151
152
  */
152
- OOC: 1;
153
+ OOC: 1 & CHAT_MESSAGE_STYLES;
153
154
 
154
155
  /**
155
156
  * The message is spoken by an associated character.
156
157
  */
157
- IC: 2;
158
+ IC: 2 & CHAT_MESSAGE_STYLES;
158
159
 
159
160
  /**
160
161
  * The message is an emote performed by the selected character.
161
162
  * Entering "/emote waves his hand." while controlling a character named Simon will send the message, "Simon waves his hand."
162
163
  */
163
- EMOTE: 3;
164
+ EMOTE: 3 & CHAT_MESSAGE_STYLES;
164
165
 
165
166
  /**
166
167
  * @deprecated since v12
167
168
  *
168
169
  * @remarks Define rolls directly in ChatMessage#rolls instead.
169
170
  */
170
- ROLL: 0;
171
+ ROLL: 0 & CHAT_MESSAGE_STYLES;
171
172
 
172
173
  /**
173
174
  * @deprecated since v12
174
175
  *
175
176
  * @remarks Define whispers directly in ChatMessage#whisper instead.
176
177
  */
177
- WHISPER: 0;
178
+ WHISPER: 0 & CHAT_MESSAGE_STYLES;
178
179
  }>;
179
- export type CHAT_MESSAGE_STYLES = ValueOf<typeof CHAT_MESSAGE_STYLES>;
180
+ export type CHAT_MESSAGE_STYLES = Brand<number, "constants.CHAT_MESSAGE_STYLES">;
180
181
 
181
182
  /**
182
183
  * Define the set of languages which have built-in support in the core software
@@ -190,37 +191,37 @@ export declare const COMPATIBILITY_MODES: Readonly<{
190
191
  /**
191
192
  * Nothing will be logged
192
193
  */
193
- SILENT: 0;
194
+ SILENT: 0 & COMPATIBILITY_MODES;
194
195
 
195
196
  /**
196
197
  * A message will be logged at the "warn" level
197
198
  */
198
- WARNING: 1;
199
+ WARNING: 1 & COMPATIBILITY_MODES;
199
200
 
200
201
  /**
201
202
  * A message will be logged at the "error" level
202
203
  */
203
- ERROR: 2;
204
+ ERROR: 2 & COMPATIBILITY_MODES;
204
205
 
205
206
  /**
206
207
  * An Error will be thrown
207
208
  */
208
- FAILURE: 3;
209
+ FAILURE: 3 & COMPATIBILITY_MODES;
209
210
  }>;
210
- export type COMPATIBILITY_MODES = ValueOf<typeof COMPATIBILITY_MODES>;
211
+ export type COMPATIBILITY_MODES = Brand<number, "constants.COMPATIBILITY_MODES">;
211
212
 
212
213
  /**
213
214
  * The lighting illumination levels which are supported.
214
215
  */
215
216
  export declare const LIGHTING_LEVELS: Readonly<{
216
- DARKNESS: -2;
217
- HALFDARK: -1;
218
- UNLIT: 0;
219
- DIM: 1;
220
- BRIGHT: 2;
221
- BRIGHTEST: 3;
217
+ DARKNESS: -2 & LIGHTING_LEVELS;
218
+ HALFDARK: -1 & LIGHTING_LEVELS;
219
+ UNLIT: 0 & LIGHTING_LEVELS;
220
+ DIM: 1 & LIGHTING_LEVELS;
221
+ BRIGHT: 2 & LIGHTING_LEVELS;
222
+ BRIGHTEST: 3 & LIGHTING_LEVELS;
222
223
  }>;
223
- export type LIGHTING_LEVELS = ValueOf<typeof LIGHTING_LEVELS>;
224
+ export type LIGHTING_LEVELS = Brand<number, "constants.LIGHTING_LEVELS">;
224
225
 
225
226
  /**
226
227
  * The CSS themes which are currently supported for the V11 Setup menu.
@@ -331,44 +332,44 @@ export type COMPENDIUM_DOCUMENT_TYPES = ValueOf<typeof COMPENDIUM_DOCUMENT_TYPES
331
332
  * Define the allowed ownership levels for a Document.
332
333
  * Each level is assigned a value in ascending order.
333
334
  * Higher levels grant more permissions.
334
- * @see https://foundryvtt.com/article/users/
335
+ * @see {@link https://foundryvtt.com/article/users/}
335
336
  */
336
337
  export declare const DOCUMENT_OWNERSHIP_LEVELS: Readonly<{
337
338
  /**
338
339
  * The User inherits permissions from the parent Folder.
339
340
  */
340
- INHERIT: -1;
341
+ INHERIT: -1 & DOCUMENT_OWNERSHIP_LEVELS;
341
342
 
342
343
  /**
343
344
  * Restricts the associated Document so that it may not be seen by this User.
344
345
  */
345
- NONE: 0;
346
+ NONE: 0 & DOCUMENT_OWNERSHIP_LEVELS;
346
347
 
347
348
  /**
348
349
  * Allows the User to interact with the Document in basic ways, allowing them to see it in sidebars and see only limited aspects of its contents. The limits of this interaction are defined by the game system being used.
349
350
  */
350
- LIMITED: 1;
351
+ LIMITED: 1 & DOCUMENT_OWNERSHIP_LEVELS;
351
352
 
352
353
  /**
353
354
  * Allows the User to view this Document as if they were owner, but prevents them from making any changes to it.
354
355
  */
355
- OBSERVER: 2;
356
+ OBSERVER: 2 & DOCUMENT_OWNERSHIP_LEVELS;
356
357
 
357
358
  /**
358
359
  * Allows the User to view and make changes to the Document as its owner. Owned documents cannot be deleted by anyone other than a gamemaster level User.
359
360
  */
360
- OWNER: 3;
361
+ OWNER: 3 & DOCUMENT_OWNERSHIP_LEVELS;
361
362
  }>;
362
- export type DOCUMENT_OWNERSHIP_LEVELS = ValueOf<typeof DOCUMENT_OWNERSHIP_LEVELS>;
363
+ export type DOCUMENT_OWNERSHIP_LEVELS = Brand<number, "constants.DOCUMENT_OWNERSHIP_LEVELS">;
363
364
 
364
365
  /**
365
366
  * Meta ownership levels that are used in the UI but never stored.
366
367
  */
367
368
  export declare const DOCUMENT_META_OWNERSHIP_LEVELS: Readonly<{
368
- DEFAULT: -20;
369
- NOCHANGE: -10;
369
+ DEFAULT: -20 & DOCUMENT_META_OWNERSHIP_LEVELS;
370
+ NOCHANGE: -10 & DOCUMENT_META_OWNERSHIP_LEVELS;
370
371
  }>;
371
- export type DOCUMENT_META_OWNERSHIP_LEVELS = ValueOf<typeof DOCUMENT_META_OWNERSHIP_LEVELS>;
372
+ export type DOCUMENT_META_OWNERSHIP_LEVELS = Brand<number, "constants.DOCUMENT_META_OWNERSHIP_LEVELS">;
372
373
 
373
374
  /**
374
375
  * Define the allowed Document types which may be dynamically linked in chat
@@ -387,7 +388,7 @@ export type DOCUMENT_LINK_TYPES = ValueOf<typeof DOCUMENT_LINK_TYPES>;
387
388
 
388
389
  /**
389
390
  * The supported dice roll visibility modes
390
- * @see https://foundryvtt.com/article/dice/
391
+ * @see {@link https://foundryvtt.com/article/dice/}
391
392
  */
392
393
  export declare const DICE_ROLL_MODES: Readonly<{
393
394
  /**
@@ -414,25 +415,25 @@ export type DICE_ROLL_MODES = ValueOf<typeof DICE_ROLL_MODES>;
414
415
 
415
416
  /**
416
417
  * The allowed fill types which a Drawing object may display
417
- * @see https://foundryvtt.com/article/drawings/
418
+ * @see {@link https://foundryvtt.com/article/drawings/}
418
419
  */
419
420
  export declare const DRAWING_FILL_TYPES: Readonly<{
420
421
  /**
421
422
  * The drawing is not filled
422
423
  */
423
- NONE: 0;
424
+ NONE: 0 & DRAWING_FILL_TYPES;
424
425
 
425
426
  /**
426
427
  * The drawing is filled with a solid color
427
428
  */
428
- SOLID: 1;
429
+ SOLID: 1 & DRAWING_FILL_TYPES;
429
430
 
430
431
  /**
431
432
  * The drawing is filled with a tiled image pattern
432
433
  */
433
- PATTERN: 2;
434
+ PATTERN: 2 & DRAWING_FILL_TYPES;
434
435
  }>;
435
- export type DRAWING_FILL_TYPES = ValueOf<typeof DRAWING_FILL_TYPES>;
436
+ export type DRAWING_FILL_TYPES = Brand<number, "constants.DRAWING_FILL_TYPES">;
436
437
 
437
438
  /**
438
439
  * Define the allowed Document types which Folders may contain
@@ -454,7 +455,7 @@ export type FOLDER_DOCUMENT_TYPES = ValueOf<typeof FOLDER_DOCUMENT_TYPES>;
454
455
  /**
455
456
  * The maximum allowed level of depth for Folder nesting
456
457
  */
457
- export declare const FOLDER_MAX_DEPTH: 4;
458
+ export declare const FOLDER_MAX_DEPTH: number;
458
459
 
459
460
  /**
460
461
  * A list of allowed game URL names
@@ -465,58 +466,58 @@ export declare const GAME_VIEWS: readonly ["game", "stream"];
465
466
  * The directions of movement.
466
467
  */
467
468
  export declare const MOVEMENT_DIRECTIONS: Readonly<{
468
- UP: 0x1;
469
- DOWN: 0x2;
470
- LEFT: 0x4;
471
- RIGHT: 0x8;
472
- UP_LEFT: 0x1 | 0x4;
473
- UP_RIGHT: 0x1 | 0x8;
474
- DOWN_LEFT: 0x2 | 0x4;
475
- DOWN_RIGHT: 0x2 | 0x8;
469
+ UP: 0x1 & MOVEMENT_DIRECTIONS;
470
+ DOWN: 0x2 & MOVEMENT_DIRECTIONS;
471
+ LEFT: 0x4 & MOVEMENT_DIRECTIONS;
472
+ RIGHT: 0x8 & MOVEMENT_DIRECTIONS;
473
+ UP_LEFT: 0x5 & MOVEMENT_DIRECTIONS;
474
+ UP_RIGHT: 0x9 & MOVEMENT_DIRECTIONS;
475
+ DOWN_LEFT: 0x6 & MOVEMENT_DIRECTIONS;
476
+ DOWN_RIGHT: 0xa & MOVEMENT_DIRECTIONS;
476
477
  }>;
477
- export type MOVEMENT_DIRECTIONS = ValueOf<typeof MOVEMENT_DIRECTIONS>;
478
+ export type MOVEMENT_DIRECTIONS = Brand<number, "constants.MOVEMENT_DIRECTIONS">;
478
479
 
479
480
  /**
480
481
  * The minimum allowed grid size which is supported by the software
481
482
  */
482
- export declare const GRID_MIN_SIZE: 20;
483
+ export declare const GRID_MIN_SIZE: number;
483
484
 
484
485
  /**
485
486
  * The allowed Grid types which are supported by the software
486
- * @see https://foundryvtt.com/article/scenes/
487
+ * @see {@link https://foundryvtt.com/article/scenes/}
487
488
  */
488
489
  export declare const GRID_TYPES: Readonly<{
489
490
  /**
490
491
  * No fixed grid is used on this Scene allowing free-form point-to-point measurement without grid lines.
491
492
  */
492
- GRIDLESS: 0;
493
+ GRIDLESS: 0 & GRID_TYPES;
493
494
 
494
495
  /**
495
496
  * A square grid is used with width and height of each grid space equal to the chosen grid size.
496
497
  */
497
- SQUARE: 1;
498
+ SQUARE: 1 & GRID_TYPES;
498
499
 
499
500
  /**
500
501
  * A row-wise hexagon grid (pointy-topped) where odd-numbered rows are offset.
501
502
  */
502
- HEXODDR: 2;
503
+ HEXODDR: 2 & GRID_TYPES;
503
504
 
504
505
  /**
505
506
  * A row-wise hexagon grid (pointy-topped) where even-numbered rows are offset.
506
507
  */
507
- HEXEVENR: 3;
508
+ HEXEVENR: 3 & GRID_TYPES;
508
509
 
509
510
  /**
510
511
  * A column-wise hexagon grid (flat-topped) where odd-numbered columns are offset.
511
512
  */
512
- HEXODDQ: 4;
513
+ HEXODDQ: 4 & GRID_TYPES;
513
514
 
514
515
  /**
515
516
  * A column-wise hexagon grid (flat-topped) where even-numbered columns are offset.
516
517
  */
517
- HEXEVENQ: 5;
518
+ HEXEVENQ: 5 & GRID_TYPES;
518
519
  }>;
519
- export type GRID_TYPES = ValueOf<typeof GRID_TYPES>;
520
+ export type GRID_TYPES = Brand<number, "constants.GRID_TYPES">;
520
521
 
521
522
  /**
522
523
  * The different rules to define and measure diagonal distance/cost in a square grid.
@@ -526,22 +527,22 @@ export declare const GRID_DIAGONALS: Readonly<{
526
527
  /**
527
528
  * The diagonal distance is 1. Diagonal movement costs the same as horizontal/vertical movement.
528
529
  */
529
- EQUIDISTANT: 0;
530
+ EQUIDISTANT: 0 & GRID_DIAGONALS;
530
531
 
531
532
  /**
532
533
  * The diagonal distance is √2. Diagonal movement costs √2 times as much as horizontal/vertical movement.
533
534
  */
534
- EXACT: 1;
535
+ EXACT: 1 & GRID_DIAGONALS;
535
536
 
536
537
  /**
537
538
  * The diagonal distance is 1.5. Diagonal movement costs 1.5 times as much as horizontal/vertical movement.
538
539
  */
539
- APPROXIMATE: 2;
540
+ APPROXIMATE: 2 & GRID_DIAGONALS;
540
541
 
541
542
  /**
542
543
  * The diagonal distance is 2. Diagonal movement costs 2 times as much as horizontal/vertical movement.
543
544
  */
544
- RECTILINEAR: 3;
545
+ RECTILINEAR: 3 & GRID_DIAGONALS;
545
546
 
546
547
  /**
547
548
  * The diagonal distance alternates between 1 and 2 starting at 1.
@@ -549,7 +550,7 @@ export declare const GRID_DIAGONALS: Readonly<{
549
550
  * The second diagonal movement costs 2 times as much as horizontal/vertical movement.
550
551
  * And so on...
551
552
  */
552
- ALTERNATING_1: 4;
553
+ ALTERNATING_1: 4 & GRID_DIAGONALS;
553
554
 
554
555
  /**
555
556
  * The diagonal distance alternates between 2 and 1 starting at 2.
@@ -557,14 +558,14 @@ export declare const GRID_DIAGONALS: Readonly<{
557
558
  * The second diagonal movement costs the same as horizontal/vertical movement.
558
559
  * And so on...
559
560
  */
560
- ALTERNATING_2: 5;
561
+ ALTERNATING_2: 5 & GRID_DIAGONALS;
561
562
 
562
563
  /**
563
564
  * The diagonal distance is ∞. Diagonal movement is not allowed/possible.
564
565
  */
565
- ILLEGAL: 6;
566
+ ILLEGAL: 6 & GRID_DIAGONALS;
566
567
  }>;
567
- export type GRID_DIAGONALS = ValueOf<typeof GRID_DIAGONALS>;
568
+ export type GRID_DIAGONALS = Brand<number, "constants.GRID_DIAGONALS">;
568
569
 
569
570
  /**
570
571
  * The grid snapping modes.
@@ -573,92 +574,92 @@ export declare const GRID_SNAPPING_MODES: Readonly<{
573
574
  /**
574
575
  * Nearest center point.
575
576
  */
576
- CENTER: 0x1;
577
+ CENTER: 0x1 & GRID_SNAPPING_MODES;
577
578
 
578
579
  /**
579
580
  * Nearest edge midpoint.
580
581
  */
581
- EDGE_MIDPOINT: 0x2;
582
+ EDGE_MIDPOINT: 0x2 & GRID_SNAPPING_MODES;
582
583
 
583
584
  /**
584
585
  * Nearest top-left vertex.
585
586
  */
586
- TOP_LEFT_VERTEX: 0x10;
587
+ TOP_LEFT_VERTEX: 0x10 & GRID_SNAPPING_MODES;
587
588
 
588
589
  /**
589
590
  * Nearest top-right vertex.
590
591
  */
591
- TOP_RIGHT_VERTEX: 0x20;
592
+ TOP_RIGHT_VERTEX: 0x20 & GRID_SNAPPING_MODES;
592
593
 
593
594
  /**
594
595
  * Nearest bottom-left vertex.
595
596
  */
596
- BOTTOM_LEFT_VERTEX: 0x40;
597
+ BOTTOM_LEFT_VERTEX: 0x40 & GRID_SNAPPING_MODES;
597
598
 
598
599
  /**
599
600
  * Nearest bottom-right vertex.
600
601
  */
601
- BOTTOM_RIGHT_VERTEX: 0x80;
602
+ BOTTOM_RIGHT_VERTEX: 0x80 & GRID_SNAPPING_MODES;
602
603
 
603
604
  /**
604
605
  * Nearest vertex.
605
606
  * Alias for `TOP_LEFT_VERTEX | TOP_RIGHT_VERTEX | BOTTOM_LEFT_VERTEX | BOTTOM_RIGHT_VERTEX`.
606
607
  */
607
- VERTEX: 0xf0;
608
+ VERTEX: 0xf0 & GRID_SNAPPING_MODES;
608
609
 
609
610
  /**
610
611
  * Nearest top-left corner.
611
612
  */
612
- TOP_LEFT_CORNER: 0x100;
613
+ TOP_LEFT_CORNER: 0x100 & GRID_SNAPPING_MODES;
613
614
 
614
615
  /**
615
616
  * Nearest top-right corner.
616
617
  */
617
- TOP_RIGHT_CORNER: 0x200;
618
+ TOP_RIGHT_CORNER: 0x200 & GRID_SNAPPING_MODES;
618
619
 
619
620
  /**
620
621
  * Nearest bottom-left corner.
621
622
  */
622
- BOTTOM_LEFT_CORNER: 0x400;
623
+ BOTTOM_LEFT_CORNER: 0x400 & GRID_SNAPPING_MODES;
623
624
 
624
625
  /**
625
626
  * Nearest bottom-right corner.
626
627
  */
627
- BOTTOM_RIGHT_CORNER: 0x800;
628
+ BOTTOM_RIGHT_CORNER: 0x800 & GRID_SNAPPING_MODES;
628
629
 
629
630
  /**
630
631
  * Nearest corner.
631
632
  * Alias for `TOP_LEFT_CORNER | TOP_RIGHT_CORNER | BOTTOM_LEFT_CORNER | BOTTOM_RIGHT_CORNER`.
632
633
  */
633
- CORNER: 0xf00;
634
+ CORNER: 0xf00 & GRID_SNAPPING_MODES;
634
635
 
635
636
  /**
636
637
  * Nearest top side midpoint.
637
638
  */
638
- TOP_SIDE_MIDPOINT: 0x1000;
639
+ TOP_SIDE_MIDPOINT: 0x1000 & GRID_SNAPPING_MODES;
639
640
 
640
641
  /**
641
642
  * Nearest bottom side midpoint.
642
643
  */
643
- BOTTOM_SIDE_MIDPOINT: 0x2000;
644
+ BOTTOM_SIDE_MIDPOINT: 0x2000 & GRID_SNAPPING_MODES;
644
645
 
645
646
  /**
646
647
  * Nearest left side midpoint.
647
648
  */
648
- LEFT_SIDE_MIDPOINT: 0x4000;
649
+ LEFT_SIDE_MIDPOINT: 0x4000 & GRID_SNAPPING_MODES;
649
650
 
650
651
  /**
651
652
  * Nearest right side midpoint.
652
653
  */
653
- RIGHT_SIDE_MIDPOINT: 0x8000;
654
+ RIGHT_SIDE_MIDPOINT: 0x8000 & GRID_SNAPPING_MODES;
654
655
 
655
656
  /**
656
657
  * Nearest side midpoint.
657
658
  * Alias for `TOP_SIDE_MIDPOINT | BOTTOM_SIDE_MIDPOINT | LEFT_SIDE_MIDPOINT | RIGHT_SIDE_MIDPOINT`.
658
659
  */
659
- SIDE_MIDPOINT: 0xf000;
660
+ SIDE_MIDPOINT: 0xf000 & GRID_SNAPPING_MODES;
660
661
  }>;
661
- export type GRID_SNAPPING_MODES = ValueOf<typeof GRID_SNAPPING_MODES>;
662
+ export type GRID_SNAPPING_MODES = Brand<number, "constants.GRID_SNAPPING_MODES">;
662
663
 
663
664
  /**
664
665
  * A list of supported setup URL names
@@ -673,7 +674,7 @@ export type MACRO_SCOPES = ValueOf<typeof MACRO_SCOPES>;
673
674
 
674
675
  /**
675
676
  * An enumeration of valid Macro types
676
- * @see https://foundryvtt.com/article/macros/
677
+ * @see {@link https://foundryvtt.com/article/macros/}
677
678
  */
678
679
  export declare const MACRO_TYPES: Readonly<{
679
680
  /**
@@ -700,35 +701,35 @@ export type AUDIO_CHANNELS = ValueOf<typeof AUDIO_CHANNELS>;
700
701
 
701
702
  /**
702
703
  * The allowed playback modes for an audio Playlist
703
- * @see https://foundryvtt.com/article/playlists/
704
+ * @see {@link https://foundryvtt.com/article/playlists/}
704
705
  */
705
706
  export declare const PLAYLIST_MODES: Readonly<{
706
707
  /**
707
708
  * The playlist does not play on its own, only individual Sound tracks played as a soundboard.
708
709
  */
709
- DISABLED: -1;
710
+ DISABLED: -1 & PLAYLIST_MODES;
710
711
 
711
712
  /**
712
713
  * The playlist plays sounds one at a time in sequence.
713
714
  */
714
- SEQUENTIAL: 0;
715
+ SEQUENTIAL: 0 & PLAYLIST_MODES;
715
716
 
716
717
  /**
717
718
  * The playlist plays sounds one at a time in randomized order.
718
719
  */
719
- SHUFFLE: 1;
720
+ SHUFFLE: 1 & PLAYLIST_MODES;
720
721
 
721
722
  /**
722
723
  * The playlist plays all contained sounds at the same time.
723
724
  */
724
- SIMULTANEOUS: 2;
725
+ SIMULTANEOUS: 2 & PLAYLIST_MODES;
725
726
  }>;
726
- export type PLAYLIST_MODES = ValueOf<typeof PLAYLIST_MODES>;
727
+ export type PLAYLIST_MODES = Brand<number, "constants.PLAYLIST_MODES">;
727
728
 
728
729
  /**
729
730
  * The available sort modes for an audio Playlist.
730
731
  * @defaultValue `"a"`
731
- * @see https://foundryvtt.com/article/playlists/
732
+ * @see {@link https://foundryvtt.com/article/playlists/}
732
733
  */
733
734
  export declare const PLAYLIST_SORT_MODES: Readonly<{
734
735
  /**
@@ -766,59 +767,59 @@ export declare const PACKAGE_AVAILABILITY_CODES: Readonly<{
766
767
  /**
767
768
  * Package availability could not be determined
768
769
  */
769
- UNKNOWN: 0;
770
+ UNKNOWN: 0 & PACKAGE_AVAILABILITY_CODES;
770
771
 
771
772
  /**
772
773
  * The Package is verified to be compatible with the current core software build
773
774
  */
774
- VERIFIED: 1;
775
+ VERIFIED: 1 & PACKAGE_AVAILABILITY_CODES;
775
776
 
776
777
  /**
777
778
  * Package is available for use, but not verified for the current core software build
778
779
  */
779
- UNVERIFIED_BUILD: 2;
780
+ UNVERIFIED_BUILD: 2 & PACKAGE_AVAILABILITY_CODES;
780
781
 
781
782
  /**
782
783
  * One or more installed system is incompatible with the Package.
783
784
  */
784
- UNVERIFIED_SYSTEM: 3;
785
+ UNVERIFIED_SYSTEM: 3 & PACKAGE_AVAILABILITY_CODES;
785
786
 
786
787
  /**
787
788
  * Package is available for use, but not verified for the current core software generation
788
789
  */
789
- UNVERIFIED_GENERATION: 4;
790
+ UNVERIFIED_GENERATION: 4 & PACKAGE_AVAILABILITY_CODES;
790
791
 
791
792
  /**
792
793
  * The System that the Package relies on is not available
793
794
  */
794
- MISSING_SYSTEM: 5;
795
+ MISSING_SYSTEM: 5 & PACKAGE_AVAILABILITY_CODES;
795
796
 
796
797
  /**
797
798
  * A dependency of the Package is not available
798
799
  */
799
- MISSING_DEPENDENCY: 6;
800
+ MISSING_DEPENDENCY: 6 & PACKAGE_AVAILABILITY_CODES;
800
801
 
801
802
  /**
802
803
  * The Package is compatible with an older version of Foundry than the currently installed version
803
804
  */
804
- REQUIRES_CORE_DOWNGRADE: 7;
805
+ REQUIRES_CORE_DOWNGRADE: 7 & PACKAGE_AVAILABILITY_CODES;
805
806
 
806
807
  /**
807
808
  * The Package is compatible with a newer version of Foundry than the currently installed version, and that version is Stable
808
809
  */
809
- REQUIRES_CORE_UPGRADE_STABLE: 8;
810
+ REQUIRES_CORE_UPGRADE_STABLE: 8 & PACKAGE_AVAILABILITY_CODES;
810
811
 
811
812
  /**
812
813
  * The Package is compatible with a newer version of Foundry than the currently installed version, and that version is not yet Stable
813
814
  */
814
- REQUIRES_CORE_UPGRADE_UNSTABLE: 9;
815
+ REQUIRES_CORE_UPGRADE_UNSTABLE: 9 & PACKAGE_AVAILABILITY_CODES;
815
816
 
816
817
  /**
817
818
  * A required dependency is not compatible with the current version of Foundry
818
819
  */
819
- REQUIRES_DEPENDENCY_UPDATE: 10;
820
+ REQUIRES_DEPENDENCY_UPDATE: 10 & PACKAGE_AVAILABILITY_CODES;
820
821
  }>;
821
- export type PACKAGE_AVAILABILITY_CODES = ValueOf<typeof PACKAGE_AVAILABILITY_CODES>;
822
+ export type PACKAGE_AVAILABILITY_CODES = Brand<number, "constants.PACKAGE_AVAILABILITY_CODES">;
822
823
 
823
824
  /**
824
825
  * A safe password string which can be displayed
@@ -854,11 +855,11 @@ export type SOFTWARE_UPDATE_CHANNELS = ValueOf<typeof SOFTWARE_UPDATE_CHANNELS>;
854
855
  /**
855
856
  * The default sorting density for manually ordering child objects within a parent
856
857
  */
857
- export declare const SORT_INTEGER_DENSITY: 100000;
858
+ export declare const SORT_INTEGER_DENSITY: number;
858
859
 
859
860
  /**
860
861
  * The allowed types of a TableResult document
861
- * @see https://foundryvtt.com/article/roll-tables/
862
+ * @see {@link https://foundryvtt.com/article/roll-tables/}
862
863
  */
863
864
  export declare const TABLE_RESULT_TYPES: Readonly<{
864
865
  /**
@@ -880,90 +881,92 @@ export type TABLE_RESULT_TYPES = ValueOf<typeof TABLE_RESULT_TYPES>;
880
881
 
881
882
  /**
882
883
  * The allowed formats of a Journal Entry Page.
883
- * @see https://foundryvtt.com/article/journal/
884
+ * @see {@link https://foundryvtt.com/article/journal/}
884
885
  */
885
886
  export declare const JOURNAL_ENTRY_PAGE_FORMATS: Readonly<{
886
887
  /**
887
888
  * The page is formatted as HTML.
888
889
  */
889
- HTML: 1;
890
+ HTML: 1 & JOURNAL_ENTRY_PAGE_FORMATS;
890
891
 
891
892
  /**
892
893
  * The page is formatted as Markdown.
893
894
  */
894
- MARKDOWN: 2;
895
+ MARKDOWN: 2 & JOURNAL_ENTRY_PAGE_FORMATS;
895
896
  }>;
896
- export type JOURNAL_ENTRY_PAGE_FORMATS = ValueOf<typeof JOURNAL_ENTRY_PAGE_FORMATS>;
897
+ export type JOURNAL_ENTRY_PAGE_FORMATS = Brand<number, "constants.JOURNAL_ENTRY_PAGE_FORMATS">;
897
898
 
898
899
  /**
899
900
  * Define the valid anchor locations for a Tooltip displayed on a Placeable Object
900
- * @see TooltipManager
901
+ * @see {@link TooltipManager | `TooltipManager`}
901
902
  */
902
903
  export declare const TEXT_ANCHOR_POINTS: Readonly<{
903
904
  /**
904
905
  * Anchor the tooltip to the center of the element.
905
906
  */
906
- CENTER: 0;
907
+ CENTER: 0 & TEXT_ANCHOR_POINTS;
907
908
 
908
909
  /**
909
910
  * Anchor the tooltip to the bottom of the element.
910
911
  */
911
- BOTTOM: 1;
912
+ BOTTOM: 1 & TEXT_ANCHOR_POINTS;
912
913
 
913
914
  /**
914
915
  * Anchor the tooltip to the top of the element.
915
916
  */
916
- TOP: 2;
917
+ TOP: 2 & TEXT_ANCHOR_POINTS;
917
918
 
918
919
  /**
919
920
  * Anchor the tooltip to the left of the element.
920
921
  */
921
- LEFT: 3;
922
+ LEFT: 3 & TEXT_ANCHOR_POINTS;
922
923
 
923
924
  /**
924
925
  * Anchor the tooltip to the right of the element.
925
926
  */
926
- RIGHT: 4;
927
+ RIGHT: 4 & TEXT_ANCHOR_POINTS;
927
928
  }>;
928
- export type TEXT_ANCHOR_POINTS = ValueOf<typeof TEXT_ANCHOR_POINTS>;
929
+ export type TEXT_ANCHOR_POINTS = Brand<number, "constants.TEXT_ANCHOR_POINTS">;
929
930
 
930
931
  /**
931
932
  * Define the valid occlusion modes which a tile can use
932
933
  * @defaultValue `1`
933
- * @see https://foundryvtt.com/article/tiles/
934
+ * @see {@link https://foundryvtt.com/article/tiles/}
934
935
  */
935
936
  export declare const OCCLUSION_MODES: Readonly<{
936
937
  /**
937
938
  * Turns off occlusion, making the tile never fade while tokens are under it.
938
939
  */
939
- NONE: 0;
940
+ NONE: 0 & OCCLUSION_MODES;
940
941
 
941
942
  /**
942
943
  * Causes the whole tile to fade when an actor token moves under it.
943
944
  * @defaultValue
944
945
  */
945
- FADE: 1;
946
+ FADE: 1 & OCCLUSION_MODES;
946
947
 
947
948
  // ROOF: 2; This mode is no longer supported so we don't use 2 for any other mode
948
949
 
949
950
  /**
950
951
  * Causes the tile to reveal the background in the vicinity of an actor token under it. The radius is determined by the token's size.
951
952
  */
952
- RADIAL: 3;
953
+ RADIAL: 3 & OCCLUSION_MODES;
953
954
 
954
955
  /**
955
956
  * Causes the tile to be partially revealed based on the vision of the actor, which does not need to be under the tile to see what's beneath it.
956
957
  * @remarks (by Foundry) This is useful for rooves on buildings where players could see through a window or door, viewing only a portion of what is obscured by the roof itself.
957
958
  */
958
- VISION: 4;
959
+ VISION: 4 & OCCLUSION_MODES;
959
960
  }>;
960
- export type OCCLUSION_MODES = ValueOf<typeof OCCLUSION_MODES>;
961
+ export type OCCLUSION_MODES = Brand<number, "constants.OCCLUSION_MODES">;
961
962
 
962
963
  /**
963
964
  * Alias for old tile occlusion modes definition
964
965
  */
965
- export declare const TILE_OCCLUSION_MODES: typeof OCCLUSION_MODES;
966
- export type TILE_OCCLUSION_MODES = ValueOf<typeof TILE_OCCLUSION_MODES>;
966
+ export declare const TILE_OCCLUSION_MODES: {
967
+ [K in keyof typeof OCCLUSION_MODES]: TILE_OCCLUSION_MODES;
968
+ };
969
+ export type TILE_OCCLUSION_MODES = Brand<number, "constants.TILE_OCCLUSION_MODES">;
967
970
 
968
971
  /**
969
972
  * The occlusion modes that define the set of tokens that trigger occlusion.
@@ -972,93 +975,93 @@ export declare const TOKEN_OCCLUSION_MODES: Readonly<{
972
975
  /**
973
976
  * Owned tokens that aren't hidden.
974
977
  */
975
- OWNED: 0x1;
978
+ OWNED: 0x1 & TOKEN_OCCLUSION_MODES;
976
979
 
977
980
  /**
978
981
  * Controlled tokens.
979
982
  */
980
- CONTROLLED: 0x2;
983
+ CONTROLLED: 0x2 & TOKEN_OCCLUSION_MODES;
981
984
 
982
985
  /**
983
986
  * Hovered tokens that are visible.
984
987
  */
985
- HOVERED: 0x4;
988
+ HOVERED: 0x4 & TOKEN_OCCLUSION_MODES;
986
989
 
987
990
  /**
988
991
  * Highlighted tokens that are visible.
989
992
  */
990
- HIGHLIGHTED: 0x8;
993
+ HIGHLIGHTED: 0x8 & TOKEN_OCCLUSION_MODES;
991
994
 
992
995
  /**
993
996
  * All visible tokens.
994
997
  */
995
- VISIBLE: 0x10;
998
+ VISIBLE: 0x10 & TOKEN_OCCLUSION_MODES;
996
999
  }>;
997
- export type TOKEN_OCCLUSION_MODES = ValueOf<typeof TOKEN_OCCLUSION_MODES>;
1000
+ export type TOKEN_OCCLUSION_MODES = Brand<number, "constants.TOKEN_OCCLUSION_MODES">;
998
1001
 
999
1002
  /**
1000
1003
  * Describe the various thresholds of token control upon which to show certain pieces of information
1001
- * @see https://foundryvtt.com/article/tokens/
1004
+ * @see {@link https://foundryvtt.com/article/tokens/}
1002
1005
  */
1003
1006
  export declare const TOKEN_DISPLAY_MODES: Readonly<{
1004
1007
  /**
1005
1008
  * No information is displayed.
1006
1009
  */
1007
- NONE: 0;
1010
+ NONE: 0 & TOKEN_DISPLAY_MODES;
1008
1011
 
1009
1012
  /**
1010
1013
  * Displayed when the token is controlled.
1011
1014
  */
1012
- CONTROL: 10;
1015
+ CONTROL: 10 & TOKEN_DISPLAY_MODES;
1013
1016
 
1014
1017
  /**
1015
1018
  * Displayed when hovered by a GM or a user who owns the actor.
1016
1019
  */
1017
- OWNER_HOVER: 20;
1020
+ OWNER_HOVER: 20 & TOKEN_DISPLAY_MODES;
1018
1021
 
1019
1022
  /**
1020
1023
  * Displayed when hovered by any user.
1021
1024
  */
1022
- HOVER: 30;
1025
+ HOVER: 30 & TOKEN_DISPLAY_MODES;
1023
1026
 
1024
1027
  /**
1025
1028
  * Always displayed for a GM or for a user who owns the actor.
1026
1029
  */
1027
- OWNER: 40;
1030
+ OWNER: 40 & TOKEN_DISPLAY_MODES;
1028
1031
 
1029
1032
  /**
1030
1033
  * Always displayed for everyone.
1031
1034
  */
1032
- ALWAYS: 50;
1035
+ ALWAYS: 50 & TOKEN_DISPLAY_MODES;
1033
1036
  }>;
1034
- export type TOKEN_DISPLAY_MODES = ValueOf<typeof TOKEN_DISPLAY_MODES>;
1037
+ export type TOKEN_DISPLAY_MODES = Brand<number, "constants.TOKEN_DISPLAY_MODES">;
1035
1038
 
1036
1039
  /**
1037
1040
  * The allowed Token disposition types
1038
- * @see https://foundryvtt.com/article/tokens/
1041
+ * @see {@link https://foundryvtt.com/article/tokens/}
1039
1042
  */
1040
1043
  export declare const TOKEN_DISPOSITIONS: Readonly<{
1041
1044
  /**
1042
1045
  * Displayed with a purple borders for owners and with no borders for others (and no pointer change).
1043
1046
  */
1044
- SECRET: -2;
1047
+ SECRET: -2 & TOKEN_DISPOSITIONS;
1045
1048
 
1046
1049
  /**
1047
1050
  * Displayed as an enemy with a red border.
1048
1051
  */
1049
- HOSTILE: -1;
1052
+ HOSTILE: -1 & TOKEN_DISPOSITIONS;
1050
1053
 
1051
1054
  /**
1052
1055
  * Displayed as neutral with a yellow border.
1053
1056
  */
1054
- NEUTRAL: 0;
1057
+ NEUTRAL: 0 & TOKEN_DISPOSITIONS;
1055
1058
 
1056
1059
  /**
1057
1060
  * Displayed as an ally with a cyan border.
1058
1061
  */
1059
- FRIENDLY: 1;
1062
+ FRIENDLY: 1 & TOKEN_DISPOSITIONS;
1060
1063
  }>;
1061
- export type TOKEN_DISPOSITIONS = ValueOf<typeof TOKEN_DISPOSITIONS>;
1064
+ export type TOKEN_DISPOSITIONS = Brand<number, "constants.TOKEN_DISPOSITIONS">;
1062
1065
 
1063
1066
  /**
1064
1067
  * The possible shapes of Tokens in hexagonal grids.
@@ -1067,80 +1070,108 @@ export declare const TOKEN_HEXAGONAL_SHAPES: Readonly<{
1067
1070
  /**
1068
1071
  * Ellipse (Variant 1)
1069
1072
  */
1070
- ELLIPSE_1: 0;
1073
+ ELLIPSE_1: 0 & TOKEN_HEXAGONAL_SHAPES;
1071
1074
 
1072
1075
  /**
1073
1076
  * Ellipse (Variant 2)
1074
1077
  */
1075
- ELLIPSE_2: 1;
1078
+ ELLIPSE_2: 1 & TOKEN_HEXAGONAL_SHAPES;
1076
1079
 
1077
1080
  /**
1078
1081
  * Trapezoid (Variant 1)
1079
1082
  */
1080
- TRAPEZOID_1: 2;
1083
+ TRAPEZOID_1: 2 & TOKEN_HEXAGONAL_SHAPES;
1081
1084
 
1082
1085
  /**
1083
1086
  * Trapezoid (Variant 2)
1084
1087
  */
1085
- TRAPEZOID_2: 3;
1088
+ TRAPEZOID_2: 3 & TOKEN_HEXAGONAL_SHAPES;
1086
1089
 
1087
1090
  /**
1088
1091
  * Rectangle (Variant 1)
1089
1092
  */
1090
- RECTANGLE_1: 4;
1093
+ RECTANGLE_1: 4 & TOKEN_HEXAGONAL_SHAPES;
1091
1094
 
1092
1095
  /**
1093
1096
  * Rectangle (Variant 2)
1094
1097
  */
1095
- RECTANGLE_2: 5;
1098
+ RECTANGLE_2: 5 & TOKEN_HEXAGONAL_SHAPES;
1096
1099
  }>;
1097
- export type TOKEN_HEXAGONAL_SHAPES = ValueOf<typeof TOKEN_HEXAGONAL_SHAPES>;
1100
+ export type TOKEN_HEXAGONAL_SHAPES = Brand<number, "constants.TOKEN_HEXAGONAL_SHAPES">;
1098
1101
 
1099
1102
  /**
1100
1103
  * Define the allowed User permission levels.
1101
1104
  * Each level is assigned a value in ascending order. Higher levels grant more permissions.
1102
- * @see https://foundryvtt.com/article/users/
1105
+ * @see {@link https://foundryvtt.com/article/users/}
1103
1106
  */
1104
1107
  export declare const USER_ROLES: Readonly<{
1105
1108
  /**
1106
1109
  * The User is blocked from taking actions in Foundry Virtual Tabletop.
1107
1110
  * You can use this role to temporarily or permanently ban a user from joining the game.
1108
1111
  */
1109
- NONE: 0;
1112
+ NONE: 0 & USER_ROLES;
1110
1113
 
1111
1114
  /**
1112
1115
  * The User is able to join the game with permissions available to a standard player.
1113
1116
  * They cannot take some more advanced actions which require Trusted permissions, but they have the basic functionalities needed to operate in the virtual tabletop.
1114
1117
  */
1115
- PLAYER: 1;
1118
+ PLAYER: 1 & USER_ROLES;
1116
1119
 
1117
1120
  /**
1118
1121
  * Similar to the Player role, except a Trusted User has the ability to perform some more advanced actions like create drawings, measured templates, or even to (optionally) upload media files to the server.
1119
1122
  */
1120
- TRUSTED: 2;
1123
+ TRUSTED: 2 & USER_ROLES;
1121
1124
 
1122
1125
  /**
1123
1126
  * A special User who has many of the same in-game controls as a Game Master User, but does not have the ability to perform administrative actions like changing User roles or modifying World-level settings.
1124
1127
  */
1125
- ASSISTANT: 3;
1128
+ ASSISTANT: 3 & USER_ROLES;
1126
1129
 
1127
1130
  /**
1128
- * A special User who has administrative control over this specific World.
1129
- * Game Masters behave quite differently than Players in that they have the ability to see all Documents and Objects within the world as well as the capability to configure World settings.
1131
+ * A special User who has administrative control over this specific World.
1132
+ * Game Masters behave quite differently than Players in that they have the ability to see all Documents and Objects within the world as well as the capability to configure World settings.
1130
1133
  */
1131
- GAMEMASTER: 4;
1134
+ GAMEMASTER: 4 & USER_ROLES;
1132
1135
  }>;
1133
- export type USER_ROLES = ValueOf<typeof USER_ROLES>;
1136
+ export type USER_ROLES = Brand<number, "constants.USER_ROLES">;
1134
1137
 
1135
1138
  /**
1136
1139
  * Invert the User Role mapping to recover role names from a role integer
1137
1140
  */
1138
- export declare const USER_ROLE_NAMES: Readonly<{ [Key in keyof typeof USER_ROLES as (typeof USER_ROLES)[Key]]: Key }>;
1141
+ export declare const USER_ROLE_NAMES: Readonly<{
1142
+ /**
1143
+ * The User is blocked from taking actions in Foundry Virtual Tabletop.
1144
+ * You can use this role to temporarily or permanently ban a user from joining the game.
1145
+ */
1146
+ "0": "NONE";
1147
+
1148
+ /**
1149
+ * The User is able to join the game with permissions available to a standard player.
1150
+ * They cannot take some more advanced actions which require Trusted permissions, but they have the basic functionalities needed to operate in the virtual tabletop.
1151
+ */
1152
+ "1": "PLAYER";
1153
+
1154
+ /**
1155
+ * Similar to the Player role, except a Trusted User has the ability to perform some more advanced actions like create drawings, measured templates, or even to (optionally) upload media files to the server.
1156
+ */
1157
+ "2": "TRUSTED";
1158
+
1159
+ /**
1160
+ * A special User who has many of the same in-game controls as a Game Master User, but does not have the ability to perform administrative actions like changing User roles or modifying World-level settings.
1161
+ */
1162
+ "3": "ASSISTANT";
1163
+
1164
+ /**
1165
+ * A special User who has administrative control over this specific World.
1166
+ * Game Masters behave quite differently than Players in that they have the ability to see all Documents and Objects within the world as well as the capability to configure World settings.
1167
+ */
1168
+ "4": "GAMEMASTER";
1169
+ }>;
1139
1170
  export type USER_ROLE_NAMES = ValueOf<typeof USER_ROLE_NAMES>;
1140
1171
 
1141
1172
  /**
1142
1173
  * An enumeration of the allowed types for a MeasuredTemplate embedded document
1143
- * @see https://foundryvtt.com/article/measurement/
1174
+ * @see {@link https://foundryvtt.com/article/measurement/}
1144
1175
  */
1145
1176
  export declare const MEASURED_TEMPLATE_TYPES: Readonly<{
1146
1177
  /**
@@ -1479,69 +1510,69 @@ export declare const USER_PERMISSIONS: Readonly<{
1479
1510
 
1480
1511
  /**
1481
1512
  * The allowed directions of effect that a Wall can have
1482
- * @see https://foundryvtt.com/article/walls/
1513
+ * @see {@link https://foundryvtt.com/article/walls/}
1483
1514
  */
1484
1515
  export declare const WALL_DIRECTIONS: Readonly<{
1485
1516
  /**
1486
1517
  * The wall collides from both directions.
1487
1518
  */
1488
- BOTH: 0;
1519
+ BOTH: 0 & WALL_DIRECTIONS;
1489
1520
 
1490
1521
  /**
1491
1522
  * The wall collides only when a ray strikes its left side.
1492
1523
  */
1493
- LEFT: 1;
1524
+ LEFT: 1 & WALL_DIRECTIONS;
1494
1525
 
1495
1526
  /**
1496
1527
  * The wall collides only when a ray strikes its right side.
1497
1528
  */
1498
- RIGHT: 2;
1529
+ RIGHT: 2 & WALL_DIRECTIONS;
1499
1530
  }>;
1500
- export type WALL_DIRECTIONS = ValueOf<typeof WALL_DIRECTIONS>;
1531
+ export type WALL_DIRECTIONS = Brand<number, "constants.WALL_DIRECTIONS">;
1501
1532
 
1502
1533
  /**
1503
1534
  * The allowed door types which a Wall may contain
1504
- * @see https://foundryvtt.com/article/walls/
1535
+ * @see {@link https://foundryvtt.com/article/walls/}
1505
1536
  */
1506
1537
  export declare const WALL_DOOR_TYPES: Readonly<{
1507
1538
  /**
1508
1539
  * The wall does not contain a door.
1509
1540
  */
1510
- NONE: 0;
1541
+ NONE: 0 & WALL_DOOR_TYPES;
1511
1542
 
1512
1543
  /**
1513
1544
  * The wall contains a regular door.
1514
1545
  */
1515
- DOOR: 1;
1546
+ DOOR: 1 & WALL_DOOR_TYPES;
1516
1547
 
1517
1548
  /**
1518
1549
  * The wall contains a secret door.
1519
1550
  */
1520
- SECRET: 2;
1551
+ SECRET: 2 & WALL_DOOR_TYPES;
1521
1552
  }>;
1522
- export type WALL_DOOR_TYPES = ValueOf<typeof WALL_DOOR_TYPES>;
1553
+ export type WALL_DOOR_TYPES = Brand<number, "constants.WALL_DOOR_TYPES">;
1523
1554
 
1524
1555
  /**
1525
1556
  * The allowed door states which may describe a Wall that contains a door
1526
- * @see https://foundryvtt.com/article/walls/
1557
+ * @see {@link https://foundryvtt.com/article/walls/}
1527
1558
  */
1528
1559
  export declare const WALL_DOOR_STATES: Readonly<{
1529
1560
  /**
1530
1561
  * The door is closed.
1531
1562
  */
1532
- CLOSED: 0;
1563
+ CLOSED: 0 & WALL_DOOR_STATES;
1533
1564
 
1534
1565
  /**
1535
1566
  * The door is open.
1536
1567
  */
1537
- OPEN: 1;
1568
+ OPEN: 1 & WALL_DOOR_STATES;
1538
1569
 
1539
1570
  /**
1540
1571
  * The door is closed and locked.
1541
1572
  */
1542
- LOCKED: 2;
1573
+ LOCKED: 2 & WALL_DOOR_STATES;
1543
1574
  }>;
1544
- export type WALL_DOOR_STATES = ValueOf<typeof WALL_DOOR_STATES>;
1575
+ export type WALL_DOOR_STATES = Brand<number, "constants.WALL_DOOR_STATES">;
1545
1576
 
1546
1577
  /**
1547
1578
  * The possible ways to interact with a door
@@ -1557,39 +1588,39 @@ export type WALL_RESTRICTION_TYPES = ValueOf<typeof WALL_RESTRICTION_TYPES>;
1557
1588
 
1558
1589
  /**
1559
1590
  * The types of sensory collision which a Wall may impose
1560
- * @see https://foundryvtt.com/article/walls/
1591
+ * @see {@link https://foundryvtt.com/article/walls/}
1561
1592
  */
1562
1593
  export declare const WALL_SENSE_TYPES: Readonly<{
1563
1594
  /**
1564
1595
  * Senses do not collide with this wall.
1565
1596
  */
1566
- NONE: 0;
1597
+ NONE: 0 & WALL_SENSE_TYPES;
1567
1598
 
1568
1599
  /**
1569
1600
  * Senses collide with this wall.
1570
1601
  */
1571
- LIMITED: 10;
1602
+ LIMITED: 10 & WALL_SENSE_TYPES;
1572
1603
 
1573
1604
  /**
1574
1605
  * Senses collide with the second intersection, bypassing the first.
1575
1606
  */
1576
- NORMAL: 20;
1607
+ NORMAL: 20 & WALL_SENSE_TYPES;
1577
1608
 
1578
1609
  /**
1579
1610
  * Senses bypass the wall within a certain proximity threshold.
1580
1611
  */
1581
- PROXIMITY: 30;
1612
+ PROXIMITY: 30 & WALL_SENSE_TYPES;
1582
1613
 
1583
1614
  /**
1584
1615
  * Senses bypass the wall outside a certain proximity threshold.
1585
1616
  */
1586
- DISTANCE: 40;
1617
+ DISTANCE: 40 & WALL_SENSE_TYPES;
1587
1618
  }>;
1588
- export type WALL_SENSE_TYPES = ValueOf<typeof WALL_SENSE_TYPES>;
1619
+ export type WALL_SENSE_TYPES = Brand<number, "constants.WALL_SENSE_TYPES">;
1589
1620
 
1590
1621
  /**
1591
1622
  * The types of movement collision which a Wall may impose
1592
- * @see https://foundryvtt.com/article/walls/
1623
+ * @see {@link https://foundryvtt.com/article/walls/}
1593
1624
  */
1594
1625
  export declare const WALL_MOVEMENT_TYPES: Readonly<{
1595
1626
  /**
@@ -1606,25 +1637,25 @@ export type WALL_MOVEMENT_TYPES = ValueOf<typeof WALL_MOVEMENT_TYPES>;
1606
1637
 
1607
1638
  /**
1608
1639
  * The possible precedence values a Keybinding might run in
1609
- * @see https://foundryvtt.com/article/keybinds/
1640
+ * @see {@link https://foundryvtt.com/article/keybinds/}
1610
1641
  */
1611
1642
  export declare const KEYBINDING_PRECEDENCE: Readonly<{
1612
1643
  /**
1613
1644
  * Runs in the first group along with other PRIORITY keybindings.
1614
1645
  */
1615
- PRIORITY: 0;
1646
+ PRIORITY: 0 & KEYBINDING_PRECEDENCE;
1616
1647
 
1617
1648
  /**
1618
1649
  * Runs after the PRIORITY group along with other NORMAL keybindings.
1619
1650
  */
1620
- NORMAL: 1;
1651
+ NORMAL: 1 & KEYBINDING_PRECEDENCE;
1621
1652
 
1622
1653
  /**
1623
1654
  * Runs in the last group along with other DEFERRED keybindings.
1624
1655
  */
1625
- DEFERRED: 2;
1656
+ DEFERRED: 2 & KEYBINDING_PRECEDENCE;
1626
1657
  }>;
1627
- export type KEYBINDING_PRECEDENCE = ValueOf<typeof KEYBINDING_PRECEDENCE>;
1658
+ export type KEYBINDING_PRECEDENCE = Brand<number, "constants.KEYBINDING_PRECEDENCE">;
1628
1659
 
1629
1660
  /**
1630
1661
  * The allowed set of HTML template extensions
@@ -1761,17 +1792,17 @@ export declare const FILE_CATEGORIES: {
1761
1792
  * A font weight to name mapping.
1762
1793
  */
1763
1794
  export declare const FONT_WEIGHTS: {
1764
- Thin: 100;
1765
- ExtraLight: 200;
1766
- Light: 300;
1767
- Regular: 400;
1768
- Medium: 500;
1769
- SemiBold: 600;
1770
- Bold: 700;
1771
- ExtraBold: 800;
1772
- Black: 900;
1795
+ Thin: 100 & FONT_WEIGHTS;
1796
+ ExtraLight: 200 & FONT_WEIGHTS;
1797
+ Light: 300 & FONT_WEIGHTS;
1798
+ Regular: 400 & FONT_WEIGHTS;
1799
+ Medium: 500 & FONT_WEIGHTS;
1800
+ SemiBold: 600 & FONT_WEIGHTS;
1801
+ Bold: 700 & FONT_WEIGHTS;
1802
+ ExtraBold: 800 & FONT_WEIGHTS;
1803
+ Black: 900 & FONT_WEIGHTS;
1773
1804
  };
1774
- export type FONT_WEIGHTS = ValueOf<typeof FONT_WEIGHTS>;
1805
+ export type FONT_WEIGHTS = Brand<number, "constants.FONT_WEIGHTS">;
1775
1806
 
1776
1807
  /**
1777
1808
  * Stores shared commonly used timeouts, measured in MS
@@ -1780,19 +1811,19 @@ export declare const TIMEOUTS: Readonly<{
1780
1811
  /**
1781
1812
  * The default timeout for interacting with the foundryvtt.com API.
1782
1813
  */
1783
- FOUNDRY_WEBSITE: 10000;
1814
+ FOUNDRY_WEBSITE: 10000 & TIMEOUTS;
1784
1815
 
1785
1816
  /**
1786
1817
  * The specific timeout for loading the list of packages from the foundryvtt.com API.
1787
1818
  */
1788
- PACKAGE_REPOSITORY: 5000;
1819
+ PACKAGE_REPOSITORY: 5000 & TIMEOUTS;
1789
1820
 
1790
1821
  /**
1791
1822
  * The specific timeout for the IP address lookup service.
1792
1823
  */
1793
- IP_DISCOVERY: 5000;
1824
+ IP_DISCOVERY: 5000 & TIMEOUTS;
1794
1825
  }>;
1795
- export type TIMEOUTS = ValueOf<typeof TIMEOUTS>;
1826
+ export type TIMEOUTS = Brand<number, "constants.TIMEOUTS">;
1796
1827
 
1797
1828
  /**
1798
1829
  * A subset of Compendium types which require a specific system to be designated
@@ -1811,7 +1842,6 @@ export declare const SHOWDOWN_OPTIONS: Readonly<{
1811
1842
  tables: true;
1812
1843
  tablesHeaderId: true;
1813
1844
  }>;
1814
- export type SHOWDOWN_OPTIONS = ValueOf<typeof SHOWDOWN_OPTIONS>;
1815
1845
 
1816
1846
  /**
1817
1847
  * The list of allowed attributes in HTML elements.
@@ -1951,7 +1981,7 @@ export declare const COMBAT_ANNOUNCEMENTS: readonly ["startEncounter", "nextUp",
1951
1981
  export type COMBAT_ANNOUNCEMENTS = ValueOf<typeof COMBAT_ANNOUNCEMENTS>;
1952
1982
 
1953
1983
  /**
1954
- * The fit modes of {@link foundry.data.TextureData#fit}.
1984
+ * The fit modes of {@link foundry.data.TextureData.fit | `foundry.data.TextureData#fit`}.
1955
1985
  */
1956
1986
  export declare const TEXTURE_DATA_FIT_MODES: readonly ["fill", "contain", "cover", "width", "height"];
1957
1987
  export type TEXTURE_DATA_FIT_MODES = ValueOf<typeof TEXTURE_DATA_FIT_MODES>;
@@ -1959,7 +1989,7 @@ export type TEXTURE_DATA_FIT_MODES = ValueOf<typeof TEXTURE_DATA_FIT_MODES>;
1959
1989
  /**
1960
1990
  * The maximum depth to recurse to when embedding enriched text.
1961
1991
  */
1962
- export const TEXT_ENRICH_EMBED_MAX_DEPTH = 5;
1992
+ export const TEXT_ENRICH_EMBED_MAX_DEPTH: number;
1963
1993
 
1964
1994
  /**
1965
1995
  * The Region events that are supported by core.
@@ -2034,19 +2064,19 @@ export declare const REGION_VISIBILITY: Readonly<{
2034
2064
  /**
2035
2065
  * Only visible on the RegionLayer.
2036
2066
  */
2037
- LAYER: 0;
2067
+ LAYER: 0 & REGION_VISIBILITY;
2038
2068
 
2039
2069
  /**
2040
2070
  * Only visible to Gamemasters.
2041
2071
  */
2042
- GAMEMASTER: 1;
2072
+ GAMEMASTER: 1 & REGION_VISIBILITY;
2043
2073
 
2044
2074
  /**
2045
2075
  * Visible to anyone.
2046
2076
  */
2047
- ALWAYS: 2;
2077
+ ALWAYS: 2 & REGION_VISIBILITY;
2048
2078
  }>;
2049
- export type REGION_VISIBILITY = ValueOf<typeof REGION_VISIBILITY>;
2079
+ export type REGION_VISIBILITY = Brand<number, "constants.REGION_VISIBILITY">;
2050
2080
 
2051
2081
  /**
2052
2082
  * @deprecated since v12