cass.cityboundforest.com
A repository for a FoundryVTT plugin for Kingmaker homebrew.
Adding JSDoc info for the Kingdom class
+21
+21
src/kingdom.ts
+21
src/kingdom.ts
···
1
+
/**
2
+
* A Kingdom structure.
3
+
* @typedef {Object} Kingdom
4
+
* @property {string} name - The name of the Kingdom
5
+
* @property {string} charter - The id of the charter
6
+
* @property {string} government - The id of the government
7
+
* @property {string} heartland - The id of the heartland
8
+
* @property {string[]} boosts - An array of free boosts for the Kingdom
9
+
* @property {object} leaders - Leaders of the kingdom.
10
+
* @property {string[]} feats - An array of feats for the Kingdom
11
+
* @property {number} size - The size of the Kingdom
12
+
* @property {object} resourceDice - The resource dice for the Kingdom
13
+
* @property {object} commodities - The commodities for the Kingdom
14
+
* @property {object} resourcePoints - The resource points for the Kingdom
15
+
* @property {object} unrest - The unrest for the Kingdom
16
+
* @property {object} ruin - The ruin for the Kingdom
17
+
* @property {object[]} groups - Other groups the Kingdom has relations with
18
+
* @property {object} krp - The Kingdom Reputation Points
19
+
* @property {string[]} settlements - An array of Scene IDs for the Kingdom's settlements
20
+
* @property {number} level - The level of the Kingdom
21
+
*/
1
22
export default class Kingdom {
2
23
3
24
}