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)
m (Add a default value of {{{Name}}})
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:


{{Infobox material/sandbox
{{Infobox material
   | Name          = Construction Parts
   | Name          = Construction Parts
   | Type1          = Crafted material
   | Type1          = Crafted material
Line 8: Line 8:
}}
}}


The template accepts the following parameters:
== Usage and Parameters ==
This is a template to show basic information of items. The template accepts the following parameters:
;Basic parameters
;Basic parameters
:*<code>Name</code>: Name of items.
:*<code>Name</code>: Name of items. (Default: The name of the page.)
:*<code>Type1</code>, <code>Type2</code>: Types of items. It is used to categorize item in this wiki.
:*<code>Type1</code>, <code>Type2</code>: Types of items. It is used to categorize item in this wiki.
:*<code>State</code>: Loose, Fluid, Unit, Molten, or Virtual.
:*<code>State</code>: Loose, Fluid, Unit, Molten, or Virtual.
Line 35: Line 36:
:*<code>Description</code> (rare): To add an in-game description, though not currently implemented in-game.
:*<code>Description</code> (rare): To add an in-game description, though not currently implemented in-game.


== Categories set by this template ==
*[[:Category:Items]]: a category for all items applied this template
*Categories depending on <code>Type1</code> and <code>Type2</code>: example [[:Category:Natural resources]]
*[[:Category:Unit products]], [[:Category:Loose products]], [[:Category:Fluid products]], [[:Category:Molten products]], [[:Category:Virtual products]]
*[[:Category:Unstorable items]]: a category for items that cannot be stored any storage. (example {{infoicon|Steam (High)}})
*[[:Category:Items with unique transport or storage]]:
*:A category for maintenance of the wiki. It is applied items which "Transported by" or "Stored in" is overridden manually. If there are too many items in this category, the automatic assignment of these parameters by this template should be updated.


== Examples ==
== Examples ==
;Example usage for standard item
;Example usage for standard item
{{markup|<nowiki>
{{markup|<nowiki>
   {{Infobox material/sandbox
   {{Infobox material
     | Name          = Electronics III
     | Name          = Electronics III
     | Type1          = Crafted material
     | Type1          = Crafted material
Line 46: Line 54:
     | Variants      = [[Electronics]]<br>[[Electronics II]]
     | Variants      = [[Electronics]]<br>[[Electronics II]]
   }} </nowiki> |  
   }} </nowiki> |  
   {{Infobox material/sandbox
   {{Infobox material
     | Name          = Electronics III
     | Name          = Electronics III
     | Type1          = Crafted material
     | Type1          = Crafted material
Line 56: Line 64:
;Example usage for items that tracks cannot transport or storage cannot store
;Example usage for items that tracks cannot transport or storage cannot store
{{markup|<nowiki>
{{markup|<nowiki>
   {{Infobox material/sandbox
   {{Infobox material
     | Name          = Chilled Water
     | Name          = Chilled Water
     | State          = Fluid
     | State          = Fluid
Line 62: Line 70:
     | StoredIn      = none
     | StoredIn      = none
   }} </nowiki> |  
   }} </nowiki> |  
   {{Infobox material/sandbox
   {{Infobox material
     | Name          = Chilled Water
     | Name          = Chilled Water
     | State          = Fluid
     | State          = Fluid
Line 71: Line 79:
;Example usage for items that the shipyard cannot store
;Example usage for items that the shipyard cannot store
{{markup|<nowiki>
{{markup|<nowiki>
   {{Infobox material/sandbox
   {{Infobox material
     | Name            = Seawater
     | Name            = Seawater
     | Type1            = Natural resource
     | Type1            = Natural resource
Line 77: Line 85:
     | StoredInShipyard = no
     | StoredInShipyard = no
   }} </nowiki> |  
   }} </nowiki> |  
   {{Infobox material/sandbox
   {{Infobox material
     | Name            = Seawater
     | Name            = Seawater
     | Type1            = Natural resource
     | Type1            = Natural resource
Line 86: Line 94:
;Example usage for items having Radiation Level
;Example usage for items having Radiation Level
{{markup|<nowiki>
{{markup|<nowiki>
   {{Infobox material/sandbox
   {{Infobox material
     | Name            = Spent Fuel
     | Name            = Spent Fuel
     | Type1            = Radioactive waste
     | Type1            = Radioactive waste
Line 92: Line 100:
     | State            = Unit
     | State            = Unit
   }} </nowiki> |  
   }} </nowiki> |  
   {{Infobox material/sandbox
   {{Infobox material
     | Name            = Spent Fuel
     | Name            = Spent Fuel
     | Type1            = Radioactive waste
     | Type1            = Radioactive waste
Line 101: Line 109:
;Example usage for items stored in special storage
;Example usage for items stored in special storage
{{markup|<nowiki>
{{markup|<nowiki>
   {{Infobox material/sandbox
   {{Infobox material
     | Name            = Spent Fuel
     | Name            = Spent Fuel
     | Type1            = Radioactive waste
     | Type1            = Radioactive waste
Line 107: Line 115:
     | StoredIn        = [[Radioactive Waste Storage]]
     | StoredIn        = [[Radioactive Waste Storage]]
   }} </nowiki> |  
   }} </nowiki> |  
   {{Infobox material/sandbox
   {{Infobox material
     | Name            = Spent Fuel
     | Name            = Spent Fuel
     | Type1            = Radioactive waste
     | Type1            = Radioactive waste
Line 116: Line 124:
;Example usage for items stored in cargo modules
;Example usage for items stored in cargo modules
{{markup|<nowiki>
{{markup|<nowiki>
   {{Infobox material/sandbox
   {{Infobox material
     | Name                = Uranium Ore
     | Name                = Uranium Ore
     | Type1                = Natural resources
     | Type1                = Natural resources
Line 122: Line 130:
     | StoredInCargoModules = yes
     | StoredInCargoModules = yes
   }} </nowiki> |  
   }} </nowiki> |  
   {{Infobox material/sandbox
   {{Infobox material
     | Name                = Uranium Ore
     | Name                = Uranium Ore
     | Type1                = Natural resources
     | Type1                = Natural resources
Line 131: Line 139:
;Example usage for items created/used in non-production-machines
;Example usage for items created/used in non-production-machines
{{markup|<nowiki>
{{markup|<nowiki>
   {{Infobox material/sandbox
   {{Infobox material
     | Name            = Coal
     | Name            = Coal
     | Type1            = Natural resources
     | Type1            = Natural resources
Line 138: Line 146:
     | UsedIn          = Foo
     | UsedIn          = Foo
   }} </nowiki> |  
   }} </nowiki> |  
   {{Infobox material/sandbox
   {{Infobox material
     | Name            = Coal
     | Name            = Coal
     | Type1            = Natural resources
     | Type1            = Natural resources

Latest revision as of 13:07, 22 May 2023

Usage and Parameters

This is a template to show basic information of items. The template accepts the following parameters:

Basic parameters
  • Name: Name of items. (Default: The name of the page.)
  • 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.

Categories set by this template

Examples

Example usage for standard item
Markup Renders as
  {{Infobox material
    | 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
    | 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
    | Name             = Seawater
    | Type1            = Natural resource
    | State            = Fluid
    | StoredInShipyard = no
  }} 
Example usage for items having Radiation Level
Markup Renders as
  {{Infobox material
    | 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
    | 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
    | 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
    | Name             = Coal
    | Type1            = Natural resources
    | State            = Loose
    | CreatedIn        = [[Coal Mine]]
    | UsedIn           = Foo
  }}