Difference between revisions of "Template:NPCTableRow/doc"

From EVE University Wiki
Jump to: navigation, search
(Add documentation for "note")
m (Fix duplicate arguments in template call.)
 
(22 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
This template is used to create NPC table rows for the pages describing combat sites.
+
; Description
−
== Dependencies ==
+
: This template is used to create a content row in NPCTable.
−
* Uses {{t|NPCTableHead}} to generate table head.
 
−
* Uses {{t|Complex}} to acquire proper CSS.
 
−
== Syntax ==
 
−
<code>{{t|Complex|Name of the complex}}<br>
 
−
{{t|NPCTableHead}}<br>
 
−
{{t|NPCTableRow|Ship size|Ship count|Ship names|4=point=yes|5=ewar=EWar|6=cargo=Loot|7=trigger=Trigger}}<br>
 
−
|}</code>
 
−
=== Parameters ===
 
−
;Ship size
 
−
:This sets the [[NPC Naming Convention|type and size]] of the NPC ship. Please use one of the following values:
 
−
:* Frigate
 
−
:* Commander Frigate
 
−
:* Elite Frigate
 
−
:* Overseer Frigate
 
−
:* Destroyer
 
−
:* Cruiser
 
−
:* Commander Cruiser
 
−
:* Overseer Cruiser
 
−
:* Battlecruiser
 
−
:* Battleship
 
−
:* Overseer Battleship
 
−
:* Sentry
 
  
−
;Ship count
+
; Dependencies:
−
: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.  
+
:; Requires
 +
:: {{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|NPCTableHead}}
  
−
;Ship names
+
; Syntax
−
: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>).  
+
: {{T|NPCTableRow|type|count|name|5=point= point|6=ewar= ewar|7=ewar2= ewar|8=ewar3= ewar|9=drop= drop|10=cargo= cargo|11=trigger= trigger|12=note= notes|end= end}}
 +
:; Parameters
 +
:: type, count and name are anonymous (positional) parameters and must be ordered as written.
 +
::; type : sets the [[NPC naming conventions|type and size]] of an NPC ship or structure. It is displayed as the ships bracket icon and type. A prefix can be added to control the brackets color. See the tables for valid options.
 +
{| class= "wikitable collapsible collapsed" style="margin-left: 4em; text-align: center;"
 +
|+ Ships
 +
|-
 +
! rowspan= 2 style="min-width: 12em;" | Name || colspan= 3 | Prefix
 +
|-
 +
| ''none'' || Neutral || Friendly
 +
|-
 +
| style="text-align: left;" | Barge || [[image:icon_red_mining_barge.png|16px|link=|Barge]] || [[image:icon_white_mining_barge.png|16px|link=|Barge]] || [[image:icon_blue_mining_barge.png|16px|link=|Barge]]
 +
|-
 +
| style="text-align: left;" | Hauler || [[image:icon_red_industrial.png|16px|link=|Hauler]] ||[[image:icon_white_industrial.png|16px|link=|Hauler]] || [[image:icon_blue_industrial.png|16px|link=|Industrial]]
 +
|-
 +
| style="text-align: left;" | Freighter || [[image:icon_red_industrial_capital.png|16px|link=|Freighter]] || [[image:icon_white_industrial_capital.png|16px|link=|Freighter]] || [[image:icon_blue_industrial_capital.png|16px|link=|Freighter]]
 +
|-
 +
| style="text-align: left;" | Drone || [[image:icon_red_drone.png|16px|link=|Drone]] || [[image:icon_bracket_drone.png|16px|link=|Drone]] || [[image:icon_blue_drone.png|16px|link=|Drone]]
 +
|-
 +
| style="text-align: left;" | Fighter || [[image:icon_red_fighter.png|16px|link=|Fighter]]|| [[image:icon_bracket_fighter.png|16px|link=|Fighter]]|| [[image:icon_blue_fighter.png|16px|link=|Fighter]]
 +
|-
 +
| style="text-align: left;" | Frigate || [[image:icon_red_frigate.png|16px|link=|Frigate]]|| [[image:icon_white_frigate.png|16px|link=|Frigate]]|| [[image:icon_blue_frigate.png|16px|link=|Frigate]]
 +
|-
 +
| style="text-align: left;" | Elite Frigate || [[image:icon_red_frigate.png|16px|link=|Elite Frigate]] || [[image:icon_white_frigate.png|16px|link=|Elite Frigate]] || [[image:icon_blue_frigate.png|16px|link=|Commander Frigate]]
 +
|-
 +
| style="text-align: left;" | Commander Frigate || [[image:icon_red_frigate.png|16px|link=|Commander Frigate]] || [[image:icon_white_frigate.png|16px|link=|Commander Frigate]] || [[image:icon_blue_frigate.png|16px|link=|Commander Frigate]]
 +
|-
 +
| style="text-align: left;" | Overseer Frigate || [[image:icon_red_frigate.png|16px|link=|Overseer Frigate]] || [[image:icon_white_frigate.png|16px|link=|Overseer Frigate]] || [[image:icon_blue_frigate.png|16px|link=|Overseer Frigate]]
 +
|-
 +
| style="text-align: left;" | Destroyer || [[image:icon_red_destroyer.png|16px|link=|Destroyer]] || [[image:icon_white_destroyer.png|16px|link=|Destroyer]] || [[image:icon_blue_destroyer.png|16px|link=|Destroyer]]
 +
|-
 +
| style="text-align: left;" | Commander Destroyer || [[image:icon_red_destroyer.png|16px|link=|Commander Destroyer]] || [[image:icon_white_destroyer.png|16px|link=|Commander Destroyer]] || [[image:icon_blue_destroyer.png|16px|link=|Commander Destroyer]]
 +
|-
 +
| style="text-align: left;" | Cruiser || [[image:icon_red_cruiser.png|16px|link=|Cruiser]] || [[image:icon_white_cruiser.png|16px|link=|Cruiser]] || [[image:icon_blue_cruiser.png|16px|link=|Cruiser]]
 +
|-
 +
| style="text-align: left;" | Elite Cruiser || [[image:icon_red_cruiser.png|16px|link=|Elite Cruiser]] || [[image:icon_white_cruiser.png|16px|link=|Elite Cruiser]] || [[image:icon_blue_cruiser.png|16px|link=|Elite Cruiser]]
 +
|-
 +
| style="text-align: left;" | Commander Cruiser || [[image:icon_red_cruiser.png|16px|link=|Commander Cruiser]] || [[image:icon_white_cruiser.png|16px|link=|Commander Cruiser]] || [[image:icon_blue_cruiser.png|16px|link=|Commander Cruiser]]
 +
|-
 +
| style="text-align: left;" | Overseer Cruiser || [[image:icon_red_cruiser.png|16px|link=|Overseer Cruiser]] || [[image:icon_white_cruiser.png|16px|link=|Overseer Cruiser]] || [[image:icon_blue_cruiser.png|16px|link=|Overseer Cruiser]]
 +
|-
 +
| style="text-align: left;" | Battlecruiser || [[image:icon_red_battlecruiser.png|16px|link=|Battlecruiser]] || [[image:icon_white_battlecruiser.png|16px|link=|Battlecruiser]] || [[image:icon_blue_battlecruiser.png|16px|link=|Battlecruiser]]
 +
|-
 +
| style="text-align: left;" | Elite Battlecruiser || [[image:icon_red_battlecruiser.png|16px|link=|Elite Battlecruiser]] || [[image:icon_white_battlecruiser.png|16px|link=|Elite Battlecruiser]] || [[image:icon_blue_battlecruiser.png|16px|link=Elite Battlecruiser]]
 +
|-
 +
| style="text-align: left;" | Commander Battlecruiser || [[image:icon_red_battlecruiser.png|16px|link=|Commander Battlecruiser]] || [[image:icon_white_battlecruiser.png|16px|link=|Commander Battlecruiser]] || [[image:icon_blue_battlecruiser.png|16px|link=|Commander Battlecruiser]]
 +
|-
 +
| style="text-align: left;" | Battleship || [[image:icon_red_battleship.png|16px|link=|Overseer Battleship]] || [[image:icon_white_battleship.png|16px|link=|Overseer Battleship]] || [[image:icon_blue_battleship.png|16px|link=|Overseer Battleship]]
 +
|-
 +
| style="text-align: left;" | Elite Battleship || [[image:icon_red_battleship.png|16px|link=|Overseer Battleship]] || [[image:icon_white_battleship.png|16px|link=|Overseer Battleship]] || [[image:icon_blue_battleship.png|16px|link=|Overseer Battleship]]
 +
|-
 +
| style="text-align: left;" | Overseer Battleship || [[image:icon_red_battleship.png|16px|link=|Overseer Battleship]] || [[image:icon_white_battleship.png|16px|link=|Overseer Battleship]] || [[image:icon_blue_battleship.png|16px|link=|Overseer Battleship]]
 +
|-
 +
| style="text-align: left;" | Carrier || [[image:icon_red_carrier.png|16px|link=|Carrier]] || [[image:icon_white_carrier.png|16px|link=|Carrier]] || [[image:icon_blue_carrier.png|16px|link=|Carrier]]
 +
|-
 +
| style="text-align: left;" | Supercarrier || [[image:icon_red_supercarrier.png|16px|link=|Supercarrier]] || [[image:icon_white_supercarrier.png|16px|link=|Supercarrier]] || [[image:icon_blue_supercarrier.png|16px|link=|Supercarrier]]
 +
|-
 +
| style="text-align: left;" | Dreadnought || [[image:icon_red_dreadnought.png|16px|link=|Dreadnought]] || [[image:icon_white_dreadnought.png|16px|link=|Dreadnought]] || [[image:icon_blue_dreadnought.png|16px|link=|Dreadnought]]
 +
|-
 +
| style="text-align: left;" | Titan || [[image:icon_red_titan.png|16px|link=|Titan]] || [[image:icon_white_titan.png|16px|link=|Titan]] || [[image:icon_blue_titan.png|16px|link=|Titan]]
 +
|-
 +
| style="text-align: left;" | Sentry || [[image:icon_red_tower.png|16px|link=|Sentry]] || [[image:icon_bracket_tower.png|16px|link=|Sentry]] || [[image:icon_blue_tower.png|16px|link=|Sentry]]
 +
|}
 +
{| class="wikitable collapsible collapsed" style="margin-left: 4em;"
 +
|+ Structures
 +
|-
 +
! style="min-width: 12em;" | Code !! Icon
 +
|-
 +
| Acceleration Gate || [[image:icon bracket accelerationgate.png|16px|link=|Acceleration Gate]]
 +
|-
 +
| Agent || [[image:Icon_bracket_agent.png|16px|link=|Agent in space]]
 +
|-
 +
| Asteroid || [[image:Icon_bracket_asteroid.png|16px|link=|Asteroid]]
 +
|-
 +
| Asteroid Field || [[image:Icon_bracket_asteroidfield.png|16px|link=|Asteroid Field]]
 +
|-
 +
| Beacon || [[image:Icon_bracket_beacon.png|16px|link=|Beacon]]
 +
|-
 +
| Billboard || [[image:Icon_bracket_billboard.png|16px|link=|Billboard]]
 +
|-
 +
| Container || [[image:Icon_bracket_container.png|16px|link=|Container]]
 +
|-
 +
| Red Container || [[image:Icon_bracket_container_red.png|16px|link=|Container]]
 +
|-
 +
| 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]]
 +
|-
 +
| Hangar Array || [[File:Icon_PersonalHangarArray.png]]
 +
|-
 +
| Station || [[image:Icon_bracket_station.png|16px|link=|Station]]
 +
|-
 +
| Stargate || [[image:Icon_bracket_stargate.png|16px|link=|Stargate]]
 +
|-
 +
| Structure || [[image:Icon_bracket_structure.png|16px|link=|Structure]]
 +
|-
 +
| Tower || [[image:Icon_bracket_tower.png|16px|link=|Tower]]
 +
|-
 +
| Wormhole || [[image:Icon_bracket_wormhole.png|16px|link=|Wormhole]]
 +
|}
  
−
;point
+
:; count : The number of NPCs of that type. This is often a range, so feel free to use number ranges (e.g. <code>10-12</code>).
−
:If the NPC has a warp disruptor or warp scrambler, set the <code>point=yes</code> parameter (otherwise omit it).  
+
:; name : The NPC's name. Consolidate ships of the same type into a single line (e.g. <code>Coreli Watchman/Patroller</code>). If there are a large number of different ship types, list the most common three or four types followed by an ellipsis (e.g. <code>Corelum Chief Guard/Defender/Protector/...</code>). It is however perfectly fine to use a separate row to make it clear which ship type is using EWAR or triggers an action.
 +
:; point : If an NPC has a [[Warp Disruptor]], set to <code>point= yes</code> or <code>point= point</code>. If an NPC uses a [[Warp Scrambler]] (shuts off [[MWD]] and stops [[MJD]]) you can specify <code>point= scram</code>.
 +
:; ewar
 +
:; ewar2
 +
:; ewar3 : Type of [[electronic warfare]] used by an NPC. Displayed as an icon
 +
{| class="wikitable" style="margin-left: 4em;"
 +
|+ EWAR codes
 +
|-
 +
! Type !! Code !! Icon
 +
|-
 +
| ECM/Jamming || ECM || [[image:icon_remote_ecm_burst_i.png|24px|link=|Jamming]]
 +
|-
 +
| Tracking disruption || TD || [[image:icon_track_disruptor_64.png|24px|link=|Tracking disruption]]
 +
|-
 +
| Guidance disruption || GD || [[image:icon_missile_guidance_computer_i.png|24px|link=|Guidance disruption]]
 +
|-
 +
| Sensor dampening || Damp || [[image:icon_remote_sensor_dampening.png|24px|link=|Sensor dampening]]
 +
|-
 +
| Target painting || TP || [[image:icon_target_painter_i.png|24px|link=|Target painting]]
 +
|-
 +
| Stasis webifier || Web || [[image:icon_stasis_webifier_i.png|24px|link=|Stasis webifier]]
 +
|-
 +
| Energy neutralization ("neut") || Neut ||[[image:icon_energy_neutralizer_i.png|24px|link=|Neuting]]
 +
|}
 +
:; drop : If an NPC leaves behind notable loot (e.g. T1 ammo, a trade good), note it here. A dull icon [[File:Icon container small.png|24px]] will be created.
 +
:; cargo : If an NPC leaves behind valuable loot (worth over 1M ISK e.g. faction modules, tech 2 salvage), note it here. A shiny icon [[File:Icon container small green.png|24px]] will be created.
 +
:; trigger : If destroying an NPC causes an action (acceleration gates get unlocked, a new wave of enemies spawn, etc), use this parameter.
 +
:; note : Use to describe important information about an NPC (for instance, an NPC deals extremely high damage, is able to self-repair themselves quickly, ...).
 +
<!--:; end : Use to include the table closing tags after this row. Any parameter value will add the table closing tag. Only use it on the last row of a table.-->
  
−
;ewar
+
; Sample
−
: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:
+
{{NPCTableCSS}}
−
:*ECM: <code><nowiki>{{icon|ecm|24|Jamming}}</nowiki></code> {{icon|ecm|24|Jamming}}
+
: <code><nowiki>{{NPCTableHead|Initial defenders}}</nowiki></code>
−
:*Tracking disruption: <code><nowiki>{{icon|td|24|Tracking disruption}}</nowiki></code> {{icon|td|24|Tracking disruption}}
+
: <code><nowiki>{{NPCTableRow|Friendly Barge|1|Digger|drop= lots of stuff}}</nowiki></code>
−
:*Sensor dampening: <code><nowiki>{{icon|damp|24|Sensor dampening (to 60 km)}}</nowiki></code> {{icon|damp|24|Sensor dampening (to 60 km)}}
+
: <code><nowiki>{{NPCTableRow|Cruiser|1|Warship|point= yes|eawr= Web|ewar2= TD|note= Important info|trigger= Mission complete|cargo= Expensive stuff}}</nowiki></code>
−
:*Target painting: <code><nowiki>{{icon|tp|24|Target painting}}</nowiki></code> {{icon|tp|24|Target painting}}
+
: <code><nowiki>|}</nowiki></code>
−
:*Stasis webifier: <code><nowiki>{{icon|web|24|Stasis webifier}}</nowiki></code> {{icon|web|24|Stasis webifier}}
+
:: gives...
−
:*Energy neutralization ("neut"): <code><nowiki>{{icon|neut|24|Neuting}}</nowiki></code> {{icon|neut|24|Neuting}}
+
{{NPCTableHead|Initial defenders}}
−
;cargo
+
{{NPCTableRow|Friendly Barge|1|Digger|drop= lots of stuff}}
−
:If the NPC drops notable loot (e.g. faction modules, tech 2 salvage), note it here. Example:
+
{{NPCTableRow|Cruiser|1|Warship|point= yes|ewar= Web|ewar2= TD|note= Important info|trigger= Mission complete|cargo= Expensive stuff}}
−
:<code><nowiki>{{icon|shiny cargo|24|Drops Gist faction modules}}</nowiki></code> {{icon|shiny cargo|24|Drops Gist faction modules}}
 
−
;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...).
 
−
== Sample output ==
 
−
<code><nowiki>{{Complex|Serpentis Lookout}}</nowiki><br>
 
−
<nowiki>{{NPCTableHead}}</nowiki><br>
 
−
<nowiki>{{NPCTableRow|Frigate|10|Coreli Agent/Pursuer/Mangler/...|point=yes|ewar={{icon|damp|24|Sensor dampening}}{{icon|web|24|Stasis webifier}}|note=These ships have high damage but short range.}}</nowiki><br>
 
−
<nowiki>{{NPCTableRow|Elite Frigate|3-5|Coreli Agent|cargo={{icon|shiny cargo|24|Drops Gist A- or B- type modules|trigger=Destroying this will unlock the acceleration gate}}}}</nowiki><br>
 
−
<nowiki>{{NPCTableFoot}}</nowiki></code>
 
−
:gives...
 
−
{{Complex|Serpentis Lookout}}
 
−
{{NPCTableHead}}
 
−
{{NPCTableRow|Frigate|10|Coreli Agent/Pursuer/Mangler/...|point=yes|ewar={{icon|damp|24|Sensor dampening}}{{icon|web|24|Stasis webifier}}|note=These ships have high damage but short range.}}
 
−
{{NPCTableRow|Elite Frigate|3-5|Coreli Agent|cargo={{icon|shiny cargo|24|Drops Gist A- or B- type modules}}|trigger=Destroying this will unlock the acceleration gate}}
 
 
|}
 
|}
−
<small>{{reflist|close=1}}</small>
+
 
−
<includeonly>[[Category:Template|{{PAGENAME}}]]<!-- Any categories for the template itself --></includeonly>
+
 
−
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+
; See also
 +
* [[UniWiki:Mission formatting guidelines|Mission formatting guidelines]]
 +
* {{T|NPCTableSeparator}}
 +
 
 +
<includeonly>[[Category:Formatting templates]]<!-- Any categories for the template itself --></includeonly>
 +
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 11:24, 4 November 2023

Description
This template is used to create a content row in NPCTable.
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.
{{NPCTableHead}}
Syntax
{{NPCTableRow|<type>|<count>|<name>|<point= point>|<ewar= ewar>|<ewar2= ewar>|<ewar3= ewar>|<drop= drop>|<cargo= cargo>|<trigger= trigger>|<note= notes>}}
Parameters
type, count and name are anonymous (positional) parameters and must be ordered as written.
type
sets the type and size of an NPC ship or structure. It is displayed as the ships bracket icon and type. A prefix can be added to control the brackets color. See the tables for valid options.
count
The number of NPCs of that type. This is often a range, so feel free to use number ranges (e.g. 10-12).
name
The NPC's name. Consolidate ships of the same type into a single line (e.g. Coreli Watchman/Patroller). If there are a large number of different ship types, list the most common three or four types followed by an ellipsis (e.g. Corelum Chief Guard/Defender/Protector/...). It is however perfectly fine to use a separate row to make it clear which ship type is using EWAR or triggers an action.
point
If an NPC has a Warp Disruptor, set to point= yes or point= point. If an NPC uses a Warp Scrambler (shuts off MWD and stops MJD) you can specify point= scram.
ewar
ewar2
ewar3
Type of electronic warfare used by an NPC. Displayed as an icon
EWAR codes
Type Code Icon
ECM/Jamming ECM Jamming
Tracking disruption TD Tracking disruption
Guidance disruption GD Guidance disruption
Sensor dampening Damp Sensor dampening
Target painting TP Target painting
Stasis webifier Web Stasis webifier
Energy neutralization ("neut") Neut Neuting
drop
If an NPC leaves behind notable loot (e.g. T1 ammo, a trade good), note it here. A dull icon Icon container small.png will be created.
cargo
If an NPC leaves behind valuable loot (worth over 1M ISK e.g. faction modules, tech 2 salvage), note it here. A shiny icon Icon container small green.png will be created.
trigger
If destroying an NPC causes an action (acceleration gates get unlocked, a new wave of enemies spawn, etc), use this parameter.
note
Use to describe important information about an NPC (for instance, an NPC deals extremely high damage, is able to self-repair themselves quickly, ...).
Sample
{{NPCTableHead|Initial defenders}}
{{NPCTableRow|Friendly Barge|1|Digger|drop= lots of stuff}}
{{NPCTableRow|Cruiser|1|Warship|point= yes|eawr= Web|ewar2= TD|note= Important info|trigger= Mission complete|cargo= Expensive stuff}}
|}
gives...
Initial defenders
WD EWAR L


Mining Barge 1 x Friendly Barge Digger lots of stuff
Cruiser 1 x Cruiser Warship Important info Mission complete Warp Disruptor Stasis Webifier Tracking Disruptor Expensive stuff


See also
Retrieved from "https://wiki.eveuniversity.org/index.php?title=Template:NPCTableRow/doc&oldid=209507"