Module:Utilities/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Browse history interactively
← Older edit

Monster Domosed (talk | contribs)

2 user groups
4,590 edits
undo
VisualWikitext
Sur (talk | contribs)
Moderators
2,147 edits
m more color examples for no_wrap
 
(4 intermediate revisions by 3 users not shown)
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 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===
===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, 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===
===Examples===
To retrieve the color alone
See examples at [[Template:Color]]
<code><nowiki>{{#invoke:Utilities|get_slot_color|Tech}}</nowiki></code>


{{#invoke:Utilities|get_slot_color|Tech|debug_mode=true}}
==remove_trailing_colon==
Remove's the ":" character from the end of a string


To retrieve other color formats
===Examples===
<code><nowiki>{{#invoke:Utilities|get_slot_color|Tech|rgb}}</nowiki></code>
<pre>{{#invoke:Utilities|remove_trailing_colon|A Fate's Tale:}}</pre>


{{#invoke:Utilities|get_slot_color|Tech|rgb|debug_mode=true}}
{{#invoke:Utilities|remove_trailing_colon|A Fate's Tale:}}


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


To style text:
===Parameters===
<code><nowiki><span style="color: {{#invoke:Utilities|get_slot_color|Weapon}};">Weapon colored text</span></nowiki></code>
* string_key - The localization key used to retrieve the base string (via Module:Lang)


<span style="color: {{#invoke:Utilities|get_slot_color|Weapon}};">Weapon colored text</span>
* item_name - The name of the item used to look up variable values (via Module:ItemData)


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


To style divs:
{{#invoke:Utilities|process_variables|upgrade_thermal_detonator_desc|Alchemical Fire}}
<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
</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:
<code><nowiki><div style="background-color: rgb({{#invoke:Utilities|get_slot_color|Armor|rgb|no_wrap=true}}, 1.0);">
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}}, 1.0);">
Armor colored div with 1.0 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: rgb({{#invoke:Utilities|get_slot_color|Armor|rgb|no_wrap=true}}, 0.2);">
Armor colored div with 0.2 alpha
</div>

Latest revision as of 21:46, 11 April 2025

Overview

[edit source]

Utility functions that serve any miscellaneous purpose

Functions

[edit source]

get_slot_color

[edit source]

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

[edit source]
  • slot - slot key, options are Weapon, Armor, and Tech
  • 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

[edit source]

See examples at Template:Color

remove_trailing_colon

[edit source]

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

Examples

[edit source]
{{#invoke:Utilities|remove_trailing_colon|A Fate's Tale:}}

A Fate's Tale

process_variables

[edit source]

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

Parameters

[edit source]
  • 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

[edit source]

Active Item descriptions in Template:Active Items 

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

Throw a flask that explodes on contact, creating an area that does increasing spirit damage per second and reduces enemy Bullet Resist.

50% less effective vs non-heroes.

Retrieved from "https://deadlock.wiki/Module:Utilities/doc?oldid=24174"