Template:Installations infobox/doc: Difference between revisions

From Official Barotrauma Wiki
Jump to: navigation, search
m (3 revisions imported)
mNo edit summary
 
(17 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{doc/start}}
{{doc/start}}
<pre>
== Basic ==
{|class="wikitable sortable" style="width: 100%;"
! Field !! Note !! Example !! Expected !! Default
|-
| name || The name of the installation. || Fabricator || || <code><nowiki>{{PAGENAME}}</nowiki></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
|-
| 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 ==
{|class="wikitable sortable" style="width: 100%;"
! 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 ==
{|class="wikitable sortable" style="width: 100%;"
! 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
|}
{{Installations infobox
{{Installations infobox
| name = Installation's name (override)
| name       = Fabricator
| image = image.png
| imagewidth = 100
| imagewidth = Image width
| identifier  = fabricator
| caption = Caption under the image
| description = A machine capable of manufacturing a wide range of items out of basic raw materials.
| category = Installation's ingame category
| category    = Machine
| powerconsumption = Power consumption of installation
| tags        = fabricator,donttakeitems,dontsellitems
| itemslots = How many item slots an installation has
| nocat      = yes
| powercapacity = How much power (kW) can be stored in a battery
 
| maxoutput = Maximum power (kW) that can be outputted out of a battery
| powerconsumption = <span class="explain" title="Lights">10</span> + <span class="explain" title="Fabrication">500</span>
| maxrechargespeed = Maximum recharge speed of a battery
| itemslots        = 5 input slots and 1 output slot
| maxforce = Maximum thrust generated by the engine (specific)
 
| maxflow = Empty/fill rate of pumps (specific)
| repairtype  = Mechanical
| o2generatedamount = How much oxygen is generated by the o2 gen (specific)
| repairskill = 55
| 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)
| construction = Construction level needed for repair
| mechanical items = Items needed for mechanical repairs (welding tool, wrench)
| electrical engineering = Electrical level needed for repair
| electrical items = Items needed for electrical repairs (screwdriver, wire)
| nocat = (no category) Doesn't include the [[:Category:Installations|Installations Category]]
| nostats = (no stats) Removes the Stats section
}}
}}
</pre>
 
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"