@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250718082453 → 13.346.0-beta.20250718083608
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/package.json +1 -1
- package/src/foundry/client/canvas/containers/elements/door-control.d.mts +12 -2
- package/src/foundry/client/canvas/groups/environment.d.mts +1 -1
- package/src/foundry/client/canvas/interaction/ruler/ruler.d.mts +12 -2
- package/src/foundry/client/canvas/layers/controls.d.mts +3 -3
- package/src/foundry/client/canvas/perception/fog.d.mts +12 -2
- package/src/foundry/client/canvas/placeables/token.d.mts +2 -2
- package/src/foundry/client/canvas/placeables/tokens/ring.d.mts +12 -2
- package/src/foundry/client/canvas/placeables/wall.d.mts +2 -2
- package/src/foundry/client/canvas/sources/global-light-source.d.mts +12 -2
- package/src/foundry/client/documents/actor.d.mts +2 -2
- package/src/foundry/client/documents/cards.d.mts +2 -2
- package/src/foundry/client/documents/chat-message.d.mts +2 -2
- package/src/foundry/client/documents/collections/actors.d.mts +12 -2
- package/src/foundry/client/documents/collections/card-stacks.d.mts +12 -2
- package/src/foundry/client/documents/collections/chat-messages.d.mts +12 -2
- package/src/foundry/client/documents/collections/combat-encounters.d.mts +12 -2
- package/src/foundry/client/documents/collections/fog-explorations.d.mts +12 -2
- package/src/foundry/client/documents/collections/folders.d.mts +12 -2
- package/src/foundry/client/documents/collections/items.d.mts +12 -2
- package/src/foundry/client/documents/collections/journal.d.mts +12 -2
- package/src/foundry/client/documents/collections/macros.d.mts +12 -2
- package/src/foundry/client/documents/collections/playlists.d.mts +12 -2
- package/src/foundry/client/documents/collections/roll-tables.d.mts +12 -2
- package/src/foundry/client/documents/collections/scenes.d.mts +12 -2
- package/src/foundry/client/documents/collections/users.d.mts +12 -2
- package/src/foundry/client/documents/collections/world-settings.d.mts +12 -2
- package/src/foundry/client/documents/combat.d.mts +2 -2
- package/src/foundry/client/documents/fog-exploration.d.mts +2 -2
- package/src/foundry/client/documents/folder.d.mts +2 -2
- package/src/foundry/client/documents/item.d.mts +2 -2
- package/src/foundry/client/documents/journal-entry.d.mts +2 -2
- package/src/foundry/client/documents/macro.d.mts +2 -2
- package/src/foundry/client/documents/playlist.d.mts +2 -2
- package/src/foundry/client/documents/roll-table.d.mts +2 -2
- package/src/foundry/client/documents/scene.d.mts +2 -2
- package/src/foundry/client/documents/setting.d.mts +2 -2
- package/src/foundry/client/documents/user.d.mts +2 -2
- package/src/foundry/common/abstract/document.d.mts +23 -13
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"$schema": "https://json.schemastore.org/package.json",
|
3
3
|
"name": "@league-of-foundry-developers/foundry-vtt-types",
|
4
|
-
"version": "13.346.0-beta.
|
4
|
+
"version": "13.346.0-beta.20250718083608",
|
5
5
|
"description": "TypeScript type definitions for Foundry VTT",
|
6
6
|
"type": "module",
|
7
7
|
"types": "./src/index.d.mts",
|
@@ -79,8 +79,18 @@ declare namespace DoorControl {
|
|
79
79
|
interface Any extends AnyDoorControl {}
|
80
80
|
interface AnyConstructor extends Identity<typeof AnyDoorControl> {}
|
81
81
|
|
82
|
-
type
|
83
|
-
type
|
82
|
+
type ImplementationClass = CONFIG["Canvas"]["doorControlClass"];
|
83
|
+
type Implementation = FixedInstanceType<ImplementationClass>;
|
84
|
+
|
85
|
+
/**
|
86
|
+
* @deprecated Replaced by {@linkcode DoorControl.ImplementationClass}.
|
87
|
+
*/
|
88
|
+
type ConfiguredClass = ImplementationClass;
|
89
|
+
|
90
|
+
/**
|
91
|
+
* @deprecated Replaced by {@linkcode DoorControl.Implementation}.
|
92
|
+
*/
|
93
|
+
type ConfiguredInstance = Implementation;
|
84
94
|
}
|
85
95
|
|
86
96
|
export default DoorControl;
|
@@ -20,7 +20,7 @@ declare class EnvironmentCanvasGroup<
|
|
20
20
|
* The global light source attached to the environment
|
21
21
|
* @remarks This is `defineProperty`'d as non-writable and non-configurable at construction
|
22
22
|
*/
|
23
|
-
readonly globalLightSource: foundry.canvas.sources.GlobalLightSource.
|
23
|
+
readonly globalLightSource: foundry.canvas.sources.GlobalLightSource.Implementation;
|
24
24
|
|
25
25
|
/**
|
26
26
|
* Should this group tear down its non-layer children?
|
@@ -348,8 +348,8 @@ declare namespace Ruler {
|
|
348
348
|
interface Any extends AnyRuler {}
|
349
349
|
interface AnyConstructor extends Identity<typeof AnyRuler> {}
|
350
350
|
|
351
|
-
type
|
352
|
-
type
|
351
|
+
type ImplementationClass = CONFIG["Canvas"]["rulerClass"];
|
352
|
+
type Implementation = FixedInstanceType<ImplementationClass>;
|
353
353
|
|
354
354
|
/** @internal */
|
355
355
|
type _ConstructorOptions = NullishProps<{
|
@@ -489,6 +489,16 @@ declare namespace Ruler {
|
|
489
489
|
interface PartialSegmentForAnimating
|
490
490
|
extends Pick<MeasurementSegment, "teleport" | "animation">,
|
491
491
|
IntentionalPartial<Omit<MeasurementSegment, "teleport" | "animation">> {}
|
492
|
+
|
493
|
+
/**
|
494
|
+
* @deprecated Replaced by {@linkcode Ruler.ImplementationClass}.
|
495
|
+
*/
|
496
|
+
type ConfiguredClass = ImplementationClass;
|
497
|
+
|
498
|
+
/**
|
499
|
+
* @deprecated Replaced by {@linkcode Ruler.Implementation}.
|
500
|
+
*/
|
501
|
+
type ConfiguredInstance = Implementation;
|
492
502
|
}
|
493
503
|
|
494
504
|
export default Ruler;
|
@@ -84,7 +84,7 @@ declare class ControlsLayer extends InteractionLayer {
|
|
84
84
|
*
|
85
85
|
* Foundry marked `@private`
|
86
86
|
*/
|
87
|
-
protected _rulers: Record<string, Ruler.
|
87
|
+
protected _rulers: Record<string, Ruler.Implementation>;
|
88
88
|
|
89
89
|
/**
|
90
90
|
* The positions of any offscreen pings we are tracking.
|
@@ -114,12 +114,12 @@ declare class ControlsLayer extends InteractionLayer {
|
|
114
114
|
/**
|
115
115
|
* A convenience accessor to the Ruler for the active game user
|
116
116
|
*/
|
117
|
-
get ruler(): Ruler.
|
117
|
+
get ruler(): Ruler.Implementation | null;
|
118
118
|
|
119
119
|
/**
|
120
120
|
* Get the Ruler display for a specific User ID
|
121
121
|
*/
|
122
|
-
getRulerForUser(userId: string): Ruler.
|
122
|
+
getRulerForUser(userId: string): Ruler.Implementation | null;
|
123
123
|
|
124
124
|
protected override _draw(options: HandleEmptyObject<ControlsLayer.DrawOptions>): Promise<void>;
|
125
125
|
|
@@ -146,8 +146,18 @@ declare namespace FogManager {
|
|
146
146
|
interface Any extends AnyFogManager {}
|
147
147
|
interface AnyConstructor extends Identity<typeof AnyFogManager> {}
|
148
148
|
|
149
|
-
type
|
150
|
-
type
|
149
|
+
type ImplementationClass = CONFIG["Canvas"]["fogManager"];
|
150
|
+
type Implementation = FixedInstanceType<ImplementationClass>;
|
151
|
+
|
152
|
+
/**
|
153
|
+
* @deprecated Replaced by {@linkcode FogManager.ImplementationClass}.
|
154
|
+
*/
|
155
|
+
type ConfiguredClass = ImplementationClass;
|
156
|
+
|
157
|
+
/**
|
158
|
+
* @deprecated Replaced by {@linkcode FogManager.Implementation}.
|
159
|
+
*/
|
160
|
+
type ConfiguredInstance = Implementation;
|
151
161
|
}
|
152
162
|
|
153
163
|
export default FogManager;
|
@@ -163,7 +163,7 @@ declare class Token extends PlaceableObject<TokenDocument.Implementation> {
|
|
163
163
|
* @defaultValue `undefined`
|
164
164
|
* @remarks Only `undefined` prior to first draw. Set `null` if `token.document.ring.enabled` is `false`.
|
165
165
|
*/
|
166
|
-
get ring(): TokenRing.
|
166
|
+
get ring(): TokenRing.Implementation | null | undefined;
|
167
167
|
|
168
168
|
/**
|
169
169
|
* A convenience boolean to test whether the Token is using a dynamic ring.
|
@@ -1139,7 +1139,7 @@ declare namespace Token {
|
|
1139
1139
|
/**
|
1140
1140
|
* The return type of {@link Token.getRingColors | `Token#getRingColors`}. Core's implementation returns `{}`.
|
1141
1141
|
* Values returned by subclasses should not be nullish, as they are `mergeObject`'d into the default color values
|
1142
|
-
* from {@linkcode TokenRing.
|
1142
|
+
* from {@linkcode TokenRing.ImplementationClass}
|
1143
1143
|
*/
|
1144
1144
|
interface RingColors {
|
1145
1145
|
ring?: Color;
|
@@ -201,8 +201,8 @@ declare namespace TokenRing {
|
|
201
201
|
interface Any extends AnyTokenRing {}
|
202
202
|
interface AnyConstructor extends Identity<typeof AnyTokenRing> {}
|
203
203
|
|
204
|
-
interface
|
205
|
-
interface
|
204
|
+
interface ImplementationClass extends Identity<CONFIG["Token"]["ring"]["ringClass"]> {}
|
205
|
+
interface Implementation extends FixedInstanceType<ImplementationClass> {}
|
206
206
|
|
207
207
|
/** @remarks Overrides for default values */
|
208
208
|
interface FlashColorOptions extends CanvasAnimation.AnimateOptions {
|
@@ -281,6 +281,16 @@ declare namespace TokenRing {
|
|
281
281
|
/** @remarks Foundry comments "or spectral pulse effect" */
|
282
282
|
readonly INVISIBILITY: 0x10 & EFFECTS;
|
283
283
|
}
|
284
|
+
|
285
|
+
/**
|
286
|
+
* @deprecated Replaced by {@linkcode TokenRing.ImplementationClass}.
|
287
|
+
*/
|
288
|
+
type ConfiguredClass = ImplementationClass;
|
289
|
+
|
290
|
+
/**
|
291
|
+
* @deprecated Replaced by {@linkcode TokenRing.Implementation}.
|
292
|
+
*/
|
293
|
+
type ConfiguredInstance = Implementation;
|
284
294
|
}
|
285
295
|
|
286
296
|
declare abstract class AnyTokenRing extends TokenRing {
|
@@ -40,7 +40,7 @@ declare class Wall extends PlaceableObject<WallDocument.Implementation> {
|
|
40
40
|
* @defaultValue `undefined`
|
41
41
|
* @remarks Only `undefined` prior to first draw. {@link Wall.clearDoorControl | `Wall#clearDoorControl`} sets it `null`.
|
42
42
|
*/
|
43
|
-
doorControl: DoorControl.
|
43
|
+
doorControl: DoorControl.Implementation | null | undefined;
|
44
44
|
|
45
45
|
/**
|
46
46
|
* The line segment that represents the Wall.
|
@@ -132,7 +132,7 @@ declare class Wall extends PlaceableObject<WallDocument.Implementation> {
|
|
132
132
|
/**
|
133
133
|
* Draw a control icon that is used to manipulate the door's open/closed state
|
134
134
|
*/
|
135
|
-
createDoorControl(): DoorControl.
|
135
|
+
createDoorControl(): DoorControl.Implementation;
|
136
136
|
|
137
137
|
/**
|
138
138
|
* Clear the door control if it exists.
|
@@ -68,6 +68,9 @@ declare namespace GlobalLightSource {
|
|
68
68
|
interface Any extends AnyGlobalLightSource {}
|
69
69
|
interface AnyConstructor extends Identity<typeof AnyGlobalLightSource> {}
|
70
70
|
|
71
|
+
type ImplementationClass = CONFIG["Canvas"]["globalLightSourceClass"];
|
72
|
+
type Implementation = FixedInstanceType<ImplementationClass>;
|
73
|
+
|
71
74
|
type Initialized<
|
72
75
|
SourceData extends GlobalLightSource.SourceData = GlobalLightSource.SourceData,
|
73
76
|
SourceShape extends PIXI.Polygon = PIXI.Polygon,
|
@@ -130,8 +133,15 @@ declare namespace GlobalLightSource {
|
|
130
133
|
};
|
131
134
|
}
|
132
135
|
|
133
|
-
|
134
|
-
|
136
|
+
/**
|
137
|
+
* @deprecated Replaced by {@linkcode GlobalLightSource.ImplementationClass}.
|
138
|
+
*/
|
139
|
+
type ConfiguredClass = ImplementationClass;
|
140
|
+
|
141
|
+
/**
|
142
|
+
* @deprecated Replaced by {@linkcode GlobalLightSource.Implementation}.
|
143
|
+
*/
|
144
|
+
type ConfiguredInstance = Implementation;
|
135
145
|
}
|
136
146
|
|
137
147
|
declare abstract class AnyGlobalLightSource extends GlobalLightSource {
|
@@ -237,12 +237,12 @@ declare namespace Actor {
|
|
237
237
|
/**
|
238
238
|
* The world collection that contains `Actor`s. Will be `never` if none exists.
|
239
239
|
*/
|
240
|
-
type CollectionClass = foundry.documents.collections.Actors.
|
240
|
+
type CollectionClass = foundry.documents.collections.Actors.ImplementationClass;
|
241
241
|
|
242
242
|
/**
|
243
243
|
* The world collection that contains `Actor`s. Will be `never` if none exists.
|
244
244
|
*/
|
245
|
-
type Collection = foundry.documents.collections.Actors.
|
245
|
+
type Collection = foundry.documents.collections.Actors.Implementation;
|
246
246
|
|
247
247
|
/**
|
248
248
|
* An instance of `Actor` that comes from the database but failed validation meaning that
|
@@ -232,12 +232,12 @@ declare namespace Cards {
|
|
232
232
|
/**
|
233
233
|
* The world collection that contains `Cards`s. Will be `never` if none exists.
|
234
234
|
*/
|
235
|
-
type CollectionClass = foundry.documents.collections.CardStacks.
|
235
|
+
type CollectionClass = foundry.documents.collections.CardStacks.ImplementationClass;
|
236
236
|
|
237
237
|
/**
|
238
238
|
* The world collection that contains `Cards`s. Will be `never` if none exists.
|
239
239
|
*/
|
240
|
-
type Collection = foundry.documents.collections.CardStacks.
|
240
|
+
type Collection = foundry.documents.collections.CardStacks.Implementation;
|
241
241
|
|
242
242
|
/**
|
243
243
|
* An instance of `Cards` that comes from the database but failed validation meaning that
|
@@ -171,12 +171,12 @@ declare namespace ChatMessage {
|
|
171
171
|
/**
|
172
172
|
* The world collection that contains `ChatMessage`s. Will be `never` if none exists.
|
173
173
|
*/
|
174
|
-
type CollectionClass = foundry.documents.collections.ChatMessages.
|
174
|
+
type CollectionClass = foundry.documents.collections.ChatMessages.ImplementationClass;
|
175
175
|
|
176
176
|
/**
|
177
177
|
* The world collection that contains `ChatMessage`s. Will be `never` if none exists.
|
178
178
|
*/
|
179
|
-
type Collection = foundry.documents.collections.ChatMessages.
|
179
|
+
type Collection = foundry.documents.collections.ChatMessages.Implementation;
|
180
180
|
|
181
181
|
/**
|
182
182
|
* An instance of `ChatMessage` that comes from the database but failed validation meaning that
|
@@ -32,8 +32,8 @@ declare namespace Actors {
|
|
32
32
|
interface Any extends AnyActors {}
|
33
33
|
interface AnyConstructor extends Identity<typeof AnyActors> {}
|
34
34
|
|
35
|
-
interface
|
36
|
-
interface
|
35
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Actor"> {}
|
36
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"Actor"> {}
|
37
37
|
|
38
38
|
interface FromCompendiumOptions extends foundry.documents.abstract.WorldCollection.FromCompendiumOptions {
|
39
39
|
/**
|
@@ -42,6 +42,16 @@ declare namespace Actors {
|
|
42
42
|
*/
|
43
43
|
clearPrototypeToken: boolean;
|
44
44
|
}
|
45
|
+
|
46
|
+
/**
|
47
|
+
* @deprecated Replaced by {@linkcode Actors.ImplementationClass}.
|
48
|
+
*/
|
49
|
+
type ConfiguredClass = ImplementationClass;
|
50
|
+
|
51
|
+
/**
|
52
|
+
* @deprecated Replaced by {@linkcode Actors.Implementation}.
|
53
|
+
*/
|
54
|
+
type Configured = Implementation;
|
45
55
|
}
|
46
56
|
|
47
57
|
declare abstract class AnyActors extends Actors {
|
@@ -14,8 +14,18 @@ declare namespace CardStacks {
|
|
14
14
|
interface Any extends AnyCardStacks {}
|
15
15
|
interface AnyConstructor extends Identity<typeof AnyCardStacks> {}
|
16
16
|
|
17
|
-
interface
|
18
|
-
interface
|
17
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Cards"> {}
|
18
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"Cards"> {}
|
19
|
+
|
20
|
+
/**
|
21
|
+
* @deprecated Replaced by {@linkcode CardStacks.ImplementationClass}.
|
22
|
+
*/
|
23
|
+
type ConfiguredClass = ImplementationClass;
|
24
|
+
|
25
|
+
/**
|
26
|
+
* @deprecated Replaced by {@linkcode CardStacks.Implementation}.
|
27
|
+
*/
|
28
|
+
type Configured = Implementation;
|
19
29
|
}
|
20
30
|
|
21
31
|
declare abstract class AnyCardStacks extends CardStacks {
|
@@ -37,8 +37,18 @@ declare namespace ChatMessages {
|
|
37
37
|
interface Any extends AnyMessages {}
|
38
38
|
interface AnyConstructor extends Identity<typeof AnyMessages> {}
|
39
39
|
|
40
|
-
interface
|
41
|
-
interface
|
40
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"ChatMessage"> {}
|
41
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"ChatMessage"> {}
|
42
|
+
|
43
|
+
/**
|
44
|
+
* @deprecated Replaced by {@linkcode ChatMessages.ImplementationClass}.
|
45
|
+
*/
|
46
|
+
type ConfiguredClass = ImplementationClass;
|
47
|
+
|
48
|
+
/**
|
49
|
+
* @deprecated Replaced by {@linkcode ChatMessages.Implementation}.
|
50
|
+
*/
|
51
|
+
type Configured = Implementation;
|
42
52
|
}
|
43
53
|
|
44
54
|
declare abstract class AnyMessages extends ChatMessages {
|
@@ -45,8 +45,18 @@ declare namespace CombatEncounters {
|
|
45
45
|
interface Any extends AnyCombatEncounters {}
|
46
46
|
interface AnyConstructor extends Identity<typeof AnyCombatEncounters> {}
|
47
47
|
|
48
|
-
interface
|
49
|
-
interface
|
48
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Combat"> {}
|
49
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"Combat"> {}
|
50
|
+
|
51
|
+
/**
|
52
|
+
* @deprecated Replaced by {@linkcode CombatEncounters.ImplementationClass}.
|
53
|
+
*/
|
54
|
+
type ConfiguredClass = ImplementationClass;
|
55
|
+
|
56
|
+
/**
|
57
|
+
* @deprecated Replaced by {@linkcode CombatEncounters.Implementation}.
|
58
|
+
*/
|
59
|
+
type Configured = Implementation;
|
50
60
|
}
|
51
61
|
|
52
62
|
declare abstract class AnyCombatEncounters extends CombatEncounters {
|
@@ -21,8 +21,18 @@ declare namespace FogExplorations {
|
|
21
21
|
interface Any extends AnyFogExplorations {}
|
22
22
|
interface AnyConstructor extends Identity<typeof AnyFogExplorations> {}
|
23
23
|
|
24
|
-
interface
|
25
|
-
interface
|
24
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"FogExploration"> {}
|
25
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"FogExploration"> {}
|
26
|
+
|
27
|
+
/**
|
28
|
+
* @deprecated Replaced by {@linkcode FogExplorations.ImplementationClass}.
|
29
|
+
*/
|
30
|
+
type ConfiguredClass = ImplementationClass;
|
31
|
+
|
32
|
+
/**
|
33
|
+
* @deprecated Replaced by {@linkcode FogExplorations.Implementation}.
|
34
|
+
*/
|
35
|
+
type Configured = Implementation;
|
26
36
|
}
|
27
37
|
|
28
38
|
declare abstract class AnyFogExplorations extends FogExplorations {
|
@@ -38,8 +38,18 @@ declare namespace Folders {
|
|
38
38
|
interface Any extends AnyFolders {}
|
39
39
|
interface AnyConstructor extends Identity<typeof AnyFolders> {}
|
40
40
|
|
41
|
-
interface
|
42
|
-
interface
|
41
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Folder"> {}
|
42
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"Folder"> {}
|
43
|
+
|
44
|
+
/**
|
45
|
+
* @deprecated Replaced by {@linkcode Folders.ImplementationClass}.
|
46
|
+
*/
|
47
|
+
type ConfiguredClass = ImplementationClass;
|
48
|
+
|
49
|
+
/**
|
50
|
+
* @deprecated Replaced by {@linkcode Folders.Implementation}.
|
51
|
+
*/
|
52
|
+
type Configured = Implementation;
|
43
53
|
}
|
44
54
|
|
45
55
|
declare abstract class AnyFolders extends Folders {
|
@@ -16,8 +16,18 @@ declare namespace Items {
|
|
16
16
|
interface Any extends AnyItems {}
|
17
17
|
interface AnyConstructor extends Identity<typeof AnyItems> {}
|
18
18
|
|
19
|
-
interface
|
20
|
-
interface
|
19
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Item"> {}
|
20
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"Item"> {}
|
21
|
+
|
22
|
+
/**
|
23
|
+
* @deprecated Replaced by {@linkcode Items.ImplementationClass}.
|
24
|
+
*/
|
25
|
+
type ConfiguredClass = ImplementationClass;
|
26
|
+
|
27
|
+
/**
|
28
|
+
* @deprecated Replaced by {@linkcode Items.Implementation}.
|
29
|
+
*/
|
30
|
+
type Configured = Implementation;
|
21
31
|
}
|
22
32
|
|
23
33
|
declare abstract class AnyItems extends Items {
|
@@ -67,8 +67,18 @@ declare namespace Journal {
|
|
67
67
|
interface Any extends AnyJournal {}
|
68
68
|
interface AnyConstructor extends Identity<typeof AnyJournal> {}
|
69
69
|
|
70
|
-
interface
|
71
|
-
interface
|
70
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"JournalEntry"> {}
|
71
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"JournalEntry"> {}
|
72
|
+
|
73
|
+
/**
|
74
|
+
* @deprecated Replaced by {@linkcode Journal.ImplementationClass}.
|
75
|
+
*/
|
76
|
+
type ConfiguredClass = ImplementationClass;
|
77
|
+
|
78
|
+
/**
|
79
|
+
* @deprecated Replaced by {@linkcode Journal.Implementation}.
|
80
|
+
*/
|
81
|
+
type Configured = Implementation;
|
72
82
|
}
|
73
83
|
|
74
84
|
declare abstract class AnyJournal extends Journal {
|
@@ -23,8 +23,18 @@ declare namespace Macros {
|
|
23
23
|
interface Any extends AnyMacros {}
|
24
24
|
interface AnyConstructor extends Identity<typeof AnyMacros> {}
|
25
25
|
|
26
|
-
interface
|
27
|
-
interface
|
26
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Macro"> {}
|
27
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"Macro"> {}
|
28
|
+
|
29
|
+
/**
|
30
|
+
* @deprecated Replaced by {@linkcode Macros.ImplementationClass}.
|
31
|
+
*/
|
32
|
+
type ConfiguredClass = ImplementationClass;
|
33
|
+
|
34
|
+
/**
|
35
|
+
* @deprecated Replaced by {@linkcode Macros.Implementation}.
|
36
|
+
*/
|
37
|
+
type Configured = Implementation;
|
28
38
|
}
|
29
39
|
|
30
40
|
declare abstract class AnyMacros extends Macros {
|
@@ -34,8 +34,18 @@ declare namespace Playlists {
|
|
34
34
|
interface Any extends AnyPlaylists {}
|
35
35
|
interface AnyConstructor extends Identity<typeof AnyPlaylists> {}
|
36
36
|
|
37
|
-
interface
|
38
|
-
interface
|
37
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Playlist"> {}
|
38
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"Playlist"> {}
|
39
|
+
|
40
|
+
/**
|
41
|
+
* @deprecated Replaced by {@linkcode Playlists.ImplementationClass}.
|
42
|
+
*/
|
43
|
+
type ConfiguredClass = ImplementationClass;
|
44
|
+
|
45
|
+
/**
|
46
|
+
* @deprecated Replaced by {@linkcode Playlists.Implementation}.
|
47
|
+
*/
|
48
|
+
type Configured = Implementation;
|
39
49
|
}
|
40
50
|
|
41
51
|
declare abstract class AnyPlaylists extends Playlists {
|
@@ -23,8 +23,18 @@ declare namespace RollTables {
|
|
23
23
|
interface Any extends AnyRollTables {}
|
24
24
|
interface AnyConstructor extends Identity<typeof AnyRollTables> {}
|
25
25
|
|
26
|
-
interface
|
27
|
-
interface
|
26
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"RollTable"> {}
|
27
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"RollTable"> {}
|
28
|
+
|
29
|
+
/**
|
30
|
+
* @deprecated Replaced by {@linkcode RollTables.ImplementationClass}.
|
31
|
+
*/
|
32
|
+
type ConfiguredClass = ImplementationClass;
|
33
|
+
|
34
|
+
/**
|
35
|
+
* @deprecated Replaced by {@linkcode RollTables.Implementation}.
|
36
|
+
*/
|
37
|
+
type Configured = Implementation;
|
28
38
|
}
|
29
39
|
|
30
40
|
declare abstract class AnyRollTables extends RollTables {
|
@@ -52,8 +52,18 @@ declare namespace Scenes {
|
|
52
52
|
interface Any extends AnyScenes {}
|
53
53
|
interface AnyConstructor extends Identity<typeof AnyScenes> {}
|
54
54
|
|
55
|
-
interface
|
56
|
-
interface
|
55
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Scene"> {}
|
56
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"Scene"> {}
|
57
|
+
|
58
|
+
/**
|
59
|
+
* @deprecated Replaced by {@linkcode Scenes.ImplementationClass}.
|
60
|
+
*/
|
61
|
+
type ConfiguredClass = ImplementationClass;
|
62
|
+
|
63
|
+
/**
|
64
|
+
* @deprecated Replaced by {@linkcode Scenes.Implementation}.
|
65
|
+
*/
|
66
|
+
type Configured = Implementation;
|
57
67
|
}
|
58
68
|
|
59
69
|
declare abstract class AnyScenes extends Scenes {
|
@@ -61,8 +61,18 @@ declare namespace Users {
|
|
61
61
|
interface Any extends AnyUsers {}
|
62
62
|
interface AnyConstructor extends Identity<typeof AnyUsers> {}
|
63
63
|
|
64
|
-
interface
|
65
|
-
interface
|
64
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"User"> {}
|
65
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"User"> {}
|
66
|
+
|
67
|
+
/**
|
68
|
+
* @deprecated Replaced by {@linkcode Users.ImplementationClass}.
|
69
|
+
*/
|
70
|
+
type ConfiguredClass = ImplementationClass;
|
71
|
+
|
72
|
+
/**
|
73
|
+
* @deprecated Replaced by {@linkcode Users.Implementation}.
|
74
|
+
*/
|
75
|
+
type Configured = Implementation;
|
66
76
|
}
|
67
77
|
|
68
78
|
declare abstract class AnyUsers extends Users {
|
@@ -33,8 +33,18 @@ declare namespace WorldSettings {
|
|
33
33
|
interface Any extends AnyWorldSettings {}
|
34
34
|
interface AnyConstructor extends Identity<typeof AnyWorldSettings> {}
|
35
35
|
|
36
|
-
interface
|
37
|
-
interface
|
36
|
+
interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Setting"> {}
|
37
|
+
interface Implementation extends Document.Internal.ConfiguredCollection<"Setting"> {}
|
38
|
+
|
39
|
+
/**
|
40
|
+
* @deprecated Replaced by {@linkcode GlobalLightSource.ImplementationClass}.
|
41
|
+
*/
|
42
|
+
type ConfiguredClass = ImplementationClass;
|
43
|
+
|
44
|
+
/**
|
45
|
+
* @deprecated Replaced by {@linkcode GlobalLightSource.Implementation}.
|
46
|
+
*/
|
47
|
+
type Configured = Implementation;
|
38
48
|
}
|
39
49
|
|
40
50
|
declare abstract class AnyWorldSettings extends WorldSettings {
|
@@ -239,12 +239,12 @@ declare namespace Combat {
|
|
239
239
|
/**
|
240
240
|
* The world collection that contains `Combat`s. Will be `never` if none exists.
|
241
241
|
*/
|
242
|
-
type CollectionClass = foundry.documents.collections.CombatEncounters.
|
242
|
+
type CollectionClass = foundry.documents.collections.CombatEncounters.ImplementationClass;
|
243
243
|
|
244
244
|
/**
|
245
245
|
* The world collection that contains `Combat`s. Will be `never` if none exists.
|
246
246
|
*/
|
247
|
-
type Collection = foundry.documents.collections.CombatEncounters.
|
247
|
+
type Collection = foundry.documents.collections.CombatEncounters.Implementation;
|
248
248
|
|
249
249
|
/**
|
250
250
|
* An instance of `Combat` that comes from the database but failed validation meaning that
|
@@ -109,12 +109,12 @@ declare namespace FogExploration {
|
|
109
109
|
/**
|
110
110
|
* The world collection that contains `FogExploration`s. Will be `never` if none exists.
|
111
111
|
*/
|
112
|
-
type CollectionClass = foundry.documents.collections.FogExplorations.
|
112
|
+
type CollectionClass = foundry.documents.collections.FogExplorations.ImplementationClass;
|
113
113
|
|
114
114
|
/**
|
115
115
|
* The world collection that contains `FogExploration`s. Will be `never` if none exists.
|
116
116
|
*/
|
117
|
-
type Collection = foundry.documents.collections.FogExplorations.
|
117
|
+
type Collection = foundry.documents.collections.FogExplorations.Implementation;
|
118
118
|
|
119
119
|
/**
|
120
120
|
* An instance of `FogExploration` that comes from the database but failed validation meaning that
|
@@ -150,12 +150,12 @@ declare namespace Folder {
|
|
150
150
|
/**
|
151
151
|
* The world collection that contains `Folder`s. Will be `never` if none exists.
|
152
152
|
*/
|
153
|
-
type CollectionClass = foundry.documents.collections.Folders.
|
153
|
+
type CollectionClass = foundry.documents.collections.Folders.ImplementationClass;
|
154
154
|
|
155
155
|
/**
|
156
156
|
* The world collection that contains `Folder`s. Will be `never` if none exists.
|
157
157
|
*/
|
158
|
-
type Collection = foundry.documents.collections.Folders.
|
158
|
+
type Collection = foundry.documents.collections.Folders.Implementation;
|
159
159
|
|
160
160
|
/**
|
161
161
|
* An instance of `Folder` that comes from the database but failed validation meaning that
|
@@ -234,12 +234,12 @@ declare namespace Item {
|
|
234
234
|
/**
|
235
235
|
* The world collection that contains `Item`s. Will be `never` if none exists.
|
236
236
|
*/
|
237
|
-
type CollectionClass = foundry.documents.collections.Items.
|
237
|
+
type CollectionClass = foundry.documents.collections.Items.ImplementationClass;
|
238
238
|
|
239
239
|
/**
|
240
240
|
* The world collection that contains `Item`s. Will be `never` if none exists.
|
241
241
|
*/
|
242
|
-
type Collection = foundry.documents.collections.Items.
|
242
|
+
type Collection = foundry.documents.collections.Items.Implementation;
|
243
243
|
|
244
244
|
/**
|
245
245
|
* An instance of `Item` that comes from the database but failed validation meaning that
|
@@ -174,12 +174,12 @@ declare namespace JournalEntry {
|
|
174
174
|
/**
|
175
175
|
* The world collection that contains `JournalEntry`s. Will be `never` if none exists.
|
176
176
|
*/
|
177
|
-
type CollectionClass = foundry.documents.collections.Journal.
|
177
|
+
type CollectionClass = foundry.documents.collections.Journal.ImplementationClass;
|
178
178
|
|
179
179
|
/**
|
180
180
|
* The world collection that contains `JournalEntry`s. Will be `never` if none exists.
|
181
181
|
*/
|
182
|
-
type Collection = foundry.documents.collections.Journal.
|
182
|
+
type Collection = foundry.documents.collections.Journal.Implementation;
|
183
183
|
|
184
184
|
/**
|
185
185
|
* An instance of `JournalEntry` that comes from the database but failed validation meaning that
|
@@ -160,12 +160,12 @@ declare namespace Macro {
|
|
160
160
|
/**
|
161
161
|
* The world collection that contains `Macro`s. Will be `never` if none exists.
|
162
162
|
*/
|
163
|
-
type CollectionClass = foundry.documents.collections.Macros.
|
163
|
+
type CollectionClass = foundry.documents.collections.Macros.ImplementationClass;
|
164
164
|
|
165
165
|
/**
|
166
166
|
* The world collection that contains `Folder`s. Will be `never` if none exists.
|
167
167
|
*/
|
168
|
-
type Collection = foundry.documents.collections.Macros.
|
168
|
+
type Collection = foundry.documents.collections.Macros.Implementation;
|
169
169
|
|
170
170
|
/**
|
171
171
|
* An instance of `Macro` that comes from the database but failed validation meaning that
|
@@ -168,12 +168,12 @@ declare namespace Playlist {
|
|
168
168
|
/**
|
169
169
|
* The world collection that contains `Playlist`s. Will be `never` if none exists.
|
170
170
|
*/
|
171
|
-
type CollectionClass = foundry.documents.collections.Playlists.
|
171
|
+
type CollectionClass = foundry.documents.collections.Playlists.ImplementationClass;
|
172
172
|
|
173
173
|
/**
|
174
174
|
* The world collection that contains `Playlist`s. Will be `never` if none exists.
|
175
175
|
*/
|
176
|
-
type Collection = foundry.documents.collections.Playlists.
|
176
|
+
type Collection = foundry.documents.collections.Playlists.Implementation;
|
177
177
|
|
178
178
|
/**
|
179
179
|
* An instance of `Playlist` that comes from the database but failed validation meaning that
|
@@ -163,12 +163,12 @@ declare namespace RollTable {
|
|
163
163
|
/**
|
164
164
|
* The world collection that contains `RollTable`s. Will be `never` if none exists.
|
165
165
|
*/
|
166
|
-
type CollectionClass = foundry.documents.collections.RollTables.
|
166
|
+
type CollectionClass = foundry.documents.collections.RollTables.ImplementationClass;
|
167
167
|
|
168
168
|
/**
|
169
169
|
* The world collection that contains `RollTable`s. Will be `never` if none exists.
|
170
170
|
*/
|
171
|
-
type Collection = foundry.documents.collections.RollTables.
|
171
|
+
type Collection = foundry.documents.collections.RollTables.Implementation;
|
172
172
|
|
173
173
|
/**
|
174
174
|
* An instance of `RollTable` that comes from the database but failed validation meaning that
|
@@ -188,12 +188,12 @@ declare namespace Scene {
|
|
188
188
|
/**
|
189
189
|
* The world collection that contains `Scene`s. Will be `never` if none exists.
|
190
190
|
*/
|
191
|
-
type CollectionClass = foundry.documents.collections.Scenes.
|
191
|
+
type CollectionClass = foundry.documents.collections.Scenes.ImplementationClass;
|
192
192
|
|
193
193
|
/**
|
194
194
|
* The world collection that contains `Scene`s. Will be `never` if none exists.
|
195
195
|
*/
|
196
|
-
type Collection = foundry.documents.collections.Scenes.
|
196
|
+
type Collection = foundry.documents.collections.Scenes.Implementation;
|
197
197
|
|
198
198
|
/**
|
199
199
|
* An instance of `Scene` that comes from the database but failed validation meaning that
|
@@ -106,12 +106,12 @@ declare namespace Setting {
|
|
106
106
|
/**
|
107
107
|
* The world collection that contains `Setting`s. Will be `never` if none exists.
|
108
108
|
*/
|
109
|
-
type CollectionClass = foundry.documents.collections.WorldSettings.
|
109
|
+
type CollectionClass = foundry.documents.collections.WorldSettings.ImplementationClass;
|
110
110
|
|
111
111
|
/**
|
112
112
|
* The world collection that contains `Setting`s. Will be `never` if none exists.
|
113
113
|
*/
|
114
|
-
type Collection = foundry.documents.collections.WorldSettings.
|
114
|
+
type Collection = foundry.documents.collections.WorldSettings.Implementation;
|
115
115
|
|
116
116
|
/**
|
117
117
|
* An instance of `Setting` that comes from the database but failed validation meaning that
|
@@ -110,12 +110,12 @@ declare namespace User {
|
|
110
110
|
/**
|
111
111
|
* The world collection that contains `User`s. Will be `never` if none exists.
|
112
112
|
*/
|
113
|
-
type CollectionClass = foundry.documents.collections.Users.
|
113
|
+
type CollectionClass = foundry.documents.collections.Users.ImplementationClass;
|
114
114
|
|
115
115
|
/**
|
116
116
|
* The world collection that contains `User`s. Will be `never` if none exists.
|
117
117
|
*/
|
118
|
-
type Collection = foundry.documents.collections.Users.
|
118
|
+
type Collection = foundry.documents.collections.Users.Implementation;
|
119
119
|
|
120
120
|
/**
|
121
121
|
* An instance of `User` that comes from the database but failed validation meaning that
|
@@ -1074,7 +1074,7 @@ declare namespace Document {
|
|
1074
1074
|
* @internal
|
1075
1075
|
*/
|
1076
1076
|
interface _WorldCollectionMap {
|
1077
|
-
Actor: foundry.documents.collections.Actors.
|
1077
|
+
Actor: foundry.documents.collections.Actors.Implementation;
|
1078
1078
|
Cards: foundry.documents.collections.CardStacks;
|
1079
1079
|
Combat: foundry.documents.collections.CombatEncounters;
|
1080
1080
|
FogExploration: foundry.documents.collections.FogExplorations;
|
@@ -1092,18 +1092,6 @@ declare namespace Document {
|
|
1092
1092
|
|
1093
1093
|
type WorldCollectionFor<Name extends Document.WorldType> = _WorldCollectionMap[Name];
|
1094
1094
|
|
1095
|
-
// Note(LukeAbby): Will be updated with the CONFIG revamp.
|
1096
|
-
type ConfiguredCollectionClass<Name extends Document.Type> = CONFIG extends {
|
1097
|
-
readonly [K in Name]: {
|
1098
|
-
readonly documentClass?: infer DocumentClass;
|
1099
|
-
};
|
1100
|
-
}
|
1101
|
-
? DocumentClass
|
1102
|
-
: never;
|
1103
|
-
|
1104
|
-
// Note(LukeAbby): Will be updated with the CONFIG revamp.
|
1105
|
-
type ConfiguredCollection<Name extends Document.Type> = FixedInstanceType<ConfiguredCollectionClass<Name>>;
|
1106
|
-
|
1107
1095
|
type IsParentOf<
|
1108
1096
|
ParentDocument extends Document.Internal.Instance.Any,
|
1109
1097
|
ChildDocument extends Document.Internal.Instance.Any,
|
@@ -1341,6 +1329,18 @@ declare namespace Document {
|
|
1341
1329
|
// The type `{}` is useful here because in an intersection it reduces down to nothing unlike `EmptyObject`.
|
1342
1330
|
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
1343
1331
|
type ConfiguredFlagsForName<Name extends Type> = GetKey<FlagConfig, Name, {}>;
|
1332
|
+
|
1333
|
+
// Note(LukeAbby): Will be updated with the CONFIG revamp.
|
1334
|
+
type ConfiguredCollectionClass<Name extends Document.Type> = CONFIG extends {
|
1335
|
+
readonly [K in Name]: {
|
1336
|
+
readonly documentClass?: infer DocumentClass;
|
1337
|
+
};
|
1338
|
+
}
|
1339
|
+
? DocumentClass
|
1340
|
+
: never;
|
1341
|
+
|
1342
|
+
// Note(LukeAbby): Will be updated with the CONFIG revamp.
|
1343
|
+
type ConfiguredCollection<Name extends Document.Type> = FixedInstanceType<ConfiguredCollectionClass<Name>>;
|
1344
1344
|
}
|
1345
1345
|
|
1346
1346
|
/** Any Document, that is a child of the given parent Document. */
|
@@ -2739,4 +2739,14 @@ declare namespace Document {
|
|
2739
2739
|
? D
|
2740
2740
|
: // eslint-disable-next-line @typescript-eslint/no-deprecated
|
2741
2741
|
Stored<D>;
|
2742
|
+
|
2743
|
+
/**
|
2744
|
+
* @deprecated This has been removed without replacement. If you have a need for it please let us know.
|
2745
|
+
*/
|
2746
|
+
type ConfiguredCollectionClass<Name extends Document.Type> = Document.Internal.ConfiguredCollectionClass<Name>;
|
2747
|
+
|
2748
|
+
/**
|
2749
|
+
* @deprecated This has been removed without replacement. If you have a need for it please let us know.
|
2750
|
+
*/
|
2751
|
+
type ConfiguredCollection<Name extends Document.Type> = Document.Internal.ConfiguredCollection<Name>;
|
2742
2752
|
}
|