Module:Utilities/doc: Difference between revisions

(7 intermediate revisions by 3 users not shown)

Line 1:

=Overview=

==Overview==

Utility functions that serve any miscellaneous purpose

=Functions=

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

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

* '''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''' - (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) - Defaults to false. Used mostly for documentation purposes

===Examples===

~~To style text~~:

See examples at [[Template:Color]]

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

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

==process_variables==

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)

~~To style divs:~~

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

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

===Examples===

Active Item descriptions in [[Template:Active Items]]

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

~~<div style="background-color:~~ {{#invoke:Utilities|~~get_slot_color~~|~~Tech~~}}~~; padding: 10px; border-radius: 5px;">~~

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

~~This is a Tech item description.~~

~~</div>~~

Module:Utilities/doc: Difference between revisionsGive feedback

Monster Domosed (talk | contribs)

@@ Line 1: / Line 1: @@
-=Overview=
+==Overview==
 Utility functions that serve any miscellaneous purpose
-=Functions=
+==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.
+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===
 * '''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''' - (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) - Defaults to false. Used mostly for documentation purposes
 ===Examples===
-To style text:
+See examples at [[Template:Color]]
-<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>
+==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:}}
+==process_variables==
+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)
-To style divs:
+* item_name - The name of the item used to look up variable values (via Module:ItemData)
-<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>
+===Examples===
+Active Item descriptions in [[Template:Active Items]]
+<pre>{{#invoke:Utilities|process_variables|upgrade_thermal_detonator_desc|Alchemical Fire}}</pre>
-<div style="background-color: {{#invoke:Utilities|get_slot_color|Tech}}; padding: 10px; border-radius: 5px;">
+{{#invoke:Utilities|process_variables|upgrade_thermal_detonator_desc|Alchemical Fire}}
-This is a Tech item description.
-</div>