Editing Template:Trait/doc

<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
Template used for [[leader traits]]. See [[:Category:Leader trait icons]] for the trait images and [[:Category:Leader trait icon elements]] for the trait background and overlay images.

== Parameters ==

{| class="wikitable"
! Parameter
! Description
! Required
! Default
|-
| 1 || Image file name, not including "Leader_trait_" or "png" || '''required''' || —
|-
| 2 || Name of the icon, unnecessary if it matches 1 || optional || [1]
|-
| w || Size of the icon<br/>Cannot use x24px format || optional || 34px
|-
| bg || Icon background, uses basic trait background by default:
* eng / engineering = engineering [[File:Leader_trait_bg_engineering.png|24px]]
* soc / society = society [[File:Leader_trait_bg_society.png|24px]]
* phy / physics = physics [[File:Leader_trait_bg physics.png|24px]]
* psi / psionic = psionic [[File:Leader_trait_bg_psionics.png|24px]]
* spec / specialist = specialist [[File:Leader_trait_bg_specialist.png|24px]]
* neg / negative = negative [[File:Leader_trait_bg_negative.png|24px]]
* adv / advanced = advanced [[File:Leader_trait_bg_advanced.png|24px]] <small>(unused in-game)</small>
| optional || basic [[File:Leader_trait_bg_basic.png|24px]]
|-
| rarity || Trait rarity, used to determine trait frame and overlay.
* veteran [[File:Leader_trait_overlay_veteran.png|24px]]
* destiny [[File:Leader_trait_overlay_destiny.png|24px]]
<div><code>veteran=yes</code> or <code>destiny=yes</code> can also be used instead.</div>
| optional || —
|-
| tier || Used to indicate trait tier/level
* 1 [[File:Leader_trait_bg basic.png|24px]]<span style="margin-left:-24px;">[[File:Leader_trait_tier_1.png|24px]]</span>
* 2 [[File:Leader_trait_bg basic.png|24px]]<span style="margin-left:-24px;">[[File:Leader_trait_tier_2.png|24px]]</span> - automatically adds "II" to trait name in hover text
* 3 [[File:Leader_trait_bg basic.png|24px]]<span style="margin-left:-24px;">[[File:Leader_trait_tier_3.png|24px]]</span> - automatically adds "III" to trait name in hover text
| optional || —
|-
| council || Adds the councilor overlay [[File:Leader_trait_bg_basic.png|24px]]<span style="margin-left:-24px;">[[File:Leader_trait_overlay_councilor.png|24px]]</span> || optional || —
|-
| class || Sets which leader class the trait belongs to, used to determine which page is linked by default
* official = [[Official traits]]
* scientist = [[Scientist traits]]
* commander = [[Commander traits]]
* default = [[Common leader traits]]
| optional || [[Common leader traits]]
|-
| link || Sets a custom link || optional || [class] traits#[3]
|-
| hover || Sets a custom hover text, overrides tier number. || optional || [3]
|-
| image || Sets an alternate image for trait icon || optional || Leader trait [1].png
|}

== Examples ==

{| class="wikitable"
! Wikitext !! Icon
|-
| <code><nowiki>{{trait|Architectural Sense|class=official|rarity=veteran|council=yes}}</nowiki></code> || {{trait|Architectural Sense|class=official|rarity=veteran|council=yes}}
|-
| <code><nowiki>{{trait|space miner|Geology Expert|w=34px|veteran=yes|tier=3}}</nowiki></code> || {{trait|space miner|Geology Expert|w=34px|veteran=yes|tier=3}}
|-
| <code><nowiki>{{trait|Scholarium Explorer|bg=spec|class=scientist}}</nowiki></code> || {{trait|Scholarium Explorer|bg=spec|class=scientist}}
|}