Difference between revisions of "Template:Infobox material/doc"

From Captain of Industry Wiki
Jump to: navigation, search
(Automate "Created in" and "Used in", and add "Radiation level" and some parameters)
Line 1: Line 1:
{{Infobox material
 
| Name          = Cement
{{Infobox material/sandbox
| Image          = <!-- only if image override is needed -->
  | Name          = Construction Parts
| Description    = <!-- not currently implemented in-game -->
  | Type1          = Crafted material
| Type1          = Crafted material
  | State          = Unit
| State          = Loose <!-- Loose, Fluid, Unit, Molten, or Virtual -->
   | StartingQty    = Sailor: 987<br>Captain: 654<br>Admiral: 321
| CreatedIn      = [[Rotary Kiln]]
  | Variants       = [[Construction Parts II]]<br>[[Construction Parts III]]<br>[[Construction Parts IV]]
| UsedIn        = [[Concrete Mixer]]
| OtherTransport = <!-- to add an extra transport to auto-generated list -->
| OtherStorage   = <!-- to add an extra storage to auto-generated list -->
| TransportedBy  = <!-- only if transport override is needed. Set to "None" to suppress the field -->
| StoredIn      = <!-- only if storage override is needed. Set to "None" to suppress the field -->
| StartingQty    = Sailor: 450<br/>Captain: 300<br/>Admiral: 300
| Variants     = [[Cement]]
}}
}}
Example usage:<pre>
 
{{Infobox material
The template accepts the following parameters:
| Name         = Cement
;Basic parameters
| Image        = <!-- only if image override is needed -->
:*<code>Name</code>: Name of items.
| Description  = <!-- not currently implemented in-game -->
:*<code>Type1</code>, <code>Type2</code>: Types of items. It is used to categorize item in this wiki.
| Type1         = Crafted material
:*<code>State</code>: Loose, Fluid, Unit, Molten, or Virtual.
| State         = Loose <!-- Loose, Fluid, Unit, Molten, or Virtual -->
:*<code>Variants</code>: Variant of the items.
| CreatedIn    = [[Rotary Kiln]]
;Parameters for transportation
| UsedIn        = [[Concrete Mixer]]
:Buildings and vehicles for transporting are automatically listed depending on State. But, it should be modified with the following parameters in some cases.
| OtherTransport = <!-- to add an extra transport to auto-generated list -->
:*<code>TrackTransport</code>: Set no if tracks cannot transport the item (Default: yes).
| OtherStorage  = <!-- to add an extra storage to auto-generated list -->
:*<code>TransportedBy</code>(rare):  Only if transport override is needed.
| TransportedBy  = <!-- only if transport override is needed. Set to "None" to suppress the field -->
:*<code>OtherTransport</code>(rare): To add an extra transport to auto-generated list.
| StoredIn      = <!-- only if storage override is needed. Set to "None" to suppress the field -->
;Parameters for storage
| StartingQty  = Sailor: 450<br/>Captain: 300<br/>Admiral: 300
:Buildings for storing are automatically listed depending on State. But, it should be modified with the following parameters in some cases.
| Variants     = [[Cement]]
:*<code>StoredInShipyard</code>: Set no if the shipyard cannot store the items (Default: yes).
:*<code>StoredInCargoModules</code>: Set yes if cargo modules can store the items (Default: no).
:*<code>StoredIn</code>: Only if storage override is needed. Set to "None" to suppress the field.
:*<code>OtherStorage</code>(rare): To add an extra storage to auto-generated list.
;Parameters for buildings that creates/uses this item
:Buildings that create/use the item are automatically listed from the table made by [[Template:Recipe define]]. But, it should be added with the following parameters in some cases.
:*<code>CreatedIn</code>: To add an extra buildings to auto-generated list.
:*<code>UsedIn</code>: To add an extra buildings to auto-generated list.
;Miscellaneous parameters
:*<code>Radiation</code>: Radiation Level of the items.
:*<code>StartingQty</code>: The number of the items stored in the [[Shipyard]] on game start.
:*<code>Image</code> (rare): Only if image override is needed.
:*<code>Description</code> (rare): To add an in-game description, though not currently implemented in-game.
 
 
== Examples ==
;Example usage for standard item
{{markup|<nowiki>
  {{Infobox material/sandbox
    | Name          = Electronics III
    | Type1          = Crafted material
    | State          = Unit
    | StartingQty   = Sailor: 987<br>Captain: 654<br>Admiral: 321
    | Variants      = [[Electronics]]<br>[[Electronics II]]
  }} </nowiki> |
   {{Infobox material/sandbox
    | Name          = Electronics III
    | Type1          = Crafted material
    | State          = Unit
    | StartingQty    = Sailor: 987<br>Captain: 654<br>Admiral: 321
    | Variants       = [[Electronics]]<br>[[Electronics II]]
  }}
}}
;Example usage for items that tracks cannot transport or storage cannot store
{{markup|<nowiki>
  {{Infobox material/sandbox
    | Name          = Chilled Water
    | State          = Fluid
    | TrackTransport = no
    | StoredIn      = none
  }} </nowiki> |
  {{Infobox material/sandbox
    | Name          = Chilled Water
    | State          = Fluid
    | TrackTransport = no
    | StoredIn      = none
  }}
}}
;Example usage for items that the shipyard cannot store
{{markup|<nowiki>
  {{Infobox material/sandbox
    | Name            = Seawater
    | Type1            = Natural resource
    | State            = Fluid
    | StoredInShipyard = no
  }} </nowiki> |
  {{Infobox material/sandbox
    | Name            = Seawater
    | Type1            = Natural resource
    | State            = Fluid
    | StoredInShipyard = no
  }}
}}
;Example usage for items having Radiation Level
{{markup|<nowiki>
  {{Infobox material/sandbox
    | Name            = Spent Fuel
    | Type1            = Radioactive waste
    | Radiation        = 2
    | State            = Unit
  }} </nowiki> |
  {{Infobox material/sandbox
    | Name            = Spent Fuel
    | Type1            = Radioactive waste
    | Radiation        = 2
    | State            = Unit
  }}
}}
;Example usage for items stored in special storage
{{markup|<nowiki>
  {{Infobox material/sandbox
    | Name            = Spent Fuel
    | Type1            = Radioactive waste
    | State            = Unit
    | StoredIn        = [[Radioactive Waste Storage]]
  }} </nowiki> |
  {{Infobox material/sandbox
    | Name            = Spent Fuel
    | Type1            = Radioactive waste
    | State            = Unit
    | StoredIn        = [[Radioactive Waste Storage]]
  }}
}}
;Example usage for items stored in cargo modules
{{markup|<nowiki>
  {{Infobox material/sandbox
    | Name                = Uranium Ore
    | Type1                = Natural resources
    | State                = Loose
    | StoredInCargoModules = yes
  }} </nowiki> |
  {{Infobox material/sandbox
    | Name                = Uranium Ore
    | Type1                = Natural resources
    | State                = Loose
    | StoredInCargoModules = yes
  }}
}}
;Example usage for items created/used in non-production-machines
{{markup|<nowiki>
  {{Infobox material/sandbox
    | Name            = Coal
    | Type1            = Natural resources
    | State            = Loose
    | CreatedIn        = [[Coal Mine]]
    | UsedIn          = Foo
  }} </nowiki> |
  {{Infobox material/sandbox
    | Name            = Coal
    | Type1            = Natural resources
    | State            = Loose
    | CreatedIn        = [[Coal Mine]]
    | UsedIn          = Foo
  }}
}}
}}
</pre>
<includeonly>[[Category:Infobox templates|Material]]</includeonly><!--
<includeonly>[[Category:Infobox templates|Material]]</includeonly><!--
--><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
--><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Revision as of 03:22, 20 May 2023

The template accepts the following parameters:

Basic parameters
  • Name: Name of items.
  • Type1, Type2: Types of items. It is used to categorize item in this wiki.
  • State: Loose, Fluid, Unit, Molten, or Virtual.
  • Variants: Variant of the items.
Parameters for transportation
Buildings and vehicles for transporting are automatically listed depending on State. But, it should be modified with the following parameters in some cases.
  • TrackTransport: Set no if tracks cannot transport the item (Default: yes).
  • TransportedBy(rare): Only if transport override is needed.
  • OtherTransport(rare): To add an extra transport to auto-generated list.
Parameters for storage
Buildings for storing are automatically listed depending on State. But, it should be modified with the following parameters in some cases.
  • StoredInShipyard: Set no if the shipyard cannot store the items (Default: yes).
  • StoredInCargoModules: Set yes if cargo modules can store the items (Default: no).
  • StoredIn: Only if storage override is needed. Set to "None" to suppress the field.
  • OtherStorage(rare): To add an extra storage to auto-generated list.
Parameters for buildings that creates/uses this item
Buildings that create/use the item are automatically listed from the table made by Template:Recipe define. But, it should be added with the following parameters in some cases.
  • CreatedIn: To add an extra buildings to auto-generated list.
  • UsedIn: To add an extra buildings to auto-generated list.
Miscellaneous parameters
  • Radiation: Radiation Level of the items.
  • StartingQty: The number of the items stored in the Shipyard on game start.
  • Image (rare): Only if image override is needed.
  • Description (rare): To add an in-game description, though not currently implemented in-game.


Examples

Example usage for standard item
Markup Renders as
  {{Infobox material/sandbox
    | Name           = Electronics III
    | Type1          = Crafted material
    | State          = Unit
    | StartingQty    = Sailor: 987<br>Captain: 654<br>Admiral: 321
    | Variants       = [[Electronics]]<br>[[Electronics II]]
  }} 
Electronics III
Electronics III.png
TypeCrafted material
StateUnit
Transported byFlat Conveyor [IIIII]
PickupTruck
Stored inUnit Storage [IIIIIIV]
Shipyard
Created inAssembly (Robotic)
Assembly (Robotic) II
Used inAssembly (Robotic)
Assembly (Robotic) II
Maintenance III Depot
Starting amountSailor: 987
Captain: 654
Admiral: 321
VariantsElectronics
Electronics II
Example usage for items that tracks cannot transport or storage cannot store
Markup Renders as
  {{Infobox material/sandbox
    | Name           = Chilled Water
    | State          = Fluid
    | TrackTransport = no
    | StoredIn       = none
  }} 
Chilled Water
Chilled Water.png
StateFluid
Transported byPipe [IIIII]
Stored inNone
Created inWater Chiller
Used inNone
Example usage for items that the shipyard cannot store
Markup Renders as
  {{Infobox material/sandbox
    | Name             = Seawater
    | Type1            = Natural resource
    | State            = Fluid
    | StoredInShipyard = no
  }} 
Example usage for items having Radiation Level
Markup Renders as
  {{Infobox material/sandbox
    | Name             = Spent Fuel
    | Type1            = Radioactive waste
    | Radiation        = 2
    | State            = Unit
  }} 
Spent Fuel
Spent Fuel.png
TypeRadioactive waste
StateUnit
Radiation Level2
Transported byFlat Conveyor [IIIII]
PickupTruck
Stored inUnit Storage [IIIIIIV]
Shipyard
Created inNuclear Reactor
Nuclear Reactor II
Used inNuclear Reprocessing Plant
Example usage for items stored in special storage
Markup Renders as
  {{Infobox material/sandbox
    | Name             = Spent Fuel
    | Type1            = Radioactive waste
    | State            = Unit
    | StoredIn         = [[Radioactive Waste Storage]]
  }} 
Spent Fuel
Spent Fuel.png
TypeRadioactive waste
StateUnit
Transported byFlat Conveyor [IIIII]
PickupTruck
Stored inRadioactive Waste Storage
Created inNuclear Reactor
Nuclear Reactor II
Used inNuclear Reprocessing Plant
Example usage for items stored in cargo modules
Markup Renders as
  {{Infobox material/sandbox
    | Name                 = Uranium Ore
    | Type1                = Natural resources
    | State                = Loose
    | StoredInCargoModules = yes
  }} 
Uranium Ore
Uranium Ore.png
TypeNatural resources
StateLoose
Transported byU-shape Conveyor [IIIII]
PickupTruck
Haul Truck (Dump)
Stored inLoose Storage [IIIIIIV]
Shipyard
Loose Module (S) [ML]
Created inNone
Used inCrusher
Crusher (Large)
Example usage for items created/used in non-production-machines
Markup Renders as
  {{Infobox material/sandbox
    | Name             = Coal
    | Type1            = Natural resources
    | State            = Loose
    | CreatedIn        = [[Coal Mine]]
    | UsedIn           = Foo
  }}