Actions

Template

Difference between revisions of "Structurebox/doc"

From Unofficial Stationeers Wiki

< Template:Structurebox
(Create a basic documentation page for the Structurebox template)
 
(Update the Structurebox documentation to the parameter rename and Construction stage usage)
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 places structures. It will create an Infobox on the right hand side at the top of the article.
+
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]].
  
−
== Usage ==
+
When included, it will also add the page, it is included in, to [[:Category:Structures]].
 +
 
 +
== Parameters ==
 +
<!-- Replace this, once we have the "Parameters" Mediawiki module installed -->
 +
The following, optional parameters can be supplied:
 +
{| class="wikitable"
 +
|-
 +
! Parameter Name  !! Description
 +
|-
 +
| name            || The name of the structure.
 +
|-
 +
| image            || An image of the completely built structure.
 +
|-
 +
| power_usage      || The power required to operate the structure.
 +
|-
 +
| placed_with_item || The item, that is used to place the initial stage of the structure.
 +
|-
 +
| placed_on_grid  || The grid size, the structure is placed on. This should be either "Small Grid", "Large Grid" or "Dynamic".
 +
|-
 +
| stage_image1    || The image for the first construction stage.
 +
|-
 +
| const_with_tool1 || The tool, that the next stage is constructed with, from the first stage.
 +
|-
 +
| const_with_item1 || The item, that the next stage is constructed with, from the first stage.
 +
|-
 +
| decon_with_tool1 || The tool, that the first stage is deconstructed with.
 +
|-
 +
| item_rec1        || The item, that the player receives, on deconstructing the first stage.
 +
|-
 +
| stage_image2    || The image for the second construction stage.
 +
|-
 +
| const_with_tool2 || The tool, that the next stage is constructed with, from the second stage.
 +
|-
 +
| const_with_item2 || The item, that the next stage is constructed with, from the second stage.
 +
|-
 +
| decon_with_tool2 || The tool, that the second stage is deconstructed with.
 +
|-
 +
| item_rec2        || The item, that the player receives, on deconstructing the second stage.
 +
|-
 +
| stage_image3    || The image for the third construction stage.
 +
|-
 +
| const_with_tool3 || The tool, that the next stage is constructed with, from the third stage.
 +
|-
 +
| const_with_item3 || The item, that the next stage is constructed with, from the third stage.
 +
|-
 +
| decon_with_tool3 || The tool, that the third stage is deconstructed with.
 +
|-
 +
| item_rec3        || The item, that the player receives, on deconstructing the third stage.
 +
|}
 +
 
 +
<!-- The below does not work, unless we install the "Parameters" Mediawiki module -->
 +
<!-- == Blank ==
 +
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}} -->
  
−
<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>

Revision as of 12:44, 1 July 2018

Summary

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.

Parameters

The following, optional parameters can be supplied:

Parameter Name Description
name The name of the structure.
image An image of the completely built structure.
power_usage The power required to operate the structure.
placed_with_item The item, that is used to place the initial stage of the structure.
placed_on_grid The grid size, the structure is placed on. This should be either "Small Grid", "Large Grid" or "Dynamic".
stage_image1 The image for the first construction stage.
const_with_tool1 The tool, that the next stage is constructed with, from the first stage.
const_with_item1 The item, that the next stage is constructed with, from the first stage.
decon_with_tool1 The tool, that the first stage is deconstructed with.
item_rec1 The item, that the player receives, on deconstructing the first stage.
stage_image2 The image for the second construction stage.
const_with_tool2 The tool, that the next stage is constructed with, from the second stage.
const_with_item2 The item, that the next stage is constructed with, from the second stage.
decon_with_tool2 The tool, that the second stage is deconstructed with.
item_rec2 The item, that the player receives, on deconstructing the second stage.
stage_image3 The image for the third construction stage.
const_with_tool3 The tool, that the next stage is constructed with, from the third stage.
const_with_item3 The item, that the next stage is constructed with, from the third stage.
decon_with_tool3 The tool, that the third stage is deconstructed with.
item_rec3 The item, that the player receives, on deconstructing the third stage.
Retrieved from "https://stationeers-wiki.com/index.php?title=Template:Structurebox/doc&oldid=4393"