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

From Captain of Industry Wiki
Jump to: navigation, search
Line 75: Line 75:
                   -->| loose    = {{variants|Loose Storage}}<!--
                   -->| loose    = {{variants|Loose Storage}}<!--
                     -->{{#ifeq: {{{StoredInShipyard|yes}}} | no ||<br/>[[Shipyard]]}}<!--
                     -->{{#ifeq: {{{StoredInShipyard|yes}}} | no ||<br/>[[Shipyard]]}}<!--
                     -->{{#ifeq: {{{StoredInCargoModule|no}}} | yes |<br/>{{variants|Loose Module}}}}<!--
                     -->{{#ifeq: {{{StoredInCargoModules|no}}} | yes |<br/>{{variants|Loose Module}}}}<!--
                   -->| fluid    = {{variants|Fluid Storage}}<!--
                   -->| fluid    = {{variants|Fluid Storage}}<!--
                     -->{{#ifeq: {{{StoredInShipyard|yes}}} | no ||<br/>[[Shipyard]]}}<!--
                     -->{{#ifeq: {{{StoredInShipyard|yes}}} | no ||<br/>[[Shipyard]]}}<!--
                     -->{{#ifeq: {{{StoredInCargoModule|no}}} | yes |<br/>{{variants|Fluid Module}}}}<!--
                     -->{{#ifeq: {{{StoredInCargoModules|no}}} | yes |<br/>{{variants|Fluid Module}}}}<!--
                   -->| unit    = {{variants|Unit Storage}}<!--
                   -->| unit    = {{variants|Unit Storage}}<!--
                     -->{{#ifeq: {{{StoredInShipyard|yes}}} | no ||<br/>[[Shipyard]]}}<!--
                     -->{{#ifeq: {{{StoredInShipyard|yes}}} | no ||<br/>[[Shipyard]]}}<!--
                     -->{{#ifeq: {{{StoredInCargoModule|no}}} | yes |<br/>{{variants|Unit Module}}}}<!--
                     -->{{#ifeq: {{{StoredInCargoModules|no}}} | yes |<br/>{{variants|Unit Module}}}}<!--
                   -->| molten  = None<!--
                   -->| molten  = None<!--
                   -->| virtual  = [[Virtual product|Ethereal plane]]<!--
                   -->| virtual  = [[Virtual product|Ethereal plane]]<!--
Line 163: Line 163:
--></includeonly><noinclude>
--></includeonly><noinclude>


{{Infobox material/sandbox
== Parameters ==
  <!-- Basic arguments -->
The template accepts the following parameters:
  | Name               = Construction Parts
;Basic parameters
  | Image              = <!-- only if image override is needed -->
:*<code>Name</code>: Name of items (example: Construction Parts).
  | Description        = Foo  <!-- 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.
  | Type2               =
::<nowiki>*</nowiki> Virtual means items are never transported. (example: Electricity)
  | State               = Unit  <!-- Loose, Fluid, Unit, Molten, or Virtual -->
:*<code>Variants</code>: Variant of the items.
  | StartingQty        = Sailor: 987<br/>Captain: 654<br/>Admiral: 321
;Advanced parameters
  | Variants           = [[Construction Parts II]]<br/>[[Construction Parts III]]<br/>[[Construction Parts IV]]
:*<code>TrackTransport</code>: Set no if tracks cannot transport the item (Default: yes).
  | TrackTransport     = yes  <!-- Set no if tracks cannot transport the item (Default: yes). -->
:*<code>StoredInShipyard</code>: Set no if the shipyard cannot store the item (Default: yes).
:*<code>StoredInCargoModules</code>: Set yes if cargo modules can store the item (Default: no).
:*<code>StoredIn</code>: Only if storage override is needed. Set to "None" to suppress the field.
:*<code>CreatedIn</code>: To add an extra buildings to auto-generated list.
:*<code>UsedIn</code>:  To add an extra buildings to auto-generated list.
:*<code>StartingQty</code>: The number of items stored in the [[Shipyard]] on game start.
;Rarely used parameters
:*<code>TransportedBy</code>:  Only if transport override is needed.
:*<code>OtherTransport</code>: To add an extra transport to auto-generated list.
:*<code>OtherStorage</code>: To add an extra storage to auto-generated list
:*<code>Image</code>: Only if image override is needed.
:*<code>Description</code>: To add an in-game description, though not currently implemented in-game.


  <!-- Arguments for storage -->
  | StoredInShipyard    = yes  <!-- Set no if the shipyard cannot store the item (Default: yes). -->
  | StoredInCargoModule = no  <!-- Set yes if cargo modules can store the item (Default: no). -->
  | OtherStorage        = <!-- to add an extra storage to auto-generated list -->
  | StoredIn            = <!-- only if storage override is needed. Set to "None" to suppress the field -->


  <!-- Arguments for transporting -->
== Examples ==
   | OtherTransport      = <!-- to add an extra transport to auto-generated list -->
;Example usage for standard item
  | TransportedBy       = <!-- only if transport override is needed. Set to "None" to suppress the field -->
{{markup|<nowiki>
 
   {{Infobox material/sandbox
   <!-- Arguments for buildings which create/use this item -->
    | Name          = Construction Parts II
   | CreatedIn           = <!-- to add an extra buildings to auto-generated list -->
    | Type1          = Crafted material
  | UsedIn              = <!-- to add an extra buildings to auto-generated list -->
    | State          = Unit
    | StartingQty    = Sailor: 987<br/>Captain: 654<br/>Admiral: 321
    | Variants       = [[Construction Parts II]]<br/>[[Construction Parts III]]<br/>[[Construction Parts IV]]
   }} </nowiki> |
   {{Infobox material/sandbox
    | Name           = Construction Parts II
    | Type1          = Crafted material
    | State          = Unit
    | StartingQty    = Sailor: 987<br/>Captain: 654<br/>Admiral: 321
    | Variants      = [[Construction Parts II]]<br/>[[Construction Parts III]]<br/>[[Construction Parts IV]]
  }}
}}
}}
Example usage:<pre>
;Example usage for items that tracks cannot transport or storage cannot store
{{Infobox material/sandbox
{{markup|<nowiki>
  <!-- Basic arguments -->
  {{Infobox material/sandbox
  | Name               = Construction Parts
    | Name           = Chilled Water
  | Image              = <!-- only if image override is needed -->
    | State         = Fluid
  | Description        = Foo  <!-- not currently implemented in-game -->
    | TrackTransport = no
  | Type1              = Crafted material
    | StoreIn        = no
  | Type2              =
   }} </nowiki> |  
  | State               = Unit  <!-- Loose, Fluid, Unit, Molten, or Virtual -->
   {{Infobox material/sandbox
  | StartingQty        = Sailor: 987<br/>Captain: 654<br/>Admiral: 321
    | Name           = Chilled Water
  | Variants            = [[Construction Parts II]]<br/>[[Construction Parts III]]<br/>[[Construction Parts IV]]
    | State         = Fluid
  | TrackTransport     = yes  <!-- Set no if tracks cannot transport the item (Default: yes). -->
    | TrackTransport = no
 
    | StoreIn       = no
  <!-- Arguments for storage -->
   }}
  | StoredInShipyard    = yes  <!-- Set no if the shipyard cannot store the item (Default: yes). -->
  | StoredInCargoModule = no
   | OtherStorage        = <!-- to add an extra storage to auto-generated list -->
  | StoredIn            = <!-- only if storage override is needed. Set to "None" to suppress the field -->
 
  <!-- Arguments for transporting -->
  | OtherTransport      = <!-- to add an extra transport to auto-generated list -->
  | TransportedBy      = <!-- only if transport override is needed. Set to "None" to suppress the field -->
 
  <!-- Arguments for buildings which create/use this item -->
  | CreatedIn          = <!-- to add an extra buildings to auto-generated list -->
   | UsedIn              = <!-- to add an extra buildings to auto-generated list -->
}}
</pre>
{{Infobox material/sandbox
  <!-- Basic arguments -->
  | Name               = Not Water
  | Image              = Water.png
  | State               = Fluid
  | TrackTransport     = yes
  | StoredIn            = none
 
  <!-- Arguments for storage -->
  | StoredInShipyard    = no
  | StoredInCargoModule = yes
  | OtherStorage       = SSS
 
   <!-- Arguments for transporting -->
  | OtherTransport      = TTT
  | CreatedIn          = CCC
  | UsedIn              = UUU
}}
}}
{{Infobox material/sandbox
;Example usage for items that the shipyard cannot store
   <!-- Basic arguments -->
{{markup|<nowiki>
   | Name               = Steam (High)
  {{Infobox material/sandbox
  | State               = Fluid
    | Name            = Seawater
  | TrackTransport      = no
    | Type1            = Natural resource
   | StoredIn            = none
    | State            = Fluid
    | StoredInShipyard = no
   }} </nowiki> |
   {{Infobox material/sandbox
    | Name             = Seawater
    | Type1            = Natural resource
    | State           = Fluid
    | StoredInShipyard = no
   }}
}}
}}
{{Infobox material/sandbox
;Example usage for items stored in special storage
   <!-- Basic arguments -->
{{markup|<nowiki>
   | Name               = Steam (High)
  {{Infobox material/sandbox
  | State              = Fluid
    | Name            = Spent Fuel
  | TransportedBy      = TXX
    | Type1            = Radioactive waste
  | StoredIn           = none
    | State            = Unit
    | StoredIn        = [[Radioactive Waste Storage]]
   }} </nowiki> |
   {{Infobox material/sandbox
    | Name             = Spent Fuel
    | Type1            = Radioactive waste
    | State            = Unit
    | StoredIn         = [[Radioactive Waste Storage]]
  }}
}}
}}
{{Infobox material/sandbox
;Example usage for items stored in cargo modules
   <!-- Basic arguments -->
{{markup|<nowiki>
   | Name                = Iron Ore
  {{Infobox material/sandbox
  | State               = Loose
    | Name                = Uranium Ore
  | CreatedIn          = Excavator
    | Type1                = Natural resources
    | State                = Loose
    | StoredInCargoModules = yes
   }} </nowiki> |
   {{Infobox material/sandbox
    | Name                 = Uranium Ore
    | Type1               = Natural resources
    | State               = Loose
    | StoredInCargoModules = yes
  }}
}}
}}
{{Infobox material/sandbox
;Example usage for items created/used in non-production-machines
   <!-- Basic arguments -->
{{markup|<nowiki>
   | Name               =  
  {{Infobox material/sandbox
  | State               = Loose
    | Name            = Iron Ore
    | Type1            = Natural resources
    | State            = Unit
    | CreatedIn        = [[Excavator]]
    | UsedIn          = [[Stacker]]
   }} </nowiki> |
   {{Infobox material/sandbox
    | Name             = Iron Ore
    | Type1            = Natural resources
    | State           = Unit
    | CreatedIn        = [[Excavator]]
    | UsedIn          = [[Stacker]]
  }}
}}
}}

Revision as of 10:40, 19 May 2023


Parameters

The template accepts the following parameters:

Basic parameters
  • Name: Name of items (example: Construction Parts).
  • Type1, Type2: Types of items. It is used to categorize item in this wiki.
  • State: Loose, Fluid, Unit, Molten, or Virtual.
* Virtual means items are never transported. (example: Electricity)
  • Variants: Variant of the items.
Advanced parameters
  • TrackTransport: Set no if tracks cannot transport the item (Default: yes).
  • StoredInShipyard: Set no if the shipyard cannot store the item (Default: yes).
  • StoredInCargoModules: Set yes if cargo modules can store the item (Default: no).
  • StoredIn: Only if storage override is needed. Set to "None" to suppress the field.
  • CreatedIn: To add an extra buildings to auto-generated list.
  • UsedIn: To add an extra buildings to auto-generated list.
  • StartingQty: The number of items stored in the Shipyard on game start.
Rarely used parameters
  • TransportedBy: Only if transport override is needed.
  • OtherTransport: To add an extra transport to auto-generated list.
  • OtherStorage: To add an extra storage to auto-generated list
  • Image: Only if image override is needed.
  • Description: 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           = Construction Parts II
    | Type1          = Crafted material
    | State          = Unit
    | StartingQty    = Sailor: 987<br/>Captain: 654<br/>Admiral: 321
    | Variants       = [[Construction Parts II]]<br/>[[Construction Parts III]]<br/>[[Construction Parts IV]]
  }} 
Construction Parts II
Construction Parts II.png
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
    | StoreIn        = no
  }} 
Chilled Water
Chilled Water.png
StateFluid
Transported byPipe [IIIII]
Stored inFluid Storage [IIIIIIV]
Shipyard
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 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]
PickupTruckHaul 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             = Iron Ore
    | Type1            = Natural resources
    | State            = Unit
    | CreatedIn        = [[Excavator]]
    | UsedIn           = [[Stacker]]
  }} 
Iron Ore
Iron Ore.png
TypeNatural resources
StateUnit
Transported byFlat Conveyor [IIIII]
PickupTruck
Stored inUnit Storage [IIIIIIV]
Shipyard
Created inDesignations
Excavator
Used inBlast Furnace
Crusher
Crusher (Large)
Designations
Stacker