Template:Items/doc

Documentation

[purge]

Usage

{{Items
| name =
| image =
| type =
| Time to use =
| description =
| info =
| interactions =
| arenas =
| tips =
| bugs =
}}

Parameters

Parameter	Data type	Description
name	String	The name of the item.
image	String	The in-game icon for the item.
type	String	The type of the item.
Time to use		The amount of time it takes to use the item. For thrown items, the header is changed to "Ignition time" instead of Time To Use, but the parameter remains the same. If there is no time to use, use - (a hyphen).
description	Wikitext	The in-game description of the item. Try to keep this true to the game text. For adding additional information, see the next few parameters.
info	Wikitext	Additional information about the item that is not included in the in-game description.
interactions	Wikitext	Optional. Information about how this item interacts with other items/abilities.
arenas	Wikitext	Arenas-specific information.
tips	Wikitext	Tips about how to effectively use the item.
bugs	Wikitext	Documents bugs related to the item. If there are no bugs, leave this empty.

Example

{{Items
| name = {{Common|Knockdown Shield}}
| image = Knockdown Shield.svg
| type = Gear
| description = Directional damage protection while knocked down (Max: '''200''' Damage).
| info = 
* Reduces movement speed to '''55%'''.
| tips = 
| bugs = 
}}

	Knockdown Shield
	Type	Gear
	Time to use	?
	Description	Directional damage protection while knocked down (Max: 200 Damage).

• Reduces movement speed to 55%.

{{Items
| name = {{Common|Body Shield}}
| image = Body Shield.svg
| type = Defense
| description = Absorbs '''50''' damage.
| info = 
* '''{{Common|Level 1}} is no longer available. See {{Legendary|Level 4}} for Battle Royale, or {{Rare|Level 2}} and {{Epic|Level 3}} for {{ItemLink|Arenas}}.'''
| tips = 
* Prioritize finding one as soon as possible at the start of the game, regardless of its level.
* On intense firefights, it may be faster to switch to another body shield of the same or lower level instead of using {{ItemLink|Shield Cell|text=Shield Cells}} or {{ItemLink|Shield Battery|text=Shield Batteries}}, as all shields keep their health when dropped and all naturally spawned body shields always start with full health.
* Completing a [[Finisher]] refills all [[Shield]] health.
| bugs = 
}}

	Body Shield
	Type	Defense
	Time to use	?
	Description	Absorbs 50 damage.

• Level 1 is no longer available. See Level 4 for Battle Royale, or Level 2 and Level 3 for Arenas.

• Prioritize finding one as soon as possible at the start of the game, regardless of its level.
• On intense firefights, it may be faster to switch to another body shield of the same or lower level instead of using Shield Cells or Shield Batteries, as all shields keep their health when dropped and all naturally spawned body shields always start with full health.
• Completing a Finisher refills all Shield health.

{{Items
| name = {{Rare|Heat Shield}}
| image = Heat Shield.svg
| type = Survival
| description = Ring damage protection in an area.<br/>Increases speed of revives outside [[the ring]] by '''25%'''.
| info =
* Spawns in stacks of 2.
* Up to 2 Heat Shields can be stacked in the Survival Slot.
* Inside the Ring, the Heat Shield does nothing. It disappears if the Ring does not touch it within 45 seconds.
* The shield starts at 100%; while absorbing ring damage, it takes damage every 1.5 seconds. The amount is based on the round. 
** '''5%''' for Rounds 1 and 2. (Maximum duration is '''30''' seconds.)
** '''6%''' for Round 3. (Maximum duration is '''25.5''' seconds.)
** '''8%''' for Round 4. (Maximum duration is '''19.5''' seconds.)
** '''15%''' for Round 5. (Maximum duration is '''10.5''' seconds.)
** '''25%''' for Round 6. (Maximum duration is '''6''' seconds.)
** '''100%''' while Round 6 is closing. (Maximum duration is '''1.5''' seconds.)
| interactions =
* Can be placed on the [[Trident]].
| tips =
* It is best to use this when you are far away from the Ring, in the earlier rounds, or being pushed to the Ring by an enemy team, or trying to get out of cover, in the later rounds.
| bugs =  <!-- Please leave this section empty if there are no bugs -->
}}

	Heat Shield
	Type	Survival
	Time to use	?
	Description	Ring damage protection in an area. Increases speed of revives outside the ring by 25%.

• Spawns in stacks of 2.
• Up to 2 Heat Shields can be stacked in the Survival Slot.
• Inside the Ring, the Heat Shield does nothing. It disappears if the Ring does not touch it within 45 seconds.
• The shield starts at 100%; while absorbing ring damage, it takes damage every 1.5 seconds. The amount is based on the round.
  • 5% for Rounds 1 and 2. (Maximum duration is 30 seconds.)
  • 6% for Round 3. (Maximum duration is 25.5 seconds.)
  • 8% for Round 4. (Maximum duration is 19.5 seconds.)
  • 15% for Round 5. (Maximum duration is 10.5 seconds.)
  • 25% for Round 6. (Maximum duration is 6 seconds.)
  • 100% while Round 6 is closing. (Maximum duration is 1.5 seconds.)

• Can be placed on the Trident.

• It is best to use this when you are far away from the Ring, in the earlier rounds, or being pushed to the Ring by an enemy team, or trying to get out of cover, in the later rounds.

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.