Difference between revisions of "Template:Recipe item/doc"
From Captain of Industry Wiki
(Created page with " ;Purpose :This is a template for improving the maintainability of Template: Recipe draw, where the code for drawing the plus sign and item icon is used nearly 20 times. This template is intended to be used '''only''' in Template: Recipe draw and does not work alone. ;Usage <templatestyles src="Template:Recipe draw/styles.css" /> :For Input1 and Output1 <div class="recipe-wrapper> {{markup|<nowiki> {{Recipe item | Name = Steam hi | Quantity = 2...") |
(Support instant recipe without unit (for Thermal Storage)) |
||
(6 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<!-- | |||
--><templatestyles src="Template:Recipe draw/styles.css" /> <!-- | |||
--> {{#vardefine: img_plus | [[File:Plus.png|24x24px]] }} <!-- | |||
--> {{#vardefine: imgsz_reg | 48x48px }}<!-- | |||
-->{{#vardefine: pollution_1 | air pollution }}<!-- | |||
-->{{#vardefine: pollution_2 | water pollution }}<!-- | |||
-->{{#vardefine: pollution_3 | }}<!-- | |||
-->{{#vardefine: pollution_4 | }}<!-- | |||
** The upper 7 rows are required to apply the proper format to render the sample on this page. | |||
--> | |||
;Purpose | ;Purpose | ||
:This is a template for improving the maintainability of [[Template: Recipe draw]], where the code for drawing the plus sign and item icon is used nearly 20 times. This template is intended to be used ''' | :This is a template for improving the maintainability of [[Template: Recipe draw]], where the code for drawing the plus sign and item icon is used nearly 20 times. This template is intended to be used '''ONLY''' in [[Template: Recipe draw]] and does not work alone. | ||
;Usage | ;Usage | ||
< | :The template accepts the following parameters: | ||
*<code>Name</code>: Name of item (example: Iron Ore). If empty string, does not display anything. | |||
*<code>Quantity</code>: Amount of consumed or produced item per 1 cycle of recipe. | |||
*<code>Time</code>: Cycle time of recipe. | |||
*<code>Unit = MW or something</code> (optional): Adds unit to Quantity. | |||
**<code>Unit = ?</code> (optional, rare): Makes quantity to "?" (For [[Waste Sorting Plant]] and so on) | |||
*<code>Plus = yes</code> (optional): Displays "+" icon left of item icon | |||
**<code>Plus = something</code> (optional, rare): Displays specified icon (or text) instead of "+" icon | |||
*<code>Pollution = only</code> (optional): Displays icon only if the item is Air Pollution or Water Pollution | |||
*<code>Pollution = hide</code> (optional): Displays icon only if the item is NOT Air Pollution or Water Pollution | |||
*<code>ImageSize = something</code> (optional, rare): Changes size of the item icon | |||
== Examples == | |||
;For Input1 and Output1 | |||
<div class="recipe-wrapper> | <div class="recipe-wrapper> | ||
{{markup|<nowiki> | {{markup|<nowiki> | ||
{{Recipe item | {{Recipe item | ||
| Name = Steam | | Name = Steam Hi | ||
| Quantity = 2 | | Quantity = 2 | ||
| Time = 10 | | Time = 10 | ||
}}</nowiki>| | }}</nowiki>| | ||
{{Recipe item | {{Recipe item | ||
| Name = Steam | | Name = Steam Hi | ||
| Quantity = 2 | | Quantity = 2 | ||
| Time = 10 | | Time = 10 | ||
Line 20: | Line 43: | ||
}} | }} | ||
</div> | </div> | ||
;For Input2-6 and Output2-6: | |||
<div class="recipe-wrapper> | <div class="recipe-wrapper> | ||
{{markup|<nowiki> | {{markup|<nowiki> | ||
{{Recipe item | {{Recipe item | ||
| Name = Steam | | Name = Steam Hi | ||
| Quantity = 2 | | Quantity = 2 | ||
| Time = 10 | | Time = 10 | ||
Line 30: | Line 53: | ||
}}</nowiki>| | }}</nowiki>| | ||
{{Recipe item | {{Recipe item | ||
| Name = Steam | | Name = Steam Hi | ||
| Quantity = 2 | | Quantity = 2 | ||
| Time = 10 | | Time = 10 | ||
Line 37: | Line 60: | ||
}} | }} | ||
</div> | </div> | ||
;For Mechanical Power and Electricity: | |||
<div class="recipe-wrapper> | <div class="recipe-wrapper> | ||
{{markup|<nowiki> | {{markup|<nowiki> | ||
Line 52: | Line 75: | ||
}} | }} | ||
</div> | </div> | ||
: | ;For Instant recipe | ||
<div class="recipe-wrapper> | |||
{{markup|<nowiki> | |||
{{Recipe item | |||
| Name = Steam Depleted | |||
| Quantity = 1 | |||
| Time = 0 | |||
}}</nowiki>| | |||
{{Recipe item | |||
| Name = Steam Depleted | |||
| Quantity = 1 | |||
| Time = 0 | |||
}} | |||
}} | |||
</div> | |||
;For variable quantity: | |||
:*For displaying "?," Unit should be used instead of Quantity since Input1Qty, etc. in [[Template: Recipe define]] can receive only integer. | |||
<div class="recipe-wrapper> | <div class="recipe-wrapper> | ||
{{markup|<nowiki> | {{markup|<nowiki> | ||
{{Recipe item | {{Recipe item | ||
| Name = Steam | | Name = Steam Hi | ||
| Unit = ? <!-- NOT Quantity --> | |||
| Time = 10 | |||
}}</nowiki>| | |||
{{Recipe item | |||
| Name = Steam Hi | |||
| Unit = ? | |||
| Time = 10 | |||
}} | |||
}} | |||
</div> | |||
;For hiding pollution: | |||
<div class="recipe-wrapper> | |||
{{markup|<nowiki> | |||
{{Recipe item | |||
| Name = Steam Hi | |||
| Quantity = 2 | |||
| Time = 10 | |||
| Pollution = hide | |||
}}</nowiki>| | |||
{{Recipe item | |||
| Name = Steam Hi | |||
| Quantity = 2 | |||
| Time = 10 | |||
| Pollution = hide | |||
}} | <nowiki> | |||
{{Recipe item | |||
| Name = Air Pollution | |||
| Quantity = 2 | |||
| Time = 10 | |||
| Pollution = hide | |||
}}</nowiki> | | |||
{{Recipe item | |||
| Name = Air Pollution | |||
| Quantity = 2 | |||
| Time = 10 | |||
| Pollution = hide | |||
}} | |||
}} | |||
</div> | |||
;For showing only pollution: | |||
<div class="recipe-wrapper> | |||
{{markup|<nowiki> | |||
{{Recipe item | |||
| Name = Steam Hi | |||
| Quantity = 2 | |||
| Time = 10 | |||
| Pollution = only | |||
}}</nowiki>| | |||
{{Recipe item | |||
| Name = Steam Hi | |||
| Quantity = 2 | |||
| Time = 10 | |||
| Pollution = only | |||
}} | <nowiki> | |||
{{Recipe item | |||
| Name = Air Pollution | |||
| Quantity = 2 | |||
| Time = 10 | |||
| Pollution = only | |||
}}</nowiki> | | |||
{{Recipe item | |||
| Name = Air Pollution | |||
| Quantity = 2 | |||
| Time = 10 | |||
| Pollution = only | |||
}} | |||
}} | |||
</div> | |||
;When Name is empty: | |||
<div class="recipe-wrapper> | |||
{{markup|<nowiki> | |||
{{Recipe item | |||
| Name = | |||
| Quantity = 2 | |||
| Time = 10 | |||
}}</nowiki>| | |||
{{Recipe item | |||
| Name = | |||
| Quantity = 2 | |||
| Time = 10 | |||
}} | |||
}} | |||
</div> | |||
;For overwriting plus icon and/or icon size: | |||
<div class="recipe-wrapper> | |||
{{markup|<nowiki> | |||
{{Recipe item | |||
| Name = Steam Hi | |||
| Quantity = 2 | | Quantity = 2 | ||
| Time = 10 | | Time = 10 | ||
Line 63: | Line 190: | ||
}}</nowiki>| | }}</nowiki>| | ||
{{Recipe item | {{Recipe item | ||
| Name = Steam | | Name = Steam Hi | ||
| Quantity = 2 | | Quantity = 2 | ||
| Time = 10 | | Time = 10 | ||
Line 71: | Line 198: | ||
}} | }} | ||
</div> | </div> | ||
:[[Template: Recipe draw]] | == Reason this template cannot be used alone == | ||
:This template depends on the following codes in [[Template: Recipe draw]] to define its style and some parameters. | |||
:*<nowiki><templatestyles src="Template:Recipe draw/styles.css" /></nowiki> | :*<nowiki><templatestyles src="Template:Recipe draw/styles.css" /></nowiki> | ||
:*<nowiki><div class="recipe-wrapper></nowiki> | :*<nowiki><div class="recipe-wrapper></nowiki> | ||
:*<nowiki>{{#vardefine: img_plus | [[File:Plus.png|24x24px]] }}</nowiki> | |||
:*<nowiki>{{#vardefine: imgsz_reg | 48x48px }}</nowiki> | |||
:*<nowiki>{{#vardefine: pollution_1 | air pollution }}</nowiki> | |||
:*<nowiki>{{#vardefine: pollution_2 | water pollution }}</nowiki> | |||
:*<nowiki>{{#vardefine: pollution_3 | }}</nowiki> | |||
:*<nowiki>{{#vardefine: pollution_4 | }}</nowiki> |
Latest revision as of 14:37, 16 May 2023
- Purpose
- This is a template for improving the maintainability of Template: Recipe draw, where the code for drawing the plus sign and item icon is used nearly 20 times. This template is intended to be used ONLY in Template: Recipe draw and does not work alone.
- Usage
- The template accepts the following parameters:
Name
: Name of item (example: Iron Ore). If empty string, does not display anything.Quantity
: Amount of consumed or produced item per 1 cycle of recipe.Time
: Cycle time of recipe.Unit = MW or something
(optional): Adds unit to Quantity.Unit = ?
(optional, rare): Makes quantity to "?" (For Waste Sorting Plant and so on)
Plus = yes
(optional): Displays "+" icon left of item iconPlus = something
(optional, rare): Displays specified icon (or text) instead of "+" icon
Pollution = only
(optional): Displays icon only if the item is Air Pollution or Water PollutionPollution = hide
(optional): Displays icon only if the item is NOT Air Pollution or Water PollutionImageSize = something
(optional, rare): Changes size of the item icon
Examples
- For Input1 and Output1
- For Input2-6 and Output2-6
- For Mechanical Power and Electricity
- For Instant recipe
- For variable quantity
-
- For displaying "?," Unit should be used instead of Quantity since Input1Qty, etc. in Template: Recipe define can receive only integer.
Markup | Renders as |
---|---|
{{Recipe item | Name = Steam Hi | Unit = ? <!-- NOT Quantity --> | Time = 10 }} |
|
- For hiding pollution
Markup | Renders as |
---|---|
{{Recipe item | Name = Steam Hi | Quantity = 2 | Time = 10 | Pollution = hide }} |
|
{{Recipe item | Name = Air Pollution | Quantity = 2 | Time = 10 | Pollution = hide }} |
|
- For showing only pollution
Markup | Renders as |
---|---|
{{Recipe item | Name = Steam Hi | Quantity = 2 | Time = 10 | Pollution = only }} |
|
{{Recipe item | Name = Air Pollution | Quantity = 2 | Time = 10 | Pollution = only }} |
|
- When Name is empty
Markup | Renders as |
---|---|
{{Recipe item | Name = | Quantity = 2 | Time = 10 }} |
|
- For overwriting plus icon and/or icon size
Markup | Renders as |
---|---|
{{Recipe item | Name = Steam Hi | Quantity = 2 | Time = 10 | Plus = [[File:Unity.png|32x32px]] | ImageSize = 24x24px }} |
|
Reason this template cannot be used alone
- This template depends on the following codes in Template: Recipe draw to define its style and some parameters.
- <templatestyles src="Template:Recipe draw/styles.css" />
- <div class="recipe-wrapper>
- {{#vardefine: img_plus | [[File:Plus.png|24x24px]] }}
- {{#vardefine: imgsz_reg | 48x48px }}
- {{#vardefine: pollution_1 | air pollution }}
- {{#vardefine: pollution_2 | water pollution }}
- {{#vardefine: pollution_3 | }}
- {{#vardefine: pollution_4 | }}