Template:Infobox SE/doc

From Space Exploration
Jump to navigation Jump to search

This template and all templates used within are adapted from the Factorio Wiki infobox and is licensed under CC BY-NC-SA 3.0.

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

Usage[edit]

Unlike the Factorio wiki, the SE wiki does not use an Infobox namespace. Instead, please create the infobox on the appropriate item page.

To create an infobox, start with the line: {{Infobox SE. 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:Logistics]]</noinclude>, replacing Logistics with the appropriate category.

Example working box:

{{Infobox SE
|category = Logistics
|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:Logistics]]</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.


Recipe syntax[edit]

The "recipe" parameter should be used as follows:


|recipe = wood, 4 > wooden chest, 1

Basically,

item1, quantity > output item, quantity.

Separate multiple items with +.

You can add up to 5 recipes using recipe, recipe2, recipe3, recipe4, and recipe5.

Currently, total raw is not calculated for you and must be input manually using total-raw, total-raw2, etc.

Parameters[edit]

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 Data.raw location
category The category the object fits into, same as the inventory tabs. Valid choices are Logistics, Production, Resources, Manufacturing, Science, and Equipment and Combat.
name The name of the object, default is the page name. Do not specify name if not necessary, to avoid translation issues. [*]/name
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. n/a
internal-name The internal name of the entity. Only use plain text here. table key
image An in-game image of the entity, without file extension (.png etc) n/a
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 in normal mode. See recipe syntax above for more info. Recipe/[*]/energy_required, Recipe/[*]/ingredients, Recipe/[*]/result
total-raw The total amount of raw materials required to make the object in normal mode. See recipe syntax above. n/a
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. Recipe/[*]/expensive
expensive-total-raw The total amount of raw materials required to make the object in expensive mode. 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. n/a
map-color The map color of the entity. [*]/map_color for * in Prototype/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 storage size of the entity, in spaces.
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. [*]/max_health for * in Prototype/EntityWithHealth
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 [*]/resistances
inventory-size-bonus The inventory size bonus provided by the item. [*]/inventory_size_bonus
grid-size The size of the grid for armor modules.
stack-size How many of the object fit into a stack. [*]/stack_size for * in Prototype/Item
range The range of the weapon, in tiles. [*]/attack_parameters/range
shooting-speed The shooting speed of the weapon. [*]/attack_parameters/cooldown (this number is min ticks between shots)
damage The damage dealt by the object.
damage-bonus The damage bonus provided by the technology or weapon. [*]/attack_parameters/damage_modifier
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. [*]/durability
ammunition What type of ammo the weapon consumes. [*]/attack_parameters/ammo_type
used-as-ammo-by Which entities use this ammo.
magazine-size The number of bullets contained in the magazine. [*]/magazine_size
efficiency The efficiency.
dimensions The size of the entity, in tiles.
energy The energy consumption of the entity. [*]/energy_consumption
drain The passive electricity drain of the entity. [*]/drain
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.
belt-speed The speed of the belt, should use Items/s as the unit. ([*]/speed)x480
rotation-speed Inserter rotation speed. [*]/rotation_speed
movement-bonus General movement speed bonus.
energy-capacity How much electricity the object can hold. [*]/buffer_capacity
heat-capacity How much heat the object can hold. [*]/heat_capacity
power-input How much electricity the object can intake. [*]/input_flow_limit
power-output Same as above, but for output. [*]/output_flow_limit
minimum-temperature The minimum temperature of the entity. [*]/default_temperature
maximum-temperature The maximum temperature of the entity. [*]/max_temperature
gas-temperature The gas temperature of the entity. [*]/gas_temperature
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. [*]/crafting_speed for * in Prototype/CraftingMachine
pumping-speed The pumping speed of this entity. [*]/pumping_speed for * in Prototype/Pump
mining-time The time it takes to mine the object. [*]/minable/mining_time for * in Prototype/Entity
mining-speed The mining speed of the object. [*]/mining_speed for * in Prototype/MiningDrill
mining-area The mining area of the entity. ([*]/resource_searching_radius + 0.01)x2 for * in Prototype/MiningDrill
speed The speed bonus/penalty of this module.
productivity The productivity bonus of this module.
fuel-value The amount of energy can be obtained by using this as fuel [*]/fuel_value for * in Prototype/Item
vehicle-acceleration The vehicle acceleration this fuel provides, e.g 180% [*]/fuel_acceleration_multiplier for * in Prototype/Item
vehicle-top-speed The vehicle top speed this fuel provides, e.g 115% [*]/fuel_top_speed_multiplier for * in Prototype/Item
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.
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. [*]/equipment_grid for * in Prototype/Vehicle
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 (machines) produce the object.
consumers What recipes consume the object.
cannot-placed Surfaces where the entity cannot be placed.
valid-fuel Which items this entity can use as fuel.
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.
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.
required-packs Science packs required to research this technology.