Template:Infobox drainable: Difference between revisions

From PZwiki
m (added unit to max units)
(removed maintenance notice, all issues should be fixed)
Line 1: Line 1:
<includeonly>{{Maintenance}}{{Infobox item
<includeonly>{{Infobox item
| name = {{{display_name|{{PAGENAME}}}}}
| name = {{{display_name|{{PAGENAME}}}}}
| name_colour = {{{name_colour|}}}
| name_colour = {{{name_colour|}}}

Revision as of 12:31, 29 July 2018

[view] [edit] [history] [purge] Template documentation
Imbox deletion.png
This page is a candidate for deletion.
Reason: Unused
This page (and any subpages) will be deleted after being reviewed by an admin, and no one has objected to its deletion. Users may discuss this request for deletion on the page's talk page. Once added, this should only be removed by an admin, or the user that added it.
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.

Infobox drainable
General
Encumbrance
Moodle Icon HeavyLoad.png
weight
{{Infobox drainable
|name =
|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

Infobox drainable
General
Encumbrance
Moodle Icon HeavyLoad.png
0.1
{{Infobox drainable
|name =Thread
|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

Infobox drainable
General
Encumbrance
Moodle Icon HeavyLoad.png
0.6
{{Infobox drainable
|name =Battery
|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

Infobox drainable
General
Encumbrance
Moodle Icon HeavyLoad.png
0.2
{{Infobox drainable
|name =Vitamins
|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

Infobox drainable
General
Encumbrance
Moodle Icon HeavyLoad.png
1 (Empty)
4 (Full)
{{Infobox drainable
|name =Bucket
|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)