Help:Boilerplate weapon: Difference between revisions

Revision as of 00:10, 14 February 2023

This boilerplate is used for giving a new page a standard look. Copy the code below and add it to your new page before adding the relevant content. This boilerplate is currently in an early format and we are likely to add and change sections as time goes on. If you wish to suggest improvements to this boilerplate, please use the discussion page.
The current code and result of the code are shown below. Anything between  is a comment and can safely be discarded, and it will not affect the template.

<!--COMMENT: This section is for the language and the format of the page. The languages section is used for linking pages. The syntax for each page (regardless of language) will be: {{languages}}, linking every subpage with "/##" at the end, where "##" is the language code. E.g. "Nails/es" and "Nails/fr" even if there are redirects.-->
{{languages}}
<!--COMMENT: The header template goes below the language template, there should be NOTHING in between. The format can be seen in the header template with a working explanation. The header connects categories and Version number. PLEASE ENTER THE VERSION AND INCREMENT NUMBER WHEN YOU MAKE OR EDIT A PAGE. It helps everyone else know how old the page is version-wise.-->
{{header|The Game World|Items|Weapons|Melee Weapons|type=Weapon|version=Version 41|incver=0}}
<!--COMMENT: Here is the infobox for the weapon. This is a quick lookup for the item's stats. For more information, see: https://pzwiki.net/wiki/Template:Infobox_weapon-->
{{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
|alternate_image3=
|alternate_name3=
|alternate_link3=
<!--GENERAL-->
|category=Weapon
|weight=2
|function=
|equipped=Two-handed
|secondary_item=
|condition_max=15
|attachment_type=
<!--CHARACTERISTICS-->
|ammo_type=
|clip_size=
|sound_radius=
|recoil_delay=
|reload_time=
|aiming_time=
<!--DAMAGE-->
|type=Blunt
|swing_time=3
|min_range=0.61
|max_range=1.5
|hit_chance=
|min_damage=0.8
|max_damage=1.2
|push_back=0.5
|knockdown=2
|kill_move=
|effect_power=
|effect_range=
|effect_timer=
|effect_type=
|sensor_range=
<!--TECHNICAL DETAILS-->
|ingredients=
|class_name=Base.BaseballBat
}}An introduction to the item. Include [[Nails|links]] (example link is to Nails article) to other pages within the wiki where appropriate. 

<!--COMMENT: This is where the 'Table Of Contents' will go if it is needed.-->
__TOC__

==Usage==
<!--COMMENT: This section contains how the item can be used, weather it be as a weapon, tool or in recipes.-->

===Weapon===
This subsection is about the item's usage as a weapon. You may want to include how many enemies can be hit with a single strike, damage, range and effectiveness.

===Breaking doors===
Include how effective the weapon is at breaking down doors.

===Tree chopping===
Can the item be used to chop down trees? If so, how much damage does it do?

===Recipes===
Include here which recipes this item can be used in. Remove this section if it isn't applicable to the weapon/item.
{{Crafting table header}}
{{Recipe Carpentry|2011}}
{{Recipe Cooking|1001}}
{{Crafting table footer}}

==Condition==
<!--COMMENT: This section contains all the info about the condition of the weapon.-->
What weapon skill does this weapon apply to? Is it [[Skills#Blunt|blunt]], [[Skills#Blade|blade]] or [[Skills#Firearm|firearm]]? The maintenance skill relates to how often the weapon will take damage from being used. The following equation should be used replacing <ConditionLowerChanceOneIn> with the value for the given item: <code>1 in (<ConditionLowerChanceOneIn> + maintenance x 2)</code>

===Repairing===
<!--COMMENT: This uses the code found in the repair file [Zomboid Folder\media\scripts\fixing.txt] which defines what it costs to repair the weapon. The table below is a graphical representation of what is required to repair.-->
Materials that can be used to repair the baseball bat, based on first time repairing.
{{Fixing weapon
|item=Baseball Bat
|woodglue=2
|woodgluerepairs=20
|woodgluechance=35
|woodwork=2
|ducttape=2
|ducttaperepairs=10
|ducttapechance=95
|glue=2
|gluerepairs=10
|gluechance=95
|scotchtape=4
|scotchtaperepairs=10
|scotchtapechance=95
}}

==Distribution==
<!--COMMENT: The locations this item can be found should be placed here. Spawn locations can be found in the distribution.lua and vehicledistribution.lua files.-->

===Buildings===
Include here the building types that the weapon can be found in, being sure to include links.

===Vehicles===
Include here all the vehicle types/areas the weapon can be found.

===NPCs===
Include here if the weapon can be found on zombies, and where. I.e. Many weapons can be found on zombies in specific areas. E.g. Police baton found on police zombies are found near police stations/roadblocks.

Once survivor NPCs are added, they will also be added into this section.

==Trivia==
Any interesting facts about the weapon should be bullet-pointed <code>*</code> in this section

==Gallery==
Here are a list of images that can be used to show off the weapon. Include screenshots, model variants, or any other images that are relevant to the weapon.
<!--COMMENT: Include a list of clothing variants, in-game screenshots, etc. here.-->
<gallery>
File:BaseballBat Animation.png|Baseball Bat W.I.P. swing animation
File:BaseballBatNails 120px.png|Spiked Baseball Bat icon
</gallery>

==Code==
<!--COMMENT: all the code related to the item found in txt files should be placed here.-->

===Item===
<!--COMMENT: Current location of Code in directory for updating purposes. Example below shows how to lay it out. ''''' is for bold italic.-->
'''''From items.txt (Project Zomboid directory/media/scripts/)'''''
<!--COMMENT: Add the retrieved template so both visitors and editors can tell how old the code is and whether or not it may need to be updated.-->
{{Retrieved|version=39|incver=67.5}}
<!--COMMENT: Example code taken from file. Items.txt and Newitems.txt are usually the source of the information at this time for basic items. Nowiki is used to display the text only, example used is BaseballBat.-->
<pre>	
	item BaseballBat
		MaxRange			= 1.5,
		WeaponSprite			= Baseballbat,
		MinAngle			= 0.2,
		Type				= Weapon,
		MinimumSwingTime		= 3,
		KnockBackOnNoDeath		= TRUE,
		SwingAmountBeforeImpact		= 0.02,
		Categories			= Blunt,
		ConditionLowerChanceOneIn	= 20,
		Weight				= 2,
		SplatNumber			= 1,
		PushBackMod			= 0.5,
		MaxDamage			= 1.2,
		SubCategory			= Swinging,
		ConditionMax			= 15,
		MaxHitCount			= 2,
		DoorDamage			= 7,
		IdleAnim			= Idle_Weapon2,
		SwingAnim			= Bat,
		CriticalChance			= 10,
		WeaponWeight			= 2,
		DisplayName			= Baseball Bat,
		MinRange			= 0.61,
		SwingTime			= 3,
		HitAngleMod			= -30,
		MinDamage			= 0.8,
		KnockdownMod			= 2,
		SplatBloodOnNoDeath		= FALSE,
		Icon				= BaseballBat,
		RunAnim				= Run_Weapon2,
        	TwoHandWeapon 			= TRUE,
        	BreakSound  			= PZ_WoodSnap,
        	TreeDamage  			= 1,
</pre>

===Repair===
<!--COMMENT: Current location of Code in directory for updating purposes. Example below shows how to lay it out. ''''' is for bold italic.-->
'''''From fixing.txt (Project Zomboid directory/media/scripts/)'''''
<!--COMMENT: Add the retrieved template so both visitors and editors can tell how old the code is and whether or not it may need to be updated.-->
{{Retrieved|version=39|incver=67.5}}
<!--COMMENT: This is the code found in the repair file [Zomboid Folder\media\scripts\fixing.txt] which defines what it costs to repair the weapon.-->
<pre>
	fixing Fix Baseball Bat
		Require : BaseballBat,
		Fixer : Woodglue=2; Woodwork=2,
		Fixer : DuctTape=2,
		Fixer : Glue=2,
		Fixer : Scotchtape=4,
</pre>

==See also==
<!--COMMENT: Location of links to relevant guides or other pages that may not have been mentioned on this page but still relate to the item in some way.-->
*[[Carpentry]]
<!--COMMENT: Navbox placement goes here. Code example = {{Navbox weapons}}, (see all current navboxs via the template section).-->
{{Navbox weapons}}

This will produce the following:

Baseball Bat

General

Usage

Weapon

This subsection is about the item's usage as a weapon. You may want to include how many enemies can be hit with a single strike, damage, range and effectiveness.

Breaking doors

Include how effective the weapon is at breaking down doors.

Tree chopping

Can the item be used to chop down trees? If so, how much damage does it do?

Recipes

Include here which recipes this item can be used in. Remove this section if it isn't applicable to the weapon/item. Template:Crafting table header Template:Recipe Carpentry Template:Recipe Cooking Template:Crafting table footer

Condition

What weapon skill does this weapon apply to? Is it blunt, blade or firearm? The maintenance skill relates to how often the weapon will take damage from being used. The following equation should be used replacing <ConditionLowerChanceOneIn> with the value for the given item: 1 in (<ConditionLowerChanceOneIn> + maintenance x 2)

Repairing

Materials that can be used to repair the baseball bat, based on first time repairing.

Repair Baseball Bat
Wood Glue Potentially repairs: 20% Chance of success: 35% Needs: Wood Glue (2 units) Carpentry Level 2
Duct Tape Potentially repairs: 10% Chance of success: 95% Needs: Duct Tape (2 units)
Glue Potentially repairs: 10% Chance of success: 95% Needs: Glue (2 units)
Adhesive Tape Potentially repairs: 10% Chance of success: 95% Needs: Adhesive Tape (4 units)

Distribution

Buildings

Include here the building types that the weapon can be found in, being sure to include links.

Vehicles

Include here all the vehicle types/areas the weapon can be found.

NPCs

Include here if the weapon can be found on zombies, and where. I.e. Many weapons can be found on zombies in specific areas. E.g. Police baton found on police zombies are found near police stations/roadblocks.

Once survivor NPCs are added, they will also be added into this section.

Trivia

Any interesting facts about the weapon should be bullet-pointed * in this section

Gallery

Here are a list of images that can be used to show off the weapon. Include screenshots, model variants, or any other images that are relevant to the weapon.

Baseball Bat W.I.P. swing animation
BaseballBatNails 120px.png

Spiked Baseball Bat icon

Code

Item

From items.txt (Project Zomboid directory/media/scripts/) Retrieved: Build 39.67.5

	
	item BaseballBat
		MaxRange			= 1.5,
		WeaponSprite			= Baseballbat,
		MinAngle			= 0.2,
		Type				= Weapon,
		MinimumSwingTime		= 3,
		KnockBackOnNoDeath		= TRUE,
		SwingAmountBeforeImpact		= 0.02,
		Categories			= Blunt,
		ConditionLowerChanceOneIn	= 20,
		Weight				= 2,
		SplatNumber			= 1,
		PushBackMod			= 0.5,
		MaxDamage			= 1.2,
		SubCategory			= Swinging,
		ConditionMax			= 15,
		MaxHitCount			= 2,
		DoorDamage			= 7,
		IdleAnim			= Idle_Weapon2,
		SwingAnim			= Bat,
		CriticalChance			= 10,
		WeaponWeight			= 2,
		DisplayName			= Baseball Bat,
		MinRange			= 0.61,
		SwingTime			= 3,
		HitAngleMod			= -30,
		MinDamage			= 0.8,
		KnockdownMod			= 2,
		SplatBloodOnNoDeath		= FALSE,
		Icon				= BaseballBat,
		RunAnim				= Run_Weapon2,
        	TwoHandWeapon 			= TRUE,
        	BreakSound  			= PZ_WoodSnap,
        	TreeDamage  			= 1,

Repair

From fixing.txt (Project Zomboid directory/media/scripts/) Retrieved: Build 39.67.5

	fixing Fix Baseball Bat
		Require : BaseballBat,
		Fixer : Woodglue=2; Woodwork=2,
		Fixer : DuctTape=2,
		Fixer : Glue=2,
		Fixer : Scotchtape=4,