Module:SoulUnlock/doc: Difference between revisions

(5 intermediate revisions by the same user not shown)

Line 1:

=Overview=

~~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=

==~~accumulate~~==

==get_max==

~~desc~~

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

===Examples===

<code><nowiki>{{#invoke:SoulUnlock|get_max|RequiredSouls}}</nowiki></code> {{#invoke:SoulUnlock|get_max|RequiredSouls}}

<code><nowiki>{{#invoke:SoulUnlock|get_max|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock|get_max|PowerIncrease}}

<code><nowiki>{{#invoke:SoulUnlock|get_max|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock|get_max|AbilityUnlocks}}

<code><nowiki>{{#invoke:SoulUnlock|get_max|AbilityPoints}}</nowiki></code> {{#invoke:SoulUnlock|get_max|AbilityPoints}}

==localize==

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

===Examples===

<code><nowiki>{{#invoke:SoulUnlock|localize|RequiredSouls}}</nowiki></code> {{#invoke:SoulUnlock|localize|RequiredSouls}}

<code><nowiki>{{#invoke:SoulUnlock|localize|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock|localize|PowerIncrease}}

<code><nowiki>{{#invoke:SoulUnlock|localize|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock|localize|AbilityUnlocks}}

<code><nowiki>{{#invoke:SoulUnlock|localize|AbilityPoints}}</nowiki></code> {{#invoke:SoulUnlock|localize|AbilityPoints}}

==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===

<code><nowiki>{{#invoke:SoulUnlock|write_accumulated}}</nowiki></code>

==write_table==

===Example===

Module:SoulUnlock/doc: Difference between revisionsGive feedback

Sur (talk | contribs)

@@ Line 1: / Line 1: @@
 =Overview=
-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=
-==accumulate==
+==get_max==
-desc
+Retrieve's maximum value for a given key in the accumulated data
+===Examples===
+<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|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock|get_max|AbilityUnlocks}}<br>
+<code><nowiki>{{#invoke:SoulUnlock|get_max|AbilityPoints}}</nowiki></code> {{#invoke:SoulUnlock|get_max|AbilityPoints}}<br>
+==localize==
+Localize a key as its stored to the current language using [[Module:Lang]].
+===Examples===
+<code><nowiki>{{#invoke:SoulUnlock|localize|RequiredSouls}}</nowiki></code> {{#invoke:SoulUnlock|localize|RequiredSouls}}<br>
+<code><nowiki>{{#invoke:SoulUnlock|localize|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock|localize|PowerIncrease}}<br>
+<code><nowiki>{{#invoke:SoulUnlock|localize|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock|localize|AbilityUnlocks}}<br>
+<code><nowiki>{{#invoke:SoulUnlock|localize|AbilityPoints}}</nowiki></code> {{#invoke:SoulUnlock|localize|AbilityPoints}}<br>
+==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===
+<code><nowiki>{{#invoke:SoulUnlock|write_accumulated}}</nowiki></code><br>
 {{#invoke:SoulUnlock|write_accumulated}}
+==write_table==
+===Example===
+{{#invoke:SoulUnlock|write_table|debug_mode=true}}
+{{#invoke:SoulUnlock|write_table}}