Difference between revisions of "Template:NPCTableHead/doc"

From EVE University Wiki
Jump to: navigation, search
(Added "Elite Battlecruiser" to documentation)
 
(23 intermediate revisions by 5 users not shown)
Line 1: Line 1:
This template is used to create NPC table for the pages describing combat complexes.
+
; Description
== Dependencies ==
+
: This template is used to start an NPCTable. It needs to be paired with the standard wiki parser code to end the table <nowiki>|}</nowiki>. It needs to be used once for every NPCTable on a page.
* Uses {{t|NPCTableCSS}} to acquire proper CSS. This template is transcluded through {{t|CMBSite}} so pages that use that template do not need to include anything else.
 
* Uses {{t|NPCTableHead}} to generate the header for NPC table.
 
* Uses {{t|NPCTableRow}} to generate rows.
 
* Uses {{t|NPCTableSeparator}} for separating parts of table with title.
 
  
== Syntax ==
+
; Dependencies:
<code>{{t|CMBSite|Name of the complex}} OR {{t|NPCTableCSS}} (either one once somewhere in the article)<br>
+
:; Requires
{{t|NPCTableHead|Table header}}<br>
+
:: {{T|NPCTableCSS}} is required only <em>once</em> per page where there's at least one NPCTable. It is included into {{T|CMBSiteInfo}} and {{T|CMBSite}}(deprecated), so when one of those is used there is no need to add it separately.
{{t|NPCTableRow|Ship size|Ship count|Ship names|4=point=yes|5=ewar=Ewar|6=cargo=Loot|7=trigger=Trigger|8=note=Notes}}<br>
+
:; Paired with
{{t|NPCTableSeparator|Separator title}}<br>
+
:: <nowiki>|}</nowiki> to close the table, or include <nowiki>|end=true}}</nowiki> as the last parameter of the last {{T|NPCTableRow}}.
{{t|NPCTableRow|Ship size|Ship count|Ship names|4=point=yes/no|5=ewar=Ewar|6=cargo=Loot|7=trigger=Trigger|8=note=Notes}}<br>
+
:; Sub templates
|}</code>
+
:: {{T|NPCTableRow}} one or more for each NPCTable.
 +
:: {{T|NPCTableSeparator}} zero or more for each NPCTable.
  
=== NPCTableHead parameters===
+
; Syntax
<code>{{t|NPCTableHead|Table header}}</code>
+
: {{T|NPCTableHead|caption}}
;Table header
+
:; Parameters
:This is the title of the NPC group, e.g. <code>Wave 1</code>, <code>Initial defenders</code>, <code>Commander wave</code>, etc.  
+
::; caption : Caption of the table. May be omitted.
  
=== NPCTableRow parameters===
+
; Sample
 +
{{NPCTableCSS}}
 +
: <code><nowiki>{{NPCTableHead|Initial defenders}}</nowiki></code>
  
<code>{{t|NPCTableRow|Ship size|Ship count|Ship names|4=point=yes/no|5=ewar=Ewar|6=cargo=Loot|7=trigger=Trigger|8=note=Notes}}</code>
+
: <code><nowiki>|}</nowiki></code>
 +
:: gives...
 +
{{NPCTableHead|Initial defenders}}
  
;Ship size
+
|}
:This sets the [[NPC Naming Convention|type and size]] of the NPC ship. Please use one of the following values:
+
Note: #222222 is used for the background color of the NPCTable headers. But because the background color of the documentation section of a template is also #222222 it can not be seen on a template page.
:* Drone
 
:* Fighter
 
:* Frigate
 
:* Commander Frigate
 
:* Elite Frigate
 
:* Overseer Frigate
 
:* Destroyer
 
:* Commander Destroyer
 
:* Cruiser
 
:* Elite Cruiser
 
:* Commander Cruiser
 
:* Storyline Mission Cruiser
 
:* Overseer Cruiser
 
:* Battlecruiser
 
:* Elite Battlecruiser
 
:* Overseer Battlecruiser
 
:* Commander Battlecruiser
 
:* Battleship
 
:* Elite Battleship
 
:* Commander Battleship
 
:* Overseer Battleship
 
:* Capital
 
:* Industrial
 
:* Sentry
 
:* Carrier
 
:* Supercapital
 
 
 
;Ship count
 
:The number of that class of NPC ship. Often this is variable, so feel free to use number ranges (e.g. <code>10-12</code>) if necessary.
 
 
 
;Ship names
 
:The name(s) of the NPCs. It's recommended to consolidate ships of the same class into a single line (e.g. <code>Coreli Patroller/Watchman</code>). If there are a large number of different ship types, list the most common three or four types (e.g. <code>Corelum Chief Defender/Guard/Protector/...</code>).
 
 
 
;point
 
:If the NPC has a warp disruptor or warp scrambler, set the <code>point=yes</code> parameter (otherwise omit it).
 
 
 
;ewar
 
:If the NPC uses [[EWAR Guide|electronic warfare]], describe it here. Use the <code>{{t|icon}}</code> template; use the mouseover text to describe the EWAR type, and (if available) additional details (e.g. maximum range of the EWAR). If NPCs use multiple types of EWAR, add them all. Some examples:
 
:*ECM: <code><nowiki>{{icon|ecm|24|Jamming}}</nowiki></code> {{icon|ecm|24|Jamming}}
 
:*Tracking disruption: <code><nowiki>{{icon|td|24|Tracking disruption}}</nowiki></code> {{icon|td|24|Tracking disruption}}
 
:*Sensor dampening: <code><nowiki>{{icon|damp|24|Sensor dampening (to 60 km)}}</nowiki></code> {{icon|damp|24|Sensor dampening (to 60 km)}}
 
:*Target painting: <code><nowiki>{{icon|tp|24|Target painting}}</nowiki></code> {{icon|tp|24|Target painting}}
 
:*Stasis webifier: <code><nowiki>{{icon|web|24|Stasis webifier}}</nowiki></code> {{icon|web|24|Stasis webifier}}
 
:*Energy neutralization ("neut"): <code><nowiki>{{icon|neut|24|Neuting}}</nowiki></code> {{icon|neut|24|Neuting}}
 
If no additional information about ewar is needed more simple <code><nowiki>ewar = </nowiki></code> is enough. If a ship uses multiple ewar types you can specify second ewar type with <code><nowiki>ewar2 = </nowiki></code>
 
  
Examples:
 
:*ECM: <code><nowiki>ewar = ECM</nowiki></code> {{icon|ecm|24|Jamming}}
 
:*Tracking disruption: <code><nowiki>ewar = TD</nowiki></code> {{icon|td|24|Tracking disruption}}
 
:*Sensor dampening: <code><nowiki>ewar = Damp</nowiki></code> {{icon|damp|24|Sensor dampening}}
 
:*Target painting: <code><nowiki>ewar = TP</nowiki></code> {{icon|tp|24|Target painting}}
 
:*Stasis webifier: <code><nowiki>ewar = Web</nowiki></code> {{icon|web|24|Stasis webifier}}
 
:*Energy neutralization ("neut"): <code><nowiki>ewar = Neut</nowiki></code> {{icon|neut|24|Neuting}}
 
;cargo
 
:If the NPC drops notable loot (e.g. faction modules, tech 2 salvage), note it here.
 
;trigger
 
:If destroying the NPC causes something to happen (unlock acceleration gate, trigger a new wave of enemies, etc), then use this parameter.
 
;note
 
:Use this parameter to add a footnote, which you can use to describe important information about the NPC (for instance, for very high dps NPCs, or high self-repair...).
 
  
=== NPCTableSeparator parameters ===
+
; See also
<code>{{t|NPCTableSeparator|Separator title}}</code>
+
* [[UniWiki:Mission formatting guidelines|Mission formatting guidelines]]
 
 
;Separator title
 
:This is the title which describes next NPC group when you don't want to create additional table e.g. <code>After 50% armor</code>, <code>On Commander aggression</code>, <code>Group near gate</code> etc.
 
 
 
== Sample output ==
 
<code><nowiki>{{NPCTableCSS}}</nowiki><br>
 
<nowiki>{{NPCTableHead|Wave #34}}</nowiki><br>
 
<nowiki>{{NPCTableRow|Frigate|100|Coreli Agent|point=yes|ewar=Damp|ewar2=Web|cargo=Drops Gist X-Type 100MN Microwarpdrive}}</nowiki><br>
 
<nowiki>{{NPCTableSeparator|After 25% on target structure}}</nowiki><br>
 
<nowiki>{{NPCTableRow|Battleship|100|Centum Loyal Fiend|ewar=Neut||trigger = Escalation trigger}}</nowiki><br>
 
<nowiki>|}</nowiki></code>
 
:gives...
 
{{NPCTableCSS}}
 
{{NPCTableHead|Wave #34}}
 
{{NPCTableRow|Frigate|100|Coreli Agent|point=yes|ewar=Damp|ewar2=Web|cargo=Drops Gist X-Type 100MN Microwarpdrive}}
 
{{NPCTableSeparator|After 25% on target structure}}
 
{{NPCTableRow|Battleship|100|Centum Loyal Fiend|ewar=Neut|trigger = Escalation trigger}}
 
|}
 
  
<includeonly>[[Category:Template|{{PAGENAME}}]]<!-- Any categories for the template itself --></includeonly>
+
<includeonly>[[Category:Formatting templates]]<!-- Any categories for the template itself --></includeonly>
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 20:01, 6 June 2023

Description
This template is used to start an NPCTable. It needs to be paired with the standard wiki parser code to end the table |}. It needs to be used once for every NPCTable on a page.
Dependencies
Requires
{{NPCTableCSS}} is required only once per page where there's at least one NPCTable. It is included into {{CMBSiteInfo}} and {{CMBSite}}(deprecated), so when one of those is used there is no need to add it separately.
Paired with
|} to close the table, or include |end=true}} as the last parameter of the last {{NPCTableRow}}.
Sub templates
{{NPCTableRow}} one or more for each NPCTable.
{{NPCTableSeparator}} zero or more for each NPCTable.
Syntax
{{NPCTableHead|<caption>}}
Parameters
caption 
Caption of the table. May be omitted.
Sample
{{NPCTableHead|Initial defenders}}
|}
gives...
Initial defenders
WD EWAR L


Note: #222222 is used for the background color of the NPCTable headers. But because the background color of the documentation section of a template is also #222222 it can not be seen on a template page.


See also