Difference between revisions of "Template:Recipe define"

From Captain of Industry Wiki
Jump to: navigation, search
(Split table declaration to its own page)
m
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>{{#cargo_attach: _table = recipes}}</noinclude><includeonly><!--
<includeonly><!--
-->{{#if: {{NAMESPACE}} || {{#cargo_store: _table = recipes}} }}<!--
  -->{{#if: {{NAMESPACE}} ||<!--
--><noinclude>{{documentation}}</noinclude>
    -->{{#cargo_store: _table = recipes <!--
 
      ** Fields are specified to specify types and try to avoid silent definition error,
      when parser decides to put empty strings in place of unspecified fields. **
 
      ** Building field is taken from info_bldg by default in preparation to the possible change,
      when recipe data won't be defined at buildings pages anymore. See Infobox templates.**
 
    -->| Building    = {{{Building|{{#var:info_bldg}}}}}
        | Unreleased  = {{{Unreleased|}}}
        | Input1Name  = {{{Input1Name|}}}
        | Input1Qty  = {{{Input1Qty|0.0}}}
        | Input1Unit  = {{{Input1Unit|}}}
        | Input2Name  = {{{Input2Name|}}}
        | Input2Qty  = {{{Input2Qty|0.0}}}
        | Input2Unit  = {{{Input2Unit|}}}
        | Input3Name  = {{{Input3Name|}}}
        | Input3Qty  = {{{Input3Qty|0.0}}}
        | Input3Unit  = {{{Input3Unit|}}}
        | Input4Name  = {{{Input4Name|}}}
        | Input4Qty  = {{{Input4Qty|0.0}}}
        | Input4Unit  = {{{Input4Unit|}}}
        | Input5Name  = {{{Input5Name|}}}
        | Input5Qty  = {{{Input5Qty|0.0}}}
        | Input5Unit  = {{{Input5Unit|}}}
        | Input6Name  = {{{Input6Name|}}}
        | Input6Qty  = {{{Input6Qty|0.0}}}
        | Input6Unit  = {{{Input6Unit|}}}
        | Time        = {{{Time|0.0}}}
        | Output1Name = {{{Output1Name|}}}
        | Output1Qty  = {{{Output1Qty|0.0}}}
        | Output1Unit = {{{Output1Unit|}}}
        | Output2Name = {{{Output2Name|}}}
        | Output2Qty  = {{{Output2Qty|0.0}}}
        | Output2Unit = {{{Output2Unit|}}}
        | Output3Name = {{{Output3Name|}}}
        | Output3Qty  = {{{Output3Qty|0.0}}}
        | Output3Unit = {{{Output3Unit|}}}
        | Output4Name = {{{Output4Name|}}}
        | Output4Qty  = {{{Output4Qty|0.0}}}
        | Output4Unit = {{{Output4Unit|}}}
        | Output5Name = {{{Output5Name|}}}
        | Output5Qty  = {{{Output5Qty|0.0}}}
        | Output5Unit = {{{Output5Unit|}}}
        | Output6Name = {{{Output6Name|}}}
        | Output6Qty  = {{{Output6Qty|0.0}}}
        | Output6Unit = {{{Output6Unit|}}} <!--
    -->}}<!--
  -->}}<!--
--></includeonly><!--
 
-->{{#vardefine: cargo_define_invoked | yes}}<!--
 
--><noinclude><!--
  -->{{#cargo_attach: _table = recipes}}<!--
  -->{{documentation}}<!--
--></noinclude>

Latest revision as of 15:21, 2 May 2023

This template adds rows to the table "recipes", which is declared by the template Recipe declare. View table.

Template documentation (for the above template, sometimes hidden or invisible) [view] [edit] [history] [refresh]
Purpose
This template provides a method to rapidly illustrate crafting recipes without in-depth knowledge of wiki syntax or manual repetition/copy-pasting.
Basic usage
The following 2 templates are provided for making a recipe.
Both templates can be used with the format written in #Examples in this document.
Parameters
The template accepts the following parameters:
  • Building: Name of buildings (example: Blast Furnace). No need to specify on pages using Template:Infobox machine because the building is automatically detected.
  • Input1Name, Input2Name, ..., Input6Name: Name of materials (example: Iron Ore)
    • Input1Name = Mining (optional): Applies special format for mining.
  • Output1Name, Output2Name, ... Output6Name: Name of products (example: Molten Iron)
    • Output1Name = Dumping (optional): Applies special format for dumping.
  • Input1Qty, ..., Input6Qty, Output1Qty, ..., Output6Qty: Amount of materials or products per 1 cycle of recipe.
  • Time: Cycle time of recipe.
  • Input1Unit, ..., Input6Unit, Output1Unit, ..., Output6Unit (optional): Adds unit (for Electricity and Mechanical Power)
  • HideBldg (optional, rare): Hides building in recipe. No need to specify on pages using Template:Infobox machine (the building is automatically hidden).
  • Unreleased = yes (optional, rare): Applies special format for unreleased recipe
Limitations
This template can accept up to 6 inputs, 6 outputs, and 1 time value per recipe. The output can include only 1 pollution.

Examples

Example usage for mining
Markup Renders as 
  {{Recipe
    | Input1Name  = Mining
    | Output1Name = Copper Ore
  }}
Mining.png
Transform.png
Copper Ore.png
Example usage for dumping loose materials
Markup Renders as 
  {{Recipe
    | Output1Name = Dumping
    | Input1Name  = Rock
  }}
Rock.png
Transform.png
Dumping.png
Example usage for a machine with both inputs and outputs without pollution (most recipes)
Markup Renders as 
  {{Recipe
    | Building    = Rotary Kiln
    | Input1Name  = Limestone
    | Input1Qty   = 12
    | Input2Name  = Coal
    | Input2Qty   = 2
    | Time        = 10
    | Output1Name = Cement
    | Output1Qty  = 4
    | Output2Name = Exhaust
    | Output2Qty  = 8
  }}
Rotary Kiln.pngCoal
:
12
Limestone.png
72
Plus.png
2
Coal.png
12
10 Clock.png
Transform.png
60 Clock 60s.png
4
Cement.png
24
Plus.png
8
Exhaust.png
48
Example for buildings that "provide" materials (Groundwater Pump, Air Separator, etc.)
Markup Renders as 
  {{Recipe
    | Building    = Groundwater Pump
    | Time        = 10
    | Output1Name = Water
    | Output1Qty  = 8
  }}
Groundwater Pump.png
:
PROVIDES
8
Water.png
48
/ 10 Clock.png

/ 60 Clock 60s.png
Example usage for dumping/flaring/venting non-polluting liquids/gasses
Markup Renders as 
  {{Recipe
    | Building    = Smoke Stack
    | Input1Name  = Oxygen
    | Input1Qty   = 200
    | Time        = 20
  }}
Smoke Stack.pngSmall
:
ACCEPTS
200
Oxygen.png
600
/ 20 Clock.png

/ 60 Clock 60s.png
Example usage for recipe with pollution
Markup Renders as 
  {{Recipe
    | Building    = Liquid Dump
    | Input1Name  = Waste Water
    | Input1Qty   = 2
    | Time        = 2
    | Output1Name = Water Pollution
    | Output1Qty  = 2
  }}
Liquid Dump.png
:
ACCEPTS
2
Waste Water.png
60
/ 2 Clock.png

/ 60 Clock 60s.png
 
2
Water Pollution.png
60
  {{Recipe
    | Building    = Exhaust Scrubber
    | Input1Name  = Exhaust
    | Input1Qty   = 30
    | Input2Name  = Water
    | Input2Qty   = 4
    | Time        = 10
    | Output1Name = Sulfur
    | Output1Qty  = 1
    | Output2Name = Carbon Dioxide
    | Output2Qty  = 12
    | Output3Name = Steam Lo
    | Output3Qty  = 4
    | Output4Name = Air Pollution
    | Output4Qty  = 4
  }}
Exhaust Scrubber.png
:
30
Exhaust.png
180
Plus.png
4
Water.png
24
10 Clock.png
Transform.png
60 Clock 60s.png
1
Sulfur.png
6
Plus.png
12
Carbon Dioxide.png
72
Plus.png
4
Steam Lo.png
24
 
4
Air Pollution.png
24
Example usage for Mechanical Power and Electricity recipes with units
Markup Renders as 
  {{Recipe
    | Building    = Low-pressure Turbine
    | Input1Name  = Steam Lo
    | Input1Qty   = 4
    | Time        = 5
    | Output1Name = Mechanical Power
    | Output1Qty  = 1
    | Output1Unit = MW
    | Output2Name = Steam Depleted
    | Output2Qty  = 4
  }}
Low-pressure Turbine.pngTier I
:
4
Steam Lo.png
48
5 Clock.png
Transform.png
60 Clock 60s.png
 
Mechanical Power.png
1 MW
Plus.png
4
Steam Depleted.png
48
Example usage for instantaneous recipes
Markup Renders as 
  {{Recipe
    | Building    = Power Generator
    | Input1Name  = Mechanical Power
    | Input1Qty   = 500
    | Input1Unit  = KW
    | Time        = 0
    | Output1Name = Electricity
    | Output1Qty  = 250
    | Output1Unit = KW
  }}
Power Generator.png
:
 
Mechanical Power.png
500 KW
Transform.png
 
Electricity.png
250 KW
Example usage for recipes with variable quantity
Markup Renders as 
  {{Recipe
    | Building    = Waste Collection
    | Time        = 60
    | Output1Name = Waste
    | Output1Unit = ?
  }}
Waste Collection.png
:
PROVIDES
?
Waste.png
?
/ 60 Clock.png

/ 60 Clock 60s.png
Example usage for hiding the building (automatically happens on pages using Template:Infobox machine)
Markup Renders as 
  {{Recipe
    | Building    = Mixer
    | HideBldg    = yes
    | Input1Name  = Sand
    | Input1Qty   = 18
    | Input2Name  = Limestone
    | Input2Qty   = 4
    | Input3Name  = Salt
    | Input3Qty   = 4
    | Time        = 20
    | Output1Name = Glass Mix
    | Output1Qty  = 14
  }}
18
Sand.png
54
Plus.png
4
Limestone.png
12
Plus.png
4
Salt.png
12
20 Clock.png
Transform.png
60 Clock 60s.png
14
Glass Mix.png
42
Example usage for unreleased recipe
Markup Renders as 
  {{Recipe
    | Building    = Crusher
    | Input1Name  = Gravel
    | Input1Qty   = 18
    | Time        = 20
    | Output1Name = Gold
    | Output1Qty  = 14
    | Unreleased  = yes
  }}
Crusher.png
:
20
Gravel.png
60
20 Clock.png
Transform.png
60 Clock 60s.png
1
Gold.png
3
UNRELEASED
The above text is transcluded from Template:Recipe draw/doc; you can change it or view its history. (How does this work?)
If you're done making changes, please refresh the text. (Why?)
You can experiment in this template's sandbox (create | mirror ) and testcases (create) pages.
Please add categories and interwikis to Template:Recipe draw/doc. (View all subpages of this page.)
Retrieved from "https://wiki.captain-of-industry.com/index.php?title=Template:Recipe_define&oldid=9392"