@league-of-foundry-developers/foundry-vtt-types 0.8.9-9 → 9.245.0

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 (295) hide show
  1. package/README.md +44 -27
  2. package/index.d.ts +2 -2
  3. package/package.json +34 -15
  4. package/src/foundry/common/abstract/document.mjs.d.ts +24 -10
  5. package/src/foundry/common/config.mjs/index.d.ts +1 -0
  6. package/src/foundry/common/config.mjs/releaseData.d.ts +98 -0
  7. package/src/foundry/common/constants.mjs.d.ts +403 -213
  8. package/src/foundry/common/data/data.mjs/activeEffectData.d.ts +36 -29
  9. package/src/foundry/common/data/data.mjs/actorData.d.ts +32 -21
  10. package/src/foundry/common/data/data.mjs/adventureData.d.ts +165 -0
  11. package/src/foundry/common/data/data.mjs/ambientLightData.d.ts +45 -124
  12. package/src/foundry/common/data/data.mjs/ambientSoundData.d.ts +49 -77
  13. package/src/foundry/common/data/data.mjs/animationData.d.ts +17 -9
  14. package/src/foundry/common/data/data.mjs/cardData.d.ts +265 -0
  15. package/src/foundry/common/data/data.mjs/cardFaceData.d.ts +66 -0
  16. package/src/foundry/common/data/data.mjs/cardsData.d.ts +238 -0
  17. package/src/foundry/common/data/data.mjs/chatMessageData.d.ts +51 -39
  18. package/src/foundry/common/data/data.mjs/chatSpeakerData.d.ts +18 -11
  19. package/src/foundry/common/data/data.mjs/combatData.d.ts +51 -25
  20. package/src/foundry/common/data/data.mjs/combatantData.d.ts +48 -30
  21. package/src/foundry/common/data/data.mjs/darknessActivation.d.ts +8 -7
  22. package/src/foundry/common/data/data.mjs/drawingData.d.ts +68 -67
  23. package/src/foundry/common/data/data.mjs/effectChangeData.d.ts +21 -25
  24. package/src/foundry/common/data/data.mjs/effectDurationData.d.ts +24 -23
  25. package/src/foundry/common/data/data.mjs/fogExplorationData.d.ts +23 -16
  26. package/src/foundry/common/data/data.mjs/folderData.d.ts +28 -25
  27. package/src/foundry/common/data/data.mjs/index.d.ts +5 -0
  28. package/src/foundry/common/data/data.mjs/itemData.d.ts +26 -18
  29. package/src/foundry/common/data/data.mjs/journalEntryData.d.ts +24 -23
  30. package/src/foundry/common/data/data.mjs/lightData.d.ts +228 -0
  31. package/src/foundry/common/data/data.mjs/macroData.d.ts +52 -35
  32. package/src/foundry/common/data/data.mjs/measuredTemplateData.d.ts +41 -38
  33. package/src/foundry/common/data/data.mjs/noteData.d.ts +47 -37
  34. package/src/foundry/common/data/data.mjs/playlistData.d.ts +55 -26
  35. package/src/foundry/common/data/data.mjs/playlistSoundData.d.ts +32 -16
  36. package/src/foundry/common/data/data.mjs/prototypeTokenData.d.ts +7 -11
  37. package/src/foundry/common/data/data.mjs/rollTableData.d.ts +30 -24
  38. package/src/foundry/common/data/data.mjs/sceneData.d.ts +132 -111
  39. package/src/foundry/common/data/data.mjs/settingData.d.ts +11 -8
  40. package/src/foundry/common/data/data.mjs/tableResultData.d.ts +30 -26
  41. package/src/foundry/common/data/data.mjs/tileData.d.ts +43 -36
  42. package/src/foundry/common/data/data.mjs/tileOcclusion.d.ts +10 -9
  43. package/src/foundry/common/data/data.mjs/tokenBarData.d.ts +6 -3
  44. package/src/foundry/common/data/data.mjs/tokenData.d.ts +105 -157
  45. package/src/foundry/common/data/data.mjs/userData.d.ts +118 -33
  46. package/src/foundry/common/data/data.mjs/videoData.d.ts +9 -8
  47. package/src/foundry/common/data/data.mjs/wallData.d.ts +67 -39
  48. package/src/foundry/common/data/fields.mjs.d.ts +180 -83
  49. package/src/foundry/common/documents.mjs/baseActiveEffect.d.ts +9 -3
  50. package/src/foundry/common/documents.mjs/baseActor.d.ts +17 -45
  51. package/src/foundry/common/documents.mjs/baseAdventure.d.ts +38 -0
  52. package/src/foundry/common/documents.mjs/baseAmbientLight.d.ts +3 -0
  53. package/src/foundry/common/documents.mjs/baseAmbientSound.d.ts +3 -1
  54. package/src/foundry/common/documents.mjs/baseCard.d.ts +62 -0
  55. package/src/foundry/common/documents.mjs/baseCards.d.ts +39 -0
  56. package/src/foundry/common/documents.mjs/baseChatMessage.d.ts +3 -0
  57. package/src/foundry/common/documents.mjs/baseCombat.d.ts +5 -2
  58. package/src/foundry/common/documents.mjs/baseCombatant.d.ts +9 -2
  59. package/src/foundry/common/documents.mjs/baseDrawing.d.ts +11 -1
  60. package/src/foundry/common/documents.mjs/baseFogExploration.d.ts +4 -3
  61. package/src/foundry/common/documents.mjs/baseFolder.d.ts +10 -1
  62. package/src/foundry/common/documents.mjs/baseItem.d.ts +11 -29
  63. package/src/foundry/common/documents.mjs/baseJournalEntry.d.ts +3 -0
  64. package/src/foundry/common/documents.mjs/baseMacro.d.ts +16 -14
  65. package/src/foundry/common/documents.mjs/baseMeasuredTemplate.d.ts +4 -1
  66. package/src/foundry/common/documents.mjs/baseNote.d.ts +2 -2
  67. package/src/foundry/common/documents.mjs/basePlaylist.d.ts +1 -0
  68. package/src/foundry/common/documents.mjs/basePlaylistSound.d.ts +2 -1
  69. package/src/foundry/common/documents.mjs/baseRollTable.d.ts +3 -0
  70. package/src/foundry/common/documents.mjs/baseScene.d.ts +1 -0
  71. package/src/foundry/common/documents.mjs/baseSetting.d.ts +1 -0
  72. package/src/foundry/common/documents.mjs/baseTableResult.d.ts +10 -3
  73. package/src/foundry/common/documents.mjs/baseTile.d.ts +1 -0
  74. package/src/foundry/common/documents.mjs/baseToken.d.ts +3 -0
  75. package/src/foundry/common/documents.mjs/baseUser.d.ts +7 -1
  76. package/src/foundry/common/documents.mjs/baseWall.d.ts +7 -10
  77. package/src/foundry/common/documents.mjs/index.d.ts +3 -0
  78. package/src/foundry/common/module.mjs.d.ts +3 -0
  79. package/src/foundry/common/packages.mjs/moduleData.d.ts +12 -9
  80. package/src/foundry/common/packages.mjs/packageAuthorData.d.ts +24 -24
  81. package/src/foundry/common/packages.mjs/packageCompendiumData.d.ts +27 -21
  82. package/src/foundry/common/packages.mjs/packageData.d.ts +108 -82
  83. package/src/foundry/common/packages.mjs/packageDependencyData.d.ts +18 -11
  84. package/src/foundry/common/packages.mjs/packageLanguageData.d.ts +16 -15
  85. package/src/foundry/common/packages.mjs/systemData.d.ts +21 -20
  86. package/src/foundry/common/packages.mjs/tagPackageAvailability.d.ts +3 -3
  87. package/src/foundry/common/packages.mjs/worldData.d.ts +29 -18
  88. package/src/foundry/common/types.mjs.d.ts +95 -0
  89. package/src/foundry/common/utils/geometry.mjs.d.ts +148 -0
  90. package/src/foundry/common/utils/helpers.mjs.d.ts +64 -39
  91. package/src/foundry/common/utils/module.mjs.d.ts +1 -0
  92. package/src/foundry/common/utils/primitives.mjs.d.ts +106 -16
  93. package/src/foundry/foundry.js/application.d.ts +138 -110
  94. package/src/foundry/foundry.js/applications/basePlaceableHUD.d.ts +2 -2
  95. package/src/foundry/foundry.js/applications/basePlaceableHUDs/drawingHUD.d.ts +2 -2
  96. package/src/foundry/foundry.js/applications/basePlaceableHUDs/tileHUD.d.ts +2 -2
  97. package/src/foundry/foundry.js/applications/basePlaceableHUDs/tokenHUD.d.ts +3 -3
  98. package/src/foundry/foundry.js/applications/cameraViews.d.ts +2 -2
  99. package/src/foundry/foundry.js/applications/chatPopout.d.ts +3 -3
  100. package/src/foundry/foundry.js/applications/compendium.d.ts +2 -2
  101. package/src/foundry/foundry.js/applications/dialog.d.ts +1 -1
  102. package/src/foundry/foundry.js/applications/filePicker.d.ts +2 -2
  103. package/src/foundry/foundry.js/applications/formApplication.d.ts +46 -15
  104. package/src/foundry/foundry.js/applications/formApplications/avConfig.d.ts +1 -1
  105. package/src/foundry/foundry.js/applications/formApplications/combatTrackerConfig.d.ts +2 -2
  106. package/src/foundry/foundry.js/applications/formApplications/defaultTokenConfig.d.ts +1 -1
  107. package/src/foundry/foundry.js/applications/formApplications/documentSheet.d.ts +20 -31
  108. package/src/foundry/foundry.js/applications/formApplications/documentSheets/activeEffectConfig.d.ts +3 -3
  109. package/src/foundry/foundry.js/applications/formApplications/documentSheets/actorSheet.d.ts +2 -2
  110. package/src/foundry/foundry.js/applications/formApplications/documentSheets/ambientLightConfig.d.ts +104 -0
  111. package/src/foundry/foundry.js/applications/formApplications/documentSheets/ambientSoundConfig.d.ts +5 -5
  112. package/src/foundry/foundry.js/applications/formApplications/documentSheets/combatantConfig.d.ts +3 -3
  113. package/src/foundry/foundry.js/applications/formApplications/documentSheets/folderConfig.d.ts +3 -3
  114. package/src/foundry/foundry.js/applications/formApplications/documentSheets/index.d.ts +1 -0
  115. package/src/foundry/foundry.js/applications/formApplications/documentSheets/itemSheet.d.ts +1 -1
  116. package/src/foundry/foundry.js/applications/formApplications/documentSheets/journalSheet.d.ts +1 -1
  117. package/src/foundry/foundry.js/applications/formApplications/documentSheets/lightConfig.d.ts +5 -79
  118. package/src/foundry/foundry.js/applications/formApplications/documentSheets/macroConfig.d.ts +3 -3
  119. package/src/foundry/foundry.js/applications/formApplications/documentSheets/measuredTemplateConfig.d.ts +4 -4
  120. package/src/foundry/foundry.js/applications/formApplications/documentSheets/noteConfig.d.ts +5 -5
  121. package/src/foundry/foundry.js/applications/formApplications/documentSheets/permissionControl.d.ts +7 -7
  122. package/src/foundry/foundry.js/applications/formApplications/documentSheets/playlistConfig.d.ts +4 -4
  123. package/src/foundry/foundry.js/applications/formApplications/documentSheets/playlistSoundConfig.d.ts +3 -3
  124. package/src/foundry/foundry.js/applications/formApplications/documentSheets/rollTableConfig.d.ts +7 -10
  125. package/src/foundry/foundry.js/applications/formApplications/documentSheets/sceneConfig.d.ts +7 -7
  126. package/src/foundry/foundry.js/applications/formApplications/documentSheets/tileConfig.d.ts +3 -3
  127. package/src/foundry/foundry.js/applications/formApplications/documentSheets/userConfig.d.ts +7 -7
  128. package/src/foundry/foundry.js/applications/formApplications/drawingConfig.d.ts +2 -2
  129. package/src/foundry/foundry.js/applications/formApplications/entitySheetConfig.d.ts +3 -3
  130. package/src/foundry/foundry.js/applications/formApplications/gridConfig.d.ts +2 -2
  131. package/src/foundry/foundry.js/applications/formApplications/imagePopout.d.ts +2 -2
  132. package/src/foundry/foundry.js/applications/formApplications/index.d.ts +1 -0
  133. package/src/foundry/foundry.js/applications/formApplications/keybindingsConfig.d.ts +257 -0
  134. package/src/foundry/foundry.js/applications/formApplications/moduleManagement.d.ts +2 -2
  135. package/src/foundry/foundry.js/applications/formApplications/permissionConfig.d.ts +2 -2
  136. package/src/foundry/foundry.js/applications/formApplications/settingsConfig.d.ts +1 -1
  137. package/src/foundry/foundry.js/applications/formApplications/tokenConfig.d.ts +11 -12
  138. package/src/foundry/foundry.js/applications/formApplications/wallConfig.d.ts +9 -9
  139. package/src/foundry/foundry.js/applications/formApplications/worldConfig.d.ts +1 -1
  140. package/src/foundry/foundry.js/applications/frameViewer.d.ts +1 -1
  141. package/src/foundry/foundry.js/applications/headsUpDisplay.d.ts +2 -2
  142. package/src/foundry/foundry.js/applications/hotbar.d.ts +2 -2
  143. package/src/foundry/foundry.js/applications/mainMenu.d.ts +2 -2
  144. package/src/foundry/foundry.js/applications/notifications.d.ts +7 -4
  145. package/src/foundry/foundry.js/applications/pause.d.ts +2 -2
  146. package/src/foundry/foundry.js/applications/playerList.d.ts +2 -2
  147. package/src/foundry/foundry.js/applications/sceneControls.d.ts +2 -2
  148. package/src/foundry/foundry.js/applications/sceneNavigation.d.ts +3 -3
  149. package/src/foundry/foundry.js/applications/sidebar.d.ts +2 -2
  150. package/src/foundry/foundry.js/applications/sidebarTab.d.ts +5 -8
  151. package/src/foundry/foundry.js/applications/sidebarTabs/chatLog.d.ts +8 -7
  152. package/src/foundry/foundry.js/applications/sidebarTabs/combatTracker.d.ts +26 -28
  153. package/src/foundry/foundry.js/applications/sidebarTabs/compendiumDirectory.d.ts +4 -4
  154. package/src/foundry/foundry.js/applications/sidebarTabs/settings.d.ts +2 -2
  155. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/cardsDirectory.d.ts +7 -0
  156. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/index.d.ts +1 -0
  157. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/playlistDirectory.d.ts +2 -2
  158. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectory.d.ts +3 -3
  159. package/src/foundry/foundry.js/audioContainer.d.ts +28 -10
  160. package/src/foundry/foundry.js/avSettings.d.ts +7 -7
  161. package/src/foundry/foundry.js/canvas.d.ts +153 -46
  162. package/src/foundry/foundry.js/canvasAnimation.d.ts +31 -8
  163. package/src/foundry/foundry.js/canvasDocumentMixin.d.ts +7 -0
  164. package/src/foundry/foundry.js/clientDocumentMixin.d.ts +47 -92
  165. package/src/foundry/foundry.js/clientDocuments/activeEffect.d.ts +3 -2
  166. package/src/foundry/foundry.js/clientDocuments/actor.d.ts +11 -11
  167. package/src/foundry/foundry.js/clientDocuments/canvasDocuments/ambientSoundDocument.d.ts +1 -6
  168. package/src/foundry/foundry.js/clientDocuments/card.d.ts +134 -0
  169. package/src/foundry/foundry.js/clientDocuments/cards.d.ts +370 -0
  170. package/src/foundry/foundry.js/clientDocuments/chatMessage.d.ts +11 -10
  171. package/src/foundry/foundry.js/clientDocuments/combat.d.ts +46 -48
  172. package/src/foundry/foundry.js/clientDocuments/combatant.d.ts +15 -18
  173. package/src/foundry/foundry.js/clientDocuments/folder.d.ts +15 -11
  174. package/src/foundry/foundry.js/clientDocuments/index.d.ts +2 -0
  175. package/src/foundry/foundry.js/clientDocuments/item.d.ts +3 -4
  176. package/src/foundry/foundry.js/clientDocuments/playlist.d.ts +4 -3
  177. package/src/foundry/foundry.js/clientDocuments/rollTable.d.ts +2 -2
  178. package/src/foundry/foundry.js/clientDocuments/scene.d.ts +30 -23
  179. package/src/foundry/foundry.js/clientKeybindings.d.ts +309 -0
  180. package/src/foundry/foundry.js/clientSettings.d.ts +12 -10
  181. package/src/foundry/foundry.js/collections/documentCollection.d.ts +1 -1
  182. package/src/foundry/foundry.js/collections/documentCollections/compendiumCollection.d.ts +1 -1
  183. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/cardStacks.d.ts +9 -0
  184. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/folders.d.ts +1 -1
  185. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/index.d.ts +1 -0
  186. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/playlists.d.ts +3 -2
  187. package/src/foundry/foundry.js/collisionResult.d.ts +60 -0
  188. package/src/foundry/foundry.js/config.d.ts +487 -907
  189. package/src/foundry/foundry.js/dragDrop.d.ts +27 -34
  190. package/src/foundry/foundry.js/game.d.ts +171 -50
  191. package/src/foundry/foundry.js/gamepadManager.d.ts +41 -0
  192. package/src/foundry/foundry.js/handlebarsHelpers.d.ts +4 -4
  193. package/src/foundry/foundry.js/hooks.d.ts +210 -84
  194. package/src/foundry/foundry.js/imageHelper.d.ts +26 -2
  195. package/src/foundry/foundry.js/keyboardManager.d.ts +165 -213
  196. package/src/foundry/foundry.js/mouseManager.d.ts +18 -0
  197. package/src/foundry/foundry.js/newUserExperience.d.ts +34 -0
  198. package/src/foundry/foundry.js/pixi/containers/cachedContainer.d.ts +8 -0
  199. package/src/foundry/foundry.js/pixi/containers/cachedContainers/index.d.ts +1 -0
  200. package/src/foundry/foundry.js/pixi/containers/cachedContainers/primaryCanvasGroup.d.ts +42 -0
  201. package/src/foundry/foundry.js/pixi/containers/canvasLayers/gridLayer.d.ts +2 -2
  202. package/src/foundry/foundry.js/pixi/containers/canvasLayers/index.d.ts +1 -1
  203. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/wallsLayer.d.ts +3 -3
  204. package/src/foundry/foundry.js/pixi/containers/canvasLayers/{effectsLayer.d.ts → weatherLayer.d.ts} +7 -7
  205. package/src/foundry/foundry.js/pixi/containers/effectsCanvasGroup.d.ts +29 -0
  206. package/src/foundry/foundry.js/pixi/containers/index.d.ts +3 -0
  207. package/src/foundry/foundry.js/pixi/containers/interfaceCanvasGroup.d.ts +27 -0
  208. package/src/foundry/foundry.js/pixi/containers/placeableObject.d.ts +2 -2
  209. package/src/foundry/foundry.js/pixi/containers/placeableObjects/token.d.ts +3 -3
  210. package/src/foundry/foundry.js/pixi/index.d.ts +3 -0
  211. package/src/foundry/foundry.js/pixi/meshes/index.d.ts +1 -0
  212. package/src/foundry/foundry.js/pixi/meshes/samplerMesh.d.ts +22 -0
  213. package/src/foundry/foundry.js/pixi/points/index.d.ts +1 -0
  214. package/src/foundry/foundry.js/pixi/points/wallEndpoint.d.ts +92 -0
  215. package/src/foundry/foundry.js/pixi/polygons/index.d.ts +2 -1
  216. package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygon.d.ts +98 -0
  217. package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygons/clockwiseSweepPolygon.d.ts +396 -0
  218. package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygons/index.d.ts +1 -0
  219. package/src/foundry/foundry.js/pixi/rectangles/normalizedRectangle.d.ts +7 -0
  220. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShader.d.ts +11 -37
  221. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShader.d.ts +114 -0
  222. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveBackgroundShader.d.ts +57 -0
  223. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShader.d.ts +47 -0
  224. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/bewitchingWaveColorationShader.d.ts +6 -0
  225. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/chromaColorationShader.d.ts +6 -0
  226. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/emanationColorationShader.d.ts +6 -0
  227. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/energyFieldColorationShader.d.ts +6 -0
  228. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/fairyLightColorationShader.d.ts +6 -0
  229. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/fogColorationShader.d.ts +6 -0
  230. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardColorationShaders → adaptiveLightingShaders/adaptiveColorationShaders}/ghostLightColorationShader.d.ts +1 -1
  231. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/hexaDomeColorationShader.d.ts +6 -0
  232. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardColorationShaders → adaptiveLightingShaders/adaptiveColorationShaders}/index.d.ts +5 -0
  233. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/lightDomeColorationShader.d.ts +6 -0
  234. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardColorationShaders → adaptiveLightingShaders/adaptiveColorationShaders}/pulseColorationShader.d.ts +1 -1
  235. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/radialRainbowColorationShader.d.ts +6 -0
  236. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardColorationShaders → adaptiveLightingShaders/adaptiveColorationShaders}/sunburstColorationShader.d.ts +1 -1
  237. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/swirlingRainbowColorationShader.d.ts +6 -0
  238. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardColorationShaders → adaptiveLightingShaders/adaptiveColorationShaders}/torchColorationShader.d.ts +3 -2
  239. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveColorationShaders/vortexColorationShader.d.ts +6 -0
  240. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardColorationShaders → adaptiveLightingShaders/adaptiveColorationShaders}/waveColorationShader.d.ts +1 -1
  241. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveIlluminationShader.d.ts +63 -0
  242. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveIlluminationShaders/bewitchingWaveIlluminationShader.d.ts +6 -0
  243. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardIlluminationShaders → adaptiveLightingShaders/adaptiveIlluminationShaders}/blackHoleIlluminationShader.d.ts +1 -1
  244. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveIlluminationShaders/fairyLightIlluminationShader.d.ts +6 -0
  245. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardIlluminationShaders → adaptiveLightingShaders/adaptiveIlluminationShaders}/ghostLightIlluminationShader.d.ts +1 -1
  246. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardIlluminationShaders → adaptiveLightingShaders/adaptiveIlluminationShaders}/index.d.ts +3 -0
  247. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardIlluminationShaders → adaptiveLightingShaders/adaptiveIlluminationShaders}/pulseIlluminationShader.d.ts +1 -1
  248. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardIlluminationShaders → adaptiveLightingShaders/adaptiveIlluminationShaders}/roilingIlluminationShader.d.ts +1 -1
  249. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardIlluminationShaders → adaptiveLightingShaders/adaptiveIlluminationShaders}/sunburstIlluminationShader.d.ts +1 -2
  250. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardIlluminationShaders → adaptiveLightingShaders/adaptiveIlluminationShaders}/torchIlluminationShader.d.ts +1 -1
  251. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/adaptiveIlluminationShaders/vortexIlluminationShader.d.ts +6 -0
  252. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/{standardIlluminationShaders → adaptiveLightingShaders/adaptiveIlluminationShaders}/waveIlluminationShader.d.ts +1 -1
  253. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/adaptiveLightingShaders/index.d.ts +5 -0
  254. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/baseSamplerShader.d.ts +22 -0
  255. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/index.d.ts +3 -4
  256. package/src/foundry/foundry.js/pixi/texts/preciseText.d.ts +10 -2
  257. package/src/foundry/foundry.js/pixi/transforms/index.d.ts +1 -0
  258. package/src/foundry/foundry.js/pixi/transforms/synchronizedTransform.d.ts +38 -0
  259. package/src/foundry/foundry.js/pointSource.d.ts +59 -328
  260. package/src/foundry/foundry.js/pointSources/index.d.ts +3 -0
  261. package/src/foundry/foundry.js/pointSources/lightSource.d.ts +417 -0
  262. package/src/foundry/foundry.js/pointSources/soundSource.d.ts +46 -0
  263. package/src/foundry/foundry.js/pointSources/visionSource.d.ts +125 -0
  264. package/src/foundry/foundry.js/polygonEdge.d.ts +26 -0
  265. package/src/foundry/foundry.js/polygonVertex.d.ts +89 -0
  266. package/src/foundry/foundry.js/quadtree.d.ts +2 -2
  267. package/src/foundry/foundry.js/quadtreeCulling.d.ts +11 -0
  268. package/src/foundry/foundry.js/ray.d.ts +156 -162
  269. package/src/foundry/foundry.js/rays/index.d.ts +1 -0
  270. package/src/foundry/foundry.js/rays/sightRay.d.ts +34 -0
  271. package/src/foundry/foundry.js/roll.d.ts +51 -65
  272. package/src/foundry/foundry.js/rollTerm.d.ts +7 -4
  273. package/src/foundry/foundry.js/rollTerms/diceTerm.d.ts +4 -22
  274. package/src/foundry/foundry.js/rollTerms/mathTerm.d.ts +3 -0
  275. package/src/foundry/foundry.js/rollTerms/parentheticalTerm.d.ts +3 -0
  276. package/src/foundry/foundry.js/rollTerms/poolTerm.d.ts +3 -5
  277. package/src/foundry/foundry.js/rollTerms/stringTerm.d.ts +4 -1
  278. package/src/foundry/foundry.js/screenCulling.d.ts +19 -0
  279. package/src/foundry/foundry.js/searchFilter.d.ts +37 -33
  280. package/src/foundry/foundry.js/specialEffect.d.ts +1 -1
  281. package/src/foundry/foundry.js/textEditor.d.ts +1 -1
  282. package/src/foundry/foundry.js/textureLoader.d.ts +28 -18
  283. package/src/foundry/foundry.js/textureUtils.d.ts +5 -8
  284. package/src/foundry/foundry.js/videoHelper.d.ts +2 -1
  285. package/src/foundry/index.d.ts +29 -26
  286. package/src/types/utils.d.ts +11 -3
  287. package/src/foundry/foundry.js/pixi/polygons/sourcePolygon.d.ts +0 -25
  288. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShader.d.ts +0 -21
  289. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/chromaColorationShader.d.ts +0 -18
  290. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/emanationColorationShader.d.ts +0 -17
  291. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/energyFieldColorationShader.d.ts +0 -18
  292. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/fogColorationShader.d.ts +0 -17
  293. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/hexaDomeColorationShader.d.ts +0 -17
  294. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardColorationShaders/lightDomeColorationShader.d.ts +0 -17
  295. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShaders/standardIlluminationShader.d.ts +0 -22
@@ -150,9 +150,7 @@ declare global {
150
150
  // eslint-disable-next-line @typescript-eslint/no-empty-interface
151
151
  interface DataConfig {}
152
152
 
153
- /**
154
- * @see {@link DataConfig}
155
- */
153
+ /** @see {@link DataConfig} */
156
154
  // eslint-disable-next-line @typescript-eslint/no-empty-interface
157
155
  interface SourceConfig {}
158
156
 
@@ -174,55 +172,38 @@ declare global {
174
172
  * Configure debugging flags to display additional information
175
173
  */
176
174
  debug: {
177
- /**
178
- * @defaultValue `false`
179
- */
175
+ /** @defaultValue `false` */
180
176
  dice: boolean;
181
177
 
182
- /**
183
- * @defaultValue `false`
184
- */
178
+ /** @defaultValue `false` */
185
179
  documents: boolean;
186
180
 
187
- /**
188
- * @defaultValue `false`
189
- */
181
+ /** @defaultValue `false` */
190
182
  fog: boolean;
191
183
 
192
- /**
193
- * @defaultValue `false`
194
- */
184
+ /** @defaultValue `false` */
195
185
  hooks: boolean;
196
186
 
197
- /**
198
- * @defaultValue `false`
199
- */
200
- sight: boolean;
201
-
202
- /**
203
- * @defaultValue `false`
204
- */
205
- sightRays: boolean;
206
-
207
- /**
208
- * @defaultValue `false`
209
- */
187
+ /** @defaultValue `false` */
210
188
  av: boolean;
211
189
 
212
- /**
213
- * @defaultValue `false`
214
- */
190
+ /** @defaultValue `false` */
215
191
  avclient: boolean;
216
192
 
217
- /**
218
- * @defaultValue `false`
219
- */
193
+ /** @defaultValue `false` */
220
194
  mouseInteraction: boolean;
221
195
 
222
- /**
223
- * @defaultValue `false`
224
- */
196
+ /** @defaultValue `false` */
225
197
  time: boolean;
198
+
199
+ /** @defaultValue `false` */
200
+ keybindings: boolean;
201
+
202
+ /** @defaultValue `false` */
203
+ polygons: boolean;
204
+
205
+ /** @defaultValue `false` */
206
+ gamepad: boolean;
226
207
  };
227
208
 
228
209
  /**
@@ -235,58 +216,86 @@ declare global {
235
216
  * Configuration for the Actor document
236
217
  */
237
218
  Actor: {
238
- /**
239
- * @defaultValue `Actor`
240
- */
219
+ /** @defaultValue `Actor` */
241
220
  documentClass: ConfiguredDocumentClassOrDefault<typeof Actor>;
242
221
 
243
- /**
244
- * @defaultValue `Actors`
245
- */
222
+ /** @defaultValue `Actors` */
246
223
  collection: ConstructorOf<Actors>;
247
224
 
248
- /**
249
- * @defaultValue `{}`
250
- */
251
- sheetClasses: CONFIG.SheetClasses;
225
+ /** @defaultValue `'fas fa-user'` */
226
+ sidebarIcon: string;
252
227
 
253
- /**
254
- * @defaultValue `'fas fa-user'`
255
- */
228
+ /** @defaultValue `{}` */
229
+ typeLabels: Record<string, string>;
230
+ };
231
+
232
+ /**
233
+ * Configuration for the Adventure document.
234
+ * Currently for internal use only.
235
+ * @internal
236
+ */
237
+ Adventure: {
238
+ /** @defaultValue `foundry.documents.BaseAdventure` */
239
+ documentClass: ConfiguredDocumentClassOrDefault<typeof foundry.documents.BaseAdventure>;
240
+ };
241
+
242
+ /**
243
+ * Configuration for the Cards primary Document type
244
+ */
245
+ Cards: {
246
+ /** @defaultValue `CardStacks` */
247
+ collection: ConstructorOf<CardStacks>;
248
+
249
+ /** @defaultValue `Cards` */
250
+ documentClass: ConfiguredDocumentClassOrDefault<typeof Cards>;
251
+
252
+ /** @defaultValue `"fas fa-id-badge"` */
256
253
  sidebarIcon: string;
257
254
 
258
- /**
259
- * @defaultValue `{}`
260
- */
261
- typeLabels: Partial<Record<string, string>>;
255
+ presets: {
256
+ /**
257
+ * @defaultValue
258
+ * ```javascript
259
+ * {
260
+ * type: "deck",
261
+ * label: "CARDS.DeckPresetPokerDark",
262
+ * src: "cards/poker-deck-dark.json"
263
+ * }
264
+ * ```
265
+ */
266
+ pokerDark: CONFIG.Cards.Preset;
267
+
268
+ /**
269
+ * @defaultValue
270
+ * ```javascript
271
+ * {
272
+ * type: "deck",
273
+ * label: "CARDS.DeckPresetPokerLight",
274
+ * src: "cards/poker-deck-light.json"
275
+ * }
276
+ * ```
277
+ */
278
+ pokerLight: CONFIG.Cards.Preset;
279
+ } & Record<string, CONFIG.Cards.Preset>;
262
280
  };
263
281
 
264
282
  /**
265
283
  * Configuration for the ChatMessage document
266
284
  */
267
285
  ChatMessage: {
268
- /**
269
- * @defaultValue `ChatMessage`
270
- */
286
+ /** @defaultValue `ChatMessage` */
271
287
  documentClass: ConfiguredDocumentClassOrDefault<typeof ChatMessage>;
272
- /**
273
- * @defaultValue `Messages`
274
- */
288
+
289
+ /** @defaultValue `Messages` */
275
290
  collection: ConstructorOf<Messages>;
276
291
 
277
- /**
278
- * @defaultValue `'templates/sidebar/chat-message.html'`
279
- */
292
+ /** @defaultValue `'templates/sidebar/chat-message.html'` */
280
293
  template: string;
281
294
 
282
- /**
283
- * @defaultValue `'fas fa-comments'`
284
- */
295
+ /** @defaultValue `'fas fa-comments'` */
285
296
  sidebarIcon: string;
286
297
 
287
- /**
288
- * @defaultValue `100`
289
- */
298
+ /** @defaultValue `100` */
290
299
  batchSize: number;
291
300
  };
292
301
 
@@ -294,35 +303,23 @@ declare global {
294
303
  * Configuration for the Combat document
295
304
  */
296
305
  Combat: {
297
- /**
298
- * @defaultValue `Combat`
299
- */
306
+ /** @defaultValue `Combat` */
300
307
  documentClass: ConfiguredDocumentClassOrDefault<typeof Combat>;
301
308
 
302
- /**
303
- * @defaultValue `CombatEncounters`
304
- */
309
+ /** @defaultValue `CombatEncounters` */
305
310
  collection: ConstructorOf<CombatEncounters>;
306
311
 
307
- /**
308
- * @defaultValue `'dead'`
309
- */
312
+ /** @defaultValue `'dead'` */
310
313
  defeatedStatusId: string;
311
314
 
312
- /**
313
- * @defaultValue `'fas fa-fist-raised'`
314
- */
315
+ /** @defaultValue `'fas fa-fist-raised'` */
315
316
  sidebarIcon: string;
316
317
 
317
318
  initiative: {
318
- /**
319
- * @defaultValue `null`
320
- */
319
+ /** @defaultValue `null` */
321
320
  formula: string | null;
322
321
 
323
- /**
324
- * @defaultValue `2`
325
- */
322
+ /** @defaultValue `2` */
326
323
  decimals: number;
327
324
  };
328
325
  };
@@ -331,36 +328,12 @@ declare global {
331
328
  * Configuration for dice rolling behaviors in the Foundry VTT client
332
329
  */
333
330
  Dice: {
334
- /**
335
- * @defaultValue `[Die, FateDie]`
336
- */
331
+ /** @defaultValue `[Die, FateDie]` */
337
332
  types: Array<ConstructorOf<DiceTerm>>;
338
333
 
339
- rollModes: {
340
- /**
341
- * @defaultValue `'CHAT.RollPublic'`
342
- */
343
- roll: string;
344
-
345
- /**
346
- * @defaultValue `'CHAT.RollPrivate'`
347
- */
348
- gmroll: string;
349
-
350
- /**
351
- * @defaultValue `CHAT.RollBlind'`
352
- */
353
- blindroll: string;
334
+ rollModes: CONFIG.Dice.RollModes;
354
335
 
355
- /**
356
- * @defaultValue `'CHAT.RollSelf'`
357
- */
358
- selfroll: string;
359
- } & Partial<Record<string, string>>;
360
-
361
- /**
362
- * @defaultValue `[Roll]`
363
- */
336
+ /** @defaultValue `[Roll]` */
364
337
  rolls: Array<ConstructorOf<Roll>>;
365
338
 
366
339
  /**
@@ -383,11 +356,9 @@ declare global {
383
356
  c: typeof Coin;
384
357
  d: typeof Die;
385
358
  f: typeof FateDie;
386
- } & Partial<Record<string, ConstructorOf<DiceTerm>>>;
359
+ } & Record<string, ConstructorOf<DiceTerm>>;
387
360
 
388
- /**
389
- * @defaultValue `MersenneTwister.random`
390
- */
361
+ /** @defaultValue `MersenneTwister.random` */
391
362
  randomUniform: () => number;
392
363
  };
393
364
 
@@ -395,14 +366,10 @@ declare global {
395
366
  * Configuration for the FogExploration document
396
367
  */
397
368
  FogExploration: {
398
- /**
399
- * @defaultValue `FogExploration`
400
- */
369
+ /** @defaultValue `FogExploration` */
401
370
  documentClass: ConfiguredDocumentClassOrDefault<typeof FogExploration>;
402
371
 
403
- /**
404
- * @defaultValue `FogExplorations`
405
- */
372
+ /** @defaultValue `FogExplorations` */
406
373
  collection: ConstructorOf<FogExplorations>;
407
374
  };
408
375
 
@@ -410,210 +377,124 @@ declare global {
410
377
  * Configuration for the Folder entity
411
378
  */
412
379
  Folder: {
413
- /**
414
- * @defaultValue `Folder`
415
- */
380
+ /** @defaultValue `Folder` */
416
381
  documentClass: ConfiguredDocumentClassOrDefault<typeof Folder>;
417
382
 
418
- /**
419
- * @defaultValue `Folders`
420
- */
383
+ /** @defaultValue `Folders` */
421
384
  collection: ConstructorOf<Folders>;
422
-
423
- /**
424
- * @defaultValue `FolderConfig`
425
- */
426
- sheetClass: ConstructorOf<FolderConfig>;
427
385
  };
428
386
 
429
387
  /**
430
388
  * Configuration for the default Item entity class
431
389
  */
432
390
  Item: {
433
- /**
434
- * @defaultValue `Item`
435
- */
391
+ /** @defaultValue `Item` */
436
392
  documentClass: ConfiguredDocumentClassOrDefault<typeof Item>;
437
393
 
438
- /**
439
- * @defaultValue `Items`
440
- */
394
+ /** @defaultValue `Items` */
441
395
  collection: ConstructorOf<Items>;
442
396
 
443
- /**
444
- * @defaultValue `{}`
445
- */
446
- sheetClasses: CONFIG.SheetClasses;
447
-
448
- /**
449
- * @defaultValue `'fas fa-suitcase'`
450
- */
397
+ /** @defaultValue `'fas fa-suitcase'` */
451
398
  sidebarIcon: string;
452
399
 
453
- /**
454
- * defaultValue `{}`
455
- */
456
- typeLabels: Partial<Record<string, string>>;
400
+ /** @defaultValue `{}` */
401
+ typeLabels: Record<string, string>;
457
402
  };
458
403
 
459
404
  /**
460
405
  * Configuration for the JournalEntry entity
461
406
  */
462
407
  JournalEntry: {
463
- /**
464
- * @defaultValue `JournalEntry`
465
- */
408
+ /** @defaultValue `JournalEntry` */
466
409
  documentClass: ConfiguredDocumentClassOrDefault<typeof JournalEntry>;
467
410
 
468
- /**
469
- * @defaultValue `Journal`
470
- */
411
+ /** @defaultValue `Journal` */
471
412
  collection: ConstructorOf<Journal>;
472
413
 
473
- /**
474
- * @defaultValue `JournalSheet`
475
- */
476
- sheetClass: ConstructorOf<JournalSheet>;
477
-
478
414
  noteIcons: {
479
- /**
480
- * @defaultValue `'icons/svg/anchor.svg'`
481
- */
415
+ /** @defaultValue `'icons/svg/anchor.svg'` */
482
416
  Anchor: string;
483
417
 
484
- /**
485
- * @defaultValue `'icons/svg/barrel.svg'`
486
- */
418
+ /** @defaultValue `'icons/svg/barrel.svg'` */
487
419
  Barrel: string;
488
420
 
489
- /**
490
- * @defaultValue `'icons/svg/book.svg'`
491
- */
421
+ /** @defaultValue `'icons/svg/book.svg'` */
492
422
  Book: string;
493
423
 
494
- /**
495
- * @defaultValue `'icons/svg/bridge.svg'`
496
- */
424
+ /** @defaultValue `'icons/svg/bridge.svg'` */
497
425
  Bridge: string;
498
426
 
499
- /**
500
- * @defaultValue `'icons/svg/cave.svg'`
501
- */
427
+ /** @defaultValue `'icons/svg/cave.svg'` */
502
428
  Cave: string;
503
429
 
504
- /**
505
- * @defaultValue `'icons/svg/castle.svg`
506
- */
430
+ /** @defaultValue `'icons/svg/castle.svg` */
507
431
  Castle: string;
508
432
 
509
- /**
510
- * @defaultValue `'icons/svg/chest.svg'`
511
- */
433
+ /** @defaultValue `'icons/svg/chest.svg'` */
512
434
  Chest: string;
513
435
 
514
- /**
515
- * @defaultValue `'icons/svg/city.svg'`
516
- */
436
+ /** @defaultValue `'icons/svg/city.svg'` */
517
437
  City: string;
518
438
 
519
- /**
520
- * @defaultValue `'icons/svg/coins.svg'`
521
- */
439
+ /** @defaultValue `'icons/svg/coins.svg'` */
522
440
  Coins: string;
523
441
 
524
- /**
525
- * @defaultValue `'icons/svg/fire.svg'`
526
- */
442
+ /** @defaultValue `'icons/svg/fire.svg'` */
527
443
  Fire: string;
528
444
 
529
- /**
530
- * @defaultValue `'icons/svg/hanging-sign.svg'`
531
- */
445
+ /** @defaultValue `'icons/svg/hanging-sign.svg'` */
532
446
  'Hanging Sign': string;
533
447
 
534
- /**
535
- * @defaultValue `'icons/svg/house.svg'`
536
- */
448
+ /** @defaultValue `'icons/svg/house.svg'` */
537
449
  House: string;
538
450
 
539
- /**
540
- * @defaultValue `'icons/svg/mountain.svg'`
541
- */
451
+ /** @defaultValue `'icons/svg/mountain.svg'` */
542
452
  Mountain: string;
543
453
 
544
- /**
545
- * @defaultValue `'icons/svg/oak.svg'`
546
- */
454
+ /** @defaultValue `'icons/svg/oak.svg'` */
547
455
  'Oak Tree': string;
548
456
 
549
- /**
550
- * @defaultValue `'icons/svg/obelisk.svg'`
551
- */
457
+ /** @defaultValue `'icons/svg/obelisk.svg'` */
552
458
  Obelisk: string;
553
459
 
554
- /**
555
- * @defaultValue `'icons/svg/pawprint.svg'`
556
- */
460
+ /** @defaultValue `'icons/svg/pawprint.svg'` */
557
461
  Pawprint: string;
558
462
 
559
- /**
560
- * @defaultValue `'icons/svg/ruins.svg'`
561
- */
463
+ /** @defaultValue `'icons/svg/ruins.svg'` */
562
464
  Ruins: string;
563
465
 
564
- /**
565
- * @defaultValue `'icons/svg/tankard.svg'`
566
- */
466
+ /** @defaultValue `'icons/svg/tankard.svg'` */
567
467
  Tankard: string;
568
468
 
569
- /**
570
- * @defaultValue `'icons/svg/temple.svg'`
571
- */
469
+ /** @defaultValue `'icons/svg/temple.svg'` */
572
470
  Temple: string;
573
471
 
574
- /**
575
- * @defaultValue `'icons/svg/tower.svg'`
576
- */
472
+ /** @defaultValue `'icons/svg/tower.svg'` */
577
473
  Tower: string;
578
474
 
579
- /**
580
- * @defaultValue `'icons/svg/trap.svg'`
581
- */
475
+ /** @defaultValue `'icons/svg/trap.svg'` */
582
476
  Trap: string;
583
477
 
584
- /**
585
- * @defaultValue `'icons/svg/skull.svg'`
586
- */
478
+ /** @defaultValue `'icons/svg/skull.svg'` */
587
479
  Skull: string;
588
480
 
589
- /**
590
- * @defaultValue `'icons/svg/statue.svg'`
591
- */
481
+ /** @defaultValue `'icons/svg/statue.svg'` */
592
482
  Statue: string;
593
483
 
594
- /**
595
- * @defaultValue `'icons/svg/sword.svg'`
596
- */
484
+ /** @defaultValue `'icons/svg/sword.svg'` */
597
485
  Sword: string;
598
486
 
599
- /**
600
- * @defaultValue `'icons/svg/village.svg'`
601
- */
487
+ /** @defaultValue `'icons/svg/village.svg'` */
602
488
  Village: string;
603
489
 
604
- /**
605
- * @defaultValue `'icons/svg/waterfall.svg'`
606
- */
490
+ /** @defaultValue `'icons/svg/waterfall.svg'` */
607
491
  Waterfall: string;
608
- /**
609
- * @defaultValue `'icons/svg/windmill.svg'`
610
- */
492
+
493
+ /** @defaultValue `'icons/svg/windmill.svg'` */
611
494
  Windmill: string;
612
- } & Partial<Record<string, string>>;
495
+ } & Record<string, string>;
613
496
 
614
- /**
615
- * @defaultValue `'fas fa-book-open'`
616
- */
497
+ /** @defaultValue `'fas fa-book-open'` */
617
498
  sidebarIcon: string;
618
499
  };
619
500
 
@@ -621,24 +502,13 @@ declare global {
621
502
  * Configuration for the Macro entity
622
503
  */
623
504
  Macro: {
624
- /**
625
- * @defaultValue `Macro`
626
- */
505
+ /** @defaultValue `Macro` */
627
506
  documentClass: ConfiguredDocumentClassOrDefault<typeof Macro>;
628
507
 
629
- /**
630
- * @defaultValue `Macros`
631
- */
508
+ /** @defaultValue `Macros` */
632
509
  collection: ConstructorOf<Macros>;
633
510
 
634
- /**
635
- * @defaultValue `MacroConfig`
636
- */
637
- sheetClass: ConstructorOf<MacroConfig>;
638
-
639
- /**
640
- * @defaultValue `'fas fa-terminal'`
641
- */
511
+ /** @defaultValue `'fas fa-code'` */
642
512
  sidebarIcon: string;
643
513
  };
644
514
 
@@ -646,29 +516,16 @@ declare global {
646
516
  * Configuration for the default Playlist entity class
647
517
  */
648
518
  Playlist: {
649
- /**
650
- * @defaultValue `Playlist`
651
- */
519
+ /** @defaultValue `Playlist` */
652
520
  documentClass: ConfiguredDocumentClassOrDefault<typeof Playlist>;
653
521
 
654
- /**
655
- * @defaultValue `Playlists`
656
- */
522
+ /** @defaultValue `Playlists` */
657
523
  collection: ConstructorOf<Playlists>;
658
524
 
659
- /**
660
- * @defaultValue `PlaylistConfig`
661
- */
662
- sheetClass: ConstructorOf<PlaylistConfig>;
663
-
664
- /**
665
- * @defaultValue `'fas fa-music'`
666
- */
525
+ /** @defaultValue `'fas fa-music'` */
667
526
  sidebarIcon: string;
668
527
 
669
- /**
670
- * @defaultValue `20`
671
- */
528
+ /** @defaultValue `20` */
672
529
  autoPreloadSeconds: number;
673
530
  };
674
531
 
@@ -676,34 +533,19 @@ declare global {
676
533
  * Configuration for RollTable random draws
677
534
  */
678
535
  RollTable: {
679
- /**
680
- * @defaultValue `RollTable`
681
- */
536
+ /** @defaultValue `RollTable` */
682
537
  documentClass: ConfiguredDocumentClassOrDefault<typeof RollTable>;
683
538
 
684
- /**
685
- * @defaultValue `RollTables`
686
- */
539
+ /** @defaultValue `RollTables` */
687
540
  collection: ConstructorOf<RollTables>;
688
541
 
689
- /**
690
- * @defaultValue `RollTableConfig`
691
- */
692
- sheetClass: ConstructorOf<RollTableConfig>;
693
-
694
- /**
695
- * @defaultValue `'fas fa-th-list'`
696
- */
542
+ /** @defaultValue `'fas fa-th-list'` */
697
543
  sidebarIcon: string;
698
544
 
699
- /**
700
- * @defaultValue `'icons/svg/d20-black.svg'`
701
- */
545
+ /** @defaultValue `'icons/svg/d20-black.svg'` */
702
546
  resultIcon: string;
703
547
 
704
- /**
705
- * @defaultValue `'templates/dice/table-result.html'`
706
- */
548
+ /** @defaultValue `'templates/dice/table-result.html'` */
707
549
  resultTemplate: string;
708
550
  };
709
551
 
@@ -711,29 +553,21 @@ declare global {
711
553
  * Configuration for the default Scene entity class
712
554
  */
713
555
  Scene: {
714
- /**
715
- * @defaultValue `Scene`
716
- */
556
+ /** @defaultValue `Scene` */
717
557
  documentClass: ConfiguredDocumentClassOrDefault<typeof Scene>;
718
558
 
719
- /**
720
- * @defaultValue `Scenes`
721
- */
559
+ /** @defaultValue `Scenes` */
722
560
  collection: ConstructorOf<Scenes>;
723
561
 
724
- /**
725
- * @defaultValue `SceneConfig`
726
- */
727
- sheetClass: ConstructorOf<SceneConfig>;
728
-
729
- /**
730
- * @defaultValue `'fas fa-map'`
731
- */
562
+ /** @defaultValue `'fas fa-map'` */
732
563
  sidebarIcon: string;
733
564
  };
734
565
 
735
566
  Setting: {
567
+ /** @defaultValue `Setting` */
736
568
  documentClass: ConfiguredDocumentClassOrDefault<typeof Setting>;
569
+
570
+ /** @defaultValue `WorldSettings` */
737
571
  collection: ConstructorOf<WorldSettings>;
738
572
  };
739
573
 
@@ -741,378 +575,312 @@ declare global {
741
575
  * Configuration for the User entity, it's roles, and permissions
742
576
  */
743
577
  User: {
744
- /**
745
- * @defaultValue `User`
746
- */
578
+ /** @defaultValue `User` */
747
579
  documentClass: ConfiguredDocumentClassOrDefault<typeof User>;
748
580
 
749
- /**
750
- * @defaultValue `Users`
751
- */
581
+ /** @defaultValue `Users` */
752
582
  collection: ConstructorOf<Users>;
753
-
754
- /**
755
- * @defaultValue `UserConfig`
756
- */
757
- sheetClass: ConstructorOf<UserConfig>;
758
583
  };
759
584
 
760
585
  /**
761
586
  * Configuration settings for the Canvas and its contained layers and objects
762
587
  */
763
588
  Canvas: {
764
- /**
765
- * @defaultValue `8`
766
- */
589
+ /** @defaultValue `8` */
767
590
  blurStrength: number;
768
591
 
769
- /**
770
- * @defaultValue `0x242448`
771
- */
592
+ /** @defaultValue `ScreenCulling` */
593
+ cullingBackend: ConstructorOf<typeof ScreenCulling | typeof QuadtreeCulling>;
594
+
595
+ /** @defaultValue `0x242448` */
772
596
  darknessColor: number;
773
597
 
774
- /**
775
- * @defaultValue `0.4`
776
- */
598
+ /** @defaultValue `0.25` */
777
599
  darknessLightPenalty: number;
778
600
 
779
- /**
780
- * @defaultValue `0xeeeeee`
781
- */
601
+ /** @defaultValue `0xeeeeee` */
782
602
  daylightColor: number;
783
603
 
784
604
  dispositionColors: {
785
- /**
786
- * @defaultValue `0xe72124`
787
- */
605
+ /** @defaultValue `0xe72124` */
788
606
  HOSTILE: number;
789
607
 
790
- /**
791
- * @defaultValue `0xf1d836`
792
- */
608
+ /** @defaultValue `0xf1d836` */
793
609
  NEUTRAL: number;
794
610
 
795
- /**
796
- * @defaultValue `0x43dfdf`
797
- */
611
+ /** @defaultValue `0x43dfdf` */
798
612
  FRIENDLY: number;
799
613
 
800
- /**
801
- * @defaultValue `0x555555`
802
- */
614
+ /** @defaultValue `0x555555` */
803
615
  INACTIVE: number;
804
616
 
805
- /**
806
- * @defaultValue `0x33bc4e`
807
- */
617
+ /** @defaultValue `0x33bc4e` */
808
618
  PARTY: number;
809
619
 
810
- /**
811
- * @defaultValue `0xff9829`
812
- */
620
+ /** @defaultValue `0xff9829` */
813
621
  CONTROLLED: number;
814
622
  };
815
623
 
816
- /**
817
- * @defaultValue `0x7f7f7f`
818
- */
624
+ /** @defaultValue `0x7f7f7f` */
819
625
  exploredColor: number;
820
626
 
821
- /**
822
- * @defaultValue `0x000000`
823
- */
627
+ /** @defaultValue `0x000000` */
824
628
  unexploredColor: number;
825
629
 
630
+ groups: CONFIG.Canvas.Groups;
631
+
826
632
  layers: CONFIG.Canvas.Layers;
827
633
 
828
634
  lightLevels: {
829
- /**
830
- * @defaultValue `0`
831
- */
635
+ /** @defaultValue `0` */
832
636
  dark: number;
833
637
 
834
- /**
835
- * @defaultValue `0.5`
836
- */
638
+ /** @defaultValue `0.25` */
837
639
  dim: number;
838
640
 
839
- /**
840
- * @defaultValue `1.0`
841
- */
641
+ /** @defaultValue `1.0` */
842
642
  bright: number;
843
643
  };
844
644
 
845
- /**
846
- * @defaultValue `0xb86200`
847
- */
645
+ /** @defaultValue `0xb86200` */
848
646
  normalLightColor: number;
849
647
 
850
- /**
851
- * @defaultValue `3.0`
852
- */
648
+ /** @defaultValue `3.0` */
853
649
  maxZoom: number;
854
650
 
855
- /**
856
- * @defaultValue `4`
857
- */
651
+ /** @defaultValue `4` */
858
652
  objectBorderThickness: number;
859
653
 
860
654
  lightAnimations: {
861
655
  torch: {
862
- /**
863
- * @defaultValue `'LIGHT.AnimationTorch'`
864
- */
656
+ /** @defaultValue `'LIGHT.AnimationTorch'` */
865
657
  label: string;
866
658
 
867
- /**
868
- * @defaultValue PointSource.prototype.animateTorch
869
- */
870
- animation: PointSource.AnimationFunction;
659
+ /** @defaultValue `LightSource.prototype.animateTorch` */
660
+ animation: CONFIG.Canvas.LightAnimationFunction;
871
661
 
872
- /**
873
- * @defaultValue `TorchIlluminationShader`
874
- */
662
+ /** @defaultValue `TorchIlluminationShader` */
875
663
  illuminationShader: ConstructorOf<AbstractBaseShader>;
876
664
 
877
- /**
878
- * @defaultValue `TorchColorationShader`
879
- */
665
+ /** @defaultValue `TorchColorationShader` */
880
666
  colorationShader: ConstructorOf<AbstractBaseShader>;
881
667
  };
882
668
 
883
669
  pulse: {
884
- /**
885
- * @defaultValue `'LIGHT.AnimationPulse'`
886
- */
670
+ /** @defaultValue `'LIGHT.AnimationPulse'` */
887
671
  label: string;
888
672
 
889
- /**
890
- * @defaultValue `PointSource.prototype.animatePulse`
891
- */
892
- animation: PointSource.AnimationFunction;
673
+ /** @defaultValue `LightSource.prototype.animatePulse` */
674
+ animation: CONFIG.Canvas.LightAnimationFunction;
893
675
 
894
- /**
895
- * @defaultValue `PulseIlluminationShader`
896
- */
676
+ /** @defaultValue `PulseIlluminationShader` */
897
677
  illuminationShader: ConstructorOf<AbstractBaseShader>;
898
678
 
899
- /**
900
- * @defaultValue `PulseColorationShader`
901
- */
679
+ /** @defaultValue `PulseColorationShader` */
902
680
  colorationShader: ConstructorOf<AbstractBaseShader>;
903
681
  };
904
682
 
905
683
  chroma: {
906
- /**
907
- * @defaultValue `'LIGHT.AnimationChroma'`
908
- */
684
+ /** @defaultValue `'LIGHT.AnimationChroma'` */
909
685
  label: string;
910
686
 
911
- /**
912
- * @defaultValue `PointSource.prototype.animateTime`
913
- */
914
- animation: PointSource.AnimationFunction;
687
+ /** @defaultValue `LightSource.prototype.animateTime` */
688
+ animation: CONFIG.Canvas.LightAnimationFunction;
915
689
 
916
- /**
917
- * @defaultValue `ChromaColorationShader`
918
- */
690
+ /** @defaultValue `ChromaColorationShader` */
919
691
  colorationShader: ConstructorOf<AbstractBaseShader>;
920
692
  };
921
693
 
922
694
  wave: {
923
- /**
924
- * @defaultValue `'LIGHT.AnimationWave'`
925
- */
695
+ /** @defaultValue `'LIGHT.AnimationWave'` */
926
696
  label: string;
927
697
 
928
- /**
929
- * @defaultValue `PointSource.prototype.animateTime`
930
- */
931
- animation: PointSource.AnimationFunction;
698
+ /** @defaultValue `LightSource.prototype.animateTime` */
699
+ animation: CONFIG.Canvas.LightAnimationFunction;
932
700
 
933
- /**
934
- * @defaultValue `WaveIlluminationShader`
935
- */
701
+ /** @defaultValue `WaveIlluminationShader` */
936
702
  illuminationShader: ConstructorOf<AbstractBaseShader>;
937
703
 
938
- /**
939
- * @defaultValue `WaveColorationShader`
940
- */
704
+ /** @defaultValue `WaveColorationShader` */
941
705
  colorationShader: ConstructorOf<AbstractBaseShader>;
942
706
  };
943
707
 
944
708
  fog: {
945
- /**
946
- * @defaultValue `'LIGHT.AnimationFog'`
947
- */
709
+ /** @defaultValue `'LIGHT.AnimationFog'` */
948
710
  label: string;
949
711
 
950
- /**
951
- * @defaultValue `PointSource.prototype.animateTime`
952
- */
953
- animation: PointSource.AnimationFunction;
712
+ /** @defaultValue `LightSource.prototype.animateTime` */
713
+ animation: CONFIG.Canvas.LightAnimationFunction;
954
714
 
955
- /**
956
- * @defaultValue `FogColorationShader`
957
- */
715
+ /** @defaultValue `FogColorationShader` */
958
716
  colorationShader: ConstructorOf<AbstractBaseShader>;
959
717
  };
960
718
 
961
719
  sunburst: {
962
- /**
963
- * @defaultValue `'LIGHT.AnimationSunburst'`
964
- */
720
+ /** @defaultValue `'LIGHT.AnimationSunburst'` */
965
721
  label: string;
966
722
 
967
- /**
968
- * @defaultValue `PointSource.prototype.animateTime`
969
- */
970
- animation: PointSource.AnimationFunction;
723
+ /** @defaultValue `LightSource.prototype.animateTime` */
724
+ animation: CONFIG.Canvas.LightAnimationFunction;
971
725
 
972
- /**
973
- * @defaultValue `SunburstIlluminationShader`
974
- */
726
+ /** @defaultValue `SunburstIlluminationShader` */
975
727
  illuminationShader: ConstructorOf<AbstractBaseShader>;
976
728
 
977
- /**
978
- * @defaultValue `SunburstColorationShader`
979
- */
729
+ /** @defaultValue `SunburstColorationShader` */
980
730
  colorationShader: ConstructorOf<AbstractBaseShader>;
981
731
  };
982
732
 
983
733
  dome: {
984
- /**
985
- * @defaultValue `'LIGHT.AnimationLightDome'`
986
- */
734
+ /** @defaultValue `'LIGHT.AnimationLightDome'` */
987
735
  label: string;
988
736
 
989
- /**
990
- * @defaultValue `PointSource.prototype.animateTime`
991
- */
992
- animation: PointSource.AnimationFunction;
737
+ /** @defaultValue `LightSource.prototype.animateTime` */
738
+ animation: CONFIG.Canvas.LightAnimationFunction;
993
739
 
994
- /**
995
- * @defaultValue `LightDomeColorationShader`
996
- */
740
+ /** @defaultValue `LightDomeColorationShader` */
997
741
  colorationShader: ConstructorOf<AbstractBaseShader>;
998
742
  };
999
743
 
1000
744
  emanation: {
1001
- /**
1002
- * @defaultValue `'LIGHT.AnimationEmanation'`
1003
- */
745
+ /** @defaultValue `'LIGHT.AnimationEmanation'` */
1004
746
  label: string;
1005
747
 
1006
- /**
1007
- * @defaultValue `PointSource.prototype.animateTime`
1008
- */
1009
- animation: PointSource.AnimationFunction;
748
+ /** @defaultValue `LightSource.prototype.animateTime` */
749
+ animation: CONFIG.Canvas.LightAnimationFunction;
1010
750
 
1011
- /**
1012
- * @defaultValue `EmanationColorationShader`
1013
- */
751
+ /** @defaultValue `EmanationColorationShader` */
1014
752
  colorationShader: ConstructorOf<AbstractBaseShader>;
1015
753
  };
1016
754
 
1017
755
  hexa: {
1018
- /**
1019
- * @defaultValue `'LIGHT.AnimationHexaDome';`
1020
- */
756
+ /** @defaultValue `'LIGHT.AnimationHexaDome';` */
1021
757
  label: string;
1022
758
 
1023
- /**
1024
- * @defaultValue `PointSource.prototype.animateTime`
1025
- */
1026
- animation: PointSource.AnimationFunction;
759
+ /** @defaultValue `LightSource.prototype.animateTime` */
760
+ animation: CONFIG.Canvas.LightAnimationFunction;
1027
761
 
1028
- /**
1029
- * @defaultValue `HexaDomeColorationShader`
1030
- */
762
+ /** @defaultValue `HexaDomeColorationShader` */
1031
763
  colorationShader: ConstructorOf<AbstractBaseShader>;
1032
764
  };
1033
765
 
1034
766
  ghost: {
1035
- /**
1036
- * @defaultValue `'LIGHT.AnimationGhostLight'`
1037
- */
767
+ /** @defaultValue `'LIGHT.AnimationGhostLight'` */
1038
768
  label: string;
1039
769
 
1040
- /**
1041
- * @defaultValue `PointSource.prototype.animateTime`
1042
- */
1043
- animation: PointSource.AnimationFunction;
770
+ /** @defaultValue `LightSource.prototype.animateTime` */
771
+ animation: CONFIG.Canvas.LightAnimationFunction;
1044
772
 
1045
- /**
1046
- * @defaultValue `GhostLightIlluminationShader`
1047
- */
773
+ /** @defaultValue `GhostLightIlluminationShader` */
1048
774
  illuminationShader: ConstructorOf<AbstractBaseShader>;
1049
775
 
1050
- /**
1051
- * @defaultValue `GhostLightColorationShader`
1052
- */
776
+ /** @defaultValue `GhostLightColorationShader` */
1053
777
  colorationShader: ConstructorOf<AbstractBaseShader>;
1054
778
  };
1055
779
 
1056
780
  energy: {
1057
- /**
1058
- * @defaultValue `'LIGHT.AnimationEnergyField'`
1059
- */
781
+ /** @defaultValue `'LIGHT.AnimationEnergyField'` */
1060
782
  label: string;
1061
783
 
1062
- /**
1063
- * @defaultValue `PointSource.prototype.animateTime`
1064
- */
1065
- animation: PointSource.AnimationFunction;
784
+ /** @defaultValue `LightSource.prototype.animateTime` */
785
+ animation: CONFIG.Canvas.LightAnimationFunction;
1066
786
 
1067
- /**
1068
- * @defaultValue `EnergyFieldColorationShader`
1069
- */
787
+ /** @defaultValue `EnergyFieldColorationShader` */
1070
788
  colorationShader: ConstructorOf<AbstractBaseShader>;
1071
789
  };
1072
790
 
1073
791
  roiling: {
1074
- /**
1075
- * @defaultValue `'LIGHT.AnimationRoilingMass'`
1076
- */
792
+ /** @defaultValue `'LIGHT.AnimationRoilingMass'` */
793
+ label: string;
794
+
795
+ /** @defaultValue `LightSource.prototype.animateTime` */
796
+ animation: CONFIG.Canvas.LightAnimationFunction;
797
+
798
+ /** @defaultValue `RoilingIlluminationShader` */
799
+ illuminationShader: ConstructorOf<AbstractBaseShader>;
800
+ };
801
+
802
+ hole: {
803
+ /** @defaultValue `'LIGHT.AnimationBlackHole'` */
1077
804
  label: string;
1078
805
 
1079
- /**
1080
- * @defaultValue `PointSource.prototype.animateTime`
1081
- */
1082
- animation: PointSource.AnimationFunction;
806
+ /** @defaultValue `LightSource.prototype.animateTime` */
807
+ animation: CONFIG.Canvas.LightAnimationFunction;
1083
808
 
1084
- /**
1085
- * @defaultValue `RoilingIlluminationShader`
1086
- */
809
+ /** @defaultValue `BlackHoleIlluminationShader` */
1087
810
  illuminationShader: ConstructorOf<AbstractBaseShader>;
1088
811
  };
1089
812
 
1090
- hole: {
1091
- /**
1092
- * @defaultValue `'LIGHT.AnimationBlackHole'`
1093
- */
813
+ vortex: {
814
+ /** @defaultValue `'LIGHT.AnimationVortex'` */
815
+ label: string;
816
+
817
+ /** @defaultValue `LightSource.prototype.animateTime` */
818
+ animation: CONFIG.Canvas.LightAnimationFunction;
819
+
820
+ /** @defaultValue `VortexIlluminationShader` */
821
+ illuminationShader: ConstructorOf<AbstractBaseShader>;
822
+
823
+ /** @defaultValue `VortexColorationShader` */
824
+ colorationShader: ConstructorOf<AbstractBaseShader>;
825
+ };
826
+
827
+ witchwave: {
828
+ /** @defaultValue `'LIGHT.AnimationBewitchingWave'` */
829
+ label: string;
830
+
831
+ /** @defaultValue `LightSource.prototype.animateTime` */
832
+ animation: CONFIG.Canvas.LightAnimationFunction;
833
+
834
+ /** @defaultValue `BewitchingWaveIlluminationShader` */
835
+ illuminationShader: ConstructorOf<AbstractBaseShader>;
836
+
837
+ /** @defaultValue `BewitchingWaveColorationShader` */
838
+ colorationShader: ConstructorOf<AbstractBaseShader>;
839
+ };
840
+
841
+ rainbowswirl: {
842
+ /** @defaultValue `'LIGHT.AnimationSwirlingRainbow'` */
843
+ label: string;
844
+
845
+ /** @defaultValue `LightSource.prototype.animateTime` */
846
+ animation: CONFIG.Canvas.LightAnimationFunction;
847
+
848
+ /** @defaultValue `SwirlingRainbowColorationShader` */
849
+ colorationShader: ConstructorOf<AbstractBaseShader>;
850
+ };
851
+
852
+ radialrainbow: {
853
+ /** @defaultValue `'LIGHT.AnimationRadialRainbow'` */
854
+ label: string;
855
+
856
+ /** @defaultValue `LightSource.prototype.animateTime` */
857
+ animation: CONFIG.Canvas.LightAnimationFunction;
858
+
859
+ /** @defaultValue `RadialRainbowColorationShader` */
860
+ colorationShader: ConstructorOf<AbstractBaseShader>;
861
+ };
862
+
863
+ fairy: {
864
+ /** @defaultValue `'LIGHT.AnimationFairyLight'` */
1094
865
  label: string;
1095
866
 
1096
- /**
1097
- * @defaultValue `PointSource.prototype.animateTime`
1098
- */
1099
- animation: PointSource.AnimationFunction;
867
+ /** @defaultValue `LightSource.prototype.animateTime` */
868
+ animation: CONFIG.Canvas.LightAnimationFunction;
1100
869
 
1101
- /**
1102
- * @defaultValue `BlackHoleIlluminationShader`
1103
- */
870
+ /** @defaultValue `FairyLightIlluminationShader` */
1104
871
  illuminationShader: ConstructorOf<AbstractBaseShader>;
872
+
873
+ /** @defaultValue `FairyLightColorationShader` */
874
+ colorationShader: ConstructorOf<AbstractBaseShader>;
1105
875
  };
1106
- } & Partial<
1107
- Record<
1108
- string,
1109
- {
1110
- label: string;
1111
- animation: PointSource.AnimationFunction;
1112
- illuminationShader?: ConstructorOf<AbstractBaseShader>;
1113
- colorationShader?: ConstructorOf<AbstractBaseShader>;
1114
- }
1115
- >
876
+ } & Record<
877
+ string,
878
+ {
879
+ label: string;
880
+ animation: CONFIG.Canvas.LightAnimationFunction;
881
+ illuminationShader?: ConstructorOf<AbstractBaseShader>;
882
+ colorationShader?: ConstructorOf<AbstractBaseShader>;
883
+ }
1116
884
  >;
1117
885
  };
1118
886
 
@@ -1143,110 +911,72 @@ declare global {
1143
911
  * Available Weather Effects implementations
1144
912
  */
1145
913
  weatherEffects: {
1146
- /**
1147
- * @defaultValue `AutumnLeavesWeatherEffect`
1148
- */
914
+ /** @defaultValue `AutumnLeavesWeatherEffect` */
1149
915
  leaves: ConstructorOf<SpecialEffect>;
1150
916
 
1151
- /**
1152
- * @defaultValue `RainWeatherEffect`
1153
- */
917
+ /** @defaultValue `RainWeatherEffect` */
1154
918
  rain: ConstructorOf<SpecialEffect>;
1155
919
 
1156
- /**
1157
- * @defaultValue `SnowWeatherEffect`
1158
- */
920
+ /** @defaultValue `SnowWeatherEffect` */
1159
921
  snow: ConstructorOf<SpecialEffect>;
1160
- } & Partial<Record<string, ConstructorOf<SpecialEffect>>>;
922
+ } & Record<string, ConstructorOf<SpecialEffect>>;
1161
923
 
1162
924
  /**
1163
925
  * The control icons used for rendering common HUD operations
1164
926
  */
1165
927
  controlIcons: {
1166
- /**
1167
- * @defaultValue `'icons/svg/combat.svg'`
1168
- */
928
+ /** @defaultValue `'icons/svg/combat.svg'` */
1169
929
  combat: string;
1170
930
 
1171
- /**
1172
- * @defaultValue `'icons/svg/cowled.svg'`
1173
- */
931
+ /** @defaultValue `'icons/svg/cowled.svg'` */
1174
932
  visibility: string;
1175
933
 
1176
- /**
1177
- * @defaultValue `'icons/svg/aura.svg'`
1178
- */
934
+ /** @defaultValue `'icons/svg/aura.svg'` */
1179
935
  effects: string;
1180
936
 
1181
- /**
1182
- * @defaultValue `'icons/svg/padlock.svg'`
1183
- */
937
+ /** @defaultValue `'icons/svg/padlock.svg'` */
1184
938
  lock: string;
1185
939
 
1186
- /**
1187
- * @defaultValue `'icons/svg/up.svg'`
1188
- */
940
+ /** @defaultValue `'icons/svg/up.svg'` */
1189
941
  up: string;
1190
942
 
1191
- /**
1192
- * @defaultValue `'icons/svg/down.svg'`
1193
- */
943
+ /** @defaultValue `'icons/svg/down.svg'` */
1194
944
  down: string;
1195
945
 
1196
- /**
1197
- * @defaultValue `'icons/svg/skull.svg'`
1198
- */
946
+ /** @defaultValue `'icons/svg/skull.svg'` */
1199
947
  defeated: string;
1200
948
 
1201
- /**
1202
- * @defaultValue `'icons/svg/light.svg'`
1203
- */
949
+ /** @defaultValue `'icons/svg/light.svg'` */
1204
950
  light: string;
1205
951
 
1206
- /**
1207
- * @defaultValue `'icons/svg/light-off.svg'`
1208
- */
952
+ /** @defaultValue `'icons/svg/light-off.svg'` */
1209
953
  lightOff: string;
1210
954
 
1211
- /**
1212
- * @defaultValue `'icons/svg/explosion.svg'`
1213
- */
955
+ /** @defaultValue `'icons/svg/explosion.svg'` */
1214
956
  template: string;
1215
957
 
1216
- /**
1217
- * @defaultValue `'icons/svg/sound.svg'`
1218
- */
958
+ /** @defaultValue `'icons/svg/sound.svg'` */
1219
959
  sound: string;
1220
960
 
1221
- /**
1222
- * @defaultValue `'icons/svg/sound-off.svg'`
1223
- */
961
+ /** @defaultValue `'icons/svg/sound-off.svg'` */
1224
962
  soundOff: string;
1225
963
 
1226
- /**
1227
- * @defaultValue `'icons/svg/door-closed-outline.svg'`
1228
- */
964
+ /** @defaultValue `'icons/svg/door-closed-outline.svg'` */
1229
965
  doorClosed: string;
1230
966
 
1231
- /**
1232
- * @defaultValue `'icons/svg/door-open-outline.svg'`
1233
- */
967
+ /** @defaultValue `'icons/svg/door-open-outline.svg'` */
1234
968
  doorOpen: string;
1235
969
 
1236
- /**
1237
- * @defaultValue `'icons/svg/door-secret-outline.svg'`
1238
- */
970
+ /** @defaultValue `'icons/svg/door-secret-outline.svg'` */
1239
971
  doorSecret: string;
1240
972
 
1241
- /**
1242
- * @defaultValue `'icons/svg/door-locked-outline.svg'`
1243
- */
973
+ /** @defaultValue `'icons/svg/door-locked-outline.svg'` */
1244
974
  doorLocked: string;
1245
- } & Partial<Record<string, string>>;
975
+ } & Record<string, string>;
1246
976
 
1247
977
  /**
1248
978
  * Suggested font families that are displayed wherever a choice is presented
1249
- * @defaultValue `['Arial', 'Arial Black', 'Comic Sans MS', 'Courier New', 'Times New Roman', 'Signika', 'Modesto Condensed']`
979
+ * @defaultValue `["Arial", "Courier", "Courier New", "Helvetica", "Signika", "Times", "Times New Roman", "Modesto Condensed"]`
1250
980
  */
1251
981
  fontFamilies: string[];
1252
982
 
@@ -1430,24 +1160,16 @@ declare global {
1430
1160
  * A mapping of core audio effects used which can be replaced by systems or mods
1431
1161
  */
1432
1162
  sounds: {
1433
- /**
1434
- * @defaultValue `'sounds/dice.wav'`
1435
- */
1163
+ /** @defaultValue `'sounds/dice.wav'` */
1436
1164
  dice: string;
1437
1165
 
1438
- /**
1439
- * @defaultValue `'sounds/lock.wav'`
1440
- */
1166
+ /** @defaultValue `'sounds/lock.wav'` */
1441
1167
  lock: string;
1442
1168
 
1443
- /**
1444
- * @defaultValue `'sounds/notify.wav'`
1445
- */
1169
+ /** @defaultValue `'sounds/notify.wav'` */
1446
1170
  notification: string;
1447
1171
 
1448
- /**
1449
- * @defaultValue `'sounds/drums.wav'`
1450
- */
1172
+ /** @defaultValue `'sounds/drums.wav'` */
1451
1173
  combat: string;
1452
1174
  };
1453
1175
 
@@ -1457,20 +1179,16 @@ declare global {
1457
1179
  */
1458
1180
  supportedLanguages: {
1459
1181
  en: string;
1460
- } & Partial<Record<string, string>>;
1182
+ } & Record<string, string>;
1461
1183
 
1462
1184
  /**
1463
1185
  * Configuration for time tracking
1464
1186
  */
1465
1187
  time: {
1466
- /**
1467
- * @defaultValue `0`
1468
- */
1188
+ /** @defaultValue `0` */
1469
1189
  turnTime: number;
1470
1190
 
1471
- /**
1472
- * @defaultValue `0`
1473
- */
1191
+ /** @defaultValue `0` */
1474
1192
  roundTime: number;
1475
1193
  };
1476
1194
 
@@ -1478,24 +1196,23 @@ declare global {
1478
1196
  * Configuration for the ActiveEffect embedded document type
1479
1197
  */
1480
1198
  ActiveEffect: {
1481
- /**
1482
- * @defaultValue `ActiveEffect`
1483
- */
1199
+ /** @defaultValue `ActiveEffect` */
1484
1200
  documentClass: ConfiguredDocumentClassOrDefault<typeof ActiveEffect>;
1201
+ };
1485
1202
 
1486
- /**
1487
- * @defaultValue `ActiveEffectConfig`
1488
- */
1489
- sheetClass: ConstructorOf<ActiveEffectConfig>;
1203
+ /**
1204
+ * Configuration for the Card embedded Document type
1205
+ */
1206
+ Card: {
1207
+ /** @defaultValue `Card` */
1208
+ documentClass: ConfiguredDocumentClassOrDefault<typeof Card>;
1490
1209
  };
1491
1210
 
1492
1211
  /**
1493
1212
  * Configuration for the TableResult embedded document type
1494
1213
  */
1495
1214
  TableResult: {
1496
- /**
1497
- * @defaultValue `TableResult`
1498
- */
1215
+ /** @defaultValue `TableResult` */
1499
1216
  documentClass: ConfiguredDocumentClassOrDefault<typeof TableResult>;
1500
1217
  };
1501
1218
 
@@ -1503,105 +1220,58 @@ declare global {
1503
1220
  * Configuration for the ActiveEffect embedded document type
1504
1221
  */
1505
1222
  PlaylistSound: {
1506
- /**
1507
- * @defaultValue `PlaylistSound`
1508
- */
1223
+ /** @defaultValue `PlaylistSound` */
1509
1224
  documentClass: ConfiguredDocumentClassOrDefault<typeof PlaylistSound>;
1510
-
1511
- /**
1512
- * @defaultValue `PlaylistSoundConfig`
1513
- */
1514
- sheetClass: ConstructorOf<PlaylistSoundConfig>;
1515
1225
  };
1516
1226
 
1517
1227
  /**
1518
1228
  * Configuration for the AmbientLight embedded document type and its representation on the game Canvas
1519
1229
  */
1520
1230
  AmbientLight: {
1521
- /**
1522
- * @defaultValue `AmbientLightDocument`
1523
- */
1231
+ /** @defaultValue `AmbientLightDocument` */
1524
1232
  documentClass: ConfiguredDocumentClassOrDefault<typeof AmbientLightDocument>;
1525
1233
 
1526
- /**
1527
- * @defaultValue `AmbientLightDocument`
1528
- */
1234
+ /** @defaultValue `AmbientLightDocument` */
1529
1235
  objectClass: ConfiguredObjectClassOrDefault<typeof AmbientLight>;
1530
1236
 
1531
- /**
1532
- * @defaultValue `AmbientLightDocument`
1533
- */
1237
+ /** @defaultValue `AmbientLightDocument` */
1534
1238
  layerClass: ConstructorOf<LightingLayer>;
1535
-
1536
- /**
1537
- * @defaultValue `AmbientLightDocument`
1538
- */
1539
- sheetClass: ConstructorOf<LightConfig>;
1540
1239
  };
1541
1240
 
1542
1241
  /**
1543
1242
  * Configuration for the AmbientSound embedded document type and its representation on the game Canvas
1544
1243
  */
1545
1244
  AmbientSound: {
1546
- /**
1547
- * @defaultValue `AmbientSoundDocument`
1548
- */
1245
+ /** @defaultValue `AmbientSoundDocument` */
1549
1246
  documentClass: ConfiguredDocumentClassOrDefault<typeof AmbientSoundDocument>;
1550
1247
 
1551
- /**
1552
- * @defaultValue `AmbientSound`
1553
- */
1248
+ /** @defaultValue `AmbientSound` */
1554
1249
  objectClass: ConfiguredObjectClassOrDefault<typeof AmbientSound>;
1555
1250
 
1556
- /**
1557
- * @defaultValue `SoundsLayer`
1558
- */
1251
+ /** @defaultValue `SoundsLayer` */
1559
1252
  layerClass: ConstructorOf<SoundsLayer>;
1560
-
1561
- /**
1562
- * @defaultValue `AmbientSoundConfig`
1563
- */
1564
- sheetClass: ConstructorOf<AmbientSoundConfig>;
1565
1253
  };
1566
1254
 
1567
1255
  /**
1568
1256
  * Configuration for the Combatant embedded document type within a Combat document
1569
1257
  */
1570
1258
  Combatant: {
1571
- /**
1572
- * @defaultValue `Combatant`
1573
- */
1259
+ /** @defaultValue `Combatant` */
1574
1260
  documentClass: ConfiguredDocumentClassOrDefault<typeof Combatant>;
1575
-
1576
- /**
1577
- * @defaultValue `CombatantConfig`
1578
- */
1579
- sheetClass: ConstructorOf<CombatantConfig>;
1580
1261
  };
1581
1262
 
1582
1263
  /**
1583
1264
  * Configuration for the Drawing embedded document type and its representation on the game Canvas
1584
1265
  */
1585
1266
  Drawing: {
1586
- /**
1587
- * @defaultValue `DrawingDocument`
1588
- */
1267
+ /** @defaultValue `DrawingDocument` */
1589
1268
  documentClass: ConfiguredDocumentClassOrDefault<typeof DrawingDocument>;
1590
1269
 
1591
- /**
1592
- * @defaultValue `Drawing`
1593
- */
1270
+ /** @defaultValue `Drawing` */
1594
1271
  objectClass: ConfiguredObjectClassOrDefault<typeof Drawing>;
1595
1272
 
1596
- /**
1597
- * @defaultValue `DrawingsLayer`
1598
- */
1273
+ /** @defaultValue `DrawingsLayer` */
1599
1274
  layerClass: ConstructorOf<DrawingsLayer>;
1600
-
1601
- /**
1602
- * @defaultValue `DrawingConfig`
1603
- */
1604
- sheetClass: ConstructorOf<DrawingConfig>;
1605
1275
  };
1606
1276
 
1607
1277
  /**
@@ -1609,158 +1279,94 @@ declare global {
1609
1279
  */
1610
1280
  MeasuredTemplate: {
1611
1281
  defaults: {
1612
- /**
1613
- * @defaultValue `53.13`
1614
- */
1282
+ /** @defaultValue `53.13` */
1615
1283
  angle: number;
1616
1284
 
1617
- /**
1618
- * @defaultValue `1`
1619
- */
1285
+ /** @defaultValue `1` */
1620
1286
  width: number;
1621
1287
  };
1622
1288
 
1623
1289
  types: {
1624
- /**
1625
- * @defaultValue `'Circle'`
1626
- */
1290
+ /** @defaultValue `'Circle'` */
1627
1291
  circle: string;
1628
1292
 
1629
- /**
1630
- * @defaultValue `'Cone'`
1631
- */
1293
+ /** @defaultValue `'Cone'` */
1632
1294
  cone: string;
1633
1295
 
1634
- /**
1635
- * @defaultValue `'Rectangle'`
1636
- */
1296
+ /** @defaultValue `'Rectangle'` */
1637
1297
  rect: string;
1638
1298
 
1639
- /**
1640
- * @defaultValue `'Ray'`
1641
- */
1299
+ /** @defaultValue `'Ray'` */
1642
1300
  ray: string;
1643
- } & Partial<Record<string, string>>;
1301
+ };
1644
1302
 
1645
- /**
1646
- * @defaultValue `MeasuredTemplateDocument`
1647
- */
1303
+ /** @defaultValue `MeasuredTemplateDocument` */
1648
1304
  documentClass: ConfiguredDocumentClassOrDefault<typeof MeasuredTemplateDocument>;
1649
1305
 
1650
- /**
1651
- * @defaultValue `MeasuredTemplate`
1652
- */
1306
+ /** @defaultValue `MeasuredTemplate` */
1653
1307
  objectClass: ConfiguredObjectClassOrDefault<typeof MeasuredTemplate>;
1654
1308
 
1655
- /**
1656
- * @defaultValue `TemplateLayer`
1657
- */
1309
+ /** @defaultValue `TemplateLayer` */
1658
1310
  layerClass: ConstructorOf<TemplateLayer>;
1659
-
1660
- /**
1661
- * @defaultValue `MeasuredTemplateConfig`
1662
- */
1663
- sheetClass: ConstructorOf<MeasuredTemplateConfig>;
1664
1311
  };
1665
1312
 
1666
1313
  /**
1667
1314
  * Configuration for the Note embedded document type and its representation on the game Canvas
1668
1315
  */
1669
1316
  Note: {
1670
- /**
1671
- * @defaultValue `NoteDocument`
1672
- */
1317
+ /** @defaultValue `NoteDocument` */
1673
1318
  documentClass: ConfiguredDocumentClassOrDefault<typeof NoteDocument>;
1674
1319
 
1675
- /**
1676
- * @defaultValue `Note`
1677
- */
1320
+ /** @defaultValue `Note` */
1678
1321
  objectClass: ConfiguredObjectClassOrDefault<typeof Note>;
1679
1322
 
1680
- /**
1681
- * @defaultValue `NotesLayer`
1682
- */
1323
+ /** @defaultValue `NotesLayer` */
1683
1324
  layerClass: ConstructorOf<NotesLayer>;
1684
-
1685
- /**
1686
- * @defaultValue `NoteConfig`
1687
- */
1688
- sheetClass: ConstructorOf<NoteConfig>;
1689
1325
  };
1690
1326
 
1691
1327
  /**
1692
1328
  * Configuration for the Tile embedded document type and its representation on the game Canvas
1693
1329
  */
1694
1330
  Tile: {
1695
- /**
1696
- * @defaultValue `TileDocument`
1697
- */
1331
+ /** @defaultValue `TileDocument` */
1698
1332
  documentClass: ConfiguredDocumentClassOrDefault<typeof TileDocument>;
1699
1333
 
1700
- /**
1701
- * @defaultValue `Tile`
1702
- */
1334
+ /** @defaultValue `Tile` */
1703
1335
  objectClass: ConfiguredObjectClassOrDefault<typeof Tile>;
1704
1336
 
1705
- /**
1706
- * @defaultValue `BackgroundLayer`
1707
- */
1337
+ /** @defaultValue `BackgroundLayer` */
1708
1338
  layerClass: ConstructorOf<BackgroundLayer>;
1709
-
1710
- /**
1711
- * @defaultValue `TileConfig`
1712
- */
1713
- sheetClass: ConstructorOf<TileConfig>;
1714
1339
  };
1715
1340
 
1716
1341
  /**
1717
1342
  * Configuration for the Token embedded document type and its representation on the game Canvas
1718
1343
  */
1719
1344
  Token: {
1720
- /**
1721
- * @defaultValue `TokenDocument`
1722
- */
1345
+ /** @defaultValue `TokenDocument` */
1723
1346
  documentClass: ConfiguredDocumentClassOrDefault<typeof TokenDocument>;
1724
1347
 
1725
- /**
1726
- * @defaultValue `Token`
1727
- */
1348
+ /** @defaultValue `Token` */
1728
1349
  objectClass: ConfiguredObjectClassOrDefault<typeof Token>;
1729
1350
 
1730
- /**
1731
- * @defaultValue `TokenLayer`
1732
- */
1351
+ /** @defaultValue `TokenLayer` */
1733
1352
  layerClass: ConstructorOf<TokenLayer>;
1734
1353
 
1735
- /**
1736
- * @defaultValue `TokenConfig`
1737
- */
1738
- sheetClass: ConstructorOf<TokenConfig>;
1354
+ /** @defaultValue `TokenConfig` */
1355
+ prototypeSheetClass: ConstructorOf<TokenConfig>;
1739
1356
  };
1740
1357
 
1741
1358
  /**
1742
1359
  * Configuration for the Wall embedded document type and its representation on the game Canvas
1743
1360
  */
1744
1361
  Wall: {
1745
- /**
1746
- * @defaultValue `WallDocument`
1747
- */
1362
+ /** @defaultValue `WallDocument` */
1748
1363
  documentClass: ConfiguredDocumentClassOrDefault<typeof WallDocument>;
1749
1364
 
1750
- /**
1751
- * @defaultValue `Wall`
1752
- */
1365
+ /** @defaultValue `Wall` */
1753
1366
  objectClass: ConfiguredObjectClassOrDefault<typeof Wall>;
1754
1367
 
1755
- /**
1756
- * @defaultValue `WallsLayer`
1757
- */
1368
+ /** @defaultValue `WallsLayer` */
1758
1369
  layerClass: ConstructorOf<WallsLayer>;
1759
-
1760
- /**
1761
- * @defaultValue `WallConfig`
1762
- */
1763
- sheetClass: ConstructorOf<WallConfig>;
1764
1370
  };
1765
1371
 
1766
1372
  /**
@@ -1772,35 +1378,26 @@ declare global {
1772
1378
  * Configuration for the WebRTC implementation class
1773
1379
  */
1774
1380
  WebRTC: {
1775
- /**
1776
- * @defaultValue `SimplePeerAVClient`
1777
- */
1381
+ /** @defaultValue `SimplePeerAVClient` */
1778
1382
  clientClass: PropertyTypeOrFallback<WebRTCConfig, 'clientClass', typeof AVClient>;
1779
1383
 
1780
- /**
1781
- * @defaultValue `50`
1782
- */
1384
+ /** @defaultValue `50` */
1783
1385
  detectPeerVolumeInterval: number;
1784
1386
 
1785
- /**
1786
- * @defaultValue `20`
1787
- */
1387
+ /** @defaultValue `20` */
1788
1388
  detectSelfVolumeInterval: number;
1789
1389
 
1790
- /**
1791
- * @defaultValue `25`
1792
- */
1390
+ /** @defaultValue `25` */
1793
1391
  emitVolumeInterval: number;
1794
1392
 
1795
- /**
1796
- * @defaultValue `2`
1797
- */
1393
+ /** @defaultValue `2` */
1798
1394
  speakingThresholdEvents: number;
1799
1395
 
1800
- /**
1801
- * @defaultValue `10`
1802
- */
1396
+ /** @defaultValue `10` */
1803
1397
  speakingHistoryLength: number;
1398
+
1399
+ /** @defaultValue `8` */
1400
+ connectedUserPollIntervalS: number;
1804
1401
  };
1805
1402
 
1806
1403
  /**
@@ -1811,187 +1408,170 @@ declare global {
1811
1408
 
1812
1409
  namespace CONFIG {
1813
1410
  interface UI {
1814
- /**
1815
- * @defaultValue `MainMenu`
1816
- */
1411
+ /** @defaultValue `MainMenu` */
1817
1412
  menu: ConstructorOf<MainMenu>;
1818
1413
 
1819
- /**
1820
- * @defaultValue `Sidebar`
1821
- */
1414
+ /** @defaultValue `Sidebar` */
1822
1415
  sidebar: ConstructorOf<Sidebar>;
1823
1416
 
1824
- /**
1825
- * @defaultValue `Pause`
1826
- */
1417
+ /** @defaultValue `Pause` */
1827
1418
  pause: ConstructorOf<Pause>;
1828
1419
 
1829
- /**
1830
- * @defaultValue `SceneNavigation`
1831
- */
1420
+ /** @defaultValue `SceneNavigation` */
1832
1421
  nav: ConstructorOf<SceneNavigation>;
1833
1422
 
1834
- /**
1835
- * @defaultValue `Notifications`
1836
- */
1423
+ /** @defaultValue `Notifications` */
1837
1424
  notifications: ConstructorOf<Notifications>;
1838
1425
 
1839
- /**
1840
- * @defaultValue `ActorDirectory`
1841
- */
1426
+ /** @defaultValue `ActorDirectory` */
1842
1427
  actors: ConstructorOf<ActorDirectory>;
1843
1428
 
1844
- /**
1845
- * @defaultValue `ChatLog`
1846
- */
1429
+ /** @defaultValue `CardsDirectory` */
1430
+ cards: ConstructorOf<CardsDirectory>;
1431
+
1432
+ /** @defaultValue `ChatLog` */
1847
1433
  chat: ConstructorOf<ChatLog>;
1848
1434
 
1849
- /**
1850
- * @defaultValue `CombatTracker`
1851
- */
1435
+ /** @defaultValue `CombatTracker` */
1852
1436
  combat: ConstructorOf<CombatTracker>;
1853
1437
 
1854
- /**
1855
- * @defaultValue `CompendiumDirectory`
1856
- */
1438
+ /** @defaultValue `CompendiumDirectory` */
1857
1439
  compendium: ConstructorOf<CompendiumDirectory>;
1858
1440
 
1859
- /**
1860
- * @defaultValue `SceneControls`
1861
- */
1441
+ /** @defaultValue `SceneControls` */
1862
1442
  controls: ConstructorOf<SceneControls>;
1863
1443
 
1864
- /**
1865
- * @defaultValue `Hotbar`
1866
- */
1444
+ /** @defaultValue `Hotbar` */
1867
1445
  hotbar: ConstructorOf<Hotbar>;
1868
1446
 
1869
- /**
1870
- * @defaultValue `ItemDirectory`
1871
- */
1447
+ /** @defaultValue `ItemDirectory` */
1872
1448
  items: ConstructorOf<ItemDirectory>;
1873
1449
 
1874
- /**
1875
- * @defaultValue `JournalDirectory`
1876
- */
1450
+ /** @defaultValue `JournalDirectory` */
1877
1451
  journal: ConstructorOf<JournalDirectory>;
1878
1452
 
1879
- /**
1880
- * @defaultValue `MacroDirectory`
1881
- */
1453
+ /** @defaultValue `MacroDirectory` */
1882
1454
  macros: ConstructorOf<MacroDirectory>;
1883
1455
 
1884
- /**
1885
- * @defaultValue `PlayerList`
1886
- */
1456
+ /** @defaultValue `PlayerList` */
1887
1457
  players: ConstructorOf<PlayerList>;
1888
1458
 
1889
- /**
1890
- * @defaultValue `PlaylistDirectory`
1891
- */
1459
+ /** @defaultValue `PlaylistDirectory` */
1892
1460
  playlists: ConstructorOf<PlaylistDirectory>;
1893
1461
 
1894
- /**
1895
- * @defaultValue `SceneDirectory`
1896
- */
1462
+ /** @defaultValue `SceneDirectory` */
1897
1463
  scenes: ConstructorOf<SceneDirectory>;
1898
1464
 
1899
- /**
1900
- * @defaultValue `Settings`
1901
- */
1465
+ /** @defaultValue `Settings` */
1902
1466
  settings: ConstructorOf<Settings>;
1903
1467
 
1904
- /**
1905
- * @defaultValue `RollTableDirectory`
1906
- */
1468
+ /** @defaultValue `RollTableDirectory` */
1907
1469
  tables: ConstructorOf<RollTableDirectory>;
1908
1470
 
1909
- /**
1910
- * @defaultValue `CameraViews`
1911
- */
1471
+ /** @defaultValue `CameraViews` */
1912
1472
  webrtc: ConstructorOf<CameraViews>;
1913
1473
  }
1914
1474
 
1915
1475
  namespace Canvas {
1476
+ interface Groups {
1477
+ /** @defaultValue `{ groupClass: PrimaryCanvasGroup }` */
1478
+ primary: CONFIG.Canvas.GroupDefinition<typeof PrimaryCanvasGroup>;
1479
+
1480
+ /** @defaultValue `{ groupClass: EffectsCanvasGroup }` */
1481
+ effects: CONFIG.Canvas.GroupDefinition<typeof EffectsCanvasGroup>;
1482
+
1483
+ /** @defaultValue `{ groupClass: InterfaceCanvasGroup }` */
1484
+ interface: CONFIG.Canvas.GroupDefinition<typeof InterfaceCanvasGroup>;
1485
+
1486
+ [key: string]: CONFIG.Canvas.GroupDefinition;
1487
+ }
1488
+
1916
1489
  interface Layers {
1917
- /**
1918
- * @defaultValue `BackgroundLayer`
1919
- */
1920
- background: ConstructorOf<BackgroundLayer>;
1490
+ /** @defaultValue `{ layerClass: BackgroundLayer, group: "primary" }` */
1491
+ background: LayerDefinition<ConstructorOf<BackgroundLayer>>;
1921
1492
 
1922
- /**
1923
- * @defaultValue `DrawingsLayer`
1924
- */
1925
- drawings: ConstructorOf<DrawingsLayer>;
1493
+ /** @defaultValue `{ layerClass: DrawingsLayer, group: "primary" }` */
1494
+ drawings: LayerDefinition<ConstructorOf<DrawingsLayer>>;
1926
1495
 
1927
- /**
1928
- * @defaultValue `GridLayer`
1929
- */
1930
- grid: ConstructorOf<GridLayer>;
1496
+ /** @defaultValue `{ layerClass: GridLayer, group: "primary" }` */
1497
+ grid: LayerDefinition<ConstructorOf<GridLayer>>;
1931
1498
 
1932
- /**
1933
- * @defaultValue `WallsLayer`
1934
- */
1935
- walls: ConstructorOf<WallsLayer>;
1499
+ /** @defaultValue `{ layerClass: TemplateLayer, group: "primary" }` */
1500
+ templates: LayerDefinition<ConstructorOf<TemplateLayer>>;
1936
1501
 
1937
- /**
1938
- * @defaultValue `TemplateLayer`
1939
- */
1940
- templates: ConstructorOf<TemplateLayer>;
1502
+ /** @defaultValue `{ layerClass: TokenLayer, group: "primary" }` */
1503
+ tokens: LayerDefinition<ConstructorOf<TokenLayer>>;
1941
1504
 
1942
- /**
1943
- * @defaultValue `NotesLayer`
1944
- */
1945
- notes: ConstructorOf<NotesLayer>;
1505
+ /** @defaultValue `{ layerClass: ForegroundLayer, group: "primary" }` */
1506
+ foreground: LayerDefinition<ConstructorOf<ForegroundLayer>>;
1946
1507
 
1947
- /**
1948
- * @defaultValue `TokenLayer`
1949
- */
1950
- tokens: ConstructorOf<TokenLayer>;
1508
+ /** @defaultValue `{ layerClass: WallsLayer, group: "effects" }` */
1509
+ walls: LayerDefinition<ConstructorOf<WallsLayer>>;
1951
1510
 
1952
- /**
1953
- * @defaultValue `ForegroundLayer`
1954
- */
1955
- foreground: ConstructorOf<ForegroundLayer>;
1511
+ /** @defaultValue `{ layerClass: LightingLayer, group: "effects" }` */
1512
+ lighting: LayerDefinition<ConstructorOf<LightingLayer>>;
1956
1513
 
1957
- /**
1958
- * @defaultValue `SoundsLayer`
1959
- */
1960
- sounds: ConstructorOf<SoundsLayer>;
1514
+ /** @defaultValue `{ layerClass: WeatherLayer, group: "effects" }` */
1515
+ weather: LayerDefinition<ConstructorOf<WeatherLayer>>;
1961
1516
 
1962
- /**
1963
- * @defaultValue `LightingLayer`
1964
- */
1965
- lighting: ConstructorOf<LightingLayer>;
1517
+ /** @defaultValue `{ layerClass: SightLayer, group: "effects" }` */
1518
+ sight: LayerDefinition<ConstructorOf<SightLayer>>;
1966
1519
 
1967
- /**
1968
- * @defaultValue `SightLayer`
1969
- */
1970
- sight: ConstructorOf<SightLayer>;
1520
+ /** @defaultValue `{ layerClass: SoundsLayer, group: "interface" }` */
1521
+ sounds: LayerDefinition<ConstructorOf<SoundsLayer>>;
1971
1522
 
1972
- /**
1973
- * @defaultValue `EffectsLayer`
1974
- */
1975
- effects: ConstructorOf<EffectsLayer>;
1523
+ /** @defaultValue `{ layerClass: NotesLayer, group: "interface" }` */
1524
+ notes: LayerDefinition<ConstructorOf<NotesLayer>>;
1976
1525
 
1977
- /**
1978
- * @defaultValue `ControlsLayer`
1979
- */
1980
- controls: ConstructorOf<ControlsLayer>;
1526
+ /** @defaultValue `{ layerClass: ControlsLayer, group: "interface" }` */
1527
+ controls: LayerDefinition<ConstructorOf<ControlsLayer>>;
1528
+
1529
+ [key: string]: LayerDefinition;
1530
+ }
1981
1531
 
1982
- [key: string]: ConstructorOf<CanvasLayer>;
1532
+ interface GroupDefinition<GroupClass extends CanvasGroupConstructor = CanvasGroupConstructor> {
1533
+ groupClass: GroupClass;
1983
1534
  }
1535
+
1536
+ interface LayerDefinition<LayerClass extends ConstructorOf<CanvasLayer> = ConstructorOf<CanvasLayer>> {
1537
+ layerClass: LayerClass;
1538
+ group: keyof CONFIG['Canvas']['groups'];
1539
+ }
1540
+
1541
+ type LightAnimationFunction = (
1542
+ this: PointSource,
1543
+ dt: number,
1544
+ properties?: { speed?: number; intensity?: number; reverse?: false }
1545
+ ) => void;
1984
1546
  }
1985
1547
 
1986
- interface SheetClass {
1987
- id: string;
1988
- cls: ConstructorOf<FormApplication>;
1989
- label: string;
1990
- default: boolean;
1548
+ namespace Cards {
1549
+ interface Preset {
1550
+ type: string;
1551
+ label: string;
1552
+ src: string;
1553
+ }
1991
1554
  }
1992
1555
 
1993
- type SheetClasses = Record<string, Record<string, SheetClass>>;
1556
+ namespace Dice {
1557
+ // eslint-disable-next-line @typescript-eslint/no-empty-interface
1558
+ interface RollModes extends Record<foundry.CONST.DICE_ROLL_MODES, string> {}
1559
+ }
1994
1560
  }
1995
1561
 
1996
1562
  const CONFIG: CONFIG;
1997
1563
  }
1564
+
1565
+ type PixiContainerConstructor = typeof PIXI.Container;
1566
+ interface CanvasGroup extends PIXI.Container {
1567
+ sortableChildren: boolean;
1568
+ }
1569
+
1570
+ interface CanvasGroupConstructor extends PixiContainerConstructor {
1571
+ new (): CanvasGroup;
1572
+
1573
+ /**
1574
+ * The name of this canvas group
1575
+ */
1576
+ groupName: string;
1577
+ }