Template:Installations infobox/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{doc/start}}
{{doc/start}}
<pre>
== Basic ==
{{Installations infobox
{|class="wikitable sortable" style="width: 100%;"
| name = Installation's name (override)
! Field !! Note !! Example !! Default
| image = image.png
|-
| imagewidth = Image width
| name || The name of the installation. || Fabricator || <code><nowiki>{{PAGENAME}}</nowiki></code>
| caption = Caption under the image
|-
| category = The category of the installation
| image || An image of the installation. || Fabricator.png || <code><nowiki>{{PAGENAME}}</nowiki>.png</code>
| subcategory The subcategory of the installation
|-
| powerconsumption = Power consumption of installation
| imagewidth || Forces the width of the image to the specified value. || 250 || 180
| itemslots = How many item slots an installation has
|-
| powercapacity = How much power (kW) can be stored in a battery
| caption || Captions the installation's image || Base
| maxoutput = Maximum power (kW) that can be outputted out of a battery
|-
| maxrechargespeed = Maximum recharge speed of a battery
| identifier || Internal identifier of the item from game files (optional) || fabricator
| maxforce = Maximum thrust generated by the engine (specific)
|-
| maxflow = Empty/fill rate of pumps (specific)
| description || In-game description || ''A machine capable of manufacturing a wide range of items out of basic raw materials.''
| o2generatedamount = How much oxygen is generated by the o2 gen (specific)
|}
| repair = What kind of repair does the installation need when broken (electrical/mechanical/both)
 
| repairitems = Items needed for repair (used if only one kind of repair is needed)
== Stats ==
| mechanical engineering = mechanical engineering level needed for repair
{|class="wikitable sortable" style="width: 100%;"
| mechanical items = Items needed for mechanical repairs (welding tool, wrench)
! Field !! Note !! Example !! Expected !! Default
| electrical engineering = Electrical level needed for repair
|-
| electrical items = Items needed for electrical repairs (screwdriver, wire)
| category || The category of the item, as defined in XML. || Machine || Structure, Decorative, Machine, Medical, Weapon, Diving, Electrical, Alien, Wrecked, Legacy, Misc || Misc
| nocat = (no category) Doesn't include the [[:Category:Installations|Installations Category]]
|-
| nostats = (no stats) Removes the Stats section
| subcategory || The subcategory of the item, as defined in XML. || Labels || Thalamus, Abandoned Outposts, Abandoned Outpost (Human), Abandoned Outpost (Monster), Exterior submarine walls, Exterior shuttle pieces, Labels, Background wall, Outpost
}}
|-
</pre>
| tags || The tags of the item, as defined in XML. || fabricator,donttakeitems,dontsellitems || CSV list of the item's tags
|-
| powerconsumption || The power consumption of the installation (in kW). || 510 || Numeric value
|-
| itemslots || The number of item slots the installation has || 6 || Numeric value
|-
| powercapacity || The amount of power that can be stored in the installation (in kWm). || 100 || Numeric value
|-
| maxoutput || The maximum amount of power that the installation can output (in kW). || 50 || Numeric value
|-
| maxrechargespeed || The maximum recharge speed of the installation (in kW). || 50 || Numeric value
|-
| maxforce || The maximum amount of thrust that the installation can produce. || 1000 || Numeric value
|-
| maxflow || The maximum rate of water intake/outtake that the installation can provide. || 250 || Numeric value
|-
| o2generatedamount || The amount of oxygen generated by the installation. || 5000 || Numeric value
|-
| repair || The type of repair the installation requires. (only if one kind of repair is needed) || mechanical || Mechanical, Electrical, Both
|-
| repairitems || The items required to repair the installation. || Wrench || Wrench, Screwdriver, etc.
|-
| mechanical engineering || The level of mechanical engineering skill required for repairs. || 40 || Numeric value
|-
| mechanical items || The items needed for mechanical repairs. || Wrench || Wrench, Welding Tool, etc.
|-
| electrical engineering || The level of electrical engineering skill required for repairs. || 40 || Numeric value
|-
| electrical items || The items needed for electrical repairs. || Screwdriver || Screwdriver, Wire, etc.
|-
| nocat || Removes the page categories || yes || yes
|-
| nostats || Removes the "Stats" section || yes || yes
|}
 
 
{{doc/end}}
{{doc/end}}

Revision as of 10:33, 18 August 2022

Documentation

Basic

Field Note Example Default
name The name of the installation. Fabricator {{PAGENAME}}
image An image of the installation. Fabricator.png {{PAGENAME}}.png
imagewidth Forces the width of the image to the specified value. 250 180
caption Captions the installation's image Base
identifier Internal identifier of the item from game files (optional) fabricator
description In-game description A machine capable of manufacturing a wide range of items out of basic raw materials.

Stats

Field Note Example Expected Default
category The category of the item, as defined in XML. Machine Structure, Decorative, Machine, Medical, Weapon, Diving, Electrical, Alien, Wrecked, Legacy, Misc Misc
subcategory The subcategory of the item, as defined in XML. Labels Thalamus, Abandoned Outposts, Abandoned Outpost (Human), Abandoned Outpost (Monster), Exterior submarine walls, Exterior shuttle pieces, Labels, Background wall, Outpost
tags The tags of the item, as defined in XML. fabricator,donttakeitems,dontsellitems CSV list of the item's tags
powerconsumption The power consumption of the installation (in kW). 510 Numeric value
itemslots The number of item slots the installation has 6 Numeric value
powercapacity The amount of power that can be stored in the installation (in kWm). 100 Numeric value
maxoutput The maximum amount of power that the installation can output (in kW). 50 Numeric value
maxrechargespeed The maximum recharge speed of the installation (in kW). 50 Numeric value
maxforce The maximum amount of thrust that the installation can produce. 1000 Numeric value
maxflow The maximum rate of water intake/outtake that the installation can provide. 250 Numeric value
o2generatedamount The amount of oxygen generated by the installation. 5000 Numeric value
repair The type of repair the installation requires. (only if one kind of repair is needed) mechanical Mechanical, Electrical, Both
repairitems The items required to repair the installation. Wrench Wrench, Screwdriver, etc.
mechanical engineering The level of mechanical engineering skill required for repairs. 40 Numeric value
mechanical items The items needed for mechanical repairs. Wrench Wrench, Welding Tool, etc.
electrical engineering The level of electrical engineering skill required for repairs. 40 Numeric value
electrical items The items needed for electrical repairs. Screwdriver Screwdriver, Wire, etc.
nocat Removes the page categories yes yes
nostats Removes the "Stats" section yes yes


This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.