Module:Item/doc: Difference between revisions
(→Adding items: better example) |
(→Adding images for items: better example) |
||
| Line 41: | Line 41: | ||
The value of an item is its icon filename. | The value of an item is its icon filename. | ||
{{Callout|Example | |||
|To add an icon for a newly added {{c|CableHV20}} item from the previous example, we would have to add a new line to the JSON file. For instance, if the icon filename is {{c|Coilhv-20.png}}, the line would be: | |||
<syntaxhighlight lang="json> | |||
"CableHV20": "Coilhv-20.png" | |||
</syntaxhighlight> | |||
}} | |||
To see if icons do work, look at newly-added items in the list of items in {{t|item}}. | To see if icons do work, look at newly-added items in the list of items in {{t|item}}. | ||
Revision as of 12:49, 17 August 2024
Module documentation
|
|---|
| View or edit this documentation • (about module documentation) |
Contains utilities for working with in-game items.
Adding items
To add more items, go to Module:Item/item names by item id.json.
It is a JSON file containing an object with keys being the item in-game IDs, but also allows custom IDs for displaying items such as coil variations.
Each item has a list of names. These are used for various lookups. An item can have as many names as you wish, but it must have at least one. The first name listed will be used as a «main» name in various lookups, so it's generally should be the name used by the game.
CableHVStack (hv), CableMVStack (mv), CableApcStack (lv).
These three allow to configure a single icon for each coil variation, but the game has more variations per type of coil depending on how many coils are left in stack. For instance, for 20 HV coils the icon will change to Lua error in Module:Item at line 83: item generation failed: no item was found by ID/name 'hv20'., and when there are 10 or less - to 
.
To support more icons per item, we can just add more "fake" item IDs, give them any name we want and then define icons for them. For the "20" variation of HV we can add:
"CableHV20": [
"HV cable coil (20)",
"HV20",
"HV (20)",
"HV coil (20)",
"HV cable (20)"
],
HV cable coil (20) would be the «main» name, and the rest are aliases.Adding images for items
To add images for items, go to Module:Item/item image files by item id.json.
It is a JSON file containing an object with keys being the item in-game IDs, but also allows custom IDs for displaying items such as coil variations.
The value of an item is its icon filename.
CableHV20 item from the previous example, we would have to add a new line to the JSON file. For instance, if the icon filename is Coilhv-20.png, the line would be:
"CableHV20": "Coilhv-20.png"
To see if icons do work, look at newly-added items in the list of items in {{item}}.
