Template:MonsterBox/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
>@DeletedUser40283032
(Documentations for the win. Probably not the final version.)
 
 
(33 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
__TOC__
<nowiki>{{MonsterBox}}</nowiki> is used to create a box with informations about the monster.
==Variables==
* name = The name of the monster.


* rarity = This is used to change the color of the name. It defaults to white, but the following settings can be used:
This template is used to create a box with informations about a monster.
:: boss - Change the color to orange.
:: unique - Change the color to orange.


* image = The name of the file/picture that should be included.
==Parameters==
All parameters except for <code>name</code> are optional. They can be excluded or left blank.


* imagealt = What should appear if you hover over the image or if the file can't be loaded etc.
{| class="wikitable sortable"
! Parameter
! Description
|-
| <code>name</code>
| The name of the monster.
|-
| <code>rarity</code>
| The [[rarity]] of the monster. <br> Has to be one of the following:
* Normal
* Magic
* Rare
* Unique
* Boss
|-
| <code>image</code>
| The image name.
|-
| <code>level</code>
| The level(s) of the monster.
|-
| <code>location</code>
| The location(s) of the monster.
|-
| <code>quest</code>
| The quest(s) the monster is related to.
|-
| <code>category</code>
| The [[monster category]] of the monster.
|-
|  <code>health</code>
| The base health of the monster.
|-
| <code>damage</code>
| The base physical damage of the monster.
|-
|  <code>aps</code>
| The base attacks per second of the monster.
|-
| <code>resistance</code>
| The base resistances of the monster.
|-
| <code>modifier</code>
| The modifier(s) (mods) the monster has.
|-
| <code>skill</code>
| The skill the monster use. Despite all monster skill are coded separately and different from skill gem, it is fine to link to a skill gem that closely related to the monster skill .
|-
| <code>metadata_id</code>
| The metadata id of the monster. Single value allowed only for now.
|}


* diff1 = The monsters level in normal difficulty (Should be the same level as the area).
==Copy Paste==
 
* diff2 = The monsters level in cruel difficulty.
 
* diff3 = The monsters level in merciless difficulty.
 
* location = The location(s) of the monster.
 
* quest =  When the monster is needed for a quest mention the name of the quest here.
 
* resistance = The resistances of the monster. Marked with "Resists". Can be seen under the name.
 
* weakness = Weaknesses of the monster. Marked with "Vulnerable to".
 
* damage = The damage the monster deals. Marked with "Extra Fire Damage" for example.
 
* skill = The skills the monster is using. Marked with "Casts".
:: Note: Not all skills may be listed under the name. [[General Gravicius]] for example addtionally casts [[Fire Trap]]s.
 
* aura = Active monster auras. "Allies have Energy Shield" for example.
 
==Copy Paste ready ==
Full version:
<pre>
<pre>
{{MonsterBox
{{MonsterBox
| name =
| name = {{PAGENAME}}
| rarity =
| rarity =  
| image =
| image =  
| imagealt =
| level =  
| diff1 =
| diff2 =
| diff3 =  
| location =  
| location =  
| quest =  
| quest =  
| category =
| health =
| damage =
| aps =
| resistance =  
| resistance =  
| weakness =
| modifier =  
| damage =
| skill =
| skill =  
| metadata_id =
| aura =
}}
</pre>
 
Minimal version:
<pre>
{{MonsterBox
| name =
| location =  
}}
}}
</pre>
</pre>


== Usage ==
{{Documentation categories|
<pre>
<!-- Categories and interwikis go here. -->
{{MonsterBox
[[Category:Templates]]
| name = General Gravicius
| rarity = boss
| image = GeneralGravicius.png
| imagealt = General Gravicius
| diff1 = 32
| diff2 = 51
| diff3 = ?
| location = Barracks
| quest = Sever the Right Hand
| resistance = Resists [[Elemental Damage]] <br> Resists [[Chaos]]
| weakness =
| damage = Extra [[Fire]] Damage
| skill = Casts [[Firestorm]] <br> Casts [[Molten Shell]] <br> Casts [[Fire Trap]]
| aura = Allies have [[Energy Shield]]
}}
</pre>
 
==Example==
{{MonsterBox
| name = General Gravicius
| rarity = boss
| image = GeneralGravicius.png
| imagealt = General Gravicius
| diff1 = 32
| diff2 = 51
| diff3 = ?
| location = Barracks
| quest = Sever the Right Hand
| resistance = Resists [[Elemental Damage]] <br> Resists [[Chaos]]
| weakness =
| damage = Extra [[Fire]] Damage
| skill = Casts [[Firestorm]] <br> Casts [[Molten Shell]] <br> Casts [[Fire Trap]]
| aura = Allies have [[Energy Shield]]
}}
}}
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Templates|{{PAGENAME}}]]
</includeonly>

Latest revision as of 17:11, 6 April 2024

This subpage provides documentation for Template:MonsterBox.

This template is used to create a box with informations about a monster.

Parameters

All parameters except for name are optional. They can be excluded or left blank.

Parameter Description
name The name of the monster.
rarity The rarity of the monster.
Has to be one of the following:
  • Normal
  • Magic
  • Rare
  • Unique
  • Boss
image The image name.
level The level(s) of the monster.
location The location(s) of the monster.
quest The quest(s) the monster is related to.
category The monster category of the monster.
health The base health of the monster.
damage The base physical damage of the monster.
aps The base attacks per second of the monster.
resistance The base resistances of the monster.
modifier The modifier(s) (mods) the monster has.
skill The skill the monster use. Despite all monster skill are coded separately and different from skill gem, it is fine to link to a skill gem that closely related to the monster skill .
metadata_id The metadata id of the monster. Single value allowed only for now.

Copy Paste

{{MonsterBox
| name = {{PAGENAME}}
| rarity = 
| image = 
| level = 
| location = 
| quest = 
| category =
| health = 
| damage = 
| aps = 
| resistance = 
| modifier = 
| skill =
| metadata_id =
}}