Template:Infobox/sandbox/doc: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Copy of current doc)
 
(Added asteroid-collection-area, asteroid-collection-arm-speed, asteroid-collection-arm-count)
 
(8 intermediate revisions by the same user not shown)
Line 17: Line 17:
|stack-size=50
|stack-size=50
|wire-reach=9
|wire-reach=9
|supply-area=7x7
|supply-area=7×7
|recipe=Time, 0.5 + Steel plate, 2 + Copper plate, 2
|recipe=Time, 0.5 + Steel plate, 2 + Copper plate, 2
|required-technologies=Electric energy distribution 1
|required-technologies=Electric energy distribution 1
|producers=Manual + Assembling machine
|producers=Player + Assembling machine
}}
}}
<noinclude>[[Category:Infobox page]]</noinclude>
<noinclude>[[Category:Infobox page]]</noinclude>
Line 31: Line 31:
If you need further help, contact a wiki admin or look at existing examples, on actual pages.
If you need further help, contact a wiki admin or look at existing examples, on actual pages.


 
== Syntax ==
== Recipe syntax ==
=== Recipe ===


The "recipe" parameter should be used as follows:
The "recipe" parameter should be used as follows:
Line 47: Line 47:
Separate multiple items with '''+'''.
Separate multiple items with '''+'''.


=== Technology trigger ===
The "technology-trigger" parameter should be used as follows:
<code>|technology-trigger = trigger-type: Item, count</code>
The trigger type can be one of the following:
* <code>mine-entity</code>
* <code>build-entity</code>
* <code>craft-item</code>
* <code>capture-spawner</code>
* <code>create-space-platform</code>
* <code>send-item-to-orbit</code>
The items and counts are optional, when they are left out then the colon after the trigger-type should also be removed.
<code>|technology-trigger = capture-spawner</code>
=== Quality ===
If a property is affected by quality, add the quality template around the different numbers for the quality levels. For example, the max health of an entity is affected by quality and formatted as follows:
<code><nowiki>|health = {{Quality|200|260|320|380|500}}</nowiki></code>
Because quality solely adds information to base game items and does not override or remove values, it is applied directly to the base properties (without space-age) and does not require "changed-by-space-age-mod" to be set.


== Parameters ==
== Parameters ==
Line 61: Line 85:
! Parameter !! Value
! Parameter !! Value
|-
|-
|  <span style="color:#FF0000"> category </span> || The category the object fits into, same as the inventory tabs. Valid choices are Logistics, Production, Intermediate products, Combat, Technology.
|  <span style="color:#FF0000"> category </span> || The category the object fits into, same as the inventory tabs. Valid choices are Logistics, Production, Intermediate products, Space, Combat, Technology.
|-
|-
| name || The name of the object, default is the page name. '''Do not specify name if not necessary, to avoid translation issues.'''
| name || The name of the object, default is the page name. '''Do not specify name if not necessary, to avoid translation issues.'''
Line 76: Line 100:
|-
|-
| extra2 || Add an extra row below all others, for misc purpose. '''Do not use templates here!'''
| extra2 || Add an extra row below all others, for misc purpose. '''Do not use templates here!'''
|-
| space-age ||  Either the string <code>yes</code>, <code>no</code> or nothing. Determines whether to display a symbol in infobox that shows whether the object is exclusive to Space Age ( <code>yes</code>) or only available if Space Age is deactivated (<code>no</code>). Most objects are available with and without Space Age, in that case this parameter should be left out.
|-
| changed-by-space-age-mod || Set to <code>yes</code> when the object always exists, but properties of the object are changed by toggling the Space Age mod, such as the recipe or tech cost.
|-
|-
| recipe || The recipe of the object in normal mode. See recipe syntax above for more info.
| recipe || The recipe of the object in normal mode. See recipe syntax above for more info.
|-
|-
| total-raw || The raw recipe of the object in normal mode. See recipe syntax above.
| total-raw || The raw recipe of the object in normal mode. See recipe syntax above. Defaults to <code>recipe</code>.
|-
|-
| expensive-recipe || The recipe of the object in expensive mode. See recipe syntax above for more info. Creates new tab in the infobox when used.
| space-age-recipe || The altered recipe of the object when the Space Age mod is active. See recipe syntax above for more info. Defaults to <code>recipe</code>. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
|-
| expensive-total-raw || The raw recipe of the object in expensive. See recipe syntax above. Creates new tab in the infobox if expensive-recipe doesn't exist but expensive-total-raw does. It then shows the normal recipe and the expensive total raw in the expensive tab.
| space-age-total-raw || The altered raw recipe of the object when the Space Age mod is active. See recipe syntax above. Defaults to <code>space-age-recipe</code> if set, otherwise defaults to <code>total-raw</code>.. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
|-
| map-color || The map color of the entity.
| map-color || The map color of the entity.
Line 93: Line 121:
| walking-speed || The walking speed of the entity.  
| walking-speed || The walking speed of the entity.  
|-
|-
| storage-size || The storage size of the entity, in spaces.
| storage-size || The inventory storage size of the entity, in slots.
|-
| space-age-storage-size ||The inventory storage size of the entity when the Space Age mod is active, in slots. Defaults to <code>storage-size</code> if not set, set to "none" to hide the row completely instead. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
|-
| fluid-storage-volume || Fluid storage volume of the entity, in units. Also used for entities that do not strictly store fluid, such as pipes.
| fluid-storage-volume || Fluid storage volume of the entity, in units. Also used for entities that do not strictly store fluid, such as pipes.
Line 112: Line 142:
|-
|-
| stack-size || How many of the object fit into a stack.
| stack-size || How many of the object fit into a stack.
|-
| space-age-stack-size || How many of the object fit into a stack when the Space Age mod is active. Defaults to <code>stack-size</code> if not set, set to "none" to hide the row completely instead. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
| rocket-capacity || How many of the object fit into one rocket.
|-
|-
| range || The range of the weapon, in tiles.
| range || The range of the weapon, in tiles.
Line 152: Line 186:
|-
|-
| charging-stations || The number of charging stations on the entity.
| charging-stations || The number of charging stations on the entity.
|-
| rotation-speed || The rotation speed of the inserter, should use °/s as the unit.
|-
|-
| belt-speed || The speed of the belt, should use Items/s as the unit.
| belt-speed || The speed of the belt, should use Items/s as the unit.
|-
| asteroid-collection-area || The collection area of the asteroid collector.
|-
| asteroid-collection-arm-speed || The collection arm max speed of the asteroid collector, should use km/h as the unit.
|-
| asteroid-collection-arm-count || The collection arm count of the asteroid collector.
|-
|-
| movement-bonus || General movement speed bonus.
| movement-bonus || General movement speed bonus.
Line 162: Line 204:
|-
|-
| power-output || Same as above, but for output.
| power-output || Same as above, but for output.
|-
| heat-output || Heat output of the reactor (or reactor-like) entity.
|-
|-
| maximum-temperature || The maximum temperature of the entity.
| maximum-temperature || The maximum temperature of the entity.
Line 186: Line 230:
|-
|-
| productivity || The productivity bonus of this module.
| productivity || The productivity bonus of this module.
|-
| quality || The quality bonus/penalty of this module.
|-
|-
| fuel-value || The amount of energy can be obtained by using this as fuel
| fuel-value || The amount of energy can be obtained by using this as fuel
Line 201: Line 247:
| pollution || The pollution generated by the object.
| pollution || The pollution generated by the object.
|-
|-
| weight || The weight of this rolling stock or vehicle.
| buildable-on || The only space locations that this entity can be placed on, e.g. "Nauvis + Gleba" or "Space platform".
|-
|-
| modules || Number of module slots.
| crafted-on || The only space locations that this recipe can be crafted on, e.g. "Nauvis + Gleba" or "Space platform".
|-
| spoil-time || The spoil time of the item, in minutes, e.g. 3.
|-
|-
| equipment || Equipment that can be put into this objects equipment grid.
| spoil-result || The spoil time of the item, e.g. "Iron plate, 2" or "Spoilage".
|-
|-
| allows || What other technologies the tech allows.
| vehicle-weight || The weight of this rolling stock or vehicle.
|-
|-
| effects || Items unlocked by researching this technology.
| modules || Number of module slots.
|-
|-
| required-technologies || Technologies required to access the tech or object.
| equipment || Equipment that can be put into this objects equipment grid.
|-
|-
| boosting-technologies || What technologies boost the object.
| boosting-technologies || What technologies boost the object.
|-
|-
| producers || What entities (machines) produce the object.
| producers || What entities (machines) produce the object.
|-
| space-age-producers || What entities (machines) produce the object when the Space Age mod is active. Defaults to <code>producers</code> if not set, set to "none" to hide the row completely instead. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
|-
| consumers || What recipes consume the object.
| consumers || What recipes consume the object.
|-
| space-age-consumers || What recipes consume the object when the Space Age mod is active. Defaults to <code>consumers</code> if not set, set to "none" to hide the row completely instead. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
|-
| valid-fuel || Which items this entity can use as fuel.
| valid-fuel || Which items this entity can use as fuel.
|-
|-
| used-as-fuel-by || What entities this item can be used in as fuel.
| used-as-fuel-by || What entities this item can be used in as fuel.
|-
| recycling-results || What the results are when this item is recycled.
|-
|-
| cost || The cost to research the technology.
| cost || The cost to research the technology.
Line 227: Line 281:
| cost-multiplier || How many times the cost must be paid to research the tech fully.
| cost-multiplier || How many times the cost must be paid to research the tech fully.
|-
|-
| expensive-cost-multiplier || How many times the cost must be paid to research the tech fully in expensive mode. Creates a new tab in the infobox when used.
| space-age-cost || The altered cost to research the technology when the Space Age mod is active. Defaults to <code>cost</code> if not set, set to "none" to hide the row completely instead. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
| space-age-cost-multiplier || How many times the cost must be paid to research the tech fully when the Space Age mod is active. Defaults to <code>cost-multiplier</code>. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
| technology-trigger || The trigger that unlocks this technology, such as mining an entity. Shown as "Researched by" in the technology tree.
|-
| space-age-technology-trigger|| The altered trigger that unlocks this technology when the Space Age mod is active. Defaults to <code>technology-trigger</code> if not set, set to "none" to hide the row completely instead. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
| allows || What other technologies the tech allows.
|-
| effects || Items unlocked by researching this technology.
|-
| required-technologies || Technologies required to access the tech or object.
|-
| space-age-allows || What other technologies the tech allows when the Space Age mod is active. Defaults to <code>allows</code> if not set, set to "none" to hide the row completely instead. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
| space-age-effects || Items unlocked by researching this technology when the Space Age mod is active. Defaults to <code>effects</code> if not set, set to "none" to hide the row completely instead. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
| space-age-required-technologies || Technologies required to access the tech or object when the Space Age mod is active. Defaults to <code>required-technologies</code> if not set, set to "none" to hide the row completely instead. Needs <code>changed-by-space-age-mod</code> to be set to be shown.
|-
|-
|}
|}


</div></div>
</div></div>

Latest revision as of 20:31, 1 November 2024

This template is designed to be used to describe an item or machine, using a box of info.

This template uses functions from Module:Infobox.

Usage

To use, create a page in the infobox namespace by prepending Infobox: to the page you are trying to add an infobox to, so that the new pages is called Infobox:(whatever the page name is). Then, on the page, add the line {{:Infobox:Page_name}}. This will "copy" the infobox you create on Infobox:... to the page itself. Of course, replace Page_name with the name of the page.

As for the infobox on Infobox:..., start with the line: {{Infobox. Then, on the next few lines, start with the pipe character, |, then place a parameter, and set it equal to the value you wish it to be. Then, end the parameter lines with two curly-brackets. "}}", and the line <noinclude>[[Category:Infobox page]]</noinclude>.

Example working box:

{{Infobox
|category = Logistics
|health=100
|stack-size=50
|wire-reach=9
|supply-area=7×7
|recipe=Time, 0.5 + Steel plate, 2 + Copper plate, 2
|required-technologies=Electric energy distribution 1
|producers=Player + Assembling machine
}}
<noinclude>[[Category:Infobox page]]</noinclude>

Additionally, the infobox will automatically translate. Just "copy" the infobox (the same way, from Infobox:...) to the page, as done for the English page. ({{:Infobox:Page name}})


If you need further help, contact a wiki admin or look at existing examples, on actual pages.

Syntax

Recipe

The "recipe" parameter should be used as follows:


|recipe = wood, 4 = wooden chest, 1

Basically,

item1, quantity = output item, quantity.

Separate multiple items with +.

Technology trigger

The "technology-trigger" parameter should be used as follows:

|technology-trigger = trigger-type: Item, count

The trigger type can be one of the following:

  • mine-entity
  • build-entity
  • craft-item
  • capture-spawner
  • create-space-platform
  • send-item-to-orbit

The items and counts are optional, when they are left out then the colon after the trigger-type should also be removed. |technology-trigger = capture-spawner

Quality

If a property is affected by quality, add the quality template around the different numbers for the quality levels. For example, the max health of an entity is affected by quality and formatted as follows:

|health = {{Quality|200|260|320|380|500}}

Because quality solely adds information to base game items and does not override or remove values, it is applied directly to the base properties (without space-age) and does not require "changed-by-space-age-mod" to be set.

Parameters

A list of valid parameters is provided below. Since this infobox is general purpose, not all must be used, however some are required. Required parameters are shown in red. Please be as descriptive as possible when making infoboxes.

Tip: This is a large table. After expanding, use CTRL + F in most browsers to search through this table easily.

Available Parameters

Parameter Value
category The category the object fits into, same as the inventory tabs. Valid choices are Logistics, Production, Intermediate products, Space, Combat, Technology.
name The name of the object, default is the page name. Do not specify name if not necessary, to avoid translation issues.
icon Specify the icon of the object, give the name of the file without the extension. This is only necessary if the icon fails to display properly.
internal-name The internal name of the entity. Only use plain text here.
prototype-type The prototype type of the entity. Only use plain text here.
image An in-game image of the entity, without file extension (.png etc)
extra1 Add an extra row above all others, for misc purpose. Do not use templates here!
extra2 Add an extra row below all others, for misc purpose. Do not use templates here!
space-age Either the string yes, no or nothing. Determines whether to display a symbol in infobox that shows whether the object is exclusive to Space Age ( yes) or only available if Space Age is deactivated (no). Most objects are available with and without Space Age, in that case this parameter should be left out.
changed-by-space-age-mod Set to yes when the object always exists, but properties of the object are changed by toggling the Space Age mod, such as the recipe or tech cost.
recipe The recipe of the object in normal mode. See recipe syntax above for more info.
total-raw The raw recipe of the object in normal mode. See recipe syntax above. Defaults to recipe.
space-age-recipe The altered recipe of the object when the Space Age mod is active. See recipe syntax above for more info. Defaults to recipe. Needs changed-by-space-age-mod to be set to be shown.
space-age-total-raw The altered raw recipe of the object when the Space Age mod is active. See recipe syntax above. Defaults to space-age-recipe if set, otherwise defaults to total-raw.. Needs changed-by-space-age-mod to be set to be shown.
map-color The map color of the entity.
map-icon The map icon of the entity.
added-in The version the object was added into the game.
walking-speed The walking speed of the entity.
storage-size The inventory storage size of the entity, in slots.
space-age-storage-size The inventory storage size of the entity when the Space Age mod is active, in slots. Defaults to storage-size if not set, set to "none" to hide the row completely instead. Needs changed-by-space-age-mod to be set to be shown.
fluid-storage-volume Fluid storage volume of the entity, in units. Also used for entities that do not strictly store fluid, such as pipes.
lifespan The lifespan of a deployed capsule in seconds.
expected-resources Resources expected to be dropped when this entity (tree/rock) is mined.
health The health points of the entity.
restores The amount of health the item restores.
resistance The elemental/physical resistances of the object. Resistances should be shown as such: point_resistance/10% Fire
inventory-size-bonus The inventory size bonus provided by the item.
grid-size The size of the grid for armor modules.
stack-size How many of the object fit into a stack.
space-age-stack-size How many of the object fit into a stack when the Space Age mod is active. Defaults to stack-size if not set, set to "none" to hide the row completely instead. Needs changed-by-space-age-mod to be set to be shown.
rocket-capacity How many of the object fit into one rocket.
range The range of the weapon, in tiles.
shooting-speed The shooting speed of the weapon.
damage The damage dealt by the object.
damage-bonus The damage bonus provided by the technology or weapon.
cluster-size The size of the cluster.
area-of-affect-size The size of the area of effect of the object.
durability The durability of the object.
ammunition What type of ammo the weapon consumes.
used-as-ammo-by Which entities use this ammo.
magazine-size The number of bullets contained in the magazine.
efficiency The efficiency.
dimensions The size of the entity, in tiles.
energy The energy consumption of the entity.
drain The passive electricity drain of the entity.
robot-recharge-rate The rate at which the object recharges robots.
internal-buffer-recharge-rate The rate at which the object fills it's internal buffer.
equipped-in Which objects with equipments grids this item can be placed in.
robot-limit Limit of robots that can fit inside the entity.
repair-speed The repair speed of the object.
charging-stations The number of charging stations on the entity.
rotation-speed The rotation speed of the inserter, should use °/s as the unit.
belt-speed The speed of the belt, should use Items/s as the unit.
asteroid-collection-area The collection area of the asteroid collector.
asteroid-collection-arm-speed The collection arm max speed of the asteroid collector, should use km/h as the unit.
asteroid-collection-arm-count The collection arm count of the asteroid collector.
movement-bonus General movement speed bonus.
energy-capacity How much electricity the object can hold.
power-input How much electricity the object can intake.
power-output Same as above, but for output.
heat-output Heat output of the reactor (or reactor-like) entity.
maximum-temperature The maximum temperature of the entity.
fluid-consumption The fluid consumption of this entity. When possible in x/s.
shield The amount of shielding this shielding equipment provides.
energy-per-hitpoint How much energy is needed to recharge 1 hitpoint of this shield equipment.
maximum-recharge-speed The max recharge speed of this shield equipment.
crafting-speed The crafting speed of the entity.
pumping-speed The pumping speed of this entity.
mining-time The time it takes to mine the object.
mining-speed The mining speed of the object.
mining-area The mining area of the entity.
speed The speed bonus/penalty of this module.
productivity The productivity bonus of this module.
quality The quality bonus/penalty of this module.
fuel-value The amount of energy can be obtained by using this as fuel
vehicle-acceleration The vehicle acceleration this fuel provides, e.g 180%
vehicle-top-speed The vehicle top speed this fuel provides, e.g 115%
supply-area The area the entity can supply, in ?x? tiles. Value of 5 would produce 5x5.
wire-reach The number of tiles the wires can reach.
construction-area The size of the construction area provided by the entity.
pollution The pollution generated by the object.
buildable-on The only space locations that this entity can be placed on, e.g. "Nauvis + Gleba" or "Space platform".
crafted-on The only space locations that this recipe can be crafted on, e.g. "Nauvis + Gleba" or "Space platform".
spoil-time The spoil time of the item, in minutes, e.g. 3.
spoil-result The spoil time of the item, e.g. "Iron plate, 2" or "Spoilage".
vehicle-weight The weight of this rolling stock or vehicle.
modules Number of module slots.
equipment Equipment that can be put into this objects equipment grid.
boosting-technologies What technologies boost the object.
producers What entities (machines) produce the object.
space-age-producers What entities (machines) produce the object when the Space Age mod is active. Defaults to producers if not set, set to "none" to hide the row completely instead. Needs changed-by-space-age-mod to be set to be shown.
consumers What recipes consume the object.
space-age-consumers What recipes consume the object when the Space Age mod is active. Defaults to consumers if not set, set to "none" to hide the row completely instead. Needs changed-by-space-age-mod to be set to be shown.
valid-fuel Which items this entity can use as fuel.
used-as-fuel-by What entities this item can be used in as fuel.
recycling-results What the results are when this item is recycled.
cost The cost to research the technology.
cost-multiplier How many times the cost must be paid to research the tech fully.
space-age-cost The altered cost to research the technology when the Space Age mod is active. Defaults to cost if not set, set to "none" to hide the row completely instead. Needs changed-by-space-age-mod to be set to be shown.
space-age-cost-multiplier How many times the cost must be paid to research the tech fully when the Space Age mod is active. Defaults to cost-multiplier. Needs changed-by-space-age-mod to be set to be shown.
technology-trigger The trigger that unlocks this technology, such as mining an entity. Shown as "Researched by" in the technology tree.
space-age-technology-trigger The altered trigger that unlocks this technology when the Space Age mod is active. Defaults to technology-trigger if not set, set to "none" to hide the row completely instead. Needs changed-by-space-age-mod to be set to be shown.
allows What other technologies the tech allows.
effects Items unlocked by researching this technology.
required-technologies Technologies required to access the tech or object.
space-age-allows What other technologies the tech allows when the Space Age mod is active. Defaults to allows if not set, set to "none" to hide the row completely instead. Needs changed-by-space-age-mod to be set to be shown.
space-age-effects Items unlocked by researching this technology when the Space Age mod is active. Defaults to effects if not set, set to "none" to hide the row completely instead. Needs changed-by-space-age-mod to be set to be shown.
space-age-required-technologies Technologies required to access the tech or object when the Space Age mod is active. Defaults to required-technologies if not set, set to "none" to hide the row completely instead. Needs changed-by-space-age-mod to be set to be shown.