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