aom.scripting.ui

Class IdleBannerGadget

Object

AbstractGadget

IdleBannerGadget

public class IdleBannerGadget
extends AbstractGadget

Represents an in-game idle banner used to locate certain types of idle units.

Note

The objectives banner is also an idle banner.

Field Summary

Fields

Modifier and Type	Field and Description
String	bannerproto Indicates the texture that will be used to display this banner.
UnitType	idleType Indicates the unit type this idle banner will represent.
boolean	shownOnIdle Indicates that this banner should only be shown when there are idle units.

Fields inherited from class AbstractGadget

background, backgroundAlpha, backgroundColor, bevel, closeButton, closeButtonUseAlpha, hidden, innerText, mouseOverText, moveable, name, size1024, sizerel1024, sunkenBevel, textFont, textFontSize, tileBackground, tileBackgroundHorizontally, tileBackgroundVertically, titlebar, tooltipText, transparent, windowZStyle, z

Constructor Summary

Constructors

Constructor and Description
IdleBannerGadget(String proto, UnitType type, boolean shownOnIdle) Creates a new idle banner with given properties.

Method Summary

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bannerproto

public String bannerproto

Indicates the texture that will be used to display this banner.

idleType

public UnitType idleType

Indicates the unit type this idle banner will represent.

shownOnIdle

public boolean shownOnIdle

Indicates that this banner should only be shown when there are idle units.

Constructor Detail

IdleBannerGadget

public IdleBannerGadget(String proto,
                        UnitType type,
                        boolean shownOnIdle)

Creates a new idle banner with given properties.