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