User:Thing II/sandbox/Template:Infobox weapon/doc

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

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.

Sorry, but we had to comment out this page for wiki maintenance, as it was calling too many outdated/unused/removed templates and was added on Category:Infobox. Feel free to add it back with updated templates. - Vaileasys (talk) Wiki Administrator 11:02, 16 February 2024 (UTC)

{{Infobox weapon
|display_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=
<!--GENERAL-->
|category=
|weight=
|function=
|equipped=
|secondary_item=
|condition_max=
|attachment_type=
<!--CHARACTERISTICS-->
|ammo_type=
|clip_size=
|sound_radius=
|recoil_delay=
|reload_time=
|aiming_time=
<!--DAMAGE-->
|type=
|swing_time=
|min_range=
|max_range=
|hit_chance=
|min_damage=
|max_damage=
|tree_damage=
|door_damage=
|push_back=
|knockdown=
|kill_move=
|effect_power=
|effect_range=
|effect_timer=
|effect_type=
|sensor_range=
<!--TECHNICAL DETAILS-->
|ingredients=
|class_name=
}}

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. Usually "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.

Characteristics

ammo_type: The ammo type this weapon uses if it has one. (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".
swing_time: The time it takes to perform a full swing. (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)
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_power: The power of the effect caused by the item. (remove if value is empty)
effect_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 display as "Effect range". (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 class name.

Examples

Blunt weapons, displaying the Baseball Bat infobox Sorry, but we had to comment out this page for wiki maintenance, as it was calling too many outdated/unused/removed templates and was added on Category:Infobox. Feel free to add it back with updated templates. - Vaileasys (talk) Wiki Administrator 11:02, 16 February 2024 (UTC)

{{Infobox weapon
|display_name=Baseball Bat
|name_colour=Weapon
|name_text_colour=Weapon
|image=BaseballBat_Model.png
|image_width=200px
|alternate_image=BaseballBat.png
|alternate_name=Baseball Bat
|alternate_link=
|alternate_image2=BaseballBatNails.png
|alternate_name2=Spiked Baseball Bat
|alternate_link2=Spiked Baseball Bat
<!--GENERAL-->
|category=Weapon
|weight=2
|equipped=Two-handed
|condition_max=15
|attachment_type=Shovel
<!--DAMAGE-->
|type=Blunt
|swing_time=3
|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
|class_name=BaseballBat
}}

Blade weapons, displaying the Kitchen Knife infobox Sorry, but we had to comment out this page for wiki maintenance, as it was calling too many outdated/unused/removed templates and was added on Category:Infobox. Feel free to add it back with updated templates. - Vaileasys (talk) Wiki Administrator 11:02, 16 February 2024 (UTC)

{{Infobox weapon
|display_name=Kitchen Knife
|name_colour=Weapon
|name_text_colour=Weapon
|image=Knife_Model.png
|image_width=200px
|alternate_image=KnifeChopping.png
|alternate_name=Kitchen Knife
|alternate_link=
|category=Weapon
|weight=0.3
|function=[[Cooking]]
|condition_max=10
|attachment_type=Knife
|type=SmallBlade
|swing_time=2
|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
|class_name=KitchenKnife
}}

Firearm weapons, displaying the Pistol (disambiguation) infobox Sorry, but we had to comment out this page for wiki maintenance, as it was calling too many outdated/unused/removed templates and was added on Category:Infobox. Feel free to add it back with updated templates. - Vaileasys (talk) Wiki Administrator 11:02, 16 February 2024 (UTC)

{{Infobox weapon
|display_name=M9 Pistol
|name_colour=Weapon
|name_text_colour=Weapon
|image=HandGun.png
|alternate_image=40calAmmoBox.png
|alternate_name=9mm Rounds
|alternate_link=9mm Rounds
<!--GENERAL-->
|category=Weapon
|weight=1.5
|equipped=One-handed
|condition_max=10
|attachment_type=Holster
<!--CHARACTERISTICS-->
|ammo_type=[[9mm Rounds]]
|clip_size=15
|sound_radius=30
|recoil_delay=10
|reload_time=30
|aiming_time=15
<!--DAMAGE-->
|type=Gunshot
|swing_time=0.5
|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-->
|class_name=Pistol
}}

Throwable weapons, displaying the Molotov Cocktail infobox Sorry, but we had to comment out this page for wiki maintenance, as it was calling too many outdated/unused/removed templates and was added on Category:Infobox. Feel free to add it back with updated templates. - Vaileasys (talk) Wiki Administrator 11:02, 16 February 2024 (UTC)

{{Infobox weapon
|display_name=Molotov Cocktail
|name_colour=Weapon
|name_text_colour=Weapon
|image=Molotov.png
<!--GENERAL-->
|category=Weapon
|weight=1.5
|equipped=One-handed
|secondary_item=[[Lighter]]
<!--DAMAGE-->
|type=[[Fire]]
|swing_time=1.5
|min_range=0
|max_range=8
|min_damage=0
|max_damage=0
|effect_power=90
|effect_range=4
|effect_type=Fire
<!--TECHNICAL DETAILS-->
|class_name=Base.Molotov
}}

Trap weapons, displaying the Aerosol Bomb with Sensor infobox Sorry, but we had to comment out this page for wiki maintenance, as it was calling too many outdated/unused/removed templates and was added on Category:Infobox. Feel free to add it back with updated templates. - Vaileasys (talk) Wiki Administrator 11:02, 16 February 2024 (UTC)

{{Infobox weapon
|display_name=Aerosol Bomb
|name_colour=Weapon
|name_text_colour=Weapon
|image=Aerosolbomb.png
|alternate_image=AerosolbombTimer.png
|alternate_name=Aerosol Bomb with Upgrade
|alternate_link=
<!--GENERAL-->
|category=Weapon
|weight=1.5
|equipped=One-handed
<!--DAMAGE-->
|type=[[Fire|Explosion]]
|swing_time=1.5
|min_range=0
|max_range=10
|min_damage=0
|max_damage=0
|effect_power=70
|effect_range=6
|effect_timer=50
|effect_type=Explosion
<!--TECHNICAL DETAILS-->
|ingredients=1 × [[Hairspray]]<br>1 × [[Box of Sparklers]]<br>1 × [[Aluminum]]
|class_name=''See [[#Item IDs|Item IDs]]''
|no_style=
}}