Module:Utilities/doc - Revision history

Monster Domosed: /* process_variables */

2025-04-11T21:46:10Z

process_variables

← Older revision		Revision as of 21:46, 11 April 2025
Line 26:		Line 26:
	==process_variables==		==process_variables==
	Processes a localized string by replacing variable patterns with their corresponding values.		Processes a localized string by replacing variable patterns with their corresponding values.

			===Parameters===
			* string_key - The localization key used to retrieve the base string (via Module:Lang)

			* item_name - The name of the item used to look up variable values (via Module:ItemData)

	===Examples===		===Examples===
			Active Item descriptions in [[Template:Active Items]]
	<pre>{{#invoke:Utilities\|process_variables\|upgrade_thermal_detonator_desc\|Alchemical Fire}}</pre>		<pre>{{#invoke:Utilities\|process_variables\|upgrade_thermal_detonator_desc\|Alchemical Fire}}</pre>

	{{#invoke:Utilities\|process_variables\|upgrade_thermal_detonator_desc\|Alchemical Fire}}		{{#invoke:Utilities\|process_variables\|upgrade_thermal_detonator_desc\|Alchemical Fire}}

Monster Domosed: added process_variables to doc

2025-04-11T21:03:22Z

added process_variables to doc

← Older revision		Revision as of 21:03, 11 April 2025
Line 23:		Line 23:

	{{#invoke:Utilities\|remove_trailing_colon\|A Fate's Tale:}}		{{#invoke:Utilities\|remove_trailing_colon\|A Fate's Tale:}}

			==process_variables==
			Processes a localized string by replacing variable patterns with their corresponding values.

			===Examples===
			<pre>{{#invoke:Utilities\|process_variables\|upgrade_thermal_detonator_desc\|Alchemical Fire}}</pre>

			{{#invoke:Utilities\|process_variables\|upgrade_thermal_detonator_desc\|Alchemical Fire}}

Sur: remove_trailing_colon example

2025-04-04T17:01:06Z

remove_trailing_colon example

← Older revision		Revision as of 17:01, 4 April 2025
Line 15:		Line 15:
	===Examples===		===Examples===
	See examples at [[Template:Color]]		See examples at [[Template:Color]]

			==remove_trailing_colon==
			Remove's the ":" character from the end of a string

			===Examples===
			<pre>{{#invoke:Utilities\|remove_trailing_colon\|A Fate's Tale:}}</pre>

			{{#invoke:Utilities\|remove_trailing_colon\|A Fate's Tale:}}

Sylphoid: cleanup, relink

2024-12-18T17:56:20Z

cleanup, relink

← Older revision		Revision as of 17:56, 18 December 2024
Line 1:		Line 1:
	=Overview=		==Overview==
	Utility functions that serve any miscellaneous purpose		Utility functions that serve any miscellaneous purpose

	=Functions=		==Functions==

	==get_slot_color==		==get_slot_color==
	Retrieve's the color of a certain slot/category in any color format (default hex), formerly known in english as Weapon, Vitality, and Spirit, though their unlocalized names are Weapon, Armor, and Tech. Utilized by [[Template:~~SlotColor~~]]		Retrieve's the color of a certain slot/category in any color format (default hex), formerly known in english as Weapon, Vitality, and Spirit, though their unlocalized names are Weapon, Armor, and Tech. Utilized by [[Template:Color]]

	===Parameters===		===Parameters===
Line 14:		Line 14:

	===Examples===		===Examples===
	See examples at [[Template:~~SlotColor~~]]		See examples at [[Template:Color]]

Sur: moving examples to SlotColor

2024-11-01T22:47:18Z

moving examples to SlotColor

@@ Line 5: / Line 5: @@
 ==get_slot_color==
-Retrieve's the hex color of a certain slot/category, formerly known in english as Weapon, Vitality, and Spirit, though their unlocalized names are Weapon, Armor, and Tech.
+Retrieve's the color of a certain slot/category in any color format (default hex), formerly known in english as Weapon, Vitality, and Spirit, though their unlocalized names are Weapon, Armor, and Tech. Utilized by [[Template:SlotColor]]
 ===Parameters===
 * '''slot''' - slot key, options are Weapon, Armor, and Tech
-* '''color_format''' - color format, defaults to hex. Valid options are hex, rgb, hsl, cmyk
+* '''color_format''' - color format - Defaults to hex. Valid options are hex, rgb, hsl, cmyk
-* '''no_wrap''' - Defaults to false. Set to true to remove prefixes and postfixes of '#' from hex, or 'rgb()', 'hsl()', and 'cmyk()' from the other formats. May be useful for altering the values dynamically
+* '''no_wrap''' - (OPTIONAL) - Defaults to false. Set to true to remove prefixes and postfixes of '#' from hex, or 'rgb()', 'hsl()', and 'cmyk()' from the other formats. May be useful for altering the values dynamically
-* '''debug_mode''' - (OPTIONAL) - used mostly for documentation purposes
+* '''debug_mode''' - (OPTIONAL) - Defaults to false. Used mostly for documentation purposes
 ===Examples===
-To retrieve the color alone
+See examples at [[Template:SlotColor]]

Sur: more color examples for no_wrap

2024-11-01T22:35:41Z

more color examples for no_wrap

← Older revision		Revision as of 22:35, 1 November 2024
Line 14:		Line 14:

	===Examples===		===Examples===
	To retrieve the ~~hex~~ color		To retrieve the color alone
	<code><nowiki>{{#invoke:Utilities\|get_slot_color\|Tech}}</nowiki></code>		<code><nowiki>{{#invoke:Utilities\|get_slot_color\|Tech}}</nowiki></code>

Line 38:		Line 38:
	Tech colored div		Tech colored div
	</div>		</div>


			To get the color without otherwise necessary prefix/postfix wrapping:

			<code><nowiki>{{#invoke:Utilities\|get_slot_color\|Tech\|rgb\|no_wrap=true}}</nowiki></code>

			{{#invoke:Utilities\|get_slot_color\|Tech\|rgb\|no_wrap=true\|debug_mode=true}}


	To alter the alpha value using rgb dynamically:		To alter the alpha value using rgb dynamically:
	<code><nowiki><div style="background-color: rgb({{#invoke:Utilities\|get_slot_color\|Armor\|rgb\|no_wrap=true}}, 0.5);">		<code><nowiki><div style="background-color: rgb({{#invoke:Utilities\|get_slot_color\|Armor\|rgb\|no_wrap=true}}, 1.0);">
	Armor colored div with 0.5 alpha</div></nowiki></code>		Armor colored div with 1.0 alpha</div></nowiki></code>

	<div style="background-color: rgb({{#invoke:Utilities\|get_slot_color\|Armor\|rgb\|no_wrap=true}}, 0.5);">		<div style="background-color: rgb({{#invoke:Utilities\|get_slot_color\|Armor\|rgb\|no_wrap=true}}, 1.0);">
	Armor colored div with 0.5 alpha		Armor colored div with 1.0 alpha
	</div>		</div>

Sur: get_slot_color with alpha colored divs

2024-11-01T21:54:07Z

get_slot_color with alpha colored divs

← Older revision		Revision as of 21:54, 1 November 2024
Line 9:		Line 9:
	===Parameters===		===Parameters===
	* '''slot''' - slot key, options are Weapon, Armor, and Tech		* '''slot''' - slot key, options are Weapon, Armor, and Tech
	* '''color_format''' - color format, defaults to hex. Valid options are hex, rgb		* '''color_format''' - color format, defaults to hex. Valid options are hex, rgb, hsl, cmyk
			* '''no_wrap''' - Defaults to false. Set to true to remove prefixes and postfixes of '#' from hex, or 'rgb()', 'hsl()', and 'cmyk()' from the other formats. May be useful for altering the values dynamically
			* '''debug_mode''' - (OPTIONAL) - used mostly for documentation purposes

	===Examples===		===Examples===
	To retrieve the color ~~alone~~		To retrieve the hex color
	<code><nowiki>{{#invoke:Utilities\|get_slot_color\|Tech}}</nowiki></code>		<code><nowiki>{{#invoke:Utilities\|get_slot_color\|Tech}}</nowiki></code>

	{{#invoke:Utilities\|get_slot_color\|Tech\|debug_mode=true}}		{{#invoke:Utilities\|get_slot_color\|Tech\|debug_mode=true}}

			To retrieve other color formats
			<code><nowiki>{{#invoke:Utilities\|get_slot_color\|Tech\|rgb}}</nowiki></code>

			{{#invoke:Utilities\|get_slot_color\|Tech\|rgb\|debug_mode=true}}


	To style text:		To style text:
	<code><nowiki><span style="color: {{#invoke:Utilities\|get_slot_color\|~~Tech~~}};">~~Tech~~ colored text</span></nowiki></code>		<code><nowiki><span style="color: {{#invoke:Utilities\|get_slot_color\|Weapon}};">Weapon colored text</span></nowiki></code>

	<span style="color: {{#invoke:Utilities\|get_slot_color\|~~Tech~~}};">~~Tech~~ colored text</span>		<span style="color: {{#invoke:Utilities\|get_slot_color\|Weapon}};">Weapon colored text</span>


	To style divs:		To style divs:
	<code><nowiki><div style="background-color: {{#invoke:Utilities\|get_slot_color\|Tech}}; ~~padding~~: ~~10px; border-radius~~: ~~5px~~;">		<code><nowiki><div style="background-color: {{#invoke:Utilities\|get_slot_color\|Tech}};">
			Tech colored div</div></nowiki></code>

			<div style="background-color: {{#invoke:Utilities\|get_slot_color\|Tech}};">
	Tech colored div		Tech colored div
	</div></nowiki></code>		</div>


			To alter the alpha value using rgb dynamically:
			<code><nowiki><div style="background-color: rgb({{#invoke:Utilities\|get_slot_color\|Armor\|rgb\|no_wrap=true}}, 0.5);">
			Armor colored div with 0.5 alpha</div></nowiki></code>

			<div style="background-color: rgb({{#invoke:Utilities\|get_slot_color\|Armor\|rgb\|no_wrap=true}}, 0.5);">
			Armor colored div with 0.5 alpha
			</div>


			<code><nowiki><div style="background-color: rgb({{#invoke:Utilities\|get_slot_color\|Armor\|rgb\|no_wrap=true}}, 0.2);">
			Armor colored div with 0.2 alpha</div></nowiki></code>

	<div style="background-color: {{#invoke:Utilities\|get_slot_color\|~~Tech~~}}~~; padding: 10px; border-radius: 5px~~;">		<div style="background-color: rgb({{#invoke:Utilities\|get_slot_color\|Armor\|rgb\|no_wrap=true}}, 0.2);">
	~~Tech~~ colored div		Armor colored div with 0.2 alpha
	</div>		</div>

Sur: get_slot_color trying an example with debug_mode

2024-11-01T21:25:06Z

get_slot_color trying an example with debug_mode

← Older revision		Revision as of 21:25, 1 November 2024
Line 12:		Line 12:

	===Examples===		===Examples===
			To retrieve the color alone
			<code><nowiki>{{#invoke:Utilities\|get_slot_color\|Tech}}</nowiki></code>

			{{#invoke:Utilities\|get_slot_color\|Tech\|debug_mode=true}}


	To style text:		To style text:
	<code><nowiki>~~'''Tech Item:'''~~ <span style="color: {{#invoke:Utilities\|get_slot_color\|Tech}};">~~Powered Up!~~</span></nowiki></code>		<code><nowiki><span style="color: {{#invoke:Utilities\|get_slot_color\|Tech}};">Tech colored text</span></nowiki></code>

	~~'''Tech Item:'''~~ <span style="color: {{#invoke:Utilities\|get_slot_color\|Tech}};">~~Powered Up!~~</span>		<span style="color: {{#invoke:Utilities\|get_slot_color\|Tech}};">Tech colored text</span>


	To style divs:		To style divs:
	<code><nowiki><div style="background-color: {{#invoke:Utilities\|get_slot_color\|Tech}}; padding: 10px; border-radius: 5px;">		<code><nowiki><div style="background-color: {{#invoke:Utilities\|get_slot_color\|Tech}}; padding: 10px; border-radius: 5px;">
	~~This is a~~ Tech ~~item description.~~		Tech colored div
	</div></nowiki></code>		</div></nowiki></code>


	<div style="background-color: {{#invoke:Utilities\|get_slot_color\|Tech}}; padding: 10px; border-radius: 5px;">		<div style="background-color: {{#invoke:Utilities\|get_slot_color\|Tech}}; padding: 10px; border-radius: 5px;">
	~~This is a~~ Tech ~~item description.~~		Tech colored div
	</div>		</div>

Sur: initial

2024-11-01T21:19:13Z

initial

New page

=Overview=
Utility functions that serve any miscellaneous purpose

=Functions=

==get_slot_color==
Retrieve's the hex color of a certain slot/category, formerly known in english as Weapon, Vitality, and Spirit, though their unlocalized names are Weapon, Armor, and Tech.

===Parameters===
* '''slot''' - slot key, options are Weapon, Armor, and Tech
* '''color_format''' - color format, defaults to hex. Valid options are hex, rgb

===Examples===
To style text:
<code><nowiki>'''Tech Item:''' <span style="color: {{#invoke:Utilities|get_slot_color|Tech}};">Powered Up!</span></nowiki></code>

'''Tech Item:''' <span style="color: {{#invoke:Utilities|get_slot_color|Tech}};">Powered Up!</span>

To style divs:
<code><nowiki><div style="background-color: {{#invoke:Utilities|get_slot_color|Tech}}; padding: 10px; border-radius: 5px;">
This is a Tech item description.
</div></nowiki></code>

<div style="background-color: {{#invoke:Utilities|get_slot_color|Tech}}; padding: 10px; border-radius: 5px;">
This is a Tech item description.
</div>