Editing Module:SoulUnlock/doc

Warning: You are not logged in. Once you make an edit, a temporary account will be created for you. Learn more. Log in or create an account to continue receiving notifications after this account expires, and to access other features.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision Your text
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]].
overview
 
The data is accumulated into another format that is used by the currently written functions.


=Functions=
=Functions=
==get_max==
==get_max==
Retrieve's maximum value for a given key in the accumulated data
desc


===Examples===
===Example===
<code><nowiki>{{#invoke:SoulUnlock|get_max|RequiredSouls}}</nowiki></code> {{#invoke:SoulUnlock|get_max|RequiredSouls}}<br>
{{#invoke:SoulUnlock|get_max|RequiredGold}}
<code><nowiki>{{#invoke:SoulUnlock|get_max|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock|get_max|PowerIncrease}}<br>
{{#invoke:SoulUnlock|get_max|PowerIncreases}}
<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==
==accumulate==
Localize a key as its stored to the current language using [[Module:Lang]].
desc
 
===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===
===Example===
<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}}
Please note that all contributions to The Deadlock Wiki are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see Deadlock:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

Pages included on this page: