Module:SoulUnlock/doc

Overview

Data for what is unlocked at each increment of Souls. Data is stored and loaded from Data:SoulUnlockData.json.

The data is accumulated into another format that is used by the currently written functions.

Functions

get_max

Retrieve's maximum value for a given key in the accumulated data

Examples

{{#invoke:SoulUnlock|get_max|RequiredSouls}} 45400
{{#invoke:SoulUnlock|get_max|PowerIncrease}} 32
{{#invoke:SoulUnlock|get_max|AbilityUnlocks}} 4
{{#invoke:SoulUnlock|get_max|AbilityPoints}} 29

localize

Localize a key as its stored to the current language using Module:Lang.

Examples

{{#invoke:SoulUnlock|localize|RequiredSouls}} Souls
{{#invoke:SoulUnlock|localize|PowerIncrease}} Boons
{{#invoke:SoulUnlock|localize|AbilityUnlocks}} Ability Unlock
{{#invoke:SoulUnlock|localize|AbilityPoints}} Ability Points

write_accumulated

Writes the accumulated data to wikitext. Not a format that is ready to be displayed on a wiki page yet. Used for debugging for any lua editors working off of the accumulated data as opposed to the original data.

Note: the keys outputted are localized to english. See the localization map at the top of the Module source.

Example

{{#invoke:SoulUnlock|write_accumulated}}
Index1: Souls:400, Ability Unlock:1,
Index2: Ability Unlock:1, Boons:1, Souls:700, Ability Points:1,
Index3: Ability Unlock:2, Boons:2, Souls:1000, Ability Points:1,
Index4: Ability Unlock:2, Boons:3, Souls:1300, Ability Points:2,
Index5: Ability Unlock:3, Boons:4, Souls:1900, Ability Points:2,
Index6: Ability Unlock:3, Boons:5, Souls:2600, Ability Points:3,
Index7: Ability Unlock:4, Boons:6, Souls:3400, Ability Points:3,
Index8: Ability Unlock:4, Boons:7, Souls:4200, Ability Points:4,
Index9: Ability Unlock:4, Boons:8, Souls:5000, Ability Points:5,
Index10: Ability Unlock:4, Boons:9, Souls:5800, Ability Points:6,
Index11: Ability Unlock:4, Boons:10, Souls:6600, Ability Points:7,
Index12: Ability Unlock:4, Boons:11, Souls:7500, Ability Points:8,
Index13: Ability Unlock:4, Boons:12, Souls:8400, Ability Points:9,
Index14: Ability Unlock:4, Boons:13, Souls:9400, Ability Points:10,
Index15: Ability Unlock:4, Boons:14, Souls:10600, Ability Points:11,
Index16: Ability Unlock:4, Boons:15, Souls:12000, Ability Points:12,
Index17: Ability Unlock:4, Boons:16, Souls:13600, Ability Points:13,
Index18: Ability Unlock:4, Boons:17, Souls:15400, Ability Points:14,
Index19: Ability Unlock:4, Boons:18, Souls:17400, Ability Points:15,
Index20: Ability Unlock:4, Boons:19, Souls:19400, Ability Points:16,
Index21: Ability Unlock:4, Boons:20, Souls:21400, Ability Points:17,
Index22: Ability Unlock:4, Boons:21, Souls:23400, Ability Points:18,
Index23: Ability Unlock:4, Boons:22, Souls:25400, Ability Points:19,
Index24: Ability Unlock:4, Boons:23, Souls:27400, Ability Points:20,
Index25: Ability Unlock:4, Boons:24, Souls:29400, Ability Points:21,
Index26: Ability Unlock:4, Boons:25, Souls:31400, Ability Points:22,
Index27: Ability Unlock:4, Boons:26, Souls:33400, Ability Points:23,
Index28: Ability Unlock:4, Boons:27, Souls:35400, Ability Points:24,
Index29: Ability Unlock:4, Boons:28, Souls:37400, Ability Points:25,
Index30: Ability Unlock:4, Boons:29, Souls:39400, Ability Points:26,
Index31: Ability Unlock:4, Boons:30, Souls:41400, Ability Points:27,
Index32: Ability Unlock:4, Boons:31, Souls:43400, Ability Points:28,
Index33: Ability Unlock:4, Boons:32, Souls:45400, Ability Points:29,

write_table

Example

	Individual			Accumulative
Souls	Boons	Ability Unlock	Ability Points	Boons	Ability Unlock	Ability Points
400					1
700				1	1	1
1000				2	2	1
1300				3	2	2
1900				4	3	2
2600				5	3	3
3400				6	4	3
4200				7	4	4
5000				8	4	5
5800				9	4	6
6600				10	4	7
7500				11	4	8
8400				12	4	9
9400				13	4	10
10600				14	4	11
12000				15	4	12
13600				16	4	13
15400				17	4	14
17400				18	4	15
19400				19	4	16
21400				20	4	17
23400				21	4	18
25400				22	4	19
27400				23	4	20
29400				24	4	21
31400				25	4	22
33400				26	4	23
35400				27	4	24
37400				28	4	25
39400				29	4	26
41400				30	4	27
43400				31	4	28
45400				32	4	29