Template:WeaponData: Difference between revisions

Latest revision as of 15:01, 16 September 2024

This template is used to display weapon data on Agent pages.

Note that some agents have special stats that require unique WeaponData entries. Those can be found below.

Parameters

Parameter Name	Parameter Type	Required?	Parameter Description
`name`	string	✓	The weapon's name as it appears in-game.
`subtitle`	string	✗	The subtitle that appears below the weapon's name as it appears in-game.
`icon`	filename	✓	The file name for the weapon's icon. "File:" should be excluded (e.g. "Weapon Chavez Sentinel Icon.png" as opposed to "File:Weapon Chavez Sentinel Icon.png").
`desc`	string	✗	The description that appears below the weapon's icon.
damage	number	✓	The amount of damage this weapon does per-bullet as a decimal. Multi-shot weapons like Cadence should be formatted as damage x number of shots, e.g. 10.0 (x2).
headshot	number	✗	The damage multiplier for a weapon headshot as a decimal. Do not include the x.
mag_size	number	✓	The number of shots the weapon has in its magazine.
starting_ammo	number	✓	The amount of ammo the Agent starts with when using this weapon.
reload_speed	number	✓	The number of seconds it takes to reload this weapon, with a decimal.
rof	number	✓	The number of shots this weapon can fire per second, with a decimal.

Example

Code

{{WeaponData
| name = Jack of Diamond
| subtitle = Reflex Sight Carbine
| icon = Weapon Ace Jack of Diamond Icon.png
| desc = Charges passive when in ADS.
| damage = 20.0
| headshot = 1.5
| mag_size = 8
| starting_ammo = 16
| reload_speed = 2.0
| rof = 1.35
}}

Result

Jack of Diamond
Reflex Sight Carbine

Charges passive when in ADS.
Damage	Mag Size	Starting Ammo	Reload Speed (Seconds)	Rate of Fire (Shots per Second)
20.0	8	16	2.0	1.35
Head Shot Damage
1.5

Agent-Specific Variants

Agent	Template
Hans	Template:WeaponData/Hans
Larcin	Template:WeaponData/Larcin
Octo	Template:WeaponData/Octo
Sasori	Template:WeaponData/Sasori
Yu-Mi	Template:WeaponData/Yumi

Additionally, one has been made for generic shotguns (like Red's): Template:WeaponData/Shotgun

@@ Line 1: / Line 1: @@
-<noinclude>This template is a work-in-progress!</noinclude><!--
+<noinclude>This template is used to display weapon data on Agent pages.
-* Specialized templates need to be made for the following:
+Note that some agents have special stats that require unique WeaponData entries. Those can be found [[Template:WeaponData#Agent-Specific Variants|below]].
-- Shotguns
-- Ace
+== Parameters ==
-- Larcin
+{| class="wikitable" style="width:100%;"
-- Sasori
+! Parameter Name || Parameter Type || Required? || Parameter Description
-- Octo
+|-
+| <code>name</code> || string || ✓ || The weapon's name as it appears in-game.
+|-
+| <code>subtitle</code> || string || ✗ || The subtitle that appears below the weapon's name as it appears in-game.
+|-
+| <code>icon</code> || filename || ✓ || The file name for the weapon's icon. "File:" should be excluded (e.g. "Weapon Chavez Sentinel Icon.png" as opposed to "File:Weapon Chavez Sentinel Icon.png").
+|-
+| <code>desc</code> || string || ✗ || The description that appears below the weapon's icon.
+|-
+| damage || number || ✓ || The amount of damage this weapon does per-bullet as a decimal. Multi-shot weapons like Cadence should be formatted as damage x number of shots, e.g. 10.0 (x2).
+|-
+| headshot || number || ✗ || The damage multiplier for a weapon headshot as a decimal. Do not include the x.
+|-
+| mag_size || number || ✓ || The number of shots the weapon has in its magazine.
+|-
+| starting_ammo || number || ✓ || The amount of ammo the Agent starts with when using this weapon.
+|-
+| reload_speed || number || ✓ || The number of seconds it takes to reload this weapon, with a decimal.
+|-
+| rof || number || ✓ || The number of shots this weapon can fire per second, with a decimal.
+|}
+== Example ==
+=== Code ===
+<pre>{{WeaponData
+| name = Jack of Diamond
+| subtitle = Reflex Sight Carbine
+| icon = Weapon Ace Jack of Diamond Icon.png
+| desc = Charges passive when in ADS.
+| damage = 20.0
+| headshot = 1.5
+| mag_size = 8
+| starting_ammo = 16
+| reload_speed = 2.0
+| rof = 1.35
+}}</pre>
+=== Result ===
+{{WeaponData
+| name = Jack of Diamond
+| subtitle = Reflex Sight Carbine
+| icon = Weapon Ace Jack of Diamond Icon.png
+| desc = Charges passive when in ADS.
+| damage = 20.0
+| headshot = 1.5
+| mag_size = 8
+| starting_ammo = 16
+| reload_speed = 2.0
+| rof = 1.35
+}}
+== Agent-Specific Variants ==
+{| class="wikitable" style="width"100%;"
+! Agent
+! Template
+|-
+| [[Hans]] || [[Template:WeaponData/Hans]]
+|-
+| [[Larcin]] || [[Template:WeaponData/Larcin]]
+|-
+| [[Octo]] || [[Template:WeaponData/Octo]]
+|-
+| [[Sasori]] || [[Template:WeaponData/Sasori]]
+|-
+| [[Yu-Mi]] || [[Template:WeaponData/Yumi]]
+|}
+Additionally, one has been made for generic shotguns (like Red's): [[Template:WeaponData/Shotgun]]
+[[Category:WeaponData Templates]]
+</noinclude><!--
-* name - str
-* subtitle
-* icon - str
-* desc - str?
-* damage - float
-* headshot - float
-* mag_size - int
-* starting_ammo - int
-* reload_speed - float
-* rof - float
 --><includeonly><table class="wikitable" style="width:100%;">
 <tr><th colspan="5"><span style="font-size: 24px;">{{{name}}}</span></th></tr>
@@ Line 37: / Line 96: @@
 <td colspan="1"><span style="display:inline-block;width:100%;text-align:center;">{{{rof|}}}</td>
 </tr>
-{{#if:{{{headshot|}}}|<tr><th colspan="5" style="font-size:16px;">Damage Hit Multiplier</th></tr><tr><th colspan="5">Head Shot</th></tr><tr><td colspan="5"><span style="display:inline-block;width:100%;text-align:center;">x{{{headshot|}}}</span></td>|}}</td></tr>
+{{#if:{{{headshot|}}}|<tr><th colspan="5">Head Shot Damage</th></tr><tr><td colspan="5" style="text-align:center;">{{{headshot}}}</td>}}</td></tr>
 </table></includeonly>