Template:Infobox Monster new/doc

This is a documentation subpage for Template:Infobox Monster new. It contains usage information, categories, and other content that is not part of the original template page.

Template:Infobox Monster new invokes function main in Module:Infobox Monster using Lua.

The standard infobox for attackable monsters.

Standard parameters

This template uses Module:Infobox, and as such the following standard parameters apply.

Versioning

This template supports versioning. To make a versioned infobox, simply add version# parameters, starting at 1 and increasing until all required versioned are covered. The value of the version parameter is the name given to the version, which applies to the button/option to select the version, as well as to any SMW subobjects used.

For example, |version1=used|version2=broken.

Other parameters can (and at least some should) be versioned, and can be done by appending corresponding integers to the parameter name (e.g. |name1=Superior tetsu body|name2=Superior tetsu body (broken)).

If a version name is set to a value that results in an invalid name for a subobject, the subobject name will be modified and Category:Pages with an invalid subobject name will be added to the page.

By default, multi-version infoboxes use 1-based indexes as the switch IDs. If multiple multi-version infoboxes or Template:Switch infoboxes exist on the same page, this can cause conflicts. If needed, you can manually specify switch IDs using the switch_id# parameter (e.g. |switch_id1=alt1|switch_id2=alt2). For more info, see Template:Switch infobox § Specifying switch IDs.

smwname

This sets the Semantic MediaWiki subobject(s) that the infobox (or current infobox version) should set the parameters into. This is only required when the infobox version name is not the intended destination of semantic properties, or if an unversioned infobox needs to set properties into a specific subobject (e.g. when versioned and unversioned infoboxes (of different types, like Item and Bonuses) are used on the same page).

By default if the page has versions, properties are set into named subobjects, where the names are the version names; if the page does not have versions, the properties are set on to the page itself. Setting smwname overrides the default behaviour - the properties will be set to the specified subobjects and only the specified subobjects.

Multiple subobjects can be specified by separating the subobject names with the broken bar ¦ - the properties will be set in all of the subobjects specified.

smwname can be versioned to change where specific infobox versions set the properties.

__dump__

If __dump__ is present with any value, rather than displaying the infobox as normal, a string version of the infobox object is dumped to the page. This is for debugging the infobox and should only be used by previewing the page; it should never be saved in a mainspace page. Setting this adds Category:Dumping infoboxes to the page.

Specifically, this applies when the infobox is converted to a string, which will always occur when the module finally returns, but may occur earlier in the code. The object is dumped using mw.dumpObject(box). Dumping will not prevent a script error occuring.

Parameters

name

Name of the monster to be displayed as the table's caption. This should be the monster's name in game exactly.

image

Image of the monster.

release

Release date of the monster. Should follow the format [[DD Month]] [[YYYY]].

update

Update page that the monster was released with. Do not include brackets ([[ & ]]) or the Update: prefix.

removal

Date the monster was removed from game. Should follow the format [[DD Month]] [[YYYY]].

removalupdate

Update page that the monster was removed with. Do not include brackets ([[ & ]]) or the Update: prefix.

members

Whether or not the monster is a members only monster.

actions

Right-click options that the monster provides. Should be a comma separated list, bullet generation is handled internally. Specify None if its only option is Examine.

examine

Examine text of the monster.

voice

Whether the monster is voice acted or not. Use "Yes" if it is, omit field if not.

race

Race of the NPC, the default is based on the slayercat if present (mapped using Module:NPC races/Slayer).

aggressive

Whether or not the monster is aggressive.

poisonous

Whether or not the monster can inflict poison. If the monster can, use the initial value of poison damage, instead of "yes".

level

The displayed combat level of the monster.

experience

Experience received in a combat skill (not Constitution) when killing a monster. Constitution experience is calculated from this number. This parameter must either be a number or "n/a".

wepxp2h

The item experience for the two-handed weapon that is received when fighting this monster. Normally this amount is calculated based on the experience parameter shown above, however there are monsters who deviate from this rule such as The Magister. This parameter must be a number or be not present at all (which is the default).

wepxpmhandarmour

The item experience for the main hand weapon and armour pieces (body and legs) that is received when fighting this monster. Normally this amount is calculated based on the experience parameter shown above, however there are monsters who deviate from this rule such as The Magister. This parameter must be a number or be not present at all (which is the default).

wepxpoh

The item experience for the off-hand weapon that is received when fighting this monster. Normally this amount is calculated based on the experience parameter shown above, however there are monsters who deviate from this rule such as The Magister. This parameter must be a number or be not present at all (which is the default).

lifepoints

Number of life points that the monster has. This parameter must either be a number or "n/a".

slaylvl

Slayer level required to damage the monster. Omit if the monster has no required level and is not assigned by any master. Use a value of "1" for monsters that do not require any level but are assigned by a master. This parameter must either be a number or "n/a".

slayxp

Slayer experience received for killing the monster on task. Omit if not assigned. This parameter must either be a number or "n/a".

slayercat

Slayer category that the monster falls under for slayer assignments. Omit if not assigned.

assigned_by

Deprecated This parameter is now auto filled based on the slayercat and should no longer be needed. Masters that can assign the monster. Create a comma separated list; e.g. "Turael, Duradel, Morvran".

Accepted values:

• Turael
• Spria
• Mazchna
• Achtryn
• Vannaka
• Chaeldar
• Sumona
• Duradel
• Lapalok
• Kuradal
• Morvran
• Laniakea
• None

The value of "None" should only be used when a monster is not assigned at all, but does require a level to damage; e.g., Night spider. Including "none" anywhere in the text of this parameter will cause the monster to appear as not assigned, even if other masters are listed.

restriction

Defines the location restriction applied to a monster, to ensure correct filtering in the bestiary. A monster (or more accurately, a specific version of monster) is considered restricted if the only way to fight it is within the bounds of the definition and not before/after/elsewhere. For example, The Inadequacy has two versions, one of which is only available during the Dream Mentor quest (making it quest restricted), and one of which is only available during Dominion Tower (making it minigame restricted).

Can be one of the following possible values:

• surface - default - parameter can be removed for this value
• quest - monsters that only appear in quests, not before/after
• minigame - monsters that only appear within minigames, not elsewhere
• dungeoneering - monsters that only appear within Daemonheim
• removed - monsters that have been removed from the game
• limited - monsters that are only available by participating in Treasure Hunter or Squeal of Fortune - this is primarily to maintain parity with Template:Infobox Item

immune_to_poison

Whether or not the monster is immune to being poisoned.

immune_to_stun

Whether or not the monster is immune to being stunned.

immune_to_deflect

Whether or not the monster is immune to deflect damage.

immune_to_drain

Whether or not the monster is immune to having its stats drained by ancient curses.

style

Attack styles of the monster in a comma separated list.

Accepted values:

• melee
• magic / mage
• ranged / range / ranging
• dragonfire / dragonbreath / dragon fire / dragon breath

primarystyle

Primary attack style of the monster. Used to determine susceptibility to the Hexhunter box, Inquisitor staff and Terrasaur maul.

Accepted values:

• melee
• magic
• ranged

speed

Attack speed of the monster. This parameter must either be a number from 0 to 9 or "n/a".

max_melee

Maximum melee damage hit the monster can deal. This parameter must either be a number or "n/a".

max_ranged

Maximum ranged damage hit the monster can deal. This parameter must either be a number or "n/a".

max_magic

Maximum magic damage hit the monster can deal. This parameter must either be a number or "n/a".

max_spec

Maximum special attack/typeless damage hit the monster can deal. This parameter must either be a number or "n/a".

abilities

Abilities used by the monster. Comma-separated list or be omitted.

weakness

Comma separated list of the monster's weakness. Only include the explicit weakness displayed in game (the class-style e.g. Bolts) or of special weaknesses (darklight/silverlight). Accepted values are listed on Template:Weakness clickpic/doc. The weakness explicitly given in game should always be listed first.

susceptibility

Comma separated list of the monster's susceptibilities. Includes all weapons and items which effect the creature other than its special weakness. Accepted values are those listed on Template:Weakness clickpic/doc which are not the explicit weakness or darklight/silverlight.

armour

The monster's base armour value. This parameter must either be a number or "n/a".

acc_melee

The monster's base melee accuracy. This parameter must either be a number or "n/a".

acc_ranged

The monster's base ranged accuracy. This parameter must either be a number or "n/a".

acc_magic

The monster's base magic accuracy. This parameter must either be a number or "n/a".

attack

The monster's attack level. This parameter must either be a number or "n/a".

Note - monsters do not have/use a 'strength' level.

ranged

The monster's ranged level. This parameter must either be a number or "n/a".

magic

The monster's magic level. This parameter must either be a number or "n/a".

defence

The monster's defence level. This parameter must either be a number or "n/a".

aff_weakness

The monster's affinity value to its explicit weakness. This parameter must either be a number or "n/a".

aff_melee

The monster's affinity value to melee attacks. This parameter must either be a number or "n/a".

aff_ranged

The monster's affinity value to ranged attacks. This parameter must either be a number or "n/a".

aff_magic

The monster's affinity value to magic attacks. This parameter must either be a number or "n/a".

id

The monster's internal game ID. This parameter must be a number.

Using switching values

Version

Infobox monster can be used to support multiple values for each of parameters with JavaScript-run switching. Alternate versions must be named and defined with the respective "version#" parameter to appear; each version parameter should be unique and sufficiently descriptive. Infobox monster will only look up to the highest consecutive value, starting at 1.

Parameters can be assigned different values in different versions by adding an index after the name. For example, if we want the 2nd version to be called "Monster 2", we would add "|name2 = Monster 2". If left blank or undefined, alternate values will default to the original value (the one without an index defined).

If there are more than 5 versions, the buttons will turn into a dropdown.

Alternative versions are not visible or accessible when Javascript is disabled, or using the mobile skin.

References

If the same parameter is used in multiple versions (but not the default, e.g. a shared image), the parameter can be set to a reference to another version of the parameter using the format $versionNumber. For example, if the image of version 4 is the same as the image in version 2, we use |image4=$2. Utilising references is only suggested for the image parameter, as using them for a numerical parameters will often result in a parsing error in the module.

Linking

If you wish to link to a page and have an alternative infobox appear, you can use a hash value, as if you were linking to a section. The hash value is the version name, as defined by the relevant version# parameter. For example, to link to the variant of a monster with |version3=Level 64, you can use [[Example#Level 64]].

Blank box

{{Infobox Monster new
|name = 
|image = 
|release = 
|update = 
|removal = 
|removalupdate = 
|members = 
|actions = 
|race = 
|examine = 
|level = 
|lifepoints = 
|experience = 
|aggressive = 
|poisonous = 
|slaylvl = 
|slayxp = 
|slayercat = 
|assigned_by = 
|max_melee = 
|max_ranged = 
|max_magic = 
|max_spec = 
|style = 
|primarystyle = 
|speed = 
|attack = 
|ranged = 
|magic = 
|acc_melee = 
|acc_ranged = 
|acc_magic = 
|abilities =
|armour = 
|defence = 
|weakness = 
|susceptibility = 
|aff_weakness = 
|aff_melee = 
|aff_ranged = 
|aff_magic = 
|immune_to_poison = 
|immune_to_deflect = 
|immune_to_stun = 
|immune_to_drain = 
|restriction = 
|id = 
}}