Template:Infobox weapon/doc

This is a documentation subpage for Template:Infobox weapon.
It contains usage information and other content that is not part of the original template page.

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

General

Category

Weapon

Encumbrance

weight

Function

primary_use
secondary_use

Equipped

equipped

Secondary

Ammo type

Damage

min_damage–max_damage

effect_type range

effect_range tiles

Sensor range

sensor_range tiles

Technical details

Base ID

class_name

{{Infobox weapon
|display_name=
|image=
|alternate_image=
|alternate_name=
|alternate_link=
|weight=
|weight_bkg=
|weapon_type=
|weapon_type_bkg=
|primary_use=
|primary_use_bkg=
|secondary_use=
|secondary_use_bkg=
|equipped=
|equipped_bkg=
|secondary_item=
|secondary_item_bkg=
|ammo=
|ammo_bkg=
|max_range=
|max_range_bkg=
|min_damage=
|min_damage_bkg=
|max_damage=
|max_damage_bkg=
|sensor_range=sensor_range
|sensor_range_bkg=
|explosion_timer=
|explosion_timer_bkg=
|effect_range=
|effect_range_bkg=
|effect_type=
|effect_type_bkg=
|class_name=
|class_name_bkg=
}}

Parameters

General

display_name: The display name of the item as it appears in-game. Leaving blank will display the pagename.
image: An image of the icon displayed at 120px. A 120px variant should be used if it has one.
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 weight of the item.
"_bkg" suffix: Will display a slightly darker background over the row; used for simpler identification between each row. Leaving blank will leave white, whereas inserting anything will give the darkened background. (same for each parameter with _bkg)
weapon_type: The skill this item belongs to, such as: blunt, blade or firearm. Any throwable weapon should be given the "Throwable" value.
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)
equipped: In which hand this item needs to be equipped: primary, secondary or both; one-hand or two-hands.
ammo: The ammo type this weapon uses if it has one. (remove if value is empty)
max_range: The item's maximum range, whether it be melee or ranged.
min_damage: The item's minimum damage it can deal.
max_damage: The item's maximum damage it can deal.
class_name: The item's class name.

Throwables

secondary_item: The item that must be in the secondary hand/slot to use this weapon.
sensor_range: How close an entity needs to be before the trap is triggered. (remove if value is empty)
explosion_timer: Time before trap is triggered. Defined by the ExplosionTimer variable. (remove if value is empty)
effect_range: The range of the trap's effect. Defined by either ExplosionRange, FireRange, SmokeRange or NoiseRange. (remove if value is empty)
effect_type: The effect given off by the trap. Can be either: "explosion", "fire", "smoke" or "noise". Any other value will not display anything. (remove if value is empty)

Examples