Difference between revisions of "Template:Command Panel UI Button/doc"

From Zero-K
Jump to navigation Jump to search
m (Fixed raider/con confusion.)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
'''{{BASEPAGENAME}}''' is a template to insert a picture of a UI panel button without having to resort to taking a screen shot. A simple wiki table effectively groups multiple buttons.
 +
 +
It is called like this:
 +
 +
<code style="display:block;white-space:pre;width:95%"><nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|unitpic=cloakraid
 +
|Glaive
 +
|18
 +
|25
 +
}}</nowiki></code>
 +
 +
This results in a nice button that shows a Glaive which is 25% completed.
 +
 +
{{{{BASEPAGENAME}}|unitpic=cloakraid
 +
|Glaive
 +
|18
 +
|25
 +
}}
 +
 +
The <code>unitpic</code> parameter is required. It provides the name of the image file to be used for the unit's picture. All images are assumed to be in .png format.
 +
 +
Everything else is optional. The following parameters are allowed:
 +
*The first unnamed one or <code>name</code> is the name of the unit.
 +
*The second unnamed one or <code>queued</code> is how many units are waiting in the queue to be built.
 +
*The third unnamed one or <code>percentage</code> is how much of the unit has already completed building, in percent. It shows the transparent yellow progress bar on the button.
 +
*<code>frame</code> is the rectangle around the unit. It defaults to <code>Mobile</code>, but other values include <code>Fac</code> for builders and <code>Misc</code> for radars and jammers. When in doubt, look at the frame in the actual game.
 +
*<code>hotkey</code> is the shortcut key assigned to the button.
 +
*<code>price</code> is the price of the unit in Metal and Energy.
 +
A full or partial panel can be simulated using wiki tables:
 +
 
{|
 
{|
−
|-
+
|{{{{BASEPAGENAME}}|unitpic=cloakcon
−
|{{Command Panel UI Button|unitpic=cloakcon
+
|Conjurer
 
|frame=Fac
 
|frame=Fac
−
|shortcut=Q
+
|hotkey=Q
 
|price=120}}
 
|price=120}}
−
|{{Command Panel UI Button|unitpic=cloakraid
+
|{{{{BASEPAGENAME}}|unitpic=cloakraid
−
|frame=Mobile
+
|Glaive
−
|shortcut=W
+
|hotkey=W
 
|price=65}}
 
|price=65}}
−
|{{Command Panel UI Button|unitpic=cloakskirm
+
|{{{{BASEPAGENAME}}|unitpic=cloakskirm
−
|frame=Mobile
+
|Ronin
−
|shortcut=E
+
|hotkey=E
 
|price=90}}
 
|price=90}}
−
|+
+
|-
−
|{{Command Panel UI Button|unitpic=cloakjammer
+
|{{{{BASEPAGENAME}}|unitpic=cloakjammer
−
|shortcut=H
+
|Iris
 +
|hotkey=H
 +
|frame=Misc
 
|price=600}}
 
|price=600}}
−
|+
+
|-
−
|{{Command Panel UI Button|unitpic=cloakraid
+
|{{{{BASEPAGENAME}}|unitpic=cloakraid
−
|frame=Mobile
+
|Glaive
 
|queued=1
 
|queued=1
 
|progress=50}}
 
|progress=50}}
 +
|{{{{BASEPAGENAME}}|unitpic=cloakskirm
 +
|Ronin
 +
|queued=3
 +
}}
 +
|{{{{BASEPAGENAME}}|unitpic=cloakcon
 +
|Conjurer
 +
|frame=Fac
 +
|queued=5
 +
}}
 +
|{{{{BASEPAGENAME}}|unitpic=cloakjammer
 +
|Iris
 +
|frame=Misc
 +
|queued=1
 +
}}
 
|}
 
|}

Latest revision as of 17:19, 23 June 2024

Command Panel UI Button is a template to insert a picture of a UI panel button without having to resort to taking a screen shot. A simple wiki table effectively groups multiple buttons.

It is called like this:

{{Command Panel UI Button|unitpic=cloakraid |Glaive |18 |25 }}

This results in a nice button that shows a Glaive which is 25% completed.

(Mobile) Glaive
18

The unitpic parameter is required. It provides the name of the image file to be used for the unit's picture. All images are assumed to be in .png format.

Everything else is optional. The following parameters are allowed:

  • The first unnamed one or name is the name of the unit.
  • The second unnamed one or queued is how many units are waiting in the queue to be built.
  • The third unnamed one or percentage is how much of the unit has already completed building, in percent. It shows the transparent yellow progress bar on the button.
  • frame is the rectangle around the unit. It defaults to Mobile, but other values include Fac for builders and Misc for radars and jammers. When in doubt, look at the frame in the actual game.
  • hotkey is the shortcut key assigned to the button.
  • price is the price of the unit in Metal and Energy.

A full or partial panel can be simulated using wiki tables:

(Fac) Conjurer
Q
120
(Mobile) Glaive
W
65
(Mobile) Ronin
E
90
(Misc) Iris
H
600
(Mobile) Glaive
1
(Mobile) Ronin
3
(Fac) Conjurer
5
(Misc) Iris
1
Retrieved from "https://zero-k.info/mediawiki/index.php?title=Template:Command_Panel_UI_Button/doc&oldid=9813"