Module:SoulUnlock/doc - Revision history

Sur: write_table example with debug_mode=true

2024-10-29T04:09:08Z

write_table example with debug_mode=true

← Older revision		Revision as of 04:09, 29 October 2024
Line 35:		Line 35:

	===Example===		===Example===
			{{#invoke:SoulUnlock\|write_table\|debug_mode=true}}

	{{#invoke:SoulUnlock\|write_table}}		{{#invoke:SoulUnlock\|write_table}}

Sur: write_table pre-initial for testing

2024-10-29T03:07:08Z

write_table pre-initial for testing

← Older revision		Revision as of 03:07, 29 October 2024
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}}

Sur: /* Examples */ fixed localize example showing lang instead of localize for func name

2024-10-29T03:05:42Z

Examples: fixed localize example showing lang instead of localize for func name

← Older revision		Revision as of 03:05, 29 October 2024
Line 18:		Line 18:

	===Examples===		===Examples===
	<code><nowiki>{{#invoke:SoulUnlock\|~~lang~~\|RequiredSouls}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|RequiredSouls}}<br>		<code><nowiki>{{#invoke:SoulUnlock\|localize\|RequiredSouls}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|RequiredSouls}}<br>
	<code><nowiki>{{#invoke:SoulUnlock\|~~lang~~\|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|PowerIncrease}}<br>		<code><nowiki>{{#invoke:SoulUnlock\|localize\|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|PowerIncrease}}<br>
	<code><nowiki>{{#invoke:SoulUnlock\|~~lang~~\|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|AbilityUnlocks}}<br>		<code><nowiki>{{#invoke:SoulUnlock\|localize\|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|AbilityUnlocks}}<br>
	<code><nowiki>{{#invoke:SoulUnlock\|~~lang~~\|AbilityPoints}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|AbilityPoints}}<br>		<code><nowiki>{{#invoke:SoulUnlock\|localize\|AbilityPoints}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|AbilityPoints}}<br>

	==write_accumulated==		==write_accumulated==

Sur: RequiredGold > RequiredSouls

2024-10-26T17:41:48Z

RequiredGold > RequiredSouls

← Older revision		Revision as of 17:41, 26 October 2024
Line 9:		Line 9:

	===Examples===		===Examples===
	<code><nowiki>{{#invoke:SoulUnlock\|get_max\|~~RequiredGold~~}}</nowiki></code> {{#invoke:SoulUnlock\|get_max\|~~RequiredGold~~}}<br>		<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\|lang\|~~RequiredGold~~}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|~~RequiredGold~~}}<br>		<code><nowiki>{{#invoke:SoulUnlock\|lang\|RequiredSouls}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|RequiredSouls}}<br>
	<code><nowiki>{{#invoke:SoulUnlock\|lang\|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|PowerIncrease}}<br>		<code><nowiki>{{#invoke:SoulUnlock\|lang\|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|PowerIncrease}}<br>
	<code><nowiki>{{#invoke:SoulUnlock\|lang\|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|AbilityUnlocks}}<br>		<code><nowiki>{{#invoke:SoulUnlock\|lang\|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|AbilityUnlocks}}<br>

Sur: localize, write_accumulated, get_max finished

2024-10-26T03:34:34Z

localize, write_accumulated, get_max finished

← Older revision		Revision as of 03:34, 26 October 2024
Line 1:		Line 1:
	=Overview=		=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=		=Functions=
	==get_max==		==get_max==
	~~desc~~		Retrieve's maximum value for a given key in the accumulated data

	===~~Example~~===		===Examples===
	{{#invoke:SoulUnlock\|get_max\|RequiredGold}}		<code><nowiki>{{#invoke:SoulUnlock\|get_max\|RequiredGold}}</nowiki></code> {{#invoke:SoulUnlock\|get_max\|RequiredGold}}<br>
	{{#invoke:SoulUnlock\|get_max\|~~PowerIncreases~~}}		<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\|lang\|RequiredGold}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|RequiredGold}}<br>
			<code><nowiki>{{#invoke:SoulUnlock\|lang\|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|PowerIncrease}}<br>
			<code><nowiki>{{#invoke:SoulUnlock\|lang\|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|AbilityUnlocks}}<br>
			<code><nowiki>{{#invoke:SoulUnlock\|lang\|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.

	~~==accumulate==~~		''Note: the keys outputted are localized to english. See the localization map at the top of the Module source.''
	~~desc~~

	===Example===		===Example===
			<code><nowiki>{{#invoke:SoulUnlock\|write_accumulated}}</nowiki></code><br>
	{{#invoke:SoulUnlock\|write_accumulated}}		{{#invoke:SoulUnlock\|write_accumulated}}

Sur: get_max example

2024-10-26T03:23:03Z

get_max example

← Older revision		Revision as of 03:23, 26 October 2024
Line 3:		Line 3:

	=Functions=		=Functions=
			==get_max==
			desc

			===Example===
			{{#invoke:SoulUnlock\|get_max\|RequiredGold}}
			{{#invoke:SoulUnlock\|get_max\|PowerIncreases}}

	==accumulate==		==accumulate==
	desc		desc

Sur: testing purposes for now

2024-10-26T02:29:34Z

testing purposes for now

New page

=Overview=
overview

=Functions=
==accumulate==
desc

===Example===
{{#invoke:SoulUnlock|write_accumulated}}

← Older revision		Revision as of 17:41, 26 October 2024
Line 9:		Line 9:

	===Examples===		===Examples===
	<code><nowiki>{{#invoke:SoulUnlock\|get_max\|~~RequiredGold~~}}</nowiki></code> {{#invoke:SoulUnlock\|get_max\|~~RequiredGold~~}}<br>		<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\|lang\|~~RequiredGold~~}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|~~RequiredGold~~}}<br>		<code><nowiki>{{#invoke:SoulUnlock\|lang\|RequiredSouls}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|RequiredSouls}}<br>
	<code><nowiki>{{#invoke:SoulUnlock\|lang\|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|PowerIncrease}}<br>		<code><nowiki>{{#invoke:SoulUnlock\|lang\|PowerIncrease}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|PowerIncrease}}<br>
	<code><nowiki>{{#invoke:SoulUnlock\|lang\|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|AbilityUnlocks}}<br>		<code><nowiki>{{#invoke:SoulUnlock\|lang\|AbilityUnlocks}}</nowiki></code> {{#invoke:SoulUnlock\|localize\|AbilityUnlocks}}<br>