Template:Infobox weapon

[view] [edit] [history] [purge] Template documentation

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 type of weapon, whether they be melee, ranged, throwable, or a trap.

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 weapon Weight weight Equipped equipped Secondary hand secondary_item Ammo ammo Clip size clip_size Conditon max. condition_max Range min_range–max_range Damage min_damage–max_damage Sound radius sound_radius Sensor range sensor_range Effect range effect_range

{{Infobox weapon
|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=
<!--GENERAL-->
|category=
|weight=
|weight2=
|function=
|equipped=
|secondary_item=
|max_units=
|contents=
|can_boil_water=
|rain_factor=
|condition_max=
|skill_type=
|attachment_type=
<!--CHARACTERISTICS-->
|ammo_type=
|ammo=
|clip_size=
|sound_radius=
|recoil_delay=
|reload_time=
|aiming_time=
<!--DAMAGE-->
|type=
|base_speed=
|min_range=
|max_range=
|hit_chance=
|min_damage=
|max_damage=
|crit_chance=
|crit_multiplier=
|tree_damage=
|door_damage=
|push_back=
|knockdown=
|kill_move=
|effect_power=
|effect_range=
|effect_duration=
|effect_timer=
|effect_type=
|sensor_range=
<!--TECHNICAL DETAILS-->
|ingredients=
|item_id =
|class_name2=
}}

Parameters

Heading/Image

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.

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.

General

Category

The in-game category the item is displayed as in the inventory. Often "Weapon".

weight

The base weight of the item.

Function

What the item is used for. 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-handed or two-handed.

secondary_item

The item required in the secondary slot to use this item, such as the Molotov Cocktail. (remove if value is empty)

condition_max

The item's maximum condition, i.e. when it's fully repaired.

skill_type

The weapon's associated skill. (remove if value is empty)

max_units

The maximum units in a full item. Calculated using the "UseDelta" value: 1 / UseDelta.

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)

Characteristics

ammo_type

**DEPRECATED: use ammo instead** The ammo type this weapon uses if it has one. (remove if value is empty)

ammo

The ammo type this weapon uses. This value is used in {{img_item}} to automatically generate the ammo icon with link. (remove if value is empty)

clip_size

The amount of ammo/bullets in a single clip/magazine. (remove if value is empty)

sound_radius

The radius of sound that is given off from using the item. (remove if value is empty)

recoil_delay

The time required between each shot before maximum accuracy. remove if value is empty)

reload_time

The time it takes to reload the weapon. (remove if value is empty)

aiming_time

The time taken to aim the weapon. (remove if value is empty)

Damage

type

The damage type this weapon does, such as blunt and blade. Firearms should be "gunshot". Throwables should be the same is their "effect_type".

base_speed

The time it takes to perform a full swing (previously "swing_time"). (remove if value is empty)

min_range

The item's minimum range, regardless of whether it's melee or ranged. (make 0 if value is empty)

max_range

The item's maximum range, regardless of whether it's melee or ranged.

hit_chance

The chance of hitting an enemy for a firearm. Should be the "HitChance" variable. (remove if value is empty)

min_damage

The item's minimum damage it can deal. (remove if value is empty)

max_damage

The item's maximum damage it can deal. (remove if value is empty)

crit_chance

The chance of doing a critical hit. (remove if value is empty)

crit_multiplier

The damage multiplayer when a critical hit. Appears as an abbr/tooltip for crit_chance. (remove if value is empty)

tree_damage

The item's damage to trees. (remove if value is empty)

door_damage

The item's damage to doors. (remove if value is empty)

push_back

The PushBackMod. (remove if value is empty)

knockdown

The KnockdownMod. (remove if value is empty)

kill_move

The special kill move a weapon has, such as Jaw Stab. (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 display as "Effect range". (remove if value is empty)

effect_power

The power of the effect caused by the item. (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_duration

The duration of the trap's effect. Defined by NoiseDuration. (remove if value is empty)

effect_timer

Time before trap is triggered. Defined by the ExplosionTimer variable. (remove if value is empty)

sensor_range

How close an entity needs to be before the trap is triggered. (remove if value is empty)

Technical details

ingredients

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 module and ID name.

Examples

Blunt weapons, displaying the Baseball Bat infobox

Infobox weapon Weight 2 Equipped One-handed Conditon max. 15 Range 0.61–1.25 Damage 0.8–1.1

{{Infobox weapon
|name =Baseball Bat
|image=BaseballBat_Model.png
|image_width=200px
|alternate_image=BaseballBat.png
|alternate_name=Baseball Bat
|alternate_link=
<!--GENERAL-->
|category=Sports
|weight=2
|equipped=One-handed
|condition_max=15
|attachment_type=Shovel
<!--DAMAGE-->
|type=Blunt
|skill_type=Blunt
|base_speed=1
|min_range=0.61
|max_range=1.25
|min_damage=0.8
|max_damage=1.1
|tree_damage=1
|door_damage=5
|push_back=0.5
|knockdown=2
<!--TECHNICAL DETAILS-->
|ingredients=
|item_id =Base.BaseballBat
}}

Blade weapons, displaying the Kitchen Knife infobox

Infobox weapon Weight 0.3 Equipped One-handed Conditon max. 10 Range 0.61–0.9 Damage 0.3–0.7

{{Infobox weapon
|name =Kitchen Knife
|image=Knife_Model.png
|image_width=200px
|alternate_image=KnifeChopping.png
|alternate_name=Kitchen Knife
|alternate_link=
<!--GENERAL-->
|category=Cooking
|weight=0.3
|equipped=One-handed
|condition_max=10
|attachment_type=Knife
<!--DAMAGE-->
|type=Slash
|skill_type=SmallBlade
|min_range=0.61
|max_range=0.9
|min_damage=0.3
|max_damage=0.7
|tree_damage=1
|door_damage=1
|push_back=0.3
|knockdown=0
|kill_move=Jaw_Stab
<!--TECHNICAL DETAILS-->
|ingredients=
|item_id =Base.KitchenKnife
}}

Firearm weapons, displaying the M9 Pistol infobox

Infobox weapon Weight 1.5 Equipped One-handed Ammo Bullets9mm Clip size 15 Conditon max. 10 Range 0.61–7 Damage 0.6–1 Sound radius 40

{{Infobox weapon
|name =M9 Pistol
|image=Handgun03_Model.png
|image_width=200px
|alternate_image=HandGun3.png
|alternate_name=M9 Pistol
|alternate_link=
<!--GENERAL-->
|category=Weapon
|weight=1.5
|equipped=One-handed
|condition_max=10
|attachment_type=Holster
<!--CHARACTERISTICS-->
|ammo=Bullets9mm
|clip_size=15
|sound_radius=40
|recoil_delay=20
|reload_time=30
|aiming_time=15
<!--DAMAGE-->
|type=Gunshot
|skill_type=Firearm
|min_range=0.61
|max_range=7
|hit_chance=50
|min_damage=0.6
|max_damage=1
|door_damage=5
|push_back=0.3
|knockdown=2
<!--TECHNICAL DETAILS-->
|ingredients=
|item_id =Base.Pistol
}}

Throwable weapons, displaying the Molotov Cocktail infobox

Infobox weapon Weight 1.5 Equipped One-handed Secondary hand Lighter Damage 0–0 Effect range 4

{{Infobox weapon
|name =Molotov Cocktail
|image=Molotov_Model.png
|image_width=200px
|alternate_image=Molotov.png
|alternate_name=Molotov Cocktail
|alternate_link=
<!--GENERAL-->
|category=Devices
|weight=1.5
|equipped=One-handed
|secondary_item=Lighter
<!--DAMAGE-->
|type=Fire
|effect_power=90
|effect_range=4
|effect_type=Fire
|max_range=8
|min_damage=0
|max_damage=0
<!--TECHNICAL DETAILS-->
|ingredients=
|item_id =Base.Molotov
}}

Trap weapons, displaying the Aerosol Bomb with Sensor infobox

Infobox weapon Weight 1.5 Equipped One-handed Damage 0–0 Effect range 6

{{Infobox weapon
|name =Aerosol Bomb with Timer
|image=Molotov_Model.png
|image_width=200px
|alternate_image=AerosolbombTimer.png
|alternate_name=Aerosol Bomb with Timer
|alternate_link=
<!--GENERAL-->
|category=Devices
|weight=1.5
|equipped=One-handed
<!--DAMAGE-->
|type=Explosion
|effect_power=70
|effect_range=6
|effect_timer=10
|effect_type=Explosion
|max_range=10
|min_damage=0
|max_damage=0
|knockdown=0
<!--TECHNICAL DETAILS-->
|ingredients=
|item_id =Base.AerosolbombTriggered
}}

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