UnitAgmtBox

Template Documentation (Edit)

This template creates an infobox for unit augmentations (eg. abilities and upgrades).

Usage

{{UnitAgmtBox
|template=
|bgcolor=
|fgcolor=
|name=
|game=
|race=
|img=
|imgsize=
|desc=
|adddesc=<!-- Insert {{UnitAgmtBox/desc}} sections here -->
<!-- Usage -->
|usepassive=
|usekey=
|usemin=
|usegas=
|usetime=
|useengy=
|usehp=
|usesh=
|useunits=
|userange=
|useduration=
|usecool=
|usenotes=
<!-- Campaign requirements -->
|campacqname=
|campacqcplte=
|campacqunlock=
|campacqvendor=
|campacqprice=
|campacqnotes=
<!-- Acquisition -->
|acqvendor=
|acqkey=
|acqnotes=
|acqtiers=<!-- Insert {{UnitAgmtBox/acq}} sections here -->
}}

{{UnitAgmtBox/desc
|racecolor=
|bgcolor=
|fgcolor=
|race=
|name=
|desc=
}}

{{UnitAgmtBox/acq
|name=
|race=
|game=
|min=
|gas=
|supply=
|engy=
|hp=
|sh=
|time=
|units=
|req=
|effect=
}}

Required

The following fields must be filled. The rest are optional.

• racecolor
  • Sets the background color based on a race's name.
  • This is a raceid value as defined in Template:ColorRace
  • Overrides race for header colors.
• game
  • Should be SC1, or SC2
  • Determines icons
• race
  • Should be Human, Infested Terran, Protoss, Terran, or Zerg
  • Determines header colors and icons
• desc
  • A description of the augmentation. May be used to describe all effects

Optional

The following are some notes on optional fields.

• template
  • The page name of the template; include namespace
  • Creates shortcut links to the template for easy retrieval and editing
• bgcolor
  • Manually sets the background color of the header text.
• fgcolor
  • Manually sets the foreground color of the header text.
• imgsize
  • Manually sets the width of image, otherwise image uses its default size.
  • Requires units to be set. 200px is a valid entry. 200 is not.
• adddesc
  • A list of Template:UnitAgmtBox/desc sections
  • Template:UnitAgmtBox/desc has its own racecolor, bgcolor, fgcolor and race parameters that must be filled separately.
• usepassive
  • Set to any value to activate
  • Displays a label indicating the augmentation's effects are passive
• usetime
  • The time needed for the augmentation to take effect
• useduration
  • The time that the effect lasts
• campacqvendor
  • The campaign object that the augmentation may be acquired from
  • Must be used before campacqprice may be activated
• acqtiers
  • A list of Template:UnitAgmtBox/acq sections
  • Template:UnitAgmtBox/acq has its own race and game parameters that must be filled separately.

Examples

Additional description section

{{UnitAgmtBox
|template=Template:UnitAgmtBox/doc
|racecolor=Terran
|bgcolor=
|fgcolor=#000000
|name=Test
|game=SC1
|race=Terran
|img=SC2 Lab Ultra Capacitors Icon.png
|imgsize=
|desc=This ability changes the color of a marine
|adddesc={{UnitAgmtBox/desc
|racecolor=Terran
|bgcolor=
|fgcolor=#000000
|race=Terran
|name=Paint recipe
|desc=
#Grind minerals
#Mix in vespene gas
#Add lava from Char
#Paint from local hardware store
}}
<!-- Usage -->
|usepassive=
|usekey=P
|usemin=1
|usegas=1
|usetime=1
|useengy=1
|usehp=1
|usesh=1
|useunits=1 SCV
|userange=1
|useduration=10
|usecool=20
|usenotes=The SCV is refunded after duration expires
<!-- Campaign requirements -->
|campacqname=Legacy of the Liberty Heart
|campacqcplte=Tour of the Paint Factory
|campacqunlock=Tier 1
|campacqvendor=Mr. Bun
|campacqprice=$10000
|campacqnotes=Giving Hobbes to Mr. Bun reduces the price to $5000
<!-- Acquisition -->
|acqvendor=Barracks
|acqkey=P
|acqnotes=The barracks will also turn the color of the upgrade
|acqtiers={{UnitAgmtBox/acq
|name=
|race=Terran
|game=SC2
|min=1
|gas=1
|engy=1
|hp=1
|sh=1
|time=1
|units=1 SCV
|req=
|effect=Changes marine armor color to polka-dots
}}
}}

Test

This ability changes the color of a marine

Paint recipe
Grind minerals Mix in vespene gas Add lava from Char Paint from local hardware store

Usage
Hotkey P Cost 1 1 1 1 HP 1 1 1 SCV Range 1 Duration 10 Cooldown 20 Notes The SCV is refunded after duration expires

Campaign Acquisition
Legacy of the Liberty Heart Complete Tour of the Paint Factory Unlock Tier 1 Acquired from Mr. Bun for $10000 Notes Giving Hobbes to Mr. Bun reduces the price to $5000

Acquisition
Purchased from Barracks Hotkey P Notes The barracks will also turn the color of the upgrade

v • e

One acquisition tier

The name parameter of the single Template:UnitAgmtBox/acq is left empty.

{{UnitAgmtBox
|template=Template:UnitAgmtBox/doc
|racecolor=Terran
|bgcolor=
|fgcolor=#000000
|name=Test
|game=SC1
|race=Terran
|img=SC2 Lab Ultra Capacitors Icon.png
|imgsize=
|desc=This ability changes the color of a marine
<!-- Usage -->
|usepassive=
|usekey=P
|usemin=1
|usegas=1
|usetime=1
|useengy=1
|usehp=1
|usesh=1
|useunits=1 SCV
|userange=1
|useduration=10
|usecool=20
|usenotes=The SCV is refunded after duration expires
<!-- Campaign requirements -->
|campacqname=Legacy of the Liberty Heart
|campacqcplte=Tour of the Paint Factory
|campacqunlock=Tier 1
|campacqvendor=Mr. Bun
|campacqprice=$10000
|campacqnotes=Giving Hobbes to Mr. Bun reduces the price to $5000
<!-- Acquisition -->
|acqvendor=Barracks
|acqkey=P
|acqnotes=The barracks will also turn the color of the upgrade
|acqtiers={{UnitAgmtBox/acq
|name=
|race=Terran
|game=SC2
|min=1
|gas=1
|engy=1
|hp=1
|sh=1
|time=1
|units=1 SCV
|req=
|effect=Changes marine armor color to polka-dots
}}
}}

Test

This ability changes the color of a marine

Usage
Hotkey P Cost 1 1 1 1 HP 1 1 1 SCV Range 1 Duration 10 Cooldown 20 Notes The SCV is refunded after duration expires

Campaign Acquisition
Legacy of the Liberty Heart Complete Tour of the Paint Factory Unlock Tier 1 Acquired from Mr. Bun for $10000 Notes Giving Hobbes to Mr. Bun reduces the price to $5000

Acquisition
Purchased from Barracks Hotkey P Notes The barracks will also turn the color of the upgrade Cost 1 1 1 1HP 1 1 1 SCV Effect Changes marine armor color to polka-dots

v • e

Multiple acquisition tiers

Each Template:UnitAgmtBox/acq segments is identified by its name argument.

{{UnitAgmtBox
|template=Template:UnitAgmtBox/doc
|racecolor=Terran
|bgcolor=
|fgcolor=#000000
|name=Test
|game=SC1
|race=Terran
|img=SC2 Lab Ultra Capacitors Icon.png
|imgsize=
|desc=This ability changes the color of a marine
<!-- Usage -->
|usepassive=
|usekey=P
|usemin=1
|usegas=1
|usetime=1
|useengy=1
|usehp=1
|usesh=1
|useunits=1 SCV
|userange=1
|useduration=10
|usecool=20
|usenotes=The SCV is refunded after duration expires
<!-- Campaign requirements -->
|campacqname=Legacy of the Liberty Heart
|campacqcplte=Tour of the Paint Factory
|campacqunlock=Tier 1
|campacqvendor=Mr. Bun
|campacqprice=$10000
|campacqnotes=Giving Hobbes to Mr. Bun reduces the price to $5000
<!-- Acquisition -->
|acqvendor=Barracks
|acqkey=P
|acqnotes=The barracks will also turn the color of the upgrade
|acqtiers={{UnitAgmtBox/acq
|name=Level 1
|race=Terran
|game=SC2
|min=1
|gas=1
|engy=1
|hp=1
|sh=1
|time=1
|units=1 SCV
|req=
|effect=Changes marine armor color to polka-dots
}}
{{UnitAgmtBox/acq
|name=Level 2
|race=Terran
|game=SC2
|min=1
|gas=1
|engy=1
|hp=1
|sh=1
|time=1
|units=1 SCV
|req=Paint shop (attached to barracks)
|effect=Changes marine armor color to neon pink
}}
{{UnitAgmtBox/acq
|name=Level 3
|race=Terran
|game=SC2
|min=1
|gas=1
|engy=1
|hp=1
|sh=1
|time=1
|units=1 SCV
|req=Paint shop (attached to barracks)
|effect=Changes marine armor color to plaid
}}
}}

Test

This ability changes the color of a marine

Usage
Hotkey P Cost 1 1 1 1 HP 1 1 1 SCV Range 1 Duration 10 Cooldown 20 Notes The SCV is refunded after duration expires

Campaign Acquisition
Legacy of the Liberty Heart Complete Tour of the Paint Factory Unlock Tier 1 Acquired from Mr. Bun for $10000 Notes Giving Hobbes to Mr. Bun reduces the price to $5000

Acquisition

Purchased from Barracks Hotkey P Notes The barracks will also turn the color of the upgrade Level 1 Cost 1 1 1 1HP 1 1 1 SCV Effect Changes marine armor color to polka-dots Level 2 Cost 1 1 1 1HP 1 1 1 SCV Required Paint shop (attached to barracks) Effect Changes marine armor color to neon pink Level 3 Cost 1 1 1 1HP 1 1 1 SCV Required Paint shop (attached to barracks) Effect Changes marine armor color to plaid

v • e