Template:EquipmentTableFromList/doc: Difference between revisions

Template:EquipmentTableFromList/doc (view source)

Revision as of 23:22, 4 June 2024

636 bytes added , 4 June

Added instructions on how to use the script

Slash

Interface administrators

4,683

edits

@@ Line 1: / Line 1: @@
-Function for creating a stat table with a given list of items. Items are sent in as one item name per parameter. An optional parameter <code>includeModifiers</code> can also be used - if <code>true</code>, then a modifiers column is also included. A script for automatically generating this template with a given search term, ran through the in-game console, can be found at [[Template:Disambiguation/doc]].
+Function for creating a stat table with a given list of items. Items are sent in as one item name per parameter. An optional parameter <code>includeModifiers</code> can also be used - if <code>true</code>, then a modifiers column is also included.
+A script for automatically generating this template with a given search term, ran through the in-game console, can be found at [[Template:Disambiguation/doc]]. To use the script, copy and paste it into the console and change the <code>searchTerm</code> to the Equipment page you're about to create. Upon hitting enter, the outputs will be pasted into the console while also being copied to the clipboard. There will be 3 categories and all items will be within the Armour category. Items must be manually sorted into their respective categories however the script will prioritize Weapons > Quiver items > Armours so it should be as simple to sort. Any items that are not part of the set, such as Earth Layered Shield in the Earth Wizard set, should be removed and left on a Disambiguation page.
 For example, {{T|EquipmentTableFromList|(G) Ancient Helmet|(G) Ancient Platebody|(G) Ancient Platelegs}} gives:
 {{EquipmentTableFromList|(G) Ancient Helmet|(G) Ancient Platebody|(G) Ancient Platelegs}}