Template:Effect Summary/Doc

The UESPWiki – Your source for The Elder Scrolls since 1995
Jump to: navigation, search

Summary[edit]

This template is to be used at the top of each magical effect page to standardize info and formatting.

Parameters[edit]

Effect Summary
Parameter Scope Description
image optional The icon used in the game for this effect. Text only, do not link. Leave blank and use dispimage for multi-effect pages like Morrowind:Resist Element.
dispimage optional The linked image to display on the effect page if there are multiple images or if a special name needs to be specified (e.g., Morrowind:Resist Element).
titlename optional The name to display in the title, if not the page name.
school optional The name of the skill school to which this effect belongs (blank or None if no school).
color optional The background color to use. It is recommended that this parameter not be specified (in which case the color will be set based on the value of School).
type optional 'Offensive' or 'Defensive'. Whether this spell is primarily used for attacking targets, or primarily used on yourself. This is only meant to indicate normal use; details can appear later on the page.
avail optional List of ways in which this effect can be used, for example:
'Spells', 'Built-In Potions', 'Custom Potions', 'Scrolls', 'Staves', 'Sigil Stones'
Each of these should be provided as a link to the page containing specific information.
syntax optional Example of how effect is described (including correct units for magnitude). Use M for magnitude, D for duration, A for area.
alchsyntax
enchsyntax
shieldsyntax
weaponsyntax
optional Example of how effect is described (including correct units for magnitude) for alchemy, enchanting, weapons, or shields respectively. Use M for magnitude, D for duration, A for area.
conditionalsyntax
condition
optional Example of how the effect is described given a specific condition. Intended to be used for simple variations like singular form. The condition should be formatted according to valid inputs of #expr. (Ex: <magnitude> = 1)
imgpath optional The path for the effect's image written in terms of its variable(s), if applicable.
notrail optional If a value is provided for this parameter the trail and category will be omitted.
Morrowind
cost optional Magicka base cost of this effect (see Spell Effects).
Oblivion
id optional Four-letter ID code for this effect (see Spell Effects).
cost optional Magicka base cost of this effect (see Spell Effects).
barter optional Barter factor of this effect (see Spell Effects).
Skyrim
id optional Form ID of effect when not used with alchemy or enchanting.
alchid
enchid
optional Form ID of the effect (MGEF) for alchemy and enchanting effects, respectively.
alchcost
enchcost
optional Base cost of this effect for alchemy and enchanting, respectively.
alchmag optional Base magnitude of this effect for alchemy.
alchdur optional Base duration of this effect for alchemy.
enchitem optional Types of items this effect can be applied to with enchanting.

Example[edit]

{{Effect Summary
|image=OB-icon-Absorb.png
|school=Restoration
|type=Offensive
|id=ABAT
|cost=0.95
|barter=0
|avail=[[Oblivion:List of Spells by Effect#Absorb Attribute|Spells]]<br>[[Oblivion:Scrolls#Absorb Attribute|Scrolls]]<br>[[Oblivion:Enchanting#Absorb Attribute|Sigil Stones]]
|syntax=Absorb [[Oblivion:Attributes|Attribute]] M points for D seconds
|notrail=yes}}
OB-icon-Absorb.png Doc
School Restoration
Type Offensive
Effect ID ABAT
Base Cost 0.95
Barter Factor 0
Availability
(Click on any item for details)
Spells
Scrolls
Sigil Stones

Absorb Attribute M points for D seconds