Difference between revisions of "Template:NPCTableHead/doc"

From EVE University Wiki
Jump to: navigation, search
(Remove template:icon)
m (Rewrite doc to be template specific.)
Tag: Replaced
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|CMBSiteInfo}} 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|CMBSiteInfo}} 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|point=yes|5=ewar=Ewar|6=cargo=Loot|7=drop=drop|8=trigger=Trigger|9=note=Notes}}<br>
+
:; Paired with
−
{{t|NPCTableSeparator|Separator title}}<br>
+
:: <nowiki>|}</nowiki> to close the table.
−
{{t|NPCTableRow|Ship size|Ship count|Ship names|point=yes|5=ewar=Ewar|6=cargo=Loot|7=drop=drop|8=trigger=Trigger|9=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
−
==== Ships ====
+
{{NPCTableCSS}}
−
 
+
: <code><nowiki>{{NPCTableHead|Initial defenders}}</nowiki></code>
−
<code>{{t|NPCTableRow|Ship size|Ship count|Ship names|point=yes|5=ewar=Ewar|6=cargo=Loot|7=drop=drop|8=trigger=Trigger|9=note=Notes}}</code>
 
−
 
 
−
;Ship size
 
−
:This sets the [[NPC Naming Convention|type and size]] of the NPC ship. Please use one of the following values:
 
−
:* Barge [[image:icon_red_mining_barge.png|16px|link=|Barge]]
 
−
:* Industrial [[image:icon_red_industrial.png|16px|link=|Industrial]]
 
−
:* Freighter [[image:icon_red_industrial_capital.png|16px|link=|Freighter]]
 
−
:* Drone [[image:icon_red_drone.png|16px|link=|Drone]]
 
−
:* Fighter [[image:icon_red_fighter.png|16px|link=|Fighter]]
 
−
:* Frigate [[image:icon_red_frigate.png|16px|link=|Frigate]]
 
−
:* Commander Frigate [[image:icon_red_frigate.png|16px|link=|Commander Frigate]]
 
−
:* Elite Frigate [[image:icon_red_frigate.png|16px|link=|Commander Frigate]]
 
−
:* Overseer Frigate [[image:icon_red_frigate.png|16px|link=|Commander Frigate]]
 
−
:* Destroyer [[image:icon_red_destroyer.png|16px|link=|Destroyer]]
 
−
:* Commander Destroyer [[image:icon_red_destroyer.png|16px|link=|Destroyer]]
 
−
:* Cruiser [[image:icon_red_cruiser.png|16px|link=|Cruiser]]
 
−
:* Elite Cruiser [[image:icon_red_cruiser.png|16px|link=|Cruiser]]
 
−
:* Commander Cruiser [[image:icon_red_cruiser.png|16px|link=|Cruiser]]
 
−
:* Storyline Mission Cruiser [[image:icon_red_cruiser.png|16px|link=|Storyline Mission Cruiser]]
 
−
:* Overseer Cruiser [[image:icon_red_cruiser.png|16px|link=|Cruiser]]
 
−
:* Battlecruiser [[image:icon_red_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Elite Battlecruiser [[image:icon_red_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Overseer Battlecruiser [[image:icon_red_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Commander Battlecruiser [[image:icon_red_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Battleship [[image:icon_red_battleship.png|16px|link=|Battleship]]
 
−
:* Elite Battleship [[image:icon_red_battleship.png|16px|link=|Battleship]]
 
−
:* Commander Battleship [[image:icon_red_battleship.png|16px|link=|Battleship]]
 
−
:* Overseer Battleship [[image:icon_red_battleship.png|16px|link=|Battleship]]
 
−
:* Carrier [[image:icon_red_carrier.png|16px|link=|Carrier]]
 
−
:* Superarrier [[image:icon_red_supercarrier.png|16px|link=|Supercarrier]]
 
−
:* Dreadnought [[image:icon_red_dreadnought.png|16px|link=|Dreadnought]]
 
−
:* Titan [[image:icon_red_titan.png|16px|link=|Titan]]
 
−
:* Sentry [[image:icon_red_tower.png|16px|link=|Sentry]]
 
−
 
 
−
Neutral ships can also be added:
 
−
 
 
−
:* Neutral Barge [[image:icon_white_mining_barge.png|16px|link=|Barge]]
 
−
:* Neutral Industrial [[image:icon_white_industrial.png|16px|link=|Industrial]]
 
−
:* Neutral Freighter [[image:icon_white_industrial_capital.png|16px|link=|Freighter]]
 
−
:* Neutral Drone [[image:icon_bracket_drone.png|16px|link=|Drone]]
 
−
:* Neutral Fighter [[image:icon_bracket_fighter.png|16px|link=|Fighter]]
 
−
:* Neutral Frigate [[image:icon_white_frigate.png|16px|link=|Frigate]]
 
−
:* Neutral Commander Frigate [[image:icon_white_frigate.png|16px|link=|Commander Frigate]]
 
−
:* Neutral Elite Frigate [[image:icon_white_frigate.png|16px|link=|Commander Frigate]]
 
−
:* Neutral Overseer Frigate [[image:icon_white_frigate.png|16px|link=|Commander Frigate]]
 
−
:* Neutral Destroyer [[image:icon_white_destroyer.png|16px|link=|Destroyer]]
 
−
:* Neutral Commander Destroyer [[image:icon_white_destroyer.png|16px|link=|Destroyer]]
 
−
:* Neutral Cruiser [[image:icon_white_cruiser.png|16px|link=|Cruiser]]
 
−
:* Neutral Elite Cruiser [[image:icon_white_cruiser.png|16px|link=|Cruiser]]
 
−
:* Neutral Commander Cruiser [[image:icon_white_cruiser.png|16px|link=|Cruiser]]
 
−
:* Neutral Storyline Mission Cruiser [[image:icon_white_cruiser.png|16px|link=|Storyline Mission Cruiser]]
 
−
:* Neutral Overseer Cruiser [[image:icon_white_cruiser.png|16px|link=|Cruiser]]
 
−
:* Neutral Battlecruiser [[image:icon_white_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Neutral Elite Battlecruiser [[image:icon_white_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Neutral Overseer Battlecruiser [[image:icon_white_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Neutral Commander Battlecruiser [[image:icon_white_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Neutral Battleship [[image:icon_white_battleship.png|16px|link=|Battleship]]
 
−
:* Neutral Elite Battleship [[image:icon_white_battleship.png|16px|link=|Battleship]]
 
−
:* Neutral Commander Battleship [[image:icon_white_battleship.png|16px|link=|Battleship]]
 
−
:* Neutral Overseer Battleship [[image:icon_white_battleship.png|16px|link=|Battleship]]
 
−
:* Neutral Carrier [[image:icon_white_carrier.png|16px|link=|Carrier]]
 
−
:* Neutral Superarrier [[image:icon_white_supercarrier.png|16px|link=|Supercarrier]]
 
−
:* Neutral Dreadnought [[image:icon_white_dreadnought.png|16px|link=|Dreadnought]]
 
−
:* Neutral Titan [[image:icon_white_titan.png|16px|link=|Titan]]
 
−
:* Neutral Sentry [[image:icon_bracket_tower.png|16px|link=|Sentry]]
 
−
 
 
−
Friendly ships can also be added:
 
−
 
 
−
:* Friendly Barge [[image:icon_blue_mining_barge.png|16px|link=|Barge]]
 
−
:* Friendly Industrial [[image:icon_blue_industrial.png|16px|link=|Industrial]]
 
−
:* Friendly Freighter [[image:icon_blue_industrial_capital.png|16px|link=|Freighter]]
 
−
:* Friendly Drone [[image:icon_blue_drone.png|16px|link=|Drone]]
 
−
:* Friendly Fighter [[image:icon_blue_fighter.png|16px|link=|Fighter]]
 
−
:* Friendly Frigate [[image:icon_blue_frigate.png|16px|link=|Frigate]]
 
−
:* Friendly Commander Frigate [[image:icon_blue_frigate.png|16px|link=|Commander Frigate]]
 
−
:* Friendly Elite Frigate [[image:icon_blue_frigate.png|16px|link=|Commander Frigate]]
 
−
:* Friendly Overseer Frigate [[image:icon_blue_frigate.png|16px|link=|Commander Frigate]]
 
−
:* Friendly Destroyer [[image:icon_blue_destroyer.png|16px|link=|Destroyer]]
 
−
:* Friendly Commander Destroyer [[image:icon_blue_destroyer.png|16px|link=|Destroyer]]
 
−
:* Friendly Cruiser [[image:icon_blue_cruiser.png|16px|link=|Cruiser]]
 
−
:* Friendly Elite Cruiser [[image:icon_blue_cruiser.png|16px|link=|Cruiser]]
 
−
:* Friendly Commander Cruiser [[image:icon_blue_cruiser.png|16px|link=|Cruiser]]
 
−
:* Friendly Storyline Mission Cruiser [[image:icon_blue_cruiser.png|16px|link=|Storyline Mission Cruiser]]
 
−
:* Friendly Overseer Cruiser [[image:icon_blue_cruiser.png|16px|link=|Cruiser]]
 
−
:* Friendly Battlecruiser [[image:icon_blue_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Friendly Elite Battlecruiser [[image:icon_blue_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Friendly Overseer Battlecruiser [[image:icon_blue_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Friendly Commander Battlecruiser [[image:icon_blue_battlecruiser.png|16px|link=|Battlecruiser]]
 
−
:* Friendly Battleship [[image:icon_blue_battleship.png|16px|link=|Battleship]]
 
−
:* Friendly Elite Battleship [[image:icon_blue_battleship.png|16px|link=|Battleship]]
 
−
:* Friendly Commander Battleship [[image:icon_blue_battleship.png|16px|link=|Battleship]]
 
−
:* Friendly Overseer Battleship [[image:icon_blue_battleship.png|16px|link=|Battleship]]
 
−
:* Friendly Carrier [[image:icon_blue_carrier.png|16px|link=|Carrier]]
 
−
:* Friendly Superarrier [[image:icon_blue_supercarrier.png|16px|link=|Supercarrier]]
 
−
:* Friendly Dreadnought [[image:icon_blue_dreadnought.png|16px|link=|Dreadnought]]
 
−
:* Friendly Titan [[image:icon_blue_titan.png|16px|link=|Titan]]
 
−
:* Friendly Sentry [[image:icon_blue_tower.png|16px|link=|Sentry]]
 
−
 
 
−
;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). If the NPC uses warp scrambler (shuts off MWD and stops MJD) you can specify <code>point=scram</code>.
 
−
 
 
−
;ewar
 
−
:If the NPC uses [[EWAR Guide|electronic warfare]], describe it here.
 
−
 
 
−
For rats that use multiple types of EWAR use ewar= |ewar2= |ewar3= |
 
−
 
 
−
Examples:
 
−
:*ECM: <code><nowiki>ewar = ECM</nowiki></code> [[image:icon_remote_ecm_burst_i.png|24px|link=|Jamming]]
 
−
:*Tracking disruption: <code><nowiki>ewar = TD</nowiki></code> [[image:icon_track_disruptor_64.png|24px|link=|Tracking disruption]]
 
−
:*Guidance disruption: <code><nowiki>ewar = GD</nowiki></code> [[image:icon_missile_guidance_computer_i.png|24px|link=|Guidance disruption]]
 
−
:*Sensor dampening: <code><nowiki>ewar = Damp</nowiki></code> [[image:icon_remote_sensor_dampening.png|24px|link=|Sensor dampening]]
 
−
:*Target painting: <code><nowiki>ewar = TP</nowiki></code> [[image:icon_target_painter_i.png|24px|link=|Target painting]]
 
−
:*Stasis webifier: <code><nowiki>ewar = Web</nowiki></code> [[image:icon_stasis_webifier_i.png|24px|link=|Stasis webifier]]
 
−
:*Energy neutralization ("neut"): <code><nowiki>ewar = Neut</nowiki></code> [[image:icon_energy_neutralizer_i.png|24px|link=|Neuting]]
 
−
 
 
−
;cargo and drop
 
−
: If something noteworthy drops it should be marked as cargo (shiny) or drop (not shiny).
 
−
 
 
−
;note
 
−
:If there is something else noteworthy about this ship then it can be added in this note.
 
−
 
 
−
;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...).
 
−
 
 
−
==== Structures ====
 
−
 
 
−
Notable structures can also be added to the table. The following values can be used:
 
−
 
 
−
:*Acceleration Gate [[image:icon bracket accelerationgate.png|16px|link=|Acceleration Gate]]
 
−
:*Station [[image:Icon_bracket_station.png|16px|link=|Station]]
 
−
:*Structure [[image:Icon_bracket_structure.png|16px|link=|Structure]]
 
−
:*Wormhole [[image:Icon_bracket_wormhole.png|16px|link=|Wormhole]]
 
−
:*Stargate [[image:Icon_bracket_stargate.png|16px|link=|Stargate]]
 
−
:*Tower [[image:Icon_bracket_tower.png|16px|link=|Tower]]
 
−
:*Asteroid [[image:Icon_bracket_asteroid.png|16px|link=|Asteroid]]
 
−
:*Asteroid Field [[image:Icon_bracket_asteroidfield.png|16px|link=|Asteroid Field]]
 
−
:*Container [[image:Icon_bracket_container.png|16px|link=|Container]]
 
−
:*Red Container [[image:Icon_bracket_container_red.png|16px|link=|Container]]
 
−
:*Beacon [[image:Icon_bracket_beacon.png|16px|link=|Beacon]]
 
−
:*Billboard [[image:Icon_bracket_billboard.png|16px|link=|Billboard]]
 
−
:*Force Field [[image:Icon_bracket_forcefield.png|16px|link=|Force Field]]
 
−
:*Gas Cloud [[image:Gas_cloud.png|16px|link=|Gas Cloud]]
 
−
:*Hackable [[image:Icon_bracket_hackable.png|16px|link=|Hackable Structure]]
 
−
:*Agent [[image:Icon_bracket_agent.png|16px|link=|Agent in space]]
 
−
:*Hangar Array [[File:Icon_PersonalHangarArray.png]]
 
−
 
 
−
In addition to the ship parameters noted above, structure entries can also use all the same parameters as ships.
 
−
 
 
−
=== NPCTableSeparator parameters ===
 
−
<code>{{t|NPCTableSeparator|Separator title}}</code>
 
  
−
;Separator title
+
: <code><nowiki>|}</nowiki></code>
−
: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.  
+
:: gives...
 +
{{NPCTableHead|Initial defenders}}
  
−
== Sample output ==
 
−
<code><nowiki>{{NPCTableCSS}}</nowiki><br><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}}
 
 
|}
 
|}
 +
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.
  
  
−
<code><nowiki>{{NPCTableCSS}}</nowiki><br><br>
+
; See also
−
<nowiki>{{NPCTableHead|Structures}}</nowiki><br>
+
* [[UniWiki:Mission formatting guidelines|Mission formatting guidelines]]
−
<nowiki>{{NPCTableRow|Acceleration Gate|1|Acceleration Gate|trigger = 5 km proximity trigger for the gate wave|note = Locked until all ships are destroyed}}</nowiki><br>
 
−
<nowiki>{{NPCTableRow|Station|1|Serpentis Stronghold|cargo=Drops Shadow Serpentis modules}}</nowiki><br>
 
−
<nowiki>{{NPCTableRow|Container|3|Supply Cache|drop=T1 ammo}}</nowiki><br>
 
−
<nowiki>{{NPCTableRow|Red Container|1|Sealed Container|cargo=24th Overseer Special Effect and sometimes a Nestor BPC}}</nowiki><br>
 
−
<nowiki>|}</nowiki></code>
 
−
:gives...
 
−
{{NPCTableHead|Structures}}
 
−
{{NPCTableRow|Acceleration Gate|1|Acceleration Gate|trigger = 5 km proximity trigger for the gate wave|note = Locked until all ships are destroyed}}
 
−
{{NPCTableRow|Station|1|Serpentis Stronghold|cargo=Drops Shadow Serpentis modules}}
 
−
{{NPCTableRow|Container|3|Supply Cache|drop=T1 ammo}}
 
−
{{NPCTableRow|Red Container|1|Sealed Container|cargo=24th Overseer Special Effect}}
 
−
|}
 
−
 
 
  
−
<includeonly>[[Category:Formatting templates|{{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>

Revision as of 09:12, 4 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.
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
Retrieved from "https://wiki.eveuniversity.org/index.php?title=Template:NPCTableHead/doc&oldid=204397"