Template:Structure/doc

From Timberborn Wiki
Jump to navigation Jump to search

Setting Up Images

Images are automatically shown in the Infobox, 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 code will instead use Template:Infobox_Gallery.
    • 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
    • The crop page 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=Boosts the growth of nearby plants. // Description as shown in the game.
|flavor= // If the structure has a flavor text/quote, it's noted here.
|author= // If the flavor text/quote has an author, it's shown here.

// 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.
|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

// Natural Structures related

|resources=[[Logs]] (3), [[Pine resin]] (2) // The resources the structure can give (for trees, Ruins, etc).
|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
|aquatic=yes // Is the plant aquatic?

// Work related

|workers=1 // The number of Workers the building can have.
|worker_type=beaver // beaver or golem. 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.

// Materials used in Building

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