Template:Structure

From Timberborn Wiki
Jump to navigation Jump to search


Template-info.svg Documentation Edit this documentation at Template:Structure/doc.
(edithistorypurge)


Setting Up Images

Images are automatically shown, as long as they are uploaded with the correct file name:

  • The default Image (shown on top) must have the filepath Page Name.png.
    • Example: Beaver Statue.png
  • If the structure has both a Folktails icon.png Folktails and an Iron Teeth icon.png Iron Teeth variation:
    • The Folktails icon.png Folktails variation image is the default, and thus must be named Page Name.png
    • The Iron Teeth icon.png Iron Teeth variation must be named Page Name (Iron Teeth).png.
    • Example: Beaver Statue.png and Beaver Statue (Iron Teeth).png
  • The image gallery also supports showing of a seedling variation of Crops icon.png Crops
    • Crop pages should be named Crop name (Crop) and the crop image should be Crop name (Crop).png
    • The seedling image should be name Crop name (Seedling).png
    • Example: Wheat (Crop).png and Wheat (Seedling).png
  • For the structure icon, the file path must be named Page Name icon.png.
    • Example: Beaver Statue icon.png
    • If you want to hide the icon, you can use noicon as the file path.

Filling Up the Template

{{Structure
|category=[[Housing]] // The category of the structure.
|dimensions=2x1 // The horizontal dimensions of the structure.
|height=1 // The height of the structure.
|description=no // Description as shown in the game, or no.
|flavor=no // no, or the flavor text/quote.
|author= // If the flavor text/quote has an author, it's shown here. Don't make it a link to a page. All pages with authors are categorized as "Quotes by <author>" and that category page can be used for their backstory.

// Structure details

|solid=no // Is the building Solid?
|ground-only=no // Is the building Ground-only?
|faction=Folktails // If the building is unique to a faction, the faction is noted here. Leave blank if it's not unique.
|requires-haulers= //yes only if the building requires haulers to function, otherwise leave blank
|satisfies=[[Sleep]], [[Comfort]] // The Needs this building can satisfy.
|capacity=30 // The Storage's capacity as shown in the game's tooltip.
|hidden_storage={{r|50|Carrots}}<br/>{{r|50|Potatoes}}<br/>{{r|50|Wheat}} // The hidden storage that a building might have, such as Farmhouses.
|inhabitants=3 // The amount of inhabitants a Housing building can have at once.
|visitors=5 // The amount of visitors a building can have at once (for Leisure buildings and other).
|custom1=[[Thirst]] // A custom field.
|custom2=Maximum depth: 2 // Another custom field.
|affected_by=Farming speed // Which bonuses affect this building
|shares-power=yes //If the structure can transmit power, omit or leave blank if not.

// Natural Structures related

|resources=[[Logs]] (3), [[Pine resin]] (2) // The [[Goods]] the structure can give (for trees, Ruins, etc). If the structure is a Natural Structure that doesn't directly produce Goods, set this to "no". Otherwise leave it blank. 
|days_to_grow=3 // The amount of days a plant needs to grow to mature state.
|days_between_harvest=12  // The amount of days it takes for resources to grow. If it is a Tree only used for wood, set this to "no".
|aquatic=yes // Is the plant aquatic?

// Work related

|workers=1 // The number of Workers the building can have.
|worker_type=beaver // beaver or bot. If the building only allows certain types of workers.
|consumes=1 {{i|Potato|notext}} 0.1 {{i|Logs|notext}} // The items consumed in production, as shown in the UI.
|produces=4 {{i|Grilled Potatoes|notext}} // The resulting amount of items produced, as shown in the UI.
|hours=0.78h // The time it takes for produce the items, as shown in the UI.
|consumes2=1 {{i|Chestnut|notext}} 0.1 {{i|Logs|notext}} // The items consumed by the second recipe, as shown in the UI.
|produces2=2 {{i|Grilled Chestnut}} // The resulting amount of items produced by the second recipe, as shown in the UI.
|hours2=0.66h // The time it takes for produce the items by the second recipe, as shown in the UI.
|consumes3=1 {{i|Wheat Flour|notext}} 0.1 {{i|Logs|notext}} // The items consumed by the thirdrecipe, as shown in the UI.
|produces3=5 {{i|Bread|notext}} // The resulting amount of items produced by the thirdrecipe, as shown in the UI.
|hours3=0.42h // The time it takes for produce the items by the third recipe, as shown in the UI.
|hp=60 // The amount of Horsepower consumed by the building.

// Construction Materials

|science=0
|unlockbot= // Leave this blank for workplaces that canot be used by bots. If it is pre-unlocked for bots, set this to zero.
|logs=0
|planks=0
|gears=0
|paper=0
|scrap_metal=0
|metal_blocks=0
|explosives=0
|pine_resin=0
|treated_planks=0
|water=0
|extract=0
}}

Automatic categories

This template creates some Wikimedia category pages. These categories have been manually added to their own category: Category:Structure_categorization.

Boilerplate

{{Structure
|category=
|dimensions=1x1
|height=1
|description=
|flavor=
|author=

|solid=no
|ground-only=no
|faction=
|requires-haulers=
|satisfies=
|capacity=
|hidden_storage=
|inhabitants=
|visitors=
|custom1=
|custom2=
|affected_by=

|resources=
|days_to_grow=
|days_between_harvest=
|aquatic=

// Work related

|workers=
|worker_type=
|consumes=
|produces=
|hours=
|consumes2=
|produces2=
|hours2=
|consumes3=
|produces3=
|hours3=
|hp=

|science=
|unlockbot=
|logs=
|planks=
|gears=
|paper=
|scrap_metal=
|metal_blocks=
|explosives=
|pine_resin=
|treated_planks=
|extract=
}}

'''{{PAGENAME}}''' <preamble>

==Construction==
===Production chain===

==Usage==

==Strategies & Tips==

==Gallery==
<gallery>
Example.jpg|Caption1
Example.jpg|Caption2
</gallery>

==History==
* [[Update n]]: Introduced.

No description.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Factionfaction

The faction this structure is exclusive to

Suggested values
Folktails Iron Teeth
Example
Folktails
Stringsuggested
Descriptiondescription

In-game descriptive text.

Stringsuggested
Solidsolid

Other buildings can be built on top

Booleanoptional
Ground-Onlyground-only groundonly ground_only

Must be built on the ground

Booleanoptional
Beaver-Onlybeaver-only beaveronly beaver_only

Only beavers are allowed to work in that workplace

Booleanoptional
Worker Typeworker_type worker-type workertype

If limited to a certain type of worker

Suggested values
Beavers Bots
Stringoptional
Aquaticaquatic

Must be planted in shallow water

Booleanoptional
Shares Powershares-power shares_power sharespower

Shares power with adjacent buildings

Booleanoptional
hphp

Hp Required / Generated / Stored

Numberoptional
Needs Satisfiedsatisfies

List of pagelinks of the type of needs satisfied

Stringoptional
Capacitycapacity

Amount of general storage

Numberoptional
Residentsinhabitants

Maximum number of Beavers that can sleep inside

Numberoptional
Visitorsvisitors

Maximum number of Beavers that can be inside the attraction at once

Numberoptional
Goods obtainedresources

Pagelink to the goods and quantity gained

Suggested values
{{i|Logs}} (3) {{i|Coffee Beans}} (1)
Stringoptional
Is Wonderwonder

The pinnacle of beaver engineering

Booleanoptional
custom1custom1

Additional typed description text

Stringoptional
custom2custom2

Additional typed description text

Stringoptional
Days to growdays_to_grow days-to-grow daystogrow

Maturation time

Numberoptional
Days between harvestdays_between_harvest days-between-havest daysbetweenharvest

no description

Numberoptional
Affected Byaffected_by affected-by affectedby

Bonuses that affect the time as pagelinks

Stringoptional
Flavorflavor

In-game flavor text

Stringoptional
Authorauthor

In-game flavor text's attributed author - if any. Don't use a pagelink, it's set automatically.

Stringoptional
Flavor 2flavor2

no description

Stringoptional
Author 2author2

no description

Unknownoptional
Dimensionsdimensions

Width x length

Suggested values
2x3 5x5
Stringrequired
Heightheight

no description

Numberrequired
Workersworkers

Maximum number of workers

Numberoptional
Ingredients (Recipe 1)consumes

Pagelink to goods used in recipe 1

Stringoptional
Hours (Recipe 1)hours

Recipe 1 time to complete with full worker complement

Numberoptional
Yield (Recipe 1)produces

Pagelink to goods or needs produced in recipe 1

Stringoptional
Ingredients (Recipe 2)consumes2

Pagelink to goods used in recipe 2

Stringoptional
Hours (Recipe 2)hours2

Recipe 2 time to complete with full worker complement

Numberoptional
Yield (Recipe 2)produces2

Pagelink to goods or needs produced in recipe 2

Stringoptional
Ingredients (Recipe 3)consumes3

Pagelink to goods used in recipe 3

Stringoptional
Hours (Recipe 3)hours3

Recipe 3 time to complete with full worker complement

Numberoptional
Yield (Recipe 3)produces3

Pagelink to goods or needs produced in recipe 3

Stringoptional
Hidden Storagehidden_storage hidden-storage hiddenstorage

Internal storage for ingredients and yield of the recipe. Use the r template to show in and out.

Unbalanced wikitextsuggested
Sciencescience

Amount of science points needed to unlock this structure

Numbersuggested
Unlock Botunlockbot unlock-bot unlock_bot

Science points needed to unlock bot workplace

Numbersuggested
Logslogs

Amount of logs needed to build this structure

Numbersuggested
Planksplanks

Amount of planks needed to build this structure

Numbersuggested
Gearsgears

Amount of gears needed to build this structure

Numbersuggested
Paperpaper

Amount of paper needed to build this structure

Numberoptional
Scrap Metalscrap_metal scrap-metal scrapmetal

Amount of scrap metal needed to build this structure

Numberoptional
Metal Blocksmetal_blocks metal-blocks metalblocks

Amount of metal blocks needed to build this structure

Numbersuggested
Explosivesexplosives

Amount of explosives needed to build this structure

Numberoptional
Extractextract

Amount of extract needed to build this structure

Numberoptional
Pine Resinpine_resin pine-resin pineresin

Amount of pine resin needed to build this structure

Numberoptional
Treated Plankstreated_planks treated-planks treatedplanks

Amount of treated planks needed to build this structure

Numbersuggested
Dirtdirt

Amount of dirt needed to build this structure

Numberoptional
Wheatwheat

Amount of wheat needed to build this structure

Numberoptional