Template:Installations infobox/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
mNo edit summary
mNo edit summary
 
(14 intermediate revisions by the same user not shown)
Line 2: Line 2:
== Basic ==
== Basic ==
{|class="wikitable sortable" style="width: 100%;"
{|class="wikitable sortable" style="width: 100%;"
! Field !! Note !! Example !! Default
! Field !! Note !! Example !! Expected !! Default
|-
|-
| name || The name of the installation. || Fabricator || <code><nowiki>{{PAGENAME}}</nowiki></code>
| name || The name of the installation. || Fabricator || || <code><nowiki>{{PAGENAME}}</nowiki></code>
|-
|-
| image || An image of the installation. || Fabricator.png || <code><nowiki>{{PAGENAME}}</nowiki>.png</code>
| image || An image of the installation. || Fabricator.png || || <code><nowiki>{{{name|{{PAGENAME}}}}}</nowiki>.png</code>
|-
|-
| imagewidth || Forces the width of the image to the specified value. || 250 || 180
| 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
|-
|-
| 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.''
|-
|-
| description || In-game description || ''A machine capable of manufacturing a wide range of items out of basic raw materials.''
| category || The category of the item, as defined in XML. || Machine || Structure, Decorative, Machine, Medical, Weapon, Diving, Equipment, Fuel, Electrical, Material, Alien, Wrecked, Legacy, Misc || Misc
|}
 
== Stats ==
{|class="wikitable sortable" style="width: 100%;"
! 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
| category2 || The second category of the item, if applicable. || Weapon || Structure, Decorative, Machine, Medical, Weapon, Diving, Equipment, Fuel, Electrical, Material, Alien, Wrecked, Legacy, 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
| 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
| tags || The tags of the item, as defined in XML. || fabricator,donttakeitems,dontsellitems || CSV list of the item's tags
|-
| nocat || Removes page categories. || yes || yes
|}
== Statistics ==
{|class="wikitable sortable" style="width: 100%;"
! Field !! Note !! Example !! Expected !! Default
|-
|-
| powerconsumption || The power consumption of the installation (in kW). || 510 || Numeric value
| powerconsumption || The power consumption of the installation (in kW). || 510 || Numeric value
|-
|-
| itemslots || The number of item slots the installation has || 6 || Numeric value
| reload || The reload time of the turret, as defined in XML. || 5 || 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
| powercapacity || The amount of power that can be stored in the installation (in kWm). || 100 || Numeric value
Line 42: Line 46:
|-
|-
| o2generatedamount || The amount of oxygen generated by the installation. || 5000 || Numeric value
| o2generatedamount || The amount of oxygen generated by the installation. || 5000 || Numeric value
|}
== Repairable ==
{|class="wikitable sortable" style="width: 100%;"
! Field !! Note !! Example !! Expected !! Default
|-
|-
| repair || The type of repair the installation requires. (only if one kind of repair is needed) || mechanical || Mechanical, Electrical, Both
| repairtype || The type of repair the installation requires. || mechanical || Mechanical, Electrical
|-
| 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
| repairskill || The level of skill required for repairs. || 40 || Numeric value
|}
|}
{{Installations infobox
| name        = Fabricator
| imagewidth  = 100
| identifier  = fabricator
| description = A machine capable of manufacturing a wide range of items out of basic raw materials.
| category    = Machine
| tags        = fabricator,donttakeitems,dontsellitems
| nocat      = yes
| powerconsumption = <span class="explain" title="Lights">10</span> + <span class="explain" title="Fabrication">500</span>
| itemslots        = 5 input slots and 1 output slot
| repairtype  = Mechanical
| repairskill = 55
}}
The example seen to the right is defined as follows:
<div style="height:940px"><pre>
{{Installations infobox
| name        = Fabricator
| imagewidth  = 100
| identifier  = fabricator
| description = A machine capable of manufacturing a wide range of items out of basic raw materials.
| category    = Machine
| tags        = fabricator,donttakeitems,dontsellitems
| nocat      = yes


| powerconsumption = <span class="explain" title="Lights">10</span> + <span class="explain" title="Fabrication">500</span>
| itemslots        = 5 input slots and 1 output slot


| repairtype  = Mechanical
| repairskill = 55
}}</pre></div>{{clr}}
{{doc/end}}
{{doc/end}}

Latest revision as of 22:10, 18 September 2022

Documentation
[purge]

Basic

Field Note Example Expected Default
name The name of the installation. Fabricator {{PAGENAME}}
image An image of the installation. Fabricator.png {{{name|{{PAGENAME}}}}}.png
imagewidth Forces the width of the image to the specified value. 250 180
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.
category The category of the item, as defined in XML. Machine Structure, Decorative, Machine, Medical, Weapon, Diving, Equipment, Fuel, Electrical, Material, Alien, Wrecked, Legacy, Misc Misc
category2 The second category of the item, if applicable. Weapon Structure, Decorative, Machine, Medical, Weapon, Diving, Equipment, Fuel, Electrical, Material, Alien, Wrecked, Legacy, 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
nocat Removes page categories. yes yes

Statistics

Field Note Example Expected Default
powerconsumption The power consumption of the installation (in kW). 510 Numeric value
reload The reload time of the turret, as defined in XML. 5 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

Repairable

Field Note Example Expected Default
repairtype The type of repair the installation requires. mechanical Mechanical, Electrical
repairskill The level of skill required for repairs. 40 Numeric value
Fabricator
A machine capable of manufacturing a wide range of items out of basic raw materials.
Statistics*
Power Consumption 10 + 500 kW
Item Slots 5 input slots and 1 output slot
Repairable
Required Skill Mechanical Engineering 55
Required Item Wrench
Technical
Identifier fabricator
Categories Machine
Tags fabricator,donttakeitems,dontsellitems

The example seen to the right is defined as follows: 

{{Installations infobox
| name        = Fabricator
| imagewidth  = 100
| identifier  = fabricator
| description = A machine capable of manufacturing a wide range of items out of basic raw materials.
| category    = Machine
| tags        = fabricator,donttakeitems,dontsellitems
| nocat       = yes

| powerconsumption = <span class="explain" title="Lights">10</span> + <span class="explain" title="Fabrication">500</span>
| itemslots        = 5 input slots and 1 output slot

| repairtype  = Mechanical
| repairskill = 55
}}

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

Retrieved from "https://barotraumagame.com/baro-wiki/index.php?title=Template:Installations_infobox/doc&oldid=31223"