Module:Utilities/doc - Revision history

Sur: artifact rarity supported

2025-05-03T21:46:12Z

artifact rarity supported

← Older revision		Revision as of 21:46, 3 May 2025
Line 33:		Line 33:

	==rarity_name_to_num==		==rarity_name_to_num==
	Translates the rarity name to its corresponding number, where Junk has numerical equivalent of 0, up to ~~Unique~~ as 7.		Translates the rarity name to its corresponding number, where Junk has numerical equivalent of 0, up to Artifact as 8.

	Used by draw_socket_cost_table() in [[Module:Enchantments]] to determine the order and css class for each rarity.		Used by draw_socket_cost_table() in [[Module:Enchantments]] to determine the order and css class for each rarity.

	===Parameters===		===Parameters===
	* ''rarity_name'' - Name of the rarity: Junk, Poor, Common, Uncommon, Rare, Epic, Legend, Unique ~~(not~~ Artifact)		* ''rarity_name'' - Name of the rarity: Junk, Poor, Common, Uncommon, Rare, Epic, Legend, Unique, and Artifact

	===Examples===		===Examples===
Line 47:		Line 47:

	==rarity_num_to_name==		==rarity_num_to_name==
	Translates the rarity number to its corresponding name, where Junk has numerical equivalent of 0, up to ~~Unique~~ as 7.		Translates the rarity number to its corresponding name, where Junk has numerical equivalent of 0, up to Artifact as 8.

	===Parameters===		===Parameters===

Sur: /* rarity_num_to_name*/ example

2025-05-03T21:45:01Z

rarity_num_to_name: example

← Older revision		Revision as of 21:45, 3 May 2025
Line 44:		Line 44:

	{{#invoke:Utilities\|rarity_name_to_num\|Poor}}		{{#invoke:Utilities\|rarity_name_to_num\|Poor}}


			==rarity_num_to_name==
			Translates the rarity number to its corresponding name, where Junk has numerical equivalent of 0, up to Unique as 7.

			===Parameters===
			* ''rarity_num'' - Number of the rarity: 0, 1, 2, 3, 4, 5, 6, 7, 8

			===Examples===
			<pre>{{#invoke:Utilities\|rarity_num_to_name\|1}}</pre>

			{{#invoke:Utilities\|rarity_num_to_name\|1}}

Sur: comment rarity_name_to_num is used in draw_socket_cost_table()

2025-02-28T21:18:14Z

comment rarity_name_to_num is used in draw_socket_cost_table()

← Older revision		Revision as of 21:18, 28 February 2025
Line 34:		Line 34:
	==rarity_name_to_num==		==rarity_name_to_num==
	Translates the rarity name to its corresponding number, where Junk has numerical equivalent of 0, up to Unique as 7.		Translates the rarity name to its corresponding number, where Junk has numerical equivalent of 0, up to Unique as 7.

			Used by draw_socket_cost_table() in [[Module:Enchantments]] to determine the order and css class for each rarity.

	===Parameters===		===Parameters===

Sur: rarity_name_to_num() init

2025-02-28T21:06:12Z

rarity_name_to_num() init

← Older revision		Revision as of 21:06, 28 February 2025
Line 30:		Line 30:
	{{#invoke:Utilities\|dash_for_space\|Physical Damage}}		{{#invoke:Utilities\|dash_for_space\|Physical Damage}}
	<!--why is there a 1 trailing the example here..? it works in the enchantment module just fine-->		<!--why is there a 1 trailing the example here..? it works in the enchantment module just fine-->


			==rarity_name_to_num==
			Translates the rarity name to its corresponding number, where Junk has numerical equivalent of 0, up to Unique as 7.

			===Parameters===
			* ''rarity_name'' - Name of the rarity: Junk, Poor, Common, Uncommon, Rare, Epic, Legend, Unique (not Artifact)

			===Examples===
			<pre>{{#invoke:Utilities\|rarity_name_to_num\|Poor}}</pre>

			{{#invoke:Utilities\|rarity_name_to_num\|Poor}}

Sur: dash_for_space

2025-02-27T23:47:16Z

dash_for_space

← Older revision		Revision as of 23:47, 27 February 2025
Line 16:		Line 16:

	{{#invoke:Utilities\|insert_space_before_capitals\|ElementalBolt}}		{{#invoke:Utilities\|insert_space_before_capitals\|ElementalBolt}}

			==dash_for_space==
			Replaces all spaces with dashes. i.e. "Physical Damage" -> "Physical Damage". Useful for turning text into something that can be used as a css class.

			See [[Module:Enchantments]] for an example that utilizes this module.

			===Parameters===
			* ''input_text'' - input string

			===Examples===
			<pre>{{#invoke:Utilities\|dash_for_space\|Physical Damage}}</pre>

			{{#invoke:Utilities\|dash_for_space\|Physical Damage}}
			<!--why is there a 1 trailing the example here..? it works in the enchantment module just fine-->

Sur: overview and insert_space_before_capitals init

2024-12-21T01:19:26Z

overview and insert_space_before_capitals init

New page

=Overview=
Utility functions

=Functions=

==insert_space_before_capitals==
Adds spaces before capital letters (other than if its the first character). i.e. "ElementalBolt" -> "Elemental Bolt"

Can be invoked within wikitext, or called within another lua module. See [[Module:MergeSpells]] for an example that utilizes this module.

===Parameters===
* ''input_text'' - input string

===Examples===
<pre>{{#invoke:Utilities|insert_space_before_capitals|ElementalBolt}}</pre>

{{#invoke:Utilities|insert_space_before_capitals|ElementalBolt}}