@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
@@ -11,16 +11,18 @@ export declare class BaseAmbientSound extends Document<
11
11
  data.AmbientSoundData,
12
12
  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>
13
13
  > {
14
+ /** @override */
14
15
  static get schema(): typeof data.AmbientSoundData;
15
16
 
17
+ /** @override */
16
18
  static get metadata(): Merge<
17
19
  DocumentMetadata,
18
20
  {
19
21
  name: 'AmbientSound';
20
22
  collection: 'sounds';
21
23
  label: 'DOCUMENT.AmbientSound';
24
+ labelPlural: 'DOCUMENT.AmbientSounds';
22
25
  isEmbedded: true;
23
- types: ['l', 'g'];
24
26
  }
25
27
  >;
26
28
  }
@@ -0,0 +1,62 @@
1
+ import { ConfiguredDocumentClass } from '../../../types/helperTypes';
2
+ import { DocumentMetadata, DocumentModificationOptions } from '../abstract/document.mjs';
3
+ import { Document } from '../abstract/module.mjs';
4
+ import * as data from '../data/data.mjs';
5
+ import type { CardDataConstructorData } from '../data/data.mjs/cardData.js';
6
+ import { BaseCards } from './baseCards';
7
+ import { BaseUser } from './baseUser';
8
+
9
+ /**
10
+ * The base Card definition which defines common behavior of an embedded Card document shared by both client and server.
11
+ */
12
+ export declare class BaseCard extends Document<data.CardData, InstanceType<ConfiguredDocumentClass<typeof BaseCards>>> {
13
+ /** @override */
14
+ static get schema(): typeof data.CardData;
15
+
16
+ /** @override */
17
+ static get metadata(): Merge<
18
+ DocumentMetadata,
19
+ {
20
+ name: 'Card';
21
+ collection: 'cards';
22
+ label: 'DOCUMENT.Card';
23
+ labelPlural: 'DOCUMENT.Cards';
24
+ isEmbedded: true;
25
+ types: string[];
26
+ hasSystemData: true;
27
+ permissions: {
28
+ create: typeof BaseCard['_canCreate'];
29
+ update: typeof BaseCard['_canUpdate'];
30
+ };
31
+ }
32
+ >;
33
+
34
+ /**
35
+ * The sub-type of Card.
36
+ */
37
+ get type(): data.CardData['type'];
38
+
39
+ /** @override */
40
+ protected _preCreate(
41
+ data: CardDataConstructorData,
42
+ options: DocumentModificationOptions,
43
+ user: BaseUser
44
+ ): Promise<void>;
45
+
46
+ /**
47
+ * Is a User able to create a new embedded Card document within this parent?
48
+ */
49
+ protected static _canCreate(user: BaseUser, doc: BaseCard, data?: object): boolean;
50
+
51
+ /**
52
+ * Is a user able to update an existing Card?
53
+ */
54
+ protected static _canUpdate(user: BaseUser, doc: BaseCard, data?: object): boolean;
55
+
56
+ /** @override */
57
+ testUserPermission(
58
+ user: BaseUser,
59
+ permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
60
+ { exact }: { exact?: boolean }
61
+ ): boolean;
62
+ }
@@ -0,0 +1,39 @@
1
+ import { DocumentMetadata } from '../abstract/document.mjs';
2
+ import { Document } from '../abstract/module.mjs';
3
+ import * as data from '../data/data.mjs';
4
+ import { BaseCard } from './baseCard';
5
+
6
+ /**
7
+ * The base Cards definition which defines common behavior of an Cards document shared by both client and server.
8
+ */
9
+ export declare class BaseCards extends Document<data.CardsData> {
10
+ /** @override */
11
+ static get schema(): typeof data.CardsData;
12
+
13
+ /** @override */
14
+ static get metadata(): Merge<
15
+ DocumentMetadata,
16
+ {
17
+ name: 'Cards';
18
+ collection: 'cards';
19
+ label: 'DOCUMENT.Cards';
20
+ labelPlural: 'DOCUMENT.CardsPlural';
21
+ isPrimary: true;
22
+ types: string[];
23
+ hasSystemData: true;
24
+ embedded: {
25
+ Card: typeof BaseCard;
26
+ };
27
+ }
28
+ >;
29
+
30
+ /**
31
+ * A reference to the Collection of Card documents contained within this Cards stack, indexed by _id.
32
+ */
33
+ get cards(): this['data']['cards'];
34
+
35
+ /**
36
+ * The sub-type of Cards.
37
+ */
38
+ get type(): data.CardsData['type'];
39
+ }
@@ -7,14 +7,17 @@ import * as data from '../data/data.mjs';
7
7
  * The base ChatMessage model definition which defines common behavior of an ChatMessage document between both client and server.
8
8
  */
9
9
  export declare class BaseChatMessage extends Document<data.ChatMessageData, null> {
10
+ /** @override */
10
11
  static get schema(): typeof data.ChatMessageData;
11
12
 
13
+ /** @override */
12
14
  static get metadata(): Merge<
13
15
  DocumentMetadata,
14
16
  {
15
17
  name: 'ChatMessage';
16
18
  collection: 'messages';
17
19
  label: 'DOCUMENT.ChatMessage';
20
+ labelPlural: 'DOCUMENT.ChatMessages';
18
21
  isPrimary: true;
19
22
  permissions: {
20
23
  create: (user: BaseUser, doc: BaseChatMessage) => boolean;
@@ -1,6 +1,6 @@
1
- import { ConstructorDataType } from '../../../types/helperTypes';
2
1
  import { DocumentMetadata } from '../abstract/document.mjs';
3
2
  import { Document } from '../abstract/module.mjs';
3
+ import type { CombatDataConstructorData } from '../data/data.mjs/combatData.js';
4
4
  import { data } from '../module.mjs';
5
5
  import { BaseCombatant } from './baseCombatant';
6
6
  import { BaseUser } from './baseUser';
@@ -9,14 +9,17 @@ import { BaseUser } from './baseUser';
9
9
  * The base Combat model definition which defines common behavior of an Combat document between both client and server.
10
10
  */
11
11
  export declare class BaseCombat extends Document<data.CombatData> {
12
+ /** @override */
12
13
  static get schema(): typeof data.CombatData;
13
14
 
15
+ /** @override */
14
16
  static get metadata(): Merge<
15
17
  DocumentMetadata,
16
18
  {
17
19
  name: 'Combat';
18
20
  collection: 'combats';
19
21
  label: 'DOCUMENT.Combat';
22
+ labelPlural: 'DOCUMENT.Combats';
20
23
  embedded: {
21
24
  Combatant: typeof BaseCombatant;
22
25
  };
@@ -34,5 +37,5 @@ export declare class BaseCombat extends Document<data.CombatData> {
34
37
  * Is a user able to update an existing Combat?
35
38
  * @param doc - (unused)
36
39
  */
37
- protected static _canUpdate(user: BaseUser, doc: unknown, data?: ConstructorDataType<data.CombatData>): boolean;
40
+ protected static _canUpdate(user: BaseUser, doc: BaseCombat, data?: CombatDataConstructorData): boolean;
38
41
  }
@@ -1,6 +1,7 @@
1
1
  import { ConfiguredDocumentClass } from '../../../types/helperTypes';
2
2
  import { DocumentMetadata } from '../abstract/document.mjs';
3
3
  import { Document } from '../abstract/module.mjs';
4
+ import type { CombatantDataConstructorData } from '../data/data.mjs/combatantData.js';
4
5
  import { data } from '../module.mjs';
5
6
  import { BaseCombat } from './baseCombat';
6
7
  import { BaseUser } from './baseUser';
@@ -12,8 +13,10 @@ export declare class BaseCombatant extends Document<
12
13
  data.CombatantData,
13
14
  InstanceType<ConfiguredDocumentClass<typeof BaseCombat>>
14
15
  > {
16
+ /** @override */
15
17
  static get schema(): typeof data.CombatantData;
16
18
 
19
+ /** @override */
17
20
  static get metadata(): Merge<
18
21
  DocumentMetadata,
19
22
  {
@@ -21,8 +24,9 @@ export declare class BaseCombatant extends Document<
21
24
  collection: 'combatants';
22
25
  label: 'DOCUMENT.Combatant';
23
26
  isEmbedded: true;
27
+ labelPlural: 'DOCUMENT.Combatants';
24
28
  permissions: {
25
- create: 'PLAYER';
29
+ create: typeof BaseCombatant._canCreate;
26
30
  update: typeof BaseCombatant._canUpdate;
27
31
  };
28
32
  }
@@ -32,5 +36,8 @@ export declare class BaseCombatant extends Document<
32
36
  * Is a user able to update an existing Combatant?
33
37
  * @remarks doc seems unused
34
38
  */
35
- protected static _canUpdate(user: BaseUser, doc: unknown, data?: object): boolean;
39
+ protected static _canUpdate(user: BaseUser, doc: BaseCombatant, data?: CombatantDataConstructorData): boolean;
40
+
41
+ /** Is a user able to create this Combatant? */
42
+ protected static _canCreate(user: BaseUser, doc: BaseCombatant, data?: CombatantDataConstructorData): boolean;
36
43
  }
@@ -2,6 +2,7 @@ import { ConfiguredDocumentClass } from '../../../types/helperTypes';
2
2
  import { DocumentMetadata } from '../abstract/document.mjs';
3
3
  import { Document } from '../abstract/module.mjs';
4
4
  import * as data from '../data/data.mjs';
5
+ import type { CONST } from '../module.mjs';
5
6
  import { BaseScene } from './baseScene';
6
7
  import { BaseUser } from './baseUser';
7
8
 
@@ -12,6 +13,7 @@ export declare class BaseDrawing extends Document<
12
13
  data.DrawingData,
13
14
  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>
14
15
  > {
16
+ /** @override */
15
17
  static get schema(): typeof data.DrawingData;
16
18
 
17
19
  /** @override */
@@ -21,7 +23,15 @@ export declare class BaseDrawing extends Document<
21
23
  name: 'Drawing';
22
24
  collection: 'drawings';
23
25
  label: 'DOCUMENT.Drawing';
26
+ labelPlural: 'DOCUMENT.Drawings';
24
27
  isEmbedded: true;
28
+ types: [
29
+ typeof CONST.DRAWING_TYPES.RECTANGLE,
30
+ typeof CONST.DRAWING_TYPES.ELLIPSE,
31
+ typeof CONST.DRAWING_TYPES.TEXT,
32
+ typeof CONST.DRAWING_TYPES.POLYGON,
33
+ typeof CONST.DRAWING_TYPES.FREEHAND
34
+ ];
25
35
  permissions: {
26
36
  create: 'DRAWING_CREATE';
27
37
  update: (user: BaseUser, doc: BaseDrawing, data?: object) => boolean;
@@ -33,7 +43,7 @@ export declare class BaseDrawing extends Document<
33
43
  /** @override */
34
44
  testUserPermission(
35
45
  user: BaseUser,
36
- permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.EntityPermission,
46
+ permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
37
47
  { exact }?: { exact?: boolean }
38
48
  ): boolean;
39
49
 
@@ -1,8 +1,8 @@
1
- import { ConstructorDataType } from '../../../types/helperTypes';
2
1
  import { DocumentMetadata, DocumentModificationOptions } from '../abstract/document.mjs';
3
2
  import { Document } from '../abstract/module.mjs';
4
- import { BaseUser } from './baseUser';
5
3
  import * as data from '../data/data.mjs';
4
+ import type { FogExplorationDataConstructorData } from '../data/data.mjs/fogExplorationData.js';
5
+ import { BaseUser } from './baseUser';
6
6
 
7
7
  /**
8
8
  * The base FogExploration model definition which defines common behavior of an FogExploration document between both client and server.
@@ -18,6 +18,7 @@ export declare class BaseFogExploration extends Document<data.FogExplorationData
18
18
  name: 'FogExploration';
19
19
  collection: 'fog';
20
20
  label: 'DOCUMENT.FogExploration';
21
+ labelPlural: 'DOCUMENT.FogExplorations';
21
22
  isPrimary: true;
22
23
  permissions: {
23
24
  create: 'PLAYER';
@@ -29,7 +30,7 @@ export declare class BaseFogExploration extends Document<data.FogExplorationData
29
30
 
30
31
  /** @override */
31
32
  protected _preUpdate(
32
- changed: DeepPartial<ConstructorDataType<data.FogExplorationData>>,
33
+ changed: DeepPartial<FogExplorationDataConstructorData>,
33
34
  options: DocumentModificationOptions,
34
35
  user: BaseUser
35
36
  ): Promise<void>;
@@ -1,21 +1,30 @@
1
1
  import * as data from '../data/data.mjs';
2
2
  import { Document } from '../abstract/module.mjs';
3
3
  import { DocumentMetadata } from '../abstract/document.mjs';
4
+ import * as CONST from '../constants.mjs';
4
5
 
5
6
  /**
6
7
  * The base Folder model definition which defines common behavior of an Folder document between both client and server.
7
8
  */
8
9
  export declare class BaseFolder extends Document<data.FolderData, BaseFolder> {
10
+ /** @override */
9
11
  static get schema(): typeof data.FolderData;
10
12
 
13
+ /** @override */
11
14
  static get metadata(): Merge<
12
15
  DocumentMetadata,
13
16
  {
14
17
  name: 'Folder';
15
18
  collection: 'folders';
16
19
  label: 'DOCUMENT.Folder';
20
+ labelPlural: 'DOCUMENT.Folders';
17
21
  isPrimary: true;
18
- types: typeof CONST.FOLDER_ENTITY_TYPES;
22
+ types: typeof CONST.FOLDER_DOCUMENT_TYPES;
19
23
  }
20
24
  >;
25
+
26
+ /**
27
+ * The type of Document contained within this Folder.
28
+ */
29
+ get type(): CONST.FOLDER_DOCUMENT_TYPES;
21
30
  }
@@ -10,14 +10,17 @@ import { ConfiguredDocumentClass } from '../../../types/helperTypes';
10
10
  * The base Item model definition which defines common behavior of an Item document between both client and server.
11
11
  */
12
12
  export declare class BaseItem extends Document<data.ItemData, InstanceType<ConfiguredDocumentClass<typeof BaseActor>>> {
13
+ /** @override */
13
14
  static get schema(): typeof data.ItemData;
14
15
 
16
+ /** @override */
15
17
  static get metadata(): Merge<
16
18
  DocumentMetadata,
17
19
  {
18
20
  name: 'Item';
19
21
  collection: 'items';
20
22
  label: 'DOCUMENT.Item';
23
+ labelPlural: 'DOCUMENT.Items';
21
24
  embedded: {
22
25
  ActiveEffect: typeof BaseActiveEffect;
23
26
  };
@@ -35,39 +38,18 @@ export declare class BaseItem extends Document<data.ItemData, InstanceType<Confi
35
38
  */
36
39
  get effects(): this['data']['effects'];
37
40
 
41
+ /**
42
+ * The sub-type of Item.
43
+ */
44
+ get type(): this['data']['type'];
45
+
46
+ /** @override */
38
47
  canUserModify(user: BaseUser, action: 'create' | 'update' | 'delete', data?: object): boolean;
39
48
 
49
+ /** @override */
40
50
  testUserPermission(
41
51
  user: BaseUser,
42
- permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.EntityPermission,
52
+ permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
43
53
  { exact }: { exact?: boolean }
44
54
  ): boolean;
45
-
46
- /**
47
- * Migrate the system data object to conform to data model defined by the current system version.
48
- * @see mergeObject
49
- * @param options - Options which customize how the system data is migrated.
50
- * @returns The migrated system data object, not yet saved to the database
51
- */
52
- migrateSystemData(options?: MigrateSystemDataOptions): object;
53
- }
54
-
55
- interface MigrateSystemDataOptions {
56
- /**
57
- * Retain keys which exist in the current data, but not the model
58
- * @defaultValue `false`
59
- */
60
- insertKeys?: boolean;
61
-
62
- /**
63
- * Retain inner-object values which exist in the current data, but not the model
64
- * @defaultValue `true`
65
- */
66
- insertValues?: boolean;
67
-
68
- /**
69
- * Require that data types match the model exactly to be retained
70
- * @defaultValue `false`
71
- */
72
- enforceTypes?: boolean;
73
55
  }
@@ -6,14 +6,17 @@ import { DocumentMetadata } from '../abstract/document.mjs';
6
6
  * The base JournalEntry model definition which defines common behavior of an JournalEntry document between both client and server.
7
7
  */
8
8
  export declare class BaseJournalEntry extends Document<data.JournalEntryData> {
9
+ /** @override */
9
10
  static get schema(): typeof data.JournalEntryData;
10
11
 
12
+ /** @override */
11
13
  static get metadata(): Merge<
12
14
  DocumentMetadata,
13
15
  {
14
16
  name: 'JournalEntry';
15
17
  collection: 'journal';
16
18
  label: 'DOCUMENT.JournalEntry';
19
+ labelPlural: 'DOCUMENT.JournalEntries';
17
20
  isPrimary: true;
18
21
  permissions: {
19
22
  create: 'JOURNAL_CREATE';
@@ -1,23 +1,27 @@
1
- import * as data from '../data/data.mjs';
2
- import { Document } from '../abstract/module.mjs';
3
1
  import { DocumentMetadata, DocumentModificationOptions } from '../abstract/document.mjs';
2
+ import { Document } from '../abstract/module.mjs';
3
+ import * as CONST from '../constants.mjs';
4
+ import * as data from '../data/data.mjs';
5
+ import type { MacroDataConstructorData } from '../data/data.mjs/macroData.js';
4
6
  import { BaseUser } from './baseUser';
5
- import { ConstructorDataType } from '../../../types/helperTypes';
6
7
 
7
8
  /**
8
9
  * The base Macro model definition which defines common behavior of an Macro document between both client and server.
9
10
  */
10
11
  export declare class BaseMacro extends Document<data.MacroData> {
12
+ /** @override */
11
13
  static get schema(): typeof data.MacroData;
12
14
 
15
+ /** @override */
13
16
  static get metadata(): Merge<
14
17
  DocumentMetadata,
15
18
  {
16
19
  name: 'Macro';
17
20
  collection: 'macros';
18
21
  label: 'DOCUMENT.Macro';
22
+ labelPlural: 'DOCUMENT.Macros';
19
23
  isPrimary: true;
20
- types: ['script', 'chat']; // TODO: Automatically infer from CONST.MACRO_TYPES
24
+ types: [typeof CONST.MACRO_TYPES.SCRIPT, typeof CONST.MACRO_TYPES.CHAT];
21
25
  permissions: {
22
26
  create: 'PLAYER';
23
27
  update: (user: BaseUser, doc: BaseMacro, data?: object) => boolean;
@@ -26,19 +30,17 @@ export declare class BaseMacro extends Document<data.MacroData> {
26
30
  }
27
31
  >;
28
32
 
33
+ /** @override */
29
34
  protected _preCreate(
30
- data: ConstructorDataType<data.MacroData>,
35
+ data: MacroDataConstructorData,
31
36
  options: DocumentModificationOptions,
32
37
  user: BaseUser
33
38
  ): Promise<void>;
34
39
 
35
- /**
36
- * Is a user able to update an existing Macro document?
37
- */
38
- protected static _canUpdate(user: BaseUser, doc: BaseMacro, data?: object): boolean;
39
-
40
- /**
41
- * Is a user able to delete an existing Macro document?
42
- */
43
- protected static _canDelete(user: BaseUser, doc: BaseMacro): boolean;
40
+ /** @override */
41
+ testUserPermission(
42
+ user: BaseUser,
43
+ permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
44
+ { exact }: { exact?: boolean }
45
+ ): boolean;
44
46
  }
@@ -12,14 +12,17 @@ export declare class BaseMeasuredTemplate extends Document<
12
12
  data.MeasuredTemplateData,
13
13
  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>
14
14
  > {
15
+ /** @override */
15
16
  static get schema(): typeof data.MeasuredTemplateData;
16
17
 
18
+ /** @override */
17
19
  static get metadata(): Merge<
18
20
  DocumentMetadata,
19
21
  {
20
22
  name: 'MeasuredTemplate';
21
23
  collection: 'templates';
22
24
  label: 'DOCUMENT.MeasuredTemplate';
25
+ labelPlural: 'DOCUMENT.MeasuredTemplates';
23
26
  isEmbedded: true;
24
27
  permissions: {
25
28
  create: 'TEMPLATE_CREATE';
@@ -32,7 +35,7 @@ export declare class BaseMeasuredTemplate extends Document<
32
35
  /** @override */
33
36
  testUserPermission(
34
37
  user: BaseUser,
35
- permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.EntityPermission,
38
+ permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
36
39
  { exact }?: { exact?: boolean }
37
40
  ): boolean;
38
41
 
@@ -1,7 +1,6 @@
1
1
  import { ConfiguredDocumentClass } from '../../../types/helperTypes';
2
2
  import { DocumentMetadata } from '../abstract/document.mjs';
3
3
  import { Document } from '../abstract/module.mjs';
4
- import { EntityPermission } from '../constants.mjs';
5
4
  import * as data from '../data/data.mjs';
6
5
  import { BaseScene } from './baseScene';
7
6
  import { BaseUser } from './baseUser';
@@ -20,6 +19,7 @@ export declare class BaseNote extends Document<data.NoteData, InstanceType<Confi
20
19
  name: 'Note';
21
20
  collection: 'notes';
22
21
  label: 'DOCUMENT.Note';
22
+ labelPlural: 'DOCUMENT.Notes';
23
23
  isEmbedded: true;
24
24
  permissions: {
25
25
  create: 'NOTE_CREATE';
@@ -30,7 +30,7 @@ export declare class BaseNote extends Document<data.NoteData, InstanceType<Confi
30
30
  /** @override */
31
31
  testUserPermission(
32
32
  user: BaseUser,
33
- permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | EntityPermission,
33
+ permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
34
34
  { exact }?: { exact?: boolean }
35
35
  ): boolean;
36
36
  }
@@ -17,6 +17,7 @@ export declare class BasePlaylist extends Document<data.PlaylistData> {
17
17
  name: 'Playlist';
18
18
  collection: 'playlists';
19
19
  label: 'DOCUMENT.Playlist';
20
+ labelPlural: 'DOCUMENT.Playlists';
20
21
  embedded: {
21
22
  PlaylistSound: typeof BasePlaylistSound;
22
23
  };
@@ -23,6 +23,7 @@ export declare class BasePlaylistSound extends Document<
23
23
  name: 'PlaylistSound';
24
24
  collection: 'sounds';
25
25
  label: 'DOCUMENT.PlaylistSound';
26
+ labelPlural: 'DOCUMENT.PlaylistSounds';
26
27
  isEmbedded: true;
27
28
  }
28
29
  >;
@@ -30,7 +31,7 @@ export declare class BasePlaylistSound extends Document<
30
31
  /** @override */
31
32
  testUserPermission(
32
33
  user: BaseUser,
33
- permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.EntityPermission,
34
+ permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
34
35
  { exact }?: { exact?: boolean }
35
36
  ): boolean;
36
37
  }
@@ -6,14 +6,17 @@ import { BaseTableResult } from './baseTableResult';
6
6
  * The base RollTable model definition which defines common behavior of an RollTable document between both client and server.
7
7
  */
8
8
  export declare class BaseRollTable extends Document<foundry.data.RollTableData> {
9
+ /** @override */
9
10
  static get schema(): typeof foundry.data.RollTableData;
10
11
 
12
+ /** @override */
11
13
  static get metadata(): Merge<
12
14
  DocumentMetadata,
13
15
  {
14
16
  name: 'RollTable';
15
17
  collection: 'tables';
16
18
  label: 'DOCUMENT.RollTable';
19
+ labelPlural: 'DOCUMENT.RollTables';
17
20
  embedded: {
18
21
  TableResult: typeof BaseTableResult;
19
22
  };
@@ -24,6 +24,7 @@ export declare class BaseScene extends Document<data.SceneData> {
24
24
  name: 'Scene';
25
25
  collection: 'scenes';
26
26
  label: 'DOCUMENT.Scene';
27
+ labelPlural: 'DOCUMENT.Scenes';
27
28
  isPrimary: true;
28
29
  embedded: {
29
30
  AmbientLight: typeof BaseAmbientLight;
@@ -16,6 +16,7 @@ export declare class BaseSetting extends Document<data.SettingData> {
16
16
  name: 'Setting';
17
17
  collection: 'settings';
18
18
  label: 'DOCUMENT.Setting';
19
+ labelPlural: 'DOCUMENT.Settings';
19
20
  isPrimary: true;
20
21
  permissions: {
21
22
  create: 'SETTINGS_MODIFY';
@@ -11,15 +11,22 @@ export declare class BaseTableResult extends Document<
11
11
  foundry.data.TableResultData,
12
12
  InstanceType<ConfiguredDocumentClass<typeof BaseRollTable>>
13
13
  > {
14
+ /** @override */
14
15
  static get schema(): typeof foundry.data.TableResultData;
15
16
 
17
+ /** @override */
16
18
  static get metadata(): Merge<
17
19
  DocumentMetadata,
18
20
  {
19
21
  name: 'TableResult';
20
22
  collection: 'results';
21
23
  label: 'DOCUMENT.TableResult';
22
- types: typeof CONST.TABLE_RESULT_TYPES;
24
+ labelPlural: 'DOCUMENT.TableResults';
25
+ types: [
26
+ `${typeof CONST.TABLE_RESULT_TYPES.TEXT}`,
27
+ `${typeof CONST.TABLE_RESULT_TYPES.DOCUMENT}`,
28
+ `${typeof CONST.TABLE_RESULT_TYPES.COMPENDIUM}`
29
+ ];
23
30
  permissions: {
24
31
  update: (user: BaseUser, doc: any, data?: object) => boolean;
25
32
  };
@@ -28,13 +35,13 @@ export declare class BaseTableResult extends Document<
28
35
 
29
36
  /**
30
37
  * Is a user able to update an existing TableResult?
31
- * @internal
32
38
  */
33
39
  protected static _canUpdate(user: BaseUser, doc: BaseTableResult, data?: object): boolean;
34
40
 
41
+ /** @override */
35
42
  testUserPermission(
36
43
  user: BaseUser,
37
- permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.EntityPermission,
44
+ permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
38
45
  { exact }?: { exact?: boolean }
39
46
  ): boolean;
40
47
  }
@@ -18,6 +18,7 @@ export declare class BaseTile extends Document<data.TileData, InstanceType<Confi
18
18
  name: 'Tile';
19
19
  collection: 'tiles';
20
20
  label: 'DOCUMENT.Tile';
21
+ labelPlural: 'DOCUMENT.Tiles';
21
22
  isEmbedded: true;
22
23
  }
23
24
  >;
@@ -11,14 +11,17 @@ export declare class BaseToken extends Document<
11
11
  data.TokenData,
12
12
  InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>
13
13
  > {
14
+ /** @override */
14
15
  static get schema(): typeof data.TokenData;
15
16
 
17
+ /** @override */
16
18
  static get metadata(): Merge<
17
19
  DocumentMetadata,
18
20
  {
19
21
  name: 'Token';
20
22
  collection: 'tokens';
21
23
  label: 'DOCUMENT.Token';
24
+ labelPlural: 'DOCUMENT.Tokens';
22
25
  isEmbedded: true;
23
26
  permissions: {
24
27
  create: 'TOKEN_CREATE';