Template:Reagent card/doc: Difference between revisions
From Space Station 14 Wiki
Created page with "== Examples == === Automatic lookup === ==== Using reagent ID ==== {{tji|reagent card|Dermaline}} {{gda}} {{reagent card|Dermaline}} ==== Using reagent name ==== {{tji|reagent card|polypyrylium oligomers}} {{gda}} {{reagent card|polypyrylium oligomers}} === Manual definition === <syntaxhighlight lang="mediawiki"> {{Reagent card | name = Licoxide | id = Licoxide | color = #abca | desc = A synthetic battery acid. It looks... electrifying. | physicalDesc = electric |..." |
added manual params |
||
Line 39: | Line 39: | ||
| effect = Lorem clown | | effect = Lorem clown | ||
}} | }} | ||
==== Data fields ==== | |||
{| class="wikitable" | |||
|+ Fields | |||
|- | |||
! Field !! Definition | |||
|- | |||
| {{c|name}} [REQUIRED] || This is the name used in the display. It should be in Title Case. However, the data itself comes in lower case, as that's how the localisation files display it. | |||
|- | |||
| {{c|id}} || This is the ID used as an ID for the reagent card element. The current standard according to the JSON is PascalCase. The ID is almost always the same text as the name, except for when it isn't (looking at you, copper blood) | |||
|- | |||
| {{c|color}} || This is the colour used in the header. It should be the colour taken from the game's files. It can be any CSS accepted color name, but hex must be proceeded by a hash. | |||
|- | |||
| {{c|recipes}} || This should contain a joined list of all the relevant recipes used to make the chemical. Each recipe should be inputted as a {{t|Recipe Box}}, where in each item follows {{t|Recipe Component}}. For standard chemicals, the {{tjp|transformer}} component should take {{t|Beaker}}. If the chemical requires a certain temperature, it can be passed into the Beaker component as {{tjp|temperature:999k}} (replacing {{c|999k}} with whatever temperature is required). | |||
|- | |||
| {{c|effects}} || This is the effects list component. It should be listed in this format: | |||
<syntaxhighlight lang="mediawiki">'''Subheading''' | |||
* Effect Description | |||
* Effect Description</syntaxhighlight> | |||
In the data, there are three alternative forms of the effects data, but only {{c|effectLine}} should be needed. | |||
|- | |||
| {{c|desc}} || Reagent description. This should be ended by a full stop. | |||
|- | |||
| {{c|physicalDesc}} || This is a short descriptor. Use lower case and no full stop. | |||
|} | |||
== List of all reagents == | == List of all reagents == | ||
[[Template:Reagent card/list of all reagents|See page]] | [[Template:Reagent card/list of all reagents|See page]] |
Latest revision as of 10:27, 27 May 2025
Examples
Automatic lookup
Using reagent ID
{{reagent card
↓
Dermaline
Recipe
Effects
An advanced chemical that is more effective at treating burn damage than kelotane.
Seems to be translucent.
Using reagent name
{{reagent card
↓
Polypyrylium Oligomers
Recipe
Effects
A purple mixture of short polyelectrolyte chains not easily synthesized in the laboratory. Heals asphyxiation and brute damage. Stops bleeding over time.
Seems to be pungent.
Manual definition
{{Reagent card
| name = Licoxide
| id = Licoxide
| color = #abca
| desc = A synthetic battery acid. It looks... electrifying.
| physicalDesc = electric
| recipe = 123
| effect = Lorem clown
}}
↓
Licoxide
Recipe
Effects
A synthetic battery acid. It looks... electrifying.
Seems to be electric.
Data fields
Field | Definition |
---|---|
name [REQUIRED] |
This is the name used in the display. It should be in Title Case. However, the data itself comes in lower case, as that's how the localisation files display it. |
id |
This is the ID used as an ID for the reagent card element. The current standard according to the JSON is PascalCase. The ID is almost always the same text as the name, except for when it isn't (looking at you, copper blood) |
color |
This is the colour used in the header. It should be the colour taken from the game's files. It can be any CSS accepted color name, but hex must be proceeded by a hash. |
recipes |
This should contain a joined list of all the relevant recipes used to make the chemical. Each recipe should be inputted as a {{Recipe Box}}, where in each item follows {{Recipe Component}}. For standard chemicals, the 999k with whatever temperature is required).
|
effects |
This is the effects list component. It should be listed in this format:
'''Subheading'''
* Effect Description
* Effect Description
In the data, there are three alternative forms of the effects data, but only |
desc |
Reagent description. This should be ended by a full stop. |
physicalDesc |
This is a short descriptor. Use lower case and no full stop. |