@league-of-foundry-developers/foundry-vtt-types 9.238.0 → 9.238.1
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 +3 -3
- package/package.json +1 -1
- package/src/foundry/foundry.js/game.d.ts +89 -43
package/README.md
CHANGED
@@ -17,7 +17,7 @@ TypeScript type definitions for [Foundry Virtual Tabletop](https://foundryvtt.co
|
|
17
17
|
|
18
18
|
We aim to support the latest release of each Foundry VTT version (0.7, 0.8, 9, etc.), starting with 0.7.
|
19
19
|
|
20
|
-
At the moment, both version 0.7 and 0.8 are supported.
|
20
|
+
At the moment, both version 0.7 and 0.8 are fully supported. Version 9 is already partially supported, but there is still a lot to be done. See https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+V9%22 to keep track of the progress.
|
21
21
|
|
22
22
|
|
23
23
|
## Installation
|
@@ -36,10 +36,10 @@ In order to install a specific version run
|
|
36
36
|
npm install --save-dev @league-of-foundry-developers/foundry-vtt-types@<version>
|
37
37
|
```
|
38
38
|
|
39
|
-
For example, to install version `
|
39
|
+
For example, to install version `9.238.0`, run
|
40
40
|
|
41
41
|
```sh
|
42
|
-
npm install --save-dev @league-of-foundry-developers/foundry-vtt-types@
|
42
|
+
npm install --save-dev @league-of-foundry-developers/foundry-vtt-types@9.238.0
|
43
43
|
```
|
44
44
|
|
45
45
|
You can then update foundry-vtt-types using the regular update mechanism for npm
|
package/package.json
CHANGED
@@ -507,72 +507,98 @@ declare global {
|
|
507
507
|
}
|
508
508
|
|
509
509
|
interface PackageData<T> {
|
510
|
-
|
510
|
+
availability: number;
|
511
511
|
data: T;
|
512
|
-
id: string;
|
513
|
-
path: string;
|
514
|
-
scripts: string[];
|
515
512
|
esmodules: string[];
|
516
|
-
|
513
|
+
id: string;
|
517
514
|
languages: Language[];
|
515
|
+
locked: boolean;
|
518
516
|
packs: {
|
519
|
-
|
517
|
+
absPath: string;
|
518
|
+
/** @deprecated since V9 */
|
519
|
+
entity: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
|
520
520
|
label: string;
|
521
|
+
name: string;
|
522
|
+
package: string;
|
521
523
|
path: string;
|
522
524
|
private: boolean;
|
523
|
-
entity: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
|
524
525
|
system?: string;
|
525
|
-
|
526
|
-
package: string;
|
526
|
+
type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
|
527
527
|
};
|
528
|
-
|
529
|
-
|
528
|
+
scripts: string[];
|
529
|
+
styles: string[];
|
530
|
+
type: 'world' | 'system' | 'module';
|
530
531
|
unavailable: boolean;
|
531
|
-
_systemUpdateCheckTime: number;
|
532
532
|
}
|
533
533
|
|
534
|
-
interface
|
535
|
-
|
534
|
+
interface ModuleData<T> extends PackageData<T> {
|
535
|
+
active: boolean;
|
536
|
+
path: string;
|
537
|
+
type: 'module';
|
536
538
|
}
|
537
539
|
|
538
540
|
interface SystemData<T> extends PackageData<T> {
|
539
|
-
|
541
|
+
_systemUpdateCheckTime: number;
|
542
|
+
documentTypes: {
|
543
|
+
[Key in
|
544
|
+
| foundry.CONST.DOCUMENT_TYPES
|
545
|
+
| 'ActiveEffect'
|
546
|
+
| 'Adventure'
|
547
|
+
| 'AmbientLight'
|
548
|
+
| 'AmbientSound'
|
549
|
+
| 'Card'
|
550
|
+
| 'Combatant'
|
551
|
+
| 'Drawing'
|
552
|
+
| 'FogExploration'
|
553
|
+
| 'MeasuredTemplate'
|
554
|
+
| 'Note'
|
555
|
+
| 'PlaylistSound'
|
556
|
+
| 'Setting'
|
557
|
+
| 'TableResult'
|
558
|
+
| 'Tile'
|
559
|
+
| 'Token'
|
560
|
+
| 'Wall']: string[];
|
561
|
+
};
|
562
|
+
model: {
|
563
|
+
Actor: Record<string, Record<string, unknown>>;
|
564
|
+
Cards: Record<string, Record<string, unknown>>;
|
565
|
+
Item: Record<string, Record<string, unknown>>;
|
566
|
+
};
|
567
|
+
path: string;
|
540
568
|
template: {
|
541
569
|
Actor?: {
|
542
570
|
types: string[];
|
543
|
-
templates?:
|
544
|
-
} &
|
571
|
+
templates?: Record<string, unknown>;
|
572
|
+
} & Record<string, unknown>;
|
545
573
|
Item?: {
|
546
574
|
types: string[];
|
547
|
-
templates?:
|
548
|
-
} &
|
549
|
-
};
|
550
|
-
entityTypes: { [Key in foundry.CONST.DOCUMENT_TYPES | 'Setting' | 'FogExploration']: string[] };
|
551
|
-
model: {
|
552
|
-
Actor: Partial<Record<string, Partial<Record<string, unknown>>>>;
|
553
|
-
Item: Partial<Record<string, Partial<Record<string, unknown>>>>;
|
575
|
+
templates?: Record<string, unknown>;
|
576
|
+
} & Record<string, unknown>;
|
554
577
|
};
|
578
|
+
type: 'system';
|
555
579
|
}
|
556
580
|
|
557
|
-
interface
|
558
|
-
|
559
|
-
|
581
|
+
interface WorldData<T> extends PackageData<T> {
|
582
|
+
_systemUpdateCheckTime: number;
|
583
|
+
type: 'world';
|
560
584
|
}
|
561
585
|
|
562
586
|
type Data = {
|
563
|
-
|
564
|
-
/** @deprecated since V9 */
|
565
|
-
version: string;
|
566
|
-
world: WorldData<foundry.packages.WorldData>;
|
567
|
-
system: SystemData<foundry.packages.SystemData>;
|
568
|
-
modules: ModuleData<foundry.packages.ModuleData>[];
|
569
|
-
paused: boolean;
|
587
|
+
activeUsers: string[];
|
570
588
|
addresses: {
|
571
589
|
local: string;
|
572
590
|
remote: string;
|
591
|
+
remoteIsAccessible: boolean;
|
592
|
+
};
|
593
|
+
coreUpdate: {
|
594
|
+
channel: unknown | null;
|
595
|
+
couldReachWebsite: boolean;
|
596
|
+
hasUpdate: boolean;
|
597
|
+
slowResponse: boolean;
|
598
|
+
version: unknown | null;
|
599
|
+
willDisableModules: boolean;
|
573
600
|
};
|
574
601
|
files: {
|
575
|
-
storages: ('public' | 'data' | 's3')[];
|
576
602
|
s3?: {
|
577
603
|
endpoint: {
|
578
604
|
protocol: string;
|
@@ -584,28 +610,48 @@ declare global {
|
|
584
610
|
href: string;
|
585
611
|
};
|
586
612
|
buckets: string[];
|
587
|
-
};
|
613
|
+
} | null;
|
614
|
+
storages: ('public' | 'data' | 's3')[];
|
588
615
|
};
|
616
|
+
modules: ModuleData<foundry.packages.ModuleData>[];
|
589
617
|
options: {
|
618
|
+
demo: boolean;
|
590
619
|
language: string;
|
591
620
|
port: number;
|
592
621
|
routePrefix: string | null;
|
593
622
|
updateChannel: string;
|
594
|
-
demo: boolean;
|
595
623
|
};
|
596
|
-
activeUsers: string[];
|
597
624
|
packs: {
|
598
|
-
|
625
|
+
/** @deprecated since V9 */
|
626
|
+
entity: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
|
627
|
+
index: {
|
628
|
+
_id: string;
|
629
|
+
name: string;
|
630
|
+
type: string;
|
631
|
+
}[];
|
599
632
|
label: string;
|
633
|
+
name: string;
|
634
|
+
package: string;
|
600
635
|
path: string;
|
601
636
|
private: boolean;
|
602
|
-
entity: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
|
603
637
|
system?: string;
|
604
|
-
|
605
|
-
|
638
|
+
type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
|
639
|
+
}[];
|
640
|
+
paused: boolean;
|
641
|
+
release: {
|
642
|
+
build: number;
|
643
|
+
channel: 'Stable' | 'Testing' | 'Development' | 'Prototype';
|
644
|
+
download: string;
|
645
|
+
generation: string;
|
646
|
+
notes: string;
|
647
|
+
time: number;
|
606
648
|
};
|
607
|
-
|
649
|
+
system: SystemData<foundry.packages.SystemData>;
|
608
650
|
systemUpdate: string | null;
|
651
|
+
userId: string;
|
652
|
+
/** @deprecated since V9 */
|
653
|
+
version?: string;
|
654
|
+
world: WorldData<foundry.packages.WorldData>;
|
609
655
|
} & {
|
610
656
|
[DocumentType in
|
611
657
|
| foundry.CONST.DOCUMENT_TYPES
|