Template:Weapon/doc

This is a documentation subpage for the Template:Weapon page.

Template that calls both Weapon/Cargo and Weapon/Article. This template will only call Cargo if it's used in no namespace and if storage is not set to 0 (e.g. test server weapons).

Template that delegates both rendering and storage of weapon data.

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
ID	id	The weapon's item_id. Example 01182C03	String	required
Name	name	The name of the weapon. Example Eternal Psychodrive Auto value {{PAGENAME}}	String	suggested
Rarity	rarity	The rarity of the weapon, 0-indexed. Suggested values 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 Default 0 Example 13	Number	suggested
Rank	rank	The rank of the weapon, mapped to a number, 1-indexed. Suggested values 1 2 3 4 Default 1 Example 4	Number	suggested
Buy Price	buy price	The buy_price of the weapon. Example 1000000	Number	suggested
Sell Price	sell price	The sell_price of the weapon. Example 50000	Number	suggested
Stat Required To Equip	stat required	The stat amount required to equip the weapon. The stat type is automatically determined by the template. Example 1320 Auto value 0	Number	suggested
Untradable	account bound	Whether the weapon can be dropped or sold in shops. Default No Example No	Boolean	optional
ATP Bonus	atp	The ATP bonus on the weapon when it is in use. Default 0 Example 0 Auto value 0	Number	suggested
ATA Bonus	ata	The ATA bonus on the weapon when it is in use. Default 0	Number	suggested
DFP Bonus	dfp	The DFP bonus on the weapon when it is in use. Default 0 Example 0	Number	suggested
TP Bonus	tp	The TP bonus on the weapon when it is in use. Default 0 Example 0	Number	suggested
EVP Bonus	evp	The EVP bonus on the weapon when it is in use. Default 0 Example 0	Number	suggested
MST Bonus	mst	The MST bonus on the weapon when it is in use. Default 0 Example 0	Number	suggested
STA Bonus	sta	The STA bonus on the weapon when it is in use. Default 0 Example 0	Number	suggested
Normal Attack Mod	normal attack mod	The multiplier on damage dealt with all damage on the weapon when it is in use. Default 1 Example 1.2	Number	suggested
Critical Mod	critical attack mod	The multiplier on damage dealt with a critical hit on the weapon when it is in use. Default 1 Example 1.4	Number	suggested
PA Mod	pa mod	The multiplier on damage dealt with a Photon Art on the weapon when it is in use. Example 1.3	Unknown	suggested
PP Mod	pp mod	The multiplier on PP gain per tick when in use. Default 1 Example 1	Number	suggested
SE Mod	se mod	The multiplier on Status Effect infliction rates from attacks originating from the weapon. Default 1 Example 1	Unknown	suggested
Striking Range	striking range	The amount that the attack hitbox dimensions are increased by when using the weapon. Default 0 Example 0	Number	suggested
Striking Animation Speed	striking speed	The speed adjustment for animations on normal attacks and striking PAs while the weapon is in use. Default 0 Example 0	Number	suggested
Bullet Range	bullet range	The amount that the bullet hitbox dimensions (?) are increased by when using the weapon. Default 0 Example 0	Number	suggested
Bullet Animation Speed	bullet speed	The speed adjustment on the animations for bullet PAs while the weapon is in use. Default 0 Example 0	Number	suggested
TECHNIC Range	technic range	The amount that the TECHNIC maximum reach is increased by when using the weapon. Default 0 Example 0	Number	suggested
TECHNIC Animation Speed	technic speed	The speed adjustment on the animations for TECHNIC PAs while the weapon is in use. Default 0 Example 0	Number	suggested
Subject to Accuracy	miss	Whether the weapon can inherently miss or not. Does not override PAs that can't miss, such as TECHNICs. Default Yes Example Yes	Boolean	suggested
Can Back Attack	back attack	Whether the weapon can guarantee hits by connecting with the back hitbox of an enemy. Example Yes	Boolean	suggested
Hitflag ID	hitflag	The ID of the hitflag that is applied on normal attacks (?) when used. Default 0 Example 0	Number	suggested
equip hand	equip hand	Metadata only? The hand slot that the weapon is assigned to. Suggested values 0 1 Default 0 Example 0	Number	optional
weapon type flag	weapon type flag	Unknown. Part of meta data. Default 0 Example 3	Number	optional
Model ID	model id	The model ID of the weapon. Example 37	Number	suggested
VFX ID	visual effect id	The visual effect ID of the weapon. Default 0 Example 100	Number	suggested
SFX ID	sound effect id	The sound effect ID from the sound bank specified on the weapon. Default 0 Example 65535	Number	suggested
Attack Variance	variance	The damage range on the weapon's attacks. Default 0	Number	suggested
Accuracy	accuracy	The accuracy stat of the weapon. Maxes at 9999. Default 0 Example 9999	Number	suggested
Grind Cap	grind cap	The maximum amount a weapon can be grinded to. Default 10 Example 10	Number	suggested
Maximum Targets on Normal Attack	max target	The maximum amount of targets the weapon can hit with its normal attacks. Default 1 Example 1	Number	suggested
PP Per Tick	pp tick	The amount of PP regained on the weapon per tick while the weapon is in use. Default 1 Example 6	Unknown	suggested
PP Gained Per Normal	pp normal	The amount of PP regained on the weapon when it successfully hits a normal attack. Default 1 Example 2	Number	suggested
Restricted by Sexes	sex	The sexes that can equip the weapon, comma-delineated. Suggested values Male Female Male,Female Default Male,Female Example Male,Female	String	optional
Restricted by Race	race	The races that can equip the weapon, comma-delineated. Suggested values Human Newman CAST Beast Default Human,Newman,CAST,Beast Example Human,Newman,CAST,Beast	String	suggested
Restricted by Class	class	The classes that can equip the weapon, comma-delineated. Does not override class restrictions. Default Hunter,Ranger,Force,Fighgunner,Guntecher,Wartecher,Fortefighter,Fortegunner,Fortetecher,Protranser,Acrofighter,Acrotecher,Fighmaster,Gunmaster,Masterforce,Acromaster Example Hunter,Ranger,Force,Fighgunner,Guntecher,Wartecher,Fortefighter,Fortegunner,Fortetecher,Protranser,Acrofighter,Acrotecher,Fighmaster,Gunmaster,Masterforce,Acromaster	String	suggested
Attack Grinds	attack grinds	The values for the attack stat per grind level, comma-delineated. Example 1320,1366,1413,1460,1509,1559,1606,1658,1711,1765,1820	String	suggested
PP Grinds	pp grinds	The values for the PP stat per grind level, comma-delineated. Example 1320,1386,1453,1520,1589,1659,1726,1798,1871,1945,2020	String	suggested
Penetration Override	pen override	Whether the projectiles that spawn from this weapon should penetrate. Default No Example No	Boolean	suggested
Possible Elements	elements	The elements that the weapon can generate as, comma-delineated. Default Neutral,Fire,Ice,Lightning,Ground,Light,Dark Example Neutral,Fire,Ice,Lightning,Ground,Light,Dark	String	suggested
Set Bonus IDs	set_bonus	Meta data? The set bonus IDs that the weapon is part of, comma-delineated. Default 0,0,0,0 Example 0,0,0,0	String	suggested
Sound Bank ID	sound bank id	The sound bank ID that the weapon uses. Default 0 Example 0	Number	suggested
Normal Attack Range	weapon range	The length component of the normal attack of the weapon. Default 0 Example 0	Number	optional
Normal Attack Width	normal attack width	The width component of the normal attack of the weapon. Default 0 Example 0	Number	suggested
Normal Attack Angle	normal attack angle	The angle component of the normal attack of the weapon. Default 0 Example 0	Number	suggested
Normal Attack Height	normal attack height	The height component of the normal attack of the weapon. Default 0 Example 0	Number	suggested
Status ID to Self	self status id	The ID of the status effect inflicted to the player when the weapon successfully lands an attack. Default 0 Example 0	Number	suggested
Status Level to Self	self status level	The level of the status effect inflicted to the player when the weapon successfully lands an attack. Default 0 Example 0	Number	suggested
Status Chance to Self	self status chance	The chance of the rolling the status effect inflicted to the player when the weapon successfully lands an attack. Default 0 Example 0	Number	suggested
Status ID when Neutral	neutral status id	The ID of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is neutral. Default 0 Example 0	Number	suggested
Status Level when Neutral	neutral status level	The level of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is neutral. Default 0 Example 0	Number	suggested
Status Chance when Neutral	neutral status chance	The chance of the rolling the status effect of the weapon to the victim when the weapon successfully lands an attack while the element of the weapon is neutral. Default 0 Example 0	Number	suggested
Status ID when Fire	fire status id	The ID of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is fire. Default 0 Example 0	Number	suggested
Status Level when Fire	fire status level	The level of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is fire. Default 0 Example 0	Number	suggested
Status Chance when Fire	fire status chance	The chance of the rolling the status effect of the weapon to the victim when the weapon successfully lands an attack while the element of the weapon is fire. Default 0 Example 0	Number	suggested
Status ID when Ice	ice status id	The ID of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is ice. Default 0 Example 0	Number	suggested
Status Level when Ice	ice status level	The level of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is ice. Default 0 Example 0	Number	suggested
Status Chance when Ice	ice status chance	The chance of the rolling the status effect of the weapon to the victim when the weapon successfully lands an attack while the element of the weapon is ice. Default 0 Example 0	Number	suggested
Status ID when Lightning	lightning status id	The ID of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is lightning. Default 0 Example 0	Number	suggested
Status Level when Lightning	lightning status level	The level of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is lightning. Default 0 Example 0	Number	suggested
Status Chance when Lightning	lightning status chance	The chance of the rolling the status effect of the weapon to the victim when the weapon successfully lands an attack while the element of the weapon is lightning. Default 0 Example 0	Number	suggested
Status ID when Ground	ground status id	The ID of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is ground. Default 0 Example 0	Number	suggested
Status Level when Ground	ground status level	The level of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is ground. Default 0 Example 0	Number	suggested
Status Chance when Ground	ground status chance	The chance of the rolling the status effect of the weapon to the victim when the weapon successfully lands an attack while the element of the weapon is ground. Default 0 Example 0	Number	suggested
Status ID when Light	light status id	The ID of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is light. Default 0 Example 0	Number	suggested
Status Level when Light	light status level	The level of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is light. Default 0 Example 0	Number	suggested
Status Chance when Light	light status chance	The chance of the rolling the status effect of the weapon to the victim when the weapon successfully lands an attack while the element of the weapon is light. Default 0 Example 0	Number	suggested
Status ID when Dark	dark status id	The ID of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is dark. Default 0 Example 0	Number	suggested
Status Level when Dark	dark status level	The level of the status effect inflicted to the victim when the weapon successfully lands an attack while the weapon's element is dark. Default 0 Example 0	Number	suggested
Status Chance when Dark	dark status chance	The chance of the rolling the status effect of the weapon to the victim when the weapon successfully lands an attack while the element of the weapon is dark. Default 0 Example 0	Number	suggested
RCSM Fire Time	rcsm fire time	The time between bullets firing on a RCSM. Default 0 Example 0	Number	suggested
RCSM Penetration Flag	rcsm penetration flag	Whether the RCSM bullets should penetrate targets. Default 0 Example 0	Boolean	suggested
RCSM Number of Shots	rcsm number of shot	The number of shots a RCSM should fire per firing event. Default 0 Example 0	Number	suggested
RCSM Bullet Type	rcsm bullet type	The type of the bullet that the RCSM should emit. See: https://psu-clementine.com/wiki/index.php?title=Template:RCSM_Bullet Suggested values 1 4 5 6 Default 0 Example 0	Number	suggested
RCSM Bullet Velocity	rcsm bullet velocity	The speed of the bullet that is emitted from a RCSM. Default 0 Example 0	Number	suggested
RCSM Bullet Size	rcsm bullet size	The size of the bullet that is emitted from a RCSM. Default 0 Example 0	Number	suggested
RCSM Bullet Range	rcsm bullet range	The maximum range of the bullet that is emitted from a RCSM before it despawns. Default 0 Example 0	Number	suggested
Description	description	The description of the weapon. Example A rod born through the union of faith and science. With the power to manipulate the heart, whoever holds this rod can control the world.	String	suggested
generate	generate	Whether the template should generate any HTML. Default Yes Example Yes	Boolean	deprecated
storage	storage	Override flag. Whether the template should store the weapon's data in Cargo. If omitted, it is treated as 1. Will not store in a namespace, regardless of setting. Example 0	Boolean	optional
jpname	jpname	no description	Unknown	optional
Name of No Variance Prototype	nv	The name of the No Variance Prototype of the weapon. Example BVB-NV2C03	String	optional
Name of Enhanced Element Prototype	ee	The name of the Enhanced Element Prototype of the weapon. Example BVB-EE2C03	String	optional
Name of Attack Range Prototype	ar	The name of the Attack Range Prototype of the weapon. Example BVB-AR2C03	String	optional
Name of Status Effect Prototype	se	The name of the Status Effect Prototype of the weapon. Example BVB-AR2C03	String	optional
Name of Damage Amplification Prototype	da	The name of the Damage Amplification Prototype of the weapon. Example EP-DA2D06	String	optional
Name of Fire Amplification Prototype	ampf	The name of the Fire Amplification Prototype of the weapon. Example EP-AMP-F2D06	String	optional
Name of Ice Amplification Prototype	ampi	The name of the Ice Amplification Prototype of the weapon. Example EP-AMP-I2D06	String	optional
Name of Lightning Amplification Prototype	ampe	The name of the Lightning Amplification Prototype of the weapon. Example EP-AMP-E2D06	String	optional
Name of Ground Amplification Prototype	ampg	The name of the Ground Amplification Prototype of the weapon. Example EP-AMP-G2D06	String	optional
Name of Light Amplification Prototype	ampl	The name of the Light Amplification Prototype of the weapon. Example EP-AMP-L2D06	String	optional
Name of Dark Amplification Prototype	ampd	The name of the Dark Amplification Prototype of the weapon. Example EP-AMP-D2D06	String	optional
Coreable at Weapon Lab	coreable	Whether the weapon can be turned into its respective type's core. Default No Example Yes	Boolean	optional
Remarks	remarks	Remarks about the weapon.	Content	optional
Trivia	trivia	Trivia about the weapon.	Content	optional
Image Path	image	The weapon's thumbnail image of the weapon. Auto value {{{id}}}.png	File	suggested