Difference between revisions of "Template:Creature Summary/Doc"

The Beyond Skyrim Wiki — Hosted by UESP
Jump to: navigation, search
m (Page unprotected - remove protection template)
 
m (→‎Example)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Summary ==
 
== Summary ==
−
This template creates an infobox for use on all Creature pages. It includes the appropriate bread crumb trails and categories.  It can be used on Morrowind, Tribunal, Bloodmoon, Oblivion, and Shivering Isles pages.
+
This template creates an infobox for use on all Creature pages. It includes the appropriate bread crumb trails and categories.
  
 
== Parameters ==
 
== Parameters ==
−
{{Parameters
+
{| class="wikitable"
−
|titlename|optional|Creature's name as displayed at the top of the infobox. Generally NOT needed; will default to use PAGENAME.  Only needed when pagename contains extra information (i.e., disambiguation).
+
!colspan="3"| {{{template|{{BASEPAGENAME}}}}}
−
|altname|optional|Creature's name as used in category tags.  Generally NOT needed: will default to use PAGENAME. Only needed when the creature's name starts with "The" or "A" to fix the alphabetization of categories.
+
|-
−
|id|required|Creature's base FormID (Oblivion) or editor ID in Morrowind. This parameter may be omitted on Morrowind pages if the ID is the same as the titlename or PAGENAME, but in lower-case.
+
! Parameter !! Scope !! Description
−
|refid|optional|Creature's reference FormID in Oblivion. Multiple IDs should be separated with a comma outside of Morrowind space. <code>refid</code> and <code>baseid</code> should be used in place of the standard id parameter for any creatures that are unique and therefore have a uniquely defined reference ID.
+
|-
−
|baseid|optional|Creature's base FormID in Oblivion. Multiple IDs should be separated with a comma outside of Morrowind space.
+
|titlename||optional||Creature's name as displayed at the top of the infobox. Will default to use PAGENAME.
−
|refidhover<br>baseidhover|optional|Whether hover text should be used. If so, ID format becomes: <code>id1,hover1,id2,hover2</code>.
+
|-
−
|mod|optional|Name of mod that adds creature (if not in baseline version of game).
+
|refid||optional||Creature's reference FormID. Multiple IDs should be separated with a comma.
−
|city|optional|Creature's "Home City" (formatted as a link to appropriate page).
+
|-
−
|house|optional|Name of the "House" where this creature lives (if not a merchant).
+
|baseid||optional||Creature's base FormID. Multiple IDs should be separated with a comma.
−
|loc|optional|"Location" where creature can be found (if not in a city or in a house)<br>N.B. generally creatures will have <code>city+house</code> or just <code>loc</code> set. All three of city, house and loc are not intended to be used together but they are provided as redundant options so that an appropriate place-related box can be created for any creature.
+
|-
−
|species|optional|Species. If speciescat is ''not'' provided <code>species</code> should be a plain word, i.e., not a link. If speciescat is provided, it can be a plain word or a link to the appropriate species page.
+
|type||optional||Creature's type (e.g. Daedra, Undead, etc.)
−
|speciescat|optional|Species to be used for page's category: not as a link, singular. Generally ''not'' needed: will default to use <code>species</code>. Only needed when creature is a non-standard species without a category. Can be set to "none" to prevent any species category from being added to page.
+
|-
−
|tribe|optional|Creature's tribe - use for goblins and other tribal creatures.
+
|species||optional||Species of the creature.
−
|level|optional|Creature's level
+
|-
−
|type|optional|Creature's type (e.g. Daedra, Undead, etc.)
+
|soul||optional||Creature's soul (Petty, Common, Grand, etc.)
−
|typenamesp|optional|Namespace for type, to be used in links. Uses article's namespace by default.
+
|-
−
|gold|optional|Merchants' gold (only needed for merchants).
+
|level||optional||Creature's level
−
|sells|optional|List of items sold by merchant.
+
|-
−
|buys|optional|List of types of items bought by merchant, corresponding to CS categories.
+
|health||optional||Creature's health.
−
|repair|optional|Set to Yes for creautres that offer repair services.
+
|-
−
|health|required|Creature's health.
+
|magicka||optional||Creature's magicka.
−
|magicka|required|Creature's magicka.
+
|-
−
|stamina|optional|Creature's stamina.
+
|stamina||optional||Creature's stamina.
−
|resp|optional|Creature's responsibility for Oblivion creatures. Should be used with <code>resp</code>.
+
|-
−
|aggress|optional|Creature's aggression for Oblivion creatures. Should be used with <code>aggress</code>.
+
|perks||optional||Creature's perks.
−
|alarm|optional|Creature's alarm level for Morrowind creatures. Should be used with <code>fight</code>.
+
|-
−
|fight|optional|Creature's fight level for Morrowind creatures. Should be used with <code>alarm</code>.
+
|skills||optional||Creature's primary skills.
−
|perks|optional|Creature's perks for Skyrim creatures.
+
|-
−
|skills|optional|Creature's primary skills for Skyrim creatures.
+
|abilities||optional||Creature's passive abilities - resistances, weaknesses, etc.
−
|essential|optional|Is Creature essential: Always, Sometimes, Never.
+
|-
−
|protected|optional|Is creature protected? Yes or empty.
+
|image||optional||The name of an image file for this Creature, just the file name.
−
|follower|optional|Is Creature a follower? Provide link to relevant quests.
+
|-
−
|faction|optional|Factions to which Creature belongs.
+
|notrail||optional||If set to "yes", the breadcrumb trail normally created by the template is suppressed (for cases where multiple templates are used on one page or when used for a generic NPC).
−
|soul|optional|Creature's soul (A number for Morrowind, Petty, Common, Grand, etc. for Oblivion)
+
|-
−
|attack|required|Creature's attacks, bulleted list.
+
|nocat||optional||If set to "yes", the categories normally added by the template are suppressed.
−
|abilities|optional|Creature's passive abilities - resistances, weaknesses, etc.
+
|}
−
|drops|optional|Any items carried by creature (or added to their corpse on death).
 
−
|image|optional|The name of an image file for this Creature, just the file name. Set to <code>none</code> if there is no image.
 
−
|imgdesc|required if <code>image</code><br>provided|Description of image.
 
−
|tablewidth|optional|Width of overall table (%). Normally only needed if infobox is being embedded in another table, in which case set it to 100%.
 
−
|nocat|optional|If set, will not put page into any categories.
 
−
|notrail|optional|If set to "yes", the breadcrumb trail normally created by the template is suppressed (for cases where multiple templates are used on one page or when used for a generic NPC.}}
 
  
 
== Example ==
 
== Example ==
−
<pre>{{Creature Summary|ns_base=Oblivion
+
<pre>{{Creature Summary
−
|refid=00091AAA
+
|image=Zombie.jpg
−
|baseid=00091AA9
+
|caption=A zombie
−
|loc=[[Oblivion:Nenyond Twyll|Nenyond Twyll]]
+
|type=Undead
 
|species=Zombie
 
|species=Zombie
−
|type=Undead
+
|soul=Leveled
−
|typenamesp=Oblivion
 
−
|soul=Leveled<sup>[[Oblivion:Souls#Soul Strengths|L:-1]]</sup>
 
 
|level=lvl-1
 
|level=lvl-1
 
|health=50×(lvl-1)
 
|health=50×(lvl-1)
 
|magicka=N/A
 
|magicka=N/A
−
|attack=*10+((lvl-1)/2) pts melee, unarmed
+
|abilities=
−
|abilities=*[[Oblivion:Resist Frost|Resist Frost]] 30%
+
*[[Oblivion:Resist Frost|Resist Frost]] 30%
 
*[[Oblivion:Resist Magic|Resist Magic]] 30%
 
*[[Oblivion:Resist Magic|Resist Magic]] 30%
 
*[[Oblivion:Resist Poison|Resist Poison]] 100%
 
*[[Oblivion:Resist Poison|Resist Poison]] 100%
 
*[[Oblivion:Weakness to Fire|Weakness to Fire]] 60%
 
*[[Oblivion:Weakness to Fire|Weakness to Fire]] 60%
−
|drops=*Minor Loot (15%)
+
|refid=00091AAA
−
*Mort Flesh
+
|baseid=00091AA9
−
|image=Mucianus_Allias.jpg
+
}}</pre>
−
|imgdesc=Mucianus Allias, what's left of him...
 
−
|faction={{Faction|CreatureFaction}}, {{Faction|Mucianus Zombie Faction}}, {{Faction|Necromancers}}
 
−
|aggress=5
 
−
|resp=0}}</pre>
 
  
 
{{Creature Summary
 
{{Creature Summary
−
|refid=00091AAA
+
|nocat=1
−
|baseid=00091AA9
+
|notrail=1
−
|loc=[[Oblivion:Nenyond Twyll|Nenyond Twyll]]
+
|image=Zombie.jpg
 +
|caption=A zombie
 +
|type=Undead
 
|species=Zombie
 
|species=Zombie
−
|type=Undead
+
|soul=Leveled
−
|typenamesp=Oblivion
 
−
|soul=Leveled<sup>[[Oblivion:Souls#Soul Strengths|L:-1]]</sup>
 
 
|level=lvl-1
 
|level=lvl-1
 
|health=50×(lvl-1)
 
|health=50×(lvl-1)
 
|magicka=N/A
 
|magicka=N/A
−
|attack=*10+((lvl-1)/2) pts melee, unarmed
+
|abilities=
−
|abilities=*[[Oblivion:Resist Frost|Resist Frost]] 30%
+
*[[Oblivion:Resist Frost|Resist Frost]] 30%
 
*[[Oblivion:Resist Magic|Resist Magic]] 30%
 
*[[Oblivion:Resist Magic|Resist Magic]] 30%
 
*[[Oblivion:Resist Poison|Resist Poison]] 100%
 
*[[Oblivion:Resist Poison|Resist Poison]] 100%
 
*[[Oblivion:Weakness to Fire|Weakness to Fire]] 60%
 
*[[Oblivion:Weakness to Fire|Weakness to Fire]] 60%
−
|drops=*Minor Loot (15%)
+
|refid=00091AAA
−
*Mort Flesh
+
|baseid=00091AA9
−
|image=OB-creature-Mucianus Allias.jpg
+
}}
−
|imgdesc=Mucianus Allias, what's left of him...
+
<includeonly>[[Category:Infobox Templates]]</includeonly>
−
|faction={{Faction|CreatureFaction|ns_base=Oblivion}}, {{Faction|Mucianus Zombie Faction|ns_base=Oblivion}}, {{Faction|Necromancers|ns_base=Oblivion}}
+
<noinclude>[[Category:Template Documentation]]</noinclude>
−
|aggress=5
 
−
|resp=0}}
 
−
<includeonly>[[Category:Infobox Templates|Creature Summary]]</includeonly>
 
−
<noinclude>[[Category:Template Documentation|{{BASEPAGENAME}}]]</noinclude>
 

Latest revision as of 14:44, 25 May 2019

Summary[edit]

This template creates an infobox for use on all Creature pages. It includes the appropriate bread crumb trails and categories.

Parameters[edit]

Creature Summary
Parameter Scope Description
titlename optional Creature's name as displayed at the top of the infobox. Will default to use PAGENAME.
refid optional Creature's reference FormID. Multiple IDs should be separated with a comma.
baseid optional Creature's base FormID. Multiple IDs should be separated with a comma.
type optional Creature's type (e.g. Daedra, Undead, etc.)
species optional Species of the creature.
soul optional Creature's soul (Petty, Common, Grand, etc.)
level optional Creature's level
health optional Creature's health.
magicka optional Creature's magicka.
stamina optional Creature's stamina.
perks optional Creature's perks.
skills optional Creature's primary skills.
abilities optional Creature's passive abilities - resistances, weaknesses, etc.
image optional The name of an image file for this Creature, just the file name.
notrail optional If set to "yes", the breadcrumb trail normally created by the template is suppressed (for cases where multiple templates are used on one page or when used for a generic NPC).
nocat optional If set to "yes", the categories normally added by the template are suppressed.

Example[edit]

{{Creature Summary
|image=Zombie.jpg
|caption=A zombie
|type=Undead
|species=Zombie
|soul=Leveled
|level=lvl-1
|health=50×(lvl-1)
|magicka=N/A
|abilities=
*[[Oblivion:Resist Frost|Resist Frost]] 30%
*[[Oblivion:Resist Magic|Resist Magic]] 30%
*[[Oblivion:Resist Poison|Resist Poison]] 100%
*[[Oblivion:Weakness to Fire|Weakness to Fire]] 60%
|refid=00091AAA
|baseid=00091AA9
}}


Creature Summary/Doc
Zombie.jpg
A zombie
Type Undead
Species Zombie
Soul Leveled
Level lvl-1
Health 50×(lvl-1)
Magicka N/A
Abilities
BaseID: 00091AA9
RefID: 00091AAA
Retrieved from "https://wiki.beyondskyrim.org/w/index.php?title=Template:Creature_Summary/Doc&oldid=1539"