Template:Spell/doc

The official GemStone IV encyclopedia.
< Template:Spell
Revision as of 19:04, 1 March 2021 by VANKRASN39 (talk | contribs) (→‎Navigation: add Lost arts nav)
Jump to navigation Jump to search

The article changes colors based on the definition of the {{{type}}} parameter. The colors are according to the following table:

Offensive is FF9 Defensive is CF9 Utility is 9CF Attack is F99 Healing is FC9 Undefined is DDD
Offensive is FFFFF8 Defensive is FCFFF8 Utility is F8FCFF Attack is FFF8F8 Healing is FFFCEF Undefined is F9F9F9

The example to the right is an undefined table.

Duration

The standard duration parameter are {{{base_dur}}} (base duration) and {{{add_dur}}} (added duration per spell circle rank or lore rank).

If the parameter {{{duration}}} is defined, it automatically replaces the shown duration fields. This is to ensure backwards compatibility with the old spell template. Additionally, if the parameter {{{custdur}}} is defined, it also replaces the shown fields and allows one to use the custom duration templates from the spellbox series of templates. These are Template:Spellbox instant, Template:Spellbox block, and Template:Spellbox duration, although the Spellbox duration template would be exactly the same as the default.

For example, the following template can be used to specify that a spell has a refreshable duration of 60 seconds: 

custdur = {{Spellbox block | duration = 60 sec. | span = [[Refreshable]]}}

Span

The parameter {{{span}}} refers to the spell's ability to be extended. Possible values include Stackable, Refreshable, and Solid block. This field only appears when using the standard duration parameters (base_dur + add_dur), but can be added as an optional parameter when using "custdur = {{Spellbox block | ...}}".

Types

The template changes drastically based on what type is chosen for the template. The preview, to the right, is what the template will look like with no type defined. Undefined, the template will be gray. However, the colors and parameters change when defined, and the type line will vanish so long as it meets one of four types: Attack, Defensive, Offensive, and Utility. It is case sensitive. Any unwanted line can be removed by defining the associated parameter as "None". This is case sensitive.

Attack

This type changes the template to have a pale red background in addition to adding lines for Subtype, Target(s), Interval, Damage Type, Critical Type, and State(s) Inflicted.

  • Subtype defines if the attack is a warding, maneuver, or bolt attack, or a combination thereof.
  • Target(s) is used to define who is targeted by the attack. Some spells affect everyone (room), everyone not in the group (ungrouped), all critters (creatures), or only a single individual. Some spells are limited in number and will chose targets randomly from an above list. If such is the case, put the list that the spell chooses from, and go into more detail in the spell description within the article itself.
  • Interval indicates the frequency of damage over time effects if the spell has such a component. For spells without any time interval component, set this parameter to "None" to hide the line.
  • Damage Type is what sort of damage is inflicted. Usually, this'll be health point damage, but it could be mana damage as well, or others.
    • Critical Type line will show if the parameter {{{dtype}}} is defined, and lists the critical table(s) used by the spell.
  • State(s) Inflicted displays the type of status ailment inflicted on the target. If this parameter is set, the spell will be designated as "Disabling" in the header.

Defensive

This type changes the template to have a pale green background in addition to adding lines for Subtype, Defensive Strength, Target Defense, Enhancement, and Availability.

  • Subtypes for defensive spells would define which sort of defensive capabilities the spell offers, such as increases to DS, TD, and skills.
  • Defensive Strength should be listed as the type of DS it provides, such as melee or bolt.
  • Target Defense should be labelled by the type of TD it provides, like DS. Options are: Spiritual, Elemental, Mental, and Generic (or All).
  • Enhancement would be used for spells such as Mass Blur which increase defensive capabilities by granting phantom ranks in the skill, Dodge; though, some spells increase ranks in Stalking and Hiding in addition to increasing defensive capabilities; such would go here.
  • Availability defines who the spell can be cast on, such as self-cast, group (like Mass Blur), and all (such as Elemental Defense I).

Offensive

This type changes the template to have a light yellow background in addition to adding lines for Subtype, Weapon Enhancement, Enhancement, and Availability or Weapon Requirements.

  • "Subtype" defines what sort of enhancement that this spell provides. Generally, weapon enhancements, attack strength enhancements, or more.
  • "Enhancement" is split into two categories, defined by which parameter is used -- {{{weapon}}} or {{{enhancement}}}.
    • {{{weapon}}} - defines the template as a weapon enhancement, and this field is used to define what sort of enhancement the spell provides to the weapon. There are currently three weapon enhancement spells, Bless Item, Minor Elemental Edge, and Elemental Blade. Bless Item grants a weapon the Blessed status, and thus would be simply labeled, "Bless". Minor Elemental Edge and Elemental Blade both grant enchantment bonuses (labeled, "Enchantment"), though, Elemental Blade also adds flares (and thus would be labeled "Enchantment, Flares"). Using this parameter replaces Availability with Requirements. Note that the spell, Enchant Item, is not considered an offensive spell due to the ability to enchant shields and armor, in addition to weaponry.
    • {{{enhancement}}} - defines the template as a general enhancement spell. This would be used where the spell provides an enhancement to an offensive skill, such as Patron's Blessing, which increases ranks in the skill, Combat Maneuvers. Also, if the spell provides an increase to Attack Strength, it would be listed here.
  • "Availability" is similar to the use with defensive spells as above, although, if this spell is labeled as a weapon enhancement by using the {{{weapon}}} parameter, this line is replaced by the Requirements line.
  • "Weapon Requirements" is used with weapon enhancements, and this line defines the requirements that are placed on the weapon to cast this spell. For example, to cast Bless Item on a weapon, it cannot have flares or weighting. Additionally, to cast Minor Elemental Edge or Elemental Blade on a weapon, it cannot be magical in any way whatsoever. This includes weighting and flares.

Healing

This type changes the template to an orange background. It is used on Empath Base and Former Empath Base (herb) healing spells.

Utility

This type changes the template to have a light blue background in addition to adding lines for Subtype, Skill Enhancement, Components, and Availability.

  • "Subtype" is often defined as either being Combat, Enhancement, or None, although other subtypes may be defined.
  • "Skill Enhancement" is used to list whatever skills might be enhanced by this spell. Increases to skills that are not directly offensive or defensive in nature, such as Stalking and Hiding, Skinning, and Foraging, will be listed as utility. If the spell does not enhance a skill, enter "None".
  • "Components" lists the various components the spell may require. Listing the components as "None" will remove this line.
  • "Availability" is used for enhancement utility spells, such as Sneaking or Whispering Willow. It is defined much like the Availability line in defensive spells.

Navigation

The parameter {{{navigation}}} allows the use of any of the navigational templates available from the Spellbox series of templates. All of the navigational templates are listed below.

Other Examples

Current examples of this template in use include 401, 601, 603, 606, and 619.

Notes

This template makes extensive use of the ParserFunctions extension. Many of these functions are severely nested and nested again and I admit the coding was rather confusing. I expect there to be bugs due to my inexperience with ParserFunctions and the complex structure of the template.

This article is subject to change.


Retrieved from "https://gswiki.play.net/index.php?title=Template:Spell/doc&oldid=145579"