Module:SoulUnlock/doc: Difference between revisionsGive feedback
m localize, write_accumulated, get_max finished |
m write_table example with debug_mode=true |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 9: | Line 9: | ||
===Examples=== | ===Examples=== | ||
<code><nowiki>{{#invoke:SoulUnlock|get_max| | <code><nowiki>{{#invoke:SoulUnlock|get_max|RequiredSouls}}</nowiki></code> {{#invoke:SoulUnlock|get_max|RequiredSouls}}<br> | ||
<code><nowiki>{{#invoke:SoulUnlock|get_max|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock|get_max|PowerIncrease}}<br> | <code><nowiki>{{#invoke:SoulUnlock|get_max|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock|get_max|PowerIncrease}}<br> | ||
<code><nowiki>{{#invoke:SoulUnlock|get_max|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock|get_max|AbilityUnlocks}}<br> | <code><nowiki>{{#invoke:SoulUnlock|get_max|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock|get_max|AbilityUnlocks}}<br> | ||
| Line 18: | Line 18: | ||
===Examples=== | ===Examples=== | ||
<code><nowiki>{{#invoke:SoulUnlock| | <code><nowiki>{{#invoke:SoulUnlock|localize|RequiredSouls}}</nowiki></code> {{#invoke:SoulUnlock|localize|RequiredSouls}}<br> | ||
<code><nowiki>{{#invoke:SoulUnlock| | <code><nowiki>{{#invoke:SoulUnlock|localize|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock|localize|PowerIncrease}}<br> | ||
<code><nowiki>{{#invoke:SoulUnlock| | <code><nowiki>{{#invoke:SoulUnlock|localize|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock|localize|AbilityUnlocks}}<br> | ||
<code><nowiki>{{#invoke:SoulUnlock| | <code><nowiki>{{#invoke:SoulUnlock|localize|AbilityPoints}}</nowiki></code> {{#invoke:SoulUnlock|localize|AbilityPoints}}<br> | ||
==write_accumulated== | ==write_accumulated== | ||
| Line 31: | Line 31: | ||
<code><nowiki>{{#invoke:SoulUnlock|write_accumulated}}</nowiki></code><br> | <code><nowiki>{{#invoke:SoulUnlock|write_accumulated}}</nowiki></code><br> | ||
{{#invoke:SoulUnlock|write_accumulated}} | {{#invoke:SoulUnlock|write_accumulated}} | ||
==write_table== | |||
===Example=== | |||
{{#invoke:SoulUnlock|write_table|debug_mode=true}} | |||
{{#invoke:SoulUnlock|write_table}} | |||
Latest revision as of 04:09, 29 October 2024
Overview
[edit source]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
[edit source]get_max
[edit source]Retrieve's maximum value for a given key in the accumulated data
Examples
[edit source]{{#invoke:SoulUnlock|get_max|RequiredSouls}} 49200
{{#invoke:SoulUnlock|get_max|PowerIncrease}} 35
{{#invoke:SoulUnlock|get_max|AbilityUnlocks}} 4
{{#invoke:SoulUnlock|get_max|AbilityPoints}} 32
localize
[edit source]Localize a key as its stored to the current language using Module:Lang.
Examples
[edit source]{{#invoke:SoulUnlock|localize|RequiredSouls}} Souls
{{#invoke:SoulUnlock|localize|PowerIncrease}} Boons
{{#invoke:SoulUnlock|localize|AbilityUnlocks}} Ability Unlock
{{#invoke:SoulUnlock|localize|AbilityPoints}} Ability Points
write_accumulated
[edit source]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
[edit source]{{#invoke:SoulUnlock|write_accumulated}}
Index1: Souls:600, Ability Unlock:1,
Index2: Ability Unlock:1, Boons:1, Souls:800, Ability Points:1,
Index3: Ability Unlock:2, Boons:2, Souls:1100, Ability Points:1,
Index4: Ability Unlock:2, Boons:3, Souls:1500, Ability Points:2,
Index5: Ability Unlock:3, Boons:4, Souls:2000, Ability Points:2,
Index6: Ability Unlock:3, Boons:5, Souls:2600, Ability Points:3,
Index7: Ability Unlock:3, Boons:6, Souls:3200, Ability Points:4,
Index8: Ability Unlock:4, Boons:7, Souls:3800, Ability Points:4,
Index9: Ability Unlock:4, Boons:8, Souls:4500, Ability Points:5,
Index10: Ability Unlock:4, Boons:9, Souls:5200, Ability Points:6,
Index11: Ability Unlock:4, Boons:10, Souls:5900, Ability Points:7,
Index12: Ability Unlock:4, Boons:11, Souls:6600, Ability Points:8,
Index13: Ability Unlock:4, Boons:12, Souls:7400, Ability Points:9,
Index14: Ability Unlock:4, Boons:13, Souls:8200, Ability Points:10,
Index15: Ability Unlock:4, Boons:14, Souls:9000, Ability Points:11,
Index16: Ability Unlock:4, Boons:15, Souls:9800, Ability Points:12,
Index17: Ability Unlock:4, Boons:16, Souls:10700, Ability Points:13,
Index18: Ability Unlock:4, Boons:17, Souls:11600, Ability Points:14,
Index19: Ability Unlock:4, Boons:18, Souls:12500, Ability Points:15,
Index20: Ability Unlock:4, Boons:19, Souls:13400, Ability Points:16,
Index21: Ability Unlock:4, Boons:20, Souls:14400, Ability Points:17,
Index22: Ability Unlock:4, Boons:21, Souls:15500, Ability Points:18,
Index23: Ability Unlock:4, Boons:22, Souls:16700, Ability Points:19,
Index24: Ability Unlock:4, Boons:23, Souls:18000, Ability Points:20,
Index25: Ability Unlock:4, Boons:24, Souls:19500, Ability Points:21,
Index26: Ability Unlock:4, Boons:25, Souls:21200, Ability Points:22,
Index27: Ability Unlock:4, Boons:26, Souls:23100, Ability Points:23,
Index28: Ability Unlock:4, Boons:27, Souls:25200, Ability Points:24,
Index29: Ability Unlock:4, Boons:28, Souls:27500, Ability Points:25,
Index30: Ability Unlock:4, Boons:29, Souls:30000, Ability Points:26,
Index31: Ability Unlock:4, Boons:30, Souls:32700, Ability Points:27,
Index32: Ability Unlock:4, Boons:31, Souls:35600, Ability Points:28,
Index33: Ability Unlock:4, Boons:32, Souls:38700, Ability Points:29,
Index34: Ability Unlock:4, Boons:33, Souls:42000, Ability Points:30,
Index35: Ability Unlock:4, Boons:34, Souls:45500, Ability Points:31,
Index36: Ability Unlock:4, Boons:35, Souls:49200, Ability Points:32,
write_table
[edit source]Example
[edit source]| Individual | Accumulative | |||||
|---|---|---|---|---|---|---|
| Souls | Boons | Ability Unlock | Ability Points | Boons | Ability Unlock | Ability Points |
| {{Souls|600}} | {{Tick}} | 1 | ||||
| {{Souls|800}} | {{Tick}} | {{Tick}} | 1 | 1 | 1 | |
| {{Souls|1100}} | {{Tick}} | {{Tick}} | 2 | 2 | 1 | |
| {{Souls|1500}} | {{Tick}} | {{Tick}} | 3 | 2 | 2 | |
| {{Souls|2000}} | {{Tick}} | {{Tick}} | 4 | 3 | 2 | |
| {{Souls|2600}} | {{Tick}} | {{Tick}} | 5 | 3 | 3 | |
| {{Souls|3200}} | {{Tick}} | {{Tick}} | 6 | 3 | 4 | |
| {{Souls|3800}} | {{Tick}} | {{Tick}} | 7 | 4 | 4 | |
| {{Souls|4500}} | {{Tick}} | {{Tick}} | 8 | 4 | 5 | |
| {{Souls|5200}} | {{Tick}} | {{Tick}} | 9 | 4 | 6 | |
| {{Souls|5900}} | {{Tick}} | {{Tick}} | 10 | 4 | 7 | |
| {{Souls|6600}} | {{Tick}} | {{Tick}} | 11 | 4 | 8 | |
| {{Souls|7400}} | {{Tick}} | {{Tick}} | 12 | 4 | 9 | |
| {{Souls|8200}} | {{Tick}} | {{Tick}} | 13 | 4 | 10 | |
| {{Souls|9000}} | {{Tick}} | {{Tick}} | 14 | 4 | 11 | |
| {{Souls|9800}} | {{Tick}} | {{Tick}} | 15 | 4 | 12 | |
| {{Souls|10700}} | {{Tick}} | {{Tick}} | 16 | 4 | 13 | |
| {{Souls|11600}} | {{Tick}} | {{Tick}} | 17 | 4 | 14 | |
| {{Souls|12500}} | {{Tick}} | {{Tick}} | 18 | 4 | 15 | |
| {{Souls|13400}} | {{Tick}} | {{Tick}} | 19 | 4 | 16 | |
| {{Souls|14400}} | {{Tick}} | {{Tick}} | 20 | 4 | 17 | |
| {{Souls|15500}} | {{Tick}} | {{Tick}} | 21 | 4 | 18 | |
| {{Souls|16700}} | {{Tick}} | {{Tick}} | 22 | 4 | 19 | |
| {{Souls|18000}} | {{Tick}} | {{Tick}} | 23 | 4 | 20 | |
| {{Souls|19500}} | {{Tick}} | {{Tick}} | 24 | 4 | 21 | |
| {{Souls|21200}} | {{Tick}} | {{Tick}} | 25 | 4 | 22 | |
| {{Souls|23100}} | {{Tick}} | {{Tick}} | 26 | 4 | 23 | |
| {{Souls|25200}} | {{Tick}} | {{Tick}} | 27 | 4 | 24 | |
| {{Souls|27500}} | {{Tick}} | {{Tick}} | 28 | 4 | 25 | |
| {{Souls|30000}} | {{Tick}} | {{Tick}} | 29 | 4 | 26 | |
| {{Souls|32700}} | {{Tick}} | {{Tick}} | 30 | 4 | 27 | |
| {{Souls|35600}} | {{Tick}} | {{Tick}} | 31 | 4 | 28 | |
| {{Souls|38700}} | {{Tick}} | {{Tick}} | 32 | 4 | 29 | |
| {{Souls|42000}} | {{Tick}} | {{Tick}} | 33 | 4 | 30 | |
| {{Souls|45500}} | {{Tick}} | {{Tick}} | 34 | 4 | 31 | |
| {{Souls|49200}} | {{Tick}} | {{Tick}} | 35 | 4 | 32 | |