Template:Infobox normal/doc: Difference between revisions

From PZwiki
(added metal_value)
m (Remove lines))
 
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude>{{Documentation subpage}}</noinclude>
{{Documentation subpage}}
 
{{Delete|Unused}}
This template is used to create an infobox in an article about empty water container, medical, drying, remote controller and other miscellaneous items.
This template is used to create an infobox in an article about empty water container, medical, drying, remote controller and other miscellaneous items.


Line 10: Line 10:
''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'''.''
''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 normal
{{Infobox normal
|display_name=display_name
|name =display_name
|name_colour=name_colour
|name_text_colour=name_text_colour
|image=image.png
|image=image.png
|image_width=200px
|image_width=200px
Line 25: Line 23:
|alternate_link3=
|alternate_link3=
|alternate_image4=image.png{{!}}32px
|alternate_image4=image.png{{!}}32px
|alternate_name4=alternate_name3
|alternate_name4=alternate_name4
|alternate_link4=
|alternate_link4=
|alternate_image5=image.png{{!}}32px
|alternate_image5=image.png{{!}}32px
|alternate_name5=alternate_name3
|alternate_name5=alternate_name5
|alternate_link5=
|alternate_link5=
|category=category
|weight=weight
|weight=weight
|primary_use=primary_use
|function=function
|secondary_use=secondary_use
|can_store_water=can_store_water
|can_store_water=can_store_water
|rain_factor=rain_factor
|rain_factor=rain_factor
Line 40: Line 38:
|remote_range=remote_range
|remote_range=remote_range
|ingredients=ingredients
|ingredients=ingredients
|class_name=class_name
|item_id =class_name
}}<pre>
}}
<pre>
{{Infobox normal
{{Infobox normal
|display_name=
|name =
|name_colour=
|name_text_colour=
|image=
|image=
|image_width=
|image_width=
|category=
|alternate_image=
|alternate_image=
|alternate_name=
|alternate_name=
Line 64: Line 62:
|alternate_link5=
|alternate_link5=
|weight=
|weight=
|primary_use= <!-- or | function = -->
|function= <!-- or | primary_use = --> <!-- or |secondary_use= -->
|secondary_use=
|metal_value= <!-- currently hidden; function not yet implemented -->
|metal_value=
|can_store_water=
|can_store_water=
|rain_factor=
|rain_factor=
Line 74: Line 71:
|remote_range=
|remote_range=
|ingredients=
|ingredients=
|class_name=
|item_id =
}}</pre>
}}
</pre>




Line 82: Line 80:
;name_colour: The background colour for the display name. Codes can be found at [[Template:Infobox nc]].
;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]].
;name_text_colour: The text colour for the display name. Codes can be found at [[Template:Infobox nc]].
;image: An image of the icon displayed at 120px. A 120px variant should be used if it has one.
;image: An image of the icon displayed at 128px by default. Item model is preferred.
;image_width: Customise the <code>image</code> width. ''Default: 128px''
;alternate_image: An alternate image displayed at 32px. Can be an empty, packaged, open or any other variant.
;alternate_image: An alternate image displayed at 32px. Can be an empty, packaged, open or any other variant.
;alternate_name: The name of the alternate item image. Leaving blank will display no name when the image is hovered over.
;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.
;alternate_link: An optional link to the alternate image page. Leaving blank will have no link.
;weight: The base weight of the item.
;weight: The base encumbrance 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)''
;function: What the item can be used for. Minor uses should be omitted. Combines the deprecated <code>primary_use</code> and <code>secondary_use</code>. The <code><nowiki><</nowiki>br></code> tag should be used instead to separate functions. ''(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)''
;{{tooltip|''primary_use''|Deprecated: use 'function' instead}}: 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)''
;{{tooltip|''secondary_use''|Deprecated: use 'function' instead}}: 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)''
;metal_value: The amount of ''metal'' this item provides when used in metalworking/smithing. (currently hidden until feature is implemented)
;metal_value: The amount of ''metal'' this item provides when used in metalworking/smithing. (currently hidden until feature is implemented)
;can_store_water: Whether this item can act as a water container ''(remove if value is false)''
;can_store_water: Whether this item can act as a water container ''(remove if value is false)''
Line 98: Line 98:
;ingrdients: A list of ingredients required to make this item. Please use the following format: <code>1 × <nowiki>[[</nowiki>Plank]]</code> and separate ingredients into a list with <code><nowiki><</nowiki>br></code>.
;ingrdients: A list of ingredients required to make this item. Please use the following format: <code>1 × <nowiki>[[</nowiki>Plank]]</code> and separate ingredients into a list with <code><nowiki><</nowiki>br></code>.
;class_name: The item's class name.
;class_name: The item's class name.


==Examples==
==Examples==
'''Miscellaneous items, displaying the [[Eraser]] infobox'''
'''Miscellaneous items, displaying the [[Eraser]] infobox'''
{{Infobox normal
{{Infobox normal
|display_name=Eraser
|name =Eraser
|name_colour=Tool
|image=Eraser.png
|name_text_colour=Tool
|image=Eraser_120px.png
|weight=0.1
|weight=0.1
|primary_use=Remove markings from an [[Map|annotated map]].
|primary_use=Remove markings from an [[Map|annotated map]].
|class_name=Base.Eraser
|item_id =Base.Eraser
}}<pre>
}}
<pre>
{{Infobox normal
{{Infobox normal
|display_name=Eraser
|name =Eraser
|name_colour=Tool
|image=Eraser.png
|name_text_colour=Tool
|image=Eraser_120px.png
|weight=0.1
|weight=0.1
|primary_use=Remove markings from an [[Map|annotated map]].
|primary_use=Remove markings from an [[Map|annotated map]].
|class_name=Base.Eraser
|item_id =Base.Eraser
}}</pre>
}}
</pre>
{{clear}}
{{clear}}


'''Empty water containers, displaying the [[Bowl]] infobox'''
'''Empty water containers, displaying the [[Bowl]] infobox'''
{{Infobox normal
{{Infobox normal
|display_name=Bowl
|name =Bowl
|name_colour=Tool
|name_text_colour=Tool
|image=Bowl.png
|image=Bowl.png
|alternate_image=BowlFull_Water.png
|alternate_image=BowlFull_Water.png
Line 136: Line 131:
|can_store_water=True
|can_store_water=True
|rain_factor=0.5
|rain_factor=0.5
|class_name=Base.Bowl
|item_id =Base.Bowl
}}<pre>
}}
<pre>
{{Infobox normal
{{Infobox normal
|display_name=Bowl
|name =Bowl
|name_colour=Tool
|name_text_colour=Tool
|image=Bowl.png
|image=Bowl.png
|alternate_image=BowlFull_Water.png
|alternate_image=BowlFull_Water.png
Line 151: Line 145:
|can_store_water=True
|can_store_water=True
|rain_factor=0.5
|rain_factor=0.5
|class_name=Base.Bowl
|item_id =Base.Bowl
}}</pre>
}}
</pre>
{{clear}}
{{clear}}


'''Medical items, displaying the [[Sterilized Rag]] infobox'''
'''Medical items, displaying the [[Sterilized Rag]] infobox'''
{{Infobox normal
{{Infobox normal
|display_name=Sterilized Rag
|name =Sterilized Rag
|name_colour=Medical
|name_text_colour=Medical
|image=Rag.png
|image=Rag.png
|alternate_image=RagDirty.png
|alternate_image=RagDirty.png
Line 168: Line 161:
|bandage_power=2
|bandage_power=2
|alcohol=True
|alcohol=True
|class_name=Base.AlcoholRippedSheets
|item_id =Base.AlcoholRippedSheets
}}<pre>
}}
<pre>
{{Infobox normal
{{Infobox normal
|display_name=Sterilized Rag
|name =Sterilized Rag
|name_colour=Medical
|name_text_colour=Medical
|image=Rag.png
|image=Rag.png
|alternate_image=RagDirty.png
|alternate_image=RagDirty.png
Line 182: Line 174:
|bandage_power=2
|bandage_power=2
|alcohol=True
|alcohol=True
|class_name=Base.AlcoholRippedSheets
|item_id =Base.AlcoholRippedSheets
}}</pre>
}}
</pre>
{{clear}}
{{clear}}


'''Drying items, displaying the [[Bath Towel]]''' infobox
'''Drying items, displaying the [[Bath Towel]]''' infobox
{{Infobox normal
{{Infobox normal
|display_name=Bath Towel
|name =Bath Towel
|name_colour=Tool
|name_text_colour=Tool
|image=Bathtowel.png
|image=Bathtowel.png
|alternate_image=Bathtowel.png
|alternate_image=Bathtowel.png
Line 198: Line 189:
|primary_use=Dry a [[Moodles#Wet|wet]] player
|primary_use=Dry a [[Moodles#Wet|wet]] player
|wet_cooldown=10000
|wet_cooldown=10000
|class_name='''Dry:''' Base.BathTowel<br>'''Wet:''' Base.BathTowelWet
|item_id ='''Dry:''' Base.BathTowel<br>'''Wet:''' Base.BathTowelWet
}}<pre>
}}
<pre>
{{Infobox normal
{{Infobox normal
|display_name=Bath Towel
|name =Bath Towel
|name_colour=Tool
|name_text_colour=Tool
|image=Bathtowel.png
|image=Bathtowel.png
|alternate_image=Bathtowel.png
|alternate_image=Bathtowel.png
Line 211: Line 201:
|primary_use=Dry a [[Moodles#Wet|wet]] player
|primary_use=Dry a [[Moodles#Wet|wet]] player
|wet_cooldown=10000
|wet_cooldown=10000
|class_name='''Dry:''' Base.BathTowel<br>'''Wet:''' Base.BathTowelWet
|item_id ='''Dry:''' Base.BathTowel<br>'''Wet:''' Base.BathTowelWet
}}</pre>
}}
</pre>
{{clear}}
{{clear}}


'''[[V1 Remote Controller]] infobox'''
'''[[V1 Remote Controller]] infobox'''
{{Infobox normal
{{Infobox normal
|display_name=V1 Remote Controller
|name =V1 Remote Controller
|name_colour=Electrical
|name_text_colour=Electrical
|image=RemoteCrafted.png
|image=RemoteCrafted.png
|weight=0.4
|weight=0.4
|primary_use=Trigger [[:Category:Bomb_and_Throwing_Items|traps]] remotely
|primary_use=Trigger [[Weapons#Explosives|traps]] remotely
|remote_range=7
|remote_range=7
|class_name=Base.RemoteCraftedV1
|item_id =Base.RemoteCraftedV1
}}<pre>
}}
<pre>
{{Infobox normal
{{Infobox normal
|display_name=V1 Remote Controller
|name =V1 Remote Controller
|name_colour=Electrical
|name_text_colour=Electrical
|image=RemoteCrafted.png
|image=RemoteCrafted.png
|weight=0.4
|weight=0.4
|primary_use=Trigger [[:Category:Bomb_and_Throwing_Items|traps]] remotely
|primary_use=Trigger [[Weapons#Explosives|traps]] remotely
|remote_range=7
|remote_range=7
|class_name=Base.RemoteCraftedV1
|item_id =Base.RemoteCraftedV1
}}</pre>
}}</pre>
{{clear}}
{{clear}}

Latest revision as of 07:29, 15 April 2024

Notebook.png
This is a documentation subpage for Template:Infobox normal.
It contains usage information and other content that is not part of the original template page.
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 empty water container, medical, drying, remote controller and other miscellaneous items.

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 alternate_name2 alternate_name3 alternate_name4 alternate_name5
General
Category category
Encumbrance
Heavy Load
weight
Function function
Can store water can_store_water
Rain factor rain_factor
Bandage power
Bleeding
bandage_power
Alcohol
Drunk
alcohol
Time to dry
Wet
wet_cooldown
Remote range remote_range tiles
Technical details
Ingredients ingredients
Base ID Item IDs
{{Infobox normal
|name =
|image=
|image_width=
|category=
|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=
|weight=
|function= <!-- or | primary_use = --> <!-- or |secondary_use= -->
|metal_value= <!-- currently hidden; function not yet implemented -->
|can_store_water=
|rain_factor=
|bandage_power=
|alcohol=
|wet_cooldown=
|remote_range=
|ingredients=
|item_id =
}}


Parameters

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
An image of the icon displayed at 128px by default. Item model is preferred.
image_width
Customise the image width. Default: 128px
alternate_image
An alternate image displayed at 32px. Can be an empty, packaged, open or any other variant.
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 encumbrance of the item.
function
What the item can be used for. Minor uses should be omitted. Combines the deprecated primary_use and secondary_use. The <br> tag should be used instead to separate functions. (remove if value is empty)
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)
metal_value
The amount of metal this item provides when used in metalworking/smithing. (currently hidden until feature is implemented)
can_store_water
Whether this item can act as a water container (remove if value is false)
rain_factor
The item's rain factor when it's left on the ground while it's raining. (remove if value is empty)
bandage_power
The item's bandage power. (remove if value is empty)
alcohol
Whether this item is considered to be alcohol and therefore contributing to the drunk moodle. (remove if value is false)
wet_cooldown
How long it takes for the item to dry if it's wet. (remove if value is empty)
remote_range
The item's maximum range it can trigger a remote trap. (remove if value is empty)
ingrdients
A list of ingredients required to make this item. Please use the following format: 1 × [[Plank]] and separate ingredients into a list with <br>.
class_name
The item's class name.

Examples

Miscellaneous items, displaying the Eraser infobox

Eraser
{{{display_name}}}
General
Category Item
Encumbrance
Heavy Load
0.1
Function Remove markings from an annotated map.
Technical details
Base ID Item IDs
{{Infobox normal
|name =Eraser
|image=Eraser.png
|weight=0.1
|primary_use=Remove markings from an [[Map|annotated map]].
|item_id =Base.Eraser
}}

Empty water containers, displaying the Bowl infobox

Bowl
{{{display_name}}}
Bowl of Water
General
Category Item
Encumbrance
Heavy Load
0.5
Function Cooking utensil
Water container
Can store water True
Rain factor 0.5
Technical details
Base ID Item IDs
{{Infobox normal
|name =Bowl
|image=Bowl.png
|alternate_image=BowlFull_Water.png
|alternate_name=Bowl of Water
|alternate_link=Bowl of Water
|weight=0.5
|primary_use=[[Cooking]] utensil
|secondary_use=[[Water]] container
|can_store_water=True
|rain_factor=0.5
|item_id =Base.Bowl
}}

Medical items, displaying the Ripped Sheets infobox

Sterilized Rag
{{{display_name}}}
Dirty Rag
General
Category Item
Encumbrance
Heavy Load
0.05
Function Bandage bleeding wounds
Bandage power
Bleeding
2
Alcohol
Drunk
True
Technical details
Base ID Item IDs
{{Infobox normal
|name =Sterilized Rag
|image=Rag.png
|alternate_image=RagDirty.png
|alternate_name=Dirty Rag
|alternate_link=Dirty Rag
|weight=0.05
|primary_use=[[Health#Bandaging|Bandage]] [[Moodles#Bleeding|bleeding]] [[Health#Types of Injuries|wounds]]
|bandage_power=2
|alcohol=True
|item_id =Base.AlcoholRippedSheets
}}

Drying items, displaying the Bath Towel infobox

Bath Towel
{{{display_name}}}
Wet Bath Towel
General
Category Item
Encumbrance
Heavy Load
Dry: 0.1
Wet: 0.5
Function Dry a wet player
Time to dry
Wet
10000
Technical details
Base ID Item IDs
{{Infobox normal
|name =Bath Towel
|image=Bathtowel.png
|alternate_image=Bathtowel.png
|alternate_name=Wet Bath Towel
|alternate_link=
|weight='''Dry:''' 0.1<br>'''Wet:''' 0.5
|primary_use=Dry a [[Moodles#Wet|wet]] player
|wet_cooldown=10000
|item_id ='''Dry:''' Base.BathTowel<br>'''Wet:''' Base.BathTowelWet
}}

Remote Controller infobox

V1 Remote Controller
{{{display_name}}}
General
Category Item
Encumbrance
Heavy Load
0.4
Function Trigger traps remotely
Remote range 7 tiles
Technical details
Base ID Item IDs
{{Infobox normal
|name =V1 Remote Controller
|image=RemoteCrafted.png
|weight=0.4
|primary_use=Trigger [[Weapons#Explosives|traps]] remotely
|remote_range=7
|item_id =Base.RemoteCraftedV1
}}