Template:Infobox/doc: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
No edit summary
(Added additional info to the docs.)
Line 5: Line 5:
To use, create a sub-page of the page you are trying to add an infobox to, called .../infobox. Then, on the page, add the line <code><nowiki>{{:Page_name/infobox}}</nowiki></code>. This will "copy" the infobox you create on .../infobox to the page itself. Of course, replace Page_name with the name of the page.
To use, create a sub-page of the page you are trying to add an infobox to, called .../infobox. Then, on the page, add the line <code><nowiki>{{:Page_name/infobox}}</nowiki></code>. 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: <code><nowiki>{{Infobox</nowiki></code>. 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. <nowiki>"}}"</nowiki>.
As for the infobox on .../infobox, start with the line: <code><nowiki>{{Infobox</nowiki></code>. 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. <nowiki>"}}"</nowiki>, and the line <code><nowiki><noinclude>[[Category:Infobox page]]</noinclude></nowiki></code>.


Additionally, the infobox will automatically translate. Just "copy" the infobox (the same way, from .../infobox) to the page, as done for the English page. If you need further help, contact a wiki admin or look at existing examples, on actual pages.
Example working box:
 
<pre>
{{Infobox
|category = Machinery
|category-name = Machine
|health=100
|stack-size=50
|wire-reach=9
|supply-area=7x7
|recipe=Time, 0.5 + Steel plate, 2 + Copper plate, 2
|required-technologies=Electric energy distribution 1
|producers=Manual + Assembling machine
}}
<noinclude>[[Category:Infobox page]]</noinclude>
 
</pre>
 
Additionally, the infobox will automatically translate. Just "copy" the infobox (the same way, from .../infobox) to the page, as done for the English page. (<code><nowiki>{{:Page name/infobox}}</nowiki></code>)
 
 
If you need further help, contact a wiki admin or look at existing examples, on actual pages.




Line 21: Line 42:
Basically,
Basically,


item1, quantity = outputitem, quantity.  
item1, quantity = output item, quantity.  


Separate multiple items with '''+'''.
Separate multiple items with '''+'''.
Line 39: Line 60:
! Parameter !! Value
! Parameter !! Value
|-
|-
|  <span style="color:#FF0000"> category </span> || The category the object fits into. Machinery, Tools, Combat, etc.  
|  <span style="color:#FF0000"> category </span> || The category the object fits into. Valid choices are Machinery, Tools, Combat, Liquids, Logic, Intermediate products, Resources, Science packs, or Item.  
|-
|-
| name || The name of the object, default is the page name.
| name || The name of the object, default is the page name. '''Do not specify name if not necessary, to avoid translation issues.'''
|-
|-
| category-name || The name of the category to be shown to users. Visual only.  
| category-name || The name of the category to be shown to users. Visual only.  
|-
|-
| icon || Specify the icon of the object, give the name of the file without the extension.
| 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.
|-
|-
| extra1 || Add an extra row above all others, for misc purpose.
| 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.
| extra2 || Add an extra row below all others, for misc purpose. '''Do not use templates here!'''
|-
|-
| recipe || The recipe of the object. See recipe syntax above for more info.
| recipe || The recipe of the object. See recipe syntax above for more info.
Line 59: Line 80:
| walking-speed || The walking speed of the entity.  
| walking-speed || The walking speed of the entity.  
|-
|-
| storage-size || The storage size of the entity.
| storage-size || The storage size of the entity, in spaces.
|-
|-
| calculations-per-second || Calculations the machine can do per 60 UPS.
| calculations-per-second || Calculations the machine can do per 60 UPS.
Line 77: Line 98:
| stack-size || How many of the object fit into a stack.
| stack-size || How many of the object fit into a stack.
|-
|-
| range || The range of the weapon.
| range || The range of the weapon, in tiles.
|-
|-
| shooting-speed || The shooting speed of the weapon.
| shooting-speed || The shooting speed of the weapon.
Line 87: Line 108:
| cluster-size || The size of the cluster.
| cluster-size || The size of the cluster.
|-
|-
| area-of-affect-size || The size of the area of effect.
| area-of-affect-size || The size of the area of effect of the object.  
|-
|-
| durability || The durability of the object.
| durability || The durability of the object.
Line 97: Line 118:
| efficiency || The efficiency.
| efficiency || The efficiency.
|-
|-
| dimensions || The size of the entity.
| dimensions || The size of the entity, in tiles.
|-
|-
| energy || The energy consumption of the entity.
| energy || The energy consumption of the entity.
Line 143: Line 164:
| 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
|-
|-
| supply-area || The area the entity can supply.
| 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.
| wire-reach || The number of tiles the wires can reach.

Revision as of 22:41, 3 October 2016

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

Usage

To use, create a sub-page of the page you are trying to add an infobox to, called .../infobox. Then, on the page, add the line {{:Page_name/infobox}}. 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 = Machinery
|category-name = Machine
|health=100
|stack-size=50
|wire-reach=9
|supply-area=7x7
|recipe=Time, 0.5 + Steel plate, 2 + Copper plate, 2
|required-technologies=Electric energy distribution 1
|producers=Manual + 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. ({{:Page name/infobox}})


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


Recipe syntax

The "recipe" parameter should be used as follows:


|recipe = wood, 4 = wooden chest, 1

Basically,

item1, quantity = output item, quantity.

Separate multiple items with +.


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. Valid choices are Machinery, Tools, Combat, Liquids, Logic, Intermediate products, Resources, Science packs, or Item.
name The name of the object, default is the page name. Do not specify name if not necessary, to avoid translation issues.
category-name The name of the category to be shown to users. Visual only.
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.
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!
recipe The recipe of the object. See recipe syntax above for more info.
total-raw The raw recipe of the object. See recipe syntax above.
added-in The version the object was added into the game.
walking-speed The walking speed of the entity.
storage-size The storage size of the entity, in spaces.
calculations-per-second Calculations the machine can do per 60 UPS.
lifespan The lifespan of a deployed capsule in seconds.
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.
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.
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.
transmission The transmission of energy 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.
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.
movement-bonus General movement speed bonus.
maximum-recharge-speed The max recharge speed of the entity.
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.
shield The amount of shielding the object has.
energy-per-unit Energy provided per unit.
crafting-speed The crafting speed of the entity.
mining-hardness The mining hardness of the entity.
mining-time The time it takes to mine the object.
mining-power The mining power of the object.
mining-speed The mining speed of the object.
mining-area The mining area of the entity.
fuel-value The amount of energy can be obtained by using this as fuel
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.
modules Number of module slots.
allows What other technologies the tech allows.
effects Items unlocked by researching this technology.
required-technologies Technologies required to access the tech or object.
boosting-technologies What technologies boost the object.
producers What entities produce the object.
producers What entities process the object.
consumers What entities consume the object.
used-as-fuel-by What entities this item can be used in as fuel.
cost The cost to research the technology.
cost-multiplier How many times the cost must be paid to research the tech fully.