Actions

Template

Difference between revisions of "Structurebox/doc"

From Unofficial Stationeers Wiki

< Template:Structurebox
(Add Editing section, referencing the Construction stage template)
(added more properties)
 
(8 intermediate revisions by 5 users not shown)
Line 9: Line 9:
 
When included, it will also add the page, it is included in, to [[:Category:Structures]].
 
When included, it will also add the page, it is included in, to [[:Category:Structures]].
  
== Parameters ==
+
== Template data ==
<!-- Replace this, once we have the "Parameters" Mediawiki module installed -->
+
 
The following, optional parameters can be supplied:
+
<templatedata>
{| class="wikitable"
+
{
|-
+
"params": {
! Parameter Name   !! Description
+
"name": {
|-
+
"label": "Name",
| name            || The name of the structure.
+
"description": "The name of the structure",
|-
+
"example": "Active Vent",
| image           || An image of the completely built structure.
+
"type": "string"
|-
+
},
| power_usage     || The power required to operate the structure.
+
"image": {
|-
+
"label": "Image",
| placed_with_item || The item, that is used to place the initial stage of the structure.
+
"description": "An image of the completely built structure.",
|-
+
"type": "wiki-file-name"
| placed_on_grid   || The grid size, the structure is placed on. This should be either "Small Grid", "Large Grid" or "Dynamic".
+
},
|-
+
"other": {
| stage_image1     || The image for the first construction stage.
+
"label": "Other",
|-
+
"description": "Any other remarks, that can be placed before the subsections.",
| const_with_tool1 || The tool, that the next stage is constructed with, from the first stage.
+
"type": "string"
|-
+
},
| const_with_item1 || The item, that the next stage is constructed with, from the first stage.
+
"paintable": {
|-
+
"label": "Paintable",
| decon_with_tool1 || The tool, that the first stage is deconstructed with.
+
"description": "Whether the structure is paitable.",
|-
+
"type": "boolean",
| item_rec1        || The item, that the player receives, on deconstructing the first stage.
+
"example": "Yes, No"
|-
+
},
| stage_image2    || The image for the second construction stage.
+
"constructable_in_rockets": {
|-
+
"label": "Constructable in rockets",
| const_with_tool2 || The tool, that the next stage is constructed with, from the second stage.
+
"description": "Whether the structure can be constructed inside a rocket.",
|-
+
"example": "Yes, No",
| const_with_item2 || The item, that the next stage is constructed with, from the second stage.
+
"type": "boolean"
|-
+
},
| decon_with_tool2 || The tool, that the second stage is deconstructed with.
+
"rocket_mass_contribution": {
|-
+
"label": "Rocket Mass Contribution",
| item_rec2        || The item, that the player receives, on deconstructing the second stage.
+
"description": "Mass in kg added to the Rocket",
|-
+
"example": "30 kg",
| stage_image3    || The image for the third construction stage.
+
"type": "string"
|-
+
},
| const_with_tool3 || The tool, that the next stage is constructed with, from the third stage.
+
"power_usage": {
|-
+
"label": "Power usage",
| const_with_item3 || The item, that the next stage is constructed with, from the third stage.
+
"description": "The power required to operate the structure.",
|-
+
"type": "string"
| decon_with_tool3 || The tool, that the third stage is deconstructed with.
+
},
|-
+
"burst_pressure": {
| item_rec3        || The item, that the player receives, on deconstructing the third stage.
+
"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 ==
 
== Editing ==
Line 63: Line 268:
 
The stage sections need to be edited on the [[Template:Construction stage]] page.
 
The stage sections need to be edited on the [[Template:Construction stage]] page.
  
<!-- The below does not work, unless we install the "Parameters" Mediawiki module -->
+
== Blank ==
<!-- == Blank ==
 
 
This is the blank template code, that can be copy-pasted into a page to use it there.
 
This is the blank template code, that can be copy-pasted into a page to use it there.
{{subst:#tag:pre|{{subst:Parameters|code|base={{subst:BASEPAGENAME}}}}|style=overflow: auto;|pad=yes}} -->
+
<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>
  
 
<noinclude>[[Category:Template Documentation]]</noinclude><includeonly>{{sandbox other||
 
<noinclude>[[Category:Template Documentation]]</noinclude><includeonly>{{sandbox other||

Latest revision as of 04:10, 27 November 2025

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

Template parameters

ParameterDescriptionTypeStatus
Namename

The name of the structure

Default
empty
Example
Active Vent
Auto value
empty
Stringoptional
Imageimage

An image of the completely built structure.

Default
empty
Example
empty
Auto value
empty
Fileoptional
Otherother

Any other remarks, that can be placed before the subsections.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Paintablepaintable

Whether the structure is paitable.

Default
empty
Example
Yes, No
Auto value
empty
Booleanoptional
Constructable in rocketsconstructable_in_rockets

Whether the structure can be constructed inside a rocket.

Default
empty
Example
Yes, No
Auto value
empty
Booleanoptional
Rocket Mass Contributionrocket_mass_contribution

Mass in kg added to the Rocket

Default
empty
Example
30 kg
Auto value
empty
Stringoptional
Power usagepower_usage

The power required to operate the structure.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Burst pressureburst_pressure

The maximum pressure the structure can withstand before breaking.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Volumevolume

Volume of the Container.

Default
empty
Example
250L
Auto value
empty
Stringoptional
Thermal Convectionconvection

Thermal Convection Factor

Default
empty
Example
0.625
Auto value
empty
Numberoptional
Thermal Radiationradiation

Thermal Radiation Factor

Default
empty
Example
0.025
Auto value
empty
Numberoptional
Solar Heatingsolar_heating

Solar Heating Factor

Default
empty
Example
1.25
Auto value
empty
Numberoptional
Prefab Hashprefab_hash

The prefab hash for the structure

Default
empty
Example
empty
Auto value
empty
Stringoptional
Prefab nameprefab_name

The prefab name for the structure

Default
empty
Example
empty
Auto value
empty
Stringoptional
Place with itemplaced_with_item

The item that is used to place the initial stage of the structure.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Place on gridplaced_on_grid

The grid size, the structure is placed on. This should be either "Small Grid", "Large Grid" or "Dynamic".

Default
empty
Example
Small Grid, Large Grid, Dynamic
Auto value
empty
Stringoptional
Slot_0slot_0

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Slot_1slot_1

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Slot_2slot_2

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Slot_3slot_3

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Stage 1 imagestage_image1

The image for the construction stage.

Default
empty
Example
empty
Auto value
empty
Fileoptional
Stage 1 toolconst_with_tool1

The tool which the stage is constructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 1 itemconst_with_item1

The item required to construct this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 1 deconstruction tooldecon_with_tool1

The tool which this stage is deconstructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 1 deconstruction itemitem_rec1

The item that the player receives when deconstructing this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 2 imagestage_image2

The image for the construction stage.

Default
empty
Example
empty
Auto value
empty
Fileoptional
Stage 2 toolconst_with_tool2

The tool which the stage is constructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 2 itemconst_with_item2

The item required to construct this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 2 deconstruction tooldecon_with_tool2

The tool which this stage is deconstructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 2 deconstruction itemitem_rec2

The item that the player receives when deconstructing this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 3 imagestage_image3

The image for the construction stage.

Default
empty
Example
empty
Auto value
empty
Fileoptional
Stage 3 toolconst_with_tool3

The tool which the stage is constructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 3 itemconst_with_item3

The item required to construct this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 3 deconstruction tooldecon_with_tool3

The tool which this stage is deconstructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 3 deconstruction itemitem_rec3

The item that the player receives when deconstructing this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 4 imagestage_image4

The image for the construction stage.

Default
empty
Example
empty
Auto value
empty
Fileoptional
Stage 4 toolconst_with_tool4

The tool which the stage is constructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 4 itemconst_with_item4

The item required to construct this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 4 deconstruction tooldecon_with_tool4

The tool which this stage is deconstructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 4 deconstruction itemitem_rec4

The item that the player receives when deconstructing this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 5 imagestage_image5

The image for the construction stage.

Default
empty
Example
empty
Auto value
empty
Fileoptional
Stage 5 toolconst_with_tool5

The tool which the stage is constructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 5 itemconst_with_item5

The item required to construct this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 5 deconstruction tooldecon_with_tool5

The tool which this stage is deconstructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 5 deconstruction itemitem_rec5

The item that the player receives when deconstructing this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 6 imagestage_image6

The image for the construction stage.

Default
empty
Example
empty
Auto value
empty
Fileoptional
Stage 6 toolconst_with_tool6

The tool which the stage is constructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 6 itemconst_with_item6

The item required to construct this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 6 deconstruction tooldecon_with_tool6

The tool which this stage is deconstructed with.

Default
empty
Example
empty
Auto value
empty
Pageoptional
Stage 6 deconstruction itemitem_rec6

The item that the player receives when deconstructing this stage.

Default
empty
Example
empty
Auto value
empty
Pageoptional

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                = 
}}