Template:Infobox drainable

From PZwiki
Revision as of 14:12, 7 March 2019 by Vaileasys (talk | contribs)
[view] [edit] [history] [purge] Template documentation
This template is used to create an infobox in an article about any drainable item, such as light sources, water containers, medicals or other tools.

Usage

To use this template in an article, copy the template below, then paste the template into an article.

All parameters are optional – those you do not populate with data will not show up in the infobox when the article is saved.

It is strongly advised to only include variables that are relevant to the specific item in question, i.e. parameters that do not display as false or 0.

display_name
{{{display_name}}}
alternate_name
General
Category Item
Weight
Heavy Load
weight
Function primary_use
secondary_use
Capacity max_units units
Contents contents
Can boil water can_boil_water
Rain factor rain_factor
Effect effect
Alcohol alcohol_power
Fatigue fatigue_change
Light distance light_distance tiles
Light strength light_strength
Torch cone torch_cone
Technical details
Base ID Item IDs


{{Infobox drainable
|name =
|name_colour=
|name_text_colour=
|image=
|image_width=
|alternate_image=
|alternate_name=
|alternate_link=
|alternate_image2=
|alternate_name2=
|alternate_link2=
|alternate_image3=
|alternate_name3=
|alternate_link3=
|alternate_image4=
|alternate_name4=
|alternate_link4=
|alternate_image5=
|alternate_name5=
|alternate_link5=
|alternate_image6=
|alternate_name6=
|alternate_link6=
|alternate_image7=
|alternate_name7=
|alternate_link7=
|alternate_image8=
|alternate_name8=
|alternate_link8=
|alternate_image9=
|alternate_name9=
|alternate_link9=
|alternate_image10=
|alternate_name10=
|alternate_link10=
|alternate_image11=
|alternate_name11=
|alternate_link11=
|alternate_image12=
|alternate_name12=
|alternate_link12=
|alternate_image13=
|alternate_name13=
|alternate_link13=
|alternate_image14=
|alternate_name14=
|alternate_link14=
|alternate_image15=
|alternate_name15=
|alternate_link15=
|alternate_image16=
|alternate_name16=
|alternate_link16=
|weight=
|primary_use=
|secondary_use=
|max_units=
|contents=
|can_boil_water=
|rain_factor=
|effect=
|alcohol_power=
|fatigue_change=
|light_distance=
|light_strength=
|torch_cone=
|item_id =
}}


Parameters

General

display_name
The display name of the item as it appears in-game. Leaving blank will display the pagename.
name_colour
The background colour for the display name. Codes can be found at Template:Infobox nc.
name_text_colour
The text colour for the display name. Codes can be found at Template:Infobox nc.
image
Image of the model.
image_width
Width of the image model.
alternate_image
An alternate image displayed at 32px. Will typically be the icon or icon variants.
alternate_name
The name of the alternate item image. Leaving blank will display no name when the image is hovered over.
alternate_link
An optional link to the alternate image page. Leaving blank will have no link.
weight
The base weight of the item.
primary_use
The item's primary use. Can usually be removed if the item isn't considered a tool by the wiki. (remove if value is empty)
secondary_use
The item's secondary use if it has one. Can usually be removed if the item isn't considered a tool by the wiki. (remove if value is empty)
max_units
The maximum units in a full item. Calculated using the "UseDelta" value: 1 / UseDelta.
class_name
The item's class name.


Container

contents
The contents of the item, e.g. water, electricity, etc. (remove if value is not considered to have any contents)
can_boil_water
Whether this item can be used to boil/cook water. Displayed by the variable "iscookable". (remove if value is not considered a water container)
rain_factor
The item's rain factor when it's left on the ground while it's raining. (remove if value is empty)

Medical

effect
The alcohol power of this item when used on wounds. (remove if value is not considered a medical item)
alcohol_power
The alcohol power of this item when used on wounds. (remove if value is empty)
fatigue_change
The value of fatigue that is changed from using/consuming this item. (remove if value is empty)


Light Source

light_distance
The distance the light from the source will travel. (remove if value is not considered a light source)
light_strength
The intensity/brightness of light the source provides. (remove if value is not considered a light source)
torch_cone
Whether the light from this item travels in a single direction, a.k.a torch cone. (remove if value is not considered a light source)


Examples

General items, displaying the Thread infobox

Thread
{{{display_name}}}
Thread
General
Category Item
Weight
Heavy Load
0.1
Function Craft mattress
Stitch deep wounds
Capacity 10 units
Technical details
Base ID Item IDs


{{Infobox drainable
|name =Thread
|name_colour=Construction
|name_text_colour=Construction
|image=Thread_Model.png 
|alternate_image=Thread.png
|alternate_name=Thread
|weight=0.1
|primary_use=Craft [[mattress]]
|secondary_use=Stitch [[Health#Types of Injuries|deep wounds]]
|max_units=10
|item_id = Base.Thread
}}

Power sources, displaying the Battery infobox

Battery
{{{display_name}}}
General
Category Item
Weight
Heavy Load
0.6
Function Power small items
Capacity 100,000 units
Contents Electricity
Technical details
Base ID Item IDs


{{Infobox drainable
|name =Battery
|name_colour=Electrical
|name_text_colour=Electrical
|image=Battery.png
|weight=0.6
|primary_use=Power small items
|max_units=100,000
|contents=[[Electricity]]
|item_id =Base.Battery
}}

Medical items, displaying the Vitamins infobox

Vitamins
{{{display_name}}}
General
Category Item
Weight
Heavy Load
0.2
Function Reduce tiredness
Capacity 10 units
Fatigue -2
Technical details
Base ID Item IDs


{{Infobox drainable
|name =Vitamins
|name_colour=Medical
|name_text_colour=Medical
|image=Vitamins.png
|weight=0.2
|primary_use=Reduce [[Moodles#Tired|tiredness]]
|content=Vitamins
|max_units=10
|fatigue_change=-2
|item_id =Base.PillsVitamins
}}

Water containers, displaying the Bucket infobox

Bucket
{{{display_name}}}
Bucket
General
Category Item
Weight
Heavy Load
1 (Empty)
4 (Full)
Function Cooking utensil
Capacity 25 units
Contents Water
Can boil water True
Rain factor 1
Technical details
Base ID Item IDs


{{Infobox drainable
|name =Bucket
|name_colour=Tool
|name_text_colour=Tool
|image=Bucket Model.png
|image_width=200px
|alternate_image=MetalBucket.png
|alternate_name=Bucket
|alternate_link=
|alternate_image2=MetalBucket_Water.png
|alternate_name2=Bucket of Water
|alternate_link2=
|weight=1 <small>(Empty)</small><br>4 <small>(Full)</small>
|function=[[Cooking]] utensil
|max_units=25
|contents=Water
|can_boil_water=True
|rain_factor=1
|item_id =Base.BucketEmpty<br>Base.BucketWaterFull
}}

Documentation transcluded from Template:Infobox drainable/doc.
Editors can experiment in this template's sandbox (create)