Difference between revisions of "Structurebox/doc"
From Unofficial Stationeers Wiki
< Template:Structurebox
F1r3w4rr10r (talk | contribs) (Create a basic documentation page for the Structurebox template) |
SchlauFuchs (talk | contribs) (added more properties) |
||
| (10 intermediate revisions by 5 users not shown) | |||
| Line 2: | Line 2: | ||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | ||
== Summary == | == Summary == | ||
| − | This template should be used for | + | This template should be used for placed structures. |
| + | |||
| + | It will create an Infobox on the right hand side, at the top of the article. | ||
It has some parameters, that are useful for documenting the most important features of a [[:Category:Structures|Structure]]. | It has some parameters, that are useful for documenting the most important features of a [[:Category:Structures|Structure]]. | ||
| − | == | + | When included, it will also add the page, it is included in, to [[:Category:Structures]]. |
| + | |||
| + | == Template data == | ||
| + | |||
| + | <templatedata> | ||
| + | { | ||
| + | "params": { | ||
| + | "name": { | ||
| + | "label": "Name", | ||
| + | "description": "The name of the structure", | ||
| + | "example": "Active Vent", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "image": { | ||
| + | "label": "Image", | ||
| + | "description": "An image of the completely built structure.", | ||
| + | "type": "wiki-file-name" | ||
| + | }, | ||
| + | "other": { | ||
| + | "label": "Other", | ||
| + | "description": "Any other remarks, that can be placed before the subsections.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "paintable": { | ||
| + | "label": "Paintable", | ||
| + | "description": "Whether the structure is paitable.", | ||
| + | "type": "boolean", | ||
| + | "example": "Yes, No" | ||
| + | }, | ||
| + | "constructable_in_rockets": { | ||
| + | "label": "Constructable in rockets", | ||
| + | "description": "Whether the structure can be constructed inside a rocket.", | ||
| + | "example": "Yes, No", | ||
| + | "type": "boolean" | ||
| + | }, | ||
| + | "rocket_mass_contribution": { | ||
| + | "label": "Rocket Mass Contribution", | ||
| + | "description": "Mass in kg added to the Rocket", | ||
| + | "example": "30 kg", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "power_usage": { | ||
| + | "label": "Power usage", | ||
| + | "description": "The power required to operate the structure.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "burst_pressure": { | ||
| + | "label": "Burst pressure", | ||
| + | "description": "The maximum pressure the structure can withstand before breaking.", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "volume": { | ||
| + | "label": "Volume", | ||
| + | "description": "Volume of the Container.", | ||
| + | "example": "250L", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "convection": { | ||
| + | "label": "Thermal Convection", | ||
| + | "description": "Thermal Convection Factor", | ||
| + | "example": "0.625", | ||
| + | "type": "number" | ||
| + | }, | ||
| + | "radiation": { | ||
| + | "label": "Thermal Radiation", | ||
| + | "description": "Thermal Radiation Factor", | ||
| + | "example": "0.025", | ||
| + | "type": "number" | ||
| + | }, | ||
| + | "solar_heating": { | ||
| + | "label": "Solar Heating", | ||
| + | "description": "Solar Heating Factor", | ||
| + | "example": "1.25", | ||
| + | "type": "number" | ||
| + | }, | ||
| + | "prefab_hash": { | ||
| + | "label": "Prefab Hash", | ||
| + | "description": "The prefab hash for the structure", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "prefab_name": { | ||
| + | "label": "Prefab name", | ||
| + | "description": "The prefab name for the structure", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "placed_with_item": { | ||
| + | "label": "Place with item", | ||
| + | "description": "The item that is used to place the initial stage of the structure.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "placed_on_grid": { | ||
| + | "label": "Place on grid", | ||
| + | "description": "The grid size, the structure is placed on. This should be either \"Small Grid\", \"Large Grid\" or \"Dynamic\".", | ||
| + | "example": "Small Grid, Large Grid, Dynamic", | ||
| + | "type": "string" | ||
| + | }, | ||
| + | "slot_0": {}, | ||
| + | "slot_1": {}, | ||
| + | "slot_2": {}, | ||
| + | "slot_3": {}, | ||
| + | "stage_image1": { | ||
| + | "label": "Stage 1 image", | ||
| + | "description": "The image for the construction stage.", | ||
| + | "type": "wiki-file-name" | ||
| + | }, | ||
| + | "const_with_tool1": { | ||
| + | "label": "Stage 1 tool", | ||
| + | "description": "The tool which the stage is constructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "const_with_item1": { | ||
| + | "label": "Stage 1 item", | ||
| + | "description": "The item required to construct this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "decon_with_tool1": { | ||
| + | "label": "Stage 1 deconstruction tool", | ||
| + | "description": "The tool which this stage is deconstructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "item_rec1": { | ||
| + | "label": "Stage 1 deconstruction item", | ||
| + | "description": "The item that the player receives when deconstructing this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "stage_image2": { | ||
| + | "label": "Stage 2 image", | ||
| + | "description": "The image for the construction stage.", | ||
| + | "type": "wiki-file-name" | ||
| + | }, | ||
| + | "const_with_tool2": { | ||
| + | "label": "Stage 2 tool", | ||
| + | "description": "The tool which the stage is constructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "const_with_item2": { | ||
| + | "label": "Stage 2 item", | ||
| + | "description": "The item required to construct this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "decon_with_tool2": { | ||
| + | "label": "Stage 2 deconstruction tool", | ||
| + | "description": "The tool which this stage is deconstructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "item_rec2": { | ||
| + | "label": "Stage 2 deconstruction item", | ||
| + | "description": "The item that the player receives when deconstructing this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "stage_image3": { | ||
| + | "label": "Stage 3 image", | ||
| + | "description": "The image for the construction stage.", | ||
| + | "type": "wiki-file-name" | ||
| + | }, | ||
| + | "const_with_tool3": { | ||
| + | "label": "Stage 3 tool", | ||
| + | "description": "The tool which the stage is constructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "const_with_item3": { | ||
| + | "label": "Stage 3 item", | ||
| + | "description": "The item required to construct this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "decon_with_tool3": { | ||
| + | "label": "Stage 3 deconstruction tool", | ||
| + | "description": "The tool which this stage is deconstructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "item_rec3": { | ||
| + | "label": "Stage 3 deconstruction item", | ||
| + | "description": "The item that the player receives when deconstructing this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "stage_image4": { | ||
| + | "label": "Stage 4 image", | ||
| + | "description": "The image for the construction stage.", | ||
| + | "type": "wiki-file-name" | ||
| + | }, | ||
| + | "const_with_tool4": { | ||
| + | "label": "Stage 4 tool", | ||
| + | "description": "The tool which the stage is constructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "const_with_item4": { | ||
| + | "label": "Stage 4 item", | ||
| + | "description": "The item required to construct this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "decon_with_tool4": { | ||
| + | "label": "Stage 4 deconstruction tool", | ||
| + | "description": "The tool which this stage is deconstructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "item_rec4": { | ||
| + | "label": "Stage 4 deconstruction item", | ||
| + | "description": "The item that the player receives when deconstructing this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "stage_image5": { | ||
| + | "label": "Stage 5 image", | ||
| + | "description": "The image for the construction stage.", | ||
| + | "type": "wiki-file-name" | ||
| + | }, | ||
| + | "const_with_tool5": { | ||
| + | "label": "Stage 5 tool", | ||
| + | "description": "The tool which the stage is constructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "const_with_item5": { | ||
| + | "label": "Stage 5 item", | ||
| + | "description": "The item required to construct this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "decon_with_tool5": { | ||
| + | "label": "Stage 5 deconstruction tool", | ||
| + | "description": "The tool which this stage is deconstructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "item_rec5": { | ||
| + | "label": "Stage 5 deconstruction item", | ||
| + | "description": "The item that the player receives when deconstructing this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "stage_image6": { | ||
| + | "label": "Stage 6 image", | ||
| + | "description": "The image for the construction stage.", | ||
| + | "type": "wiki-file-name" | ||
| + | }, | ||
| + | "const_with_tool6": { | ||
| + | "label": "Stage 6 tool", | ||
| + | "description": "The tool which the stage is constructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "const_with_item6": { | ||
| + | "label": "Stage 6 item", | ||
| + | "description": "The item required to construct this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "decon_with_tool6": { | ||
| + | "label": "Stage 6 deconstruction tool", | ||
| + | "description": "The tool which this stage is deconstructed with.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "item_rec6": { | ||
| + | "label": "Stage 6 deconstruction item", | ||
| + | "description": "The item that the player receives when deconstructing this stage.", | ||
| + | "type": "wiki-page-name" | ||
| + | } | ||
| + | }, | ||
| + | "description": "Data valid for the Structurebox template" | ||
| + | } | ||
| + | </templatedata> | ||
| + | |||
| + | == Editing == | ||
| + | |||
| + | Most of the template can be edited on the [[Template:Structurebox]] page. | ||
| + | |||
| + | The stage sections need to be edited on the [[Template:Construction stage]] page. | ||
| + | |||
| + | == Blank == | ||
| + | This is the blank template code, that can be copy-pasted into a page to use it there. | ||
| + | <pre style="overflow: auto;" pad="yes">{{Structurebox | ||
| + | | name = | ||
| + | | image = | ||
| + | | prefab_hash = | ||
| + | | prefab_name = | ||
| + | | other = | ||
| + | | power_usage = | ||
| + | | burst_pressure = | ||
| + | | volume = | ||
| + | | convection = | ||
| + | | radiation = | ||
| + | | solar_heating = | ||
| + | | placed_with_item = | ||
| + | | placed_on_grid = | ||
| + | | paintable = | ||
| + | | constructable_in_rockets = | ||
| + | | rocket_mass_contribution = | ||
| + | | stage_image1 = | ||
| + | | const_with_tool1 = | ||
| + | | const_with_item1 = | ||
| + | | decon_with_tool1 = | ||
| + | | item_rec1 = | ||
| + | | stage_image2 = | ||
| + | | const_with_tool2 = | ||
| + | | const_with_item2 = | ||
| + | | decon_with_tool2 = | ||
| + | | item_rec2 = | ||
| + | | stage_image3 = | ||
| + | | const_with_tool3 = | ||
| + | | const_with_item3 = | ||
| + | | decon_with_tool3 = | ||
| + | | item_rec4 = | ||
| + | | stage_image4 = | ||
| + | | const_with_tool4 = | ||
| + | | const_with_item4 = | ||
| + | | decon_with_tool4 = | ||
| + | | item_rec4 = | ||
| + | | stage_image5 = | ||
| + | | const_with_tool5 = | ||
| + | | const_with_item5 = | ||
| + | | decon_with_tool5 = | ||
| + | | item_rec5 = | ||
| + | | stage_image6 = | ||
| + | | const_with_tool6 = | ||
| + | | const_with_item6 = | ||
| + | | decon_with_tool6 = | ||
| + | | item_rec6 = | ||
| + | }}</pre> | ||
| − | <includeonly>{{sandbox other|| | + | <noinclude>[[Category:Template Documentation]]</noinclude><includeonly>{{sandbox other|| |
<!-- Categories below this line, please; interwikis at Wikidata --> | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 04:10, 27 November 2025
| This is a documentation subpage for Template:Structurebox. It contains usage information, categories and other content that is not part of the original template page. |
Contents
Summary[edit]
This template should be used for placed structures.
It will create an Infobox on the right hand side, at the top of the article. It has some parameters, that are useful for documenting the most important features of a Structure.
When included, it will also add the page, it is included in, to Category:Structures.
Template data[edit]
Data valid for the Structurebox template
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Name | name | The name of the structure
| String | optional |
| Image | image | An image of the completely built structure.
| File | optional |
| Other | other | Any other remarks, that can be placed before the subsections.
| String | optional |
| Paintable | paintable | Whether the structure is paitable.
| Boolean | optional |
| Constructable in rockets | constructable_in_rockets | Whether the structure can be constructed inside a rocket.
| Boolean | optional |
| Rocket Mass Contribution | rocket_mass_contribution | Mass in kg added to the Rocket
| String | optional |
| Power usage | power_usage | The power required to operate the structure.
| String | optional |
| Burst pressure | burst_pressure | The maximum pressure the structure can withstand before breaking.
| String | optional |
| Volume | volume | Volume of the Container.
| String | optional |
| Thermal Convection | convection | Thermal Convection Factor
| Number | optional |
| Thermal Radiation | radiation | Thermal Radiation Factor
| Number | optional |
| Solar Heating | solar_heating | Solar Heating Factor
| Number | optional |
| Prefab Hash | prefab_hash | The prefab hash for the structure
| String | optional |
| Prefab name | prefab_name | The prefab name for the structure
| String | optional |
| Place with item | placed_with_item | The item that is used to place the initial stage of the structure.
| Page | optional |
| Place on grid | placed_on_grid | The grid size, the structure is placed on. This should be either "Small Grid", "Large Grid" or "Dynamic".
| String | optional |
| Slot_0 | slot_0 | no description
| Unknown | optional |
| Slot_1 | slot_1 | no description
| Unknown | optional |
| Slot_2 | slot_2 | no description
| Unknown | optional |
| Slot_3 | slot_3 | no description
| Unknown | optional |
| Stage 1 image | stage_image1 | The image for the construction stage.
| File | optional |
| Stage 1 tool | const_with_tool1 | The tool which the stage is constructed with.
| Page | optional |
| Stage 1 item | const_with_item1 | The item required to construct this stage.
| Page | optional |
| Stage 1 deconstruction tool | decon_with_tool1 | The tool which this stage is deconstructed with.
| Page | optional |
| Stage 1 deconstruction item | item_rec1 | The item that the player receives when deconstructing this stage.
| Page | optional |
| Stage 2 image | stage_image2 | The image for the construction stage.
| File | optional |
| Stage 2 tool | const_with_tool2 | The tool which the stage is constructed with.
| Page | optional |
| Stage 2 item | const_with_item2 | The item required to construct this stage.
| Page | optional |
| Stage 2 deconstruction tool | decon_with_tool2 | The tool which this stage is deconstructed with.
| Page | optional |
| Stage 2 deconstruction item | item_rec2 | The item that the player receives when deconstructing this stage.
| Page | optional |
| Stage 3 image | stage_image3 | The image for the construction stage.
| File | optional |
| Stage 3 tool | const_with_tool3 | The tool which the stage is constructed with.
| Page | optional |
| Stage 3 item | const_with_item3 | The item required to construct this stage.
| Page | optional |
| Stage 3 deconstruction tool | decon_with_tool3 | The tool which this stage is deconstructed with.
| Page | optional |
| Stage 3 deconstruction item | item_rec3 | The item that the player receives when deconstructing this stage.
| Page | optional |
| Stage 4 image | stage_image4 | The image for the construction stage.
| File | optional |
| Stage 4 tool | const_with_tool4 | The tool which the stage is constructed with.
| Page | optional |
| Stage 4 item | const_with_item4 | The item required to construct this stage.
| Page | optional |
| Stage 4 deconstruction tool | decon_with_tool4 | The tool which this stage is deconstructed with.
| Page | optional |
| Stage 4 deconstruction item | item_rec4 | The item that the player receives when deconstructing this stage.
| Page | optional |
| Stage 5 image | stage_image5 | The image for the construction stage.
| File | optional |
| Stage 5 tool | const_with_tool5 | The tool which the stage is constructed with.
| Page | optional |
| Stage 5 item | const_with_item5 | The item required to construct this stage.
| Page | optional |
| Stage 5 deconstruction tool | decon_with_tool5 | The tool which this stage is deconstructed with.
| Page | optional |
| Stage 5 deconstruction item | item_rec5 | The item that the player receives when deconstructing this stage.
| Page | optional |
| Stage 6 image | stage_image6 | The image for the construction stage.
| File | optional |
| Stage 6 tool | const_with_tool6 | The tool which the stage is constructed with.
| Page | optional |
| Stage 6 item | const_with_item6 | The item required to construct this stage.
| Page | optional |
| Stage 6 deconstruction tool | decon_with_tool6 | The tool which this stage is deconstructed with.
| Page | optional |
| Stage 6 deconstruction item | item_rec6 | The item that the player receives when deconstructing this stage.
| Page | optional |
Editing[edit]
Most of the template can be edited on the Template:Structurebox page.
The stage sections need to be edited on the Template:Construction stage page.
Blank[edit]
This is the blank template code, that can be copy-pasted into a page to use it there.
{{Structurebox
| name =
| image =
| prefab_hash =
| prefab_name =
| other =
| power_usage =
| burst_pressure =
| volume =
| convection =
| radiation =
| solar_heating =
| placed_with_item =
| placed_on_grid =
| paintable =
| constructable_in_rockets =
| rocket_mass_contribution =
| stage_image1 =
| const_with_tool1 =
| const_with_item1 =
| decon_with_tool1 =
| item_rec1 =
| stage_image2 =
| const_with_tool2 =
| const_with_item2 =
| decon_with_tool2 =
| item_rec2 =
| stage_image3 =
| const_with_tool3 =
| const_with_item3 =
| decon_with_tool3 =
| item_rec4 =
| stage_image4 =
| const_with_tool4 =
| const_with_item4 =
| decon_with_tool4 =
| item_rec4 =
| stage_image5 =
| const_with_tool5 =
| const_with_item5 =
| decon_with_tool5 =
| item_rec5 =
| stage_image6 =
| const_with_tool6 =
| const_with_item6 =
| decon_with_tool6 =
| item_rec6 =
}}
