UpgradeType (jbwapi 2.1.0 API)

java.lang.Object
- java.lang.Enum<UpgradeType>
- - bwapi.UpgradeType

All Implemented Interfaces:

Serializable, Comparable<UpgradeType>
```
public enum UpgradeType
extends Enum<UpgradeType>
```
The upgrade type represents a passive upgrade that can be obtained with Unit.upgrade(bwapi.UpgradeType).

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Adrenal_Glands`
`Anabolic_Synthesis`
`Antennae`
`Apial_Sensors`
`Apollo_Reactor`
`Argus_Jewel`
`Argus_Talisman`
`Caduceus_Reactor`
`Carrier_Capacity`
`Charon_Boosters`
`Chitinous_Plating`
`Colossus_Reactor`
`Gamete_Meiosis`
`Gravitic_Boosters`
`Gravitic_Drive`
`Gravitic_Thrusters`
`Grooved_Spines`
`Ion_Thrusters`
`Khaydarin_Amulet`
`Khaydarin_Core`
`Leg_Enhancements`
`Metabolic_Boost`
`Metasynaptic_Node`
`Moebius_Reactor`
`Muscular_Augments`
`None`
`Ocular_Implants`
`Pneumatized_Carapace`
`Protoss_Air_Armor`
`Protoss_Air_Weapons`
`Protoss_Ground_Armor`
`Protoss_Ground_Weapons`
`Protoss_Plasma_Shields`
`Reaver_Capacity`
`Scarab_Damage`
`Sensor_Array`
`Singularity_Charge`
`Terran_Infantry_Armor`
`Terran_Infantry_Weapons`
`Terran_Ship_Plating`
`Terran_Ship_Weapons`
`Terran_Vehicle_Plating`
`Terran_Vehicle_Weapons`
`Titan_Reactor`
`U_238_Shells`
`Unknown`
`Upgrade_60`
`Ventral_Sacs`
`Zerg_Carapace`
`Zerg_Flyer_Attacks`
`Zerg_Flyer_Carapace`
`Zerg_Melee_Attacks`
`Zerg_Missile_Attacks`

Field Summary

Fields
Modifier and Type Field and Description

int id

Fields
Modifier and Type	Field and Description
`int`	`id`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`gasPrice()`
`int`	`gasPrice(int level)` Returns the vespene gas price for the first upgrade.
`int`	`gasPriceFactor()` Returns the amount that the vespene gas price increases for each additional upgrade.
`Race`	`getRace()` Retrieves the race the upgrade is for.
`int`	`maxRepeats()` Returns the maximum number of times the upgrade can be researched.
`int`	`mineralPrice()`
`int`	`mineralPrice(int level)` Returns the mineral price for the upgrade.
`int`	`mineralPriceFactor()` The amount that the mineral price increases for each additional upgrade.
`int`	`upgradeTime()`
`int`	`upgradeTime(int level)` Returns the number of frames needed to research the first upgrade.
`int`	`upgradeTimeFactor()` Returns the number of frames that the upgrade time increases for each additional upgrade.
`static UpgradeType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static UpgradeType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`UnitType`	`whatsRequired()`
`UnitType`	`whatsRequired(int level)` Returns the type of unit that is required for the upgrade.
`UnitType`	`whatUpgrades()` Returns the type of unit that researches the upgrade.
`List<UnitType>`	`whatUses()` Returns the set of units that are affected by this upgrade.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - Terran_Infantry_Armor
```
public static final UpgradeType Terran_Infantry_Armor
```
  - Terran_Vehicle_Plating
```
public static final UpgradeType Terran_Vehicle_Plating
```
  - Terran_Ship_Plating
```
public static final UpgradeType Terran_Ship_Plating
```
  - Zerg_Carapace
```
public static final UpgradeType Zerg_Carapace
```
  - Zerg_Flyer_Carapace
```
public static final UpgradeType Zerg_Flyer_Carapace
```
  - Protoss_Ground_Armor
```
public static final UpgradeType Protoss_Ground_Armor
```
  - Protoss_Air_Armor
```
public static final UpgradeType Protoss_Air_Armor
```
  - Terran_Infantry_Weapons
```
public static final UpgradeType Terran_Infantry_Weapons
```
  - Terran_Vehicle_Weapons
```
public static final UpgradeType Terran_Vehicle_Weapons
```
  - Terran_Ship_Weapons
```
public static final UpgradeType Terran_Ship_Weapons
```
  - Zerg_Melee_Attacks
```
public static final UpgradeType Zerg_Melee_Attacks
```
  - Zerg_Missile_Attacks
```
public static final UpgradeType Zerg_Missile_Attacks
```
  - Zerg_Flyer_Attacks
```
public static final UpgradeType Zerg_Flyer_Attacks
```
  - Protoss_Ground_Weapons
```
public static final UpgradeType Protoss_Ground_Weapons
```
  - Protoss_Air_Weapons
```
public static final UpgradeType Protoss_Air_Weapons
```
  - Protoss_Plasma_Shields
```
public static final UpgradeType Protoss_Plasma_Shields
```
  - U_238_Shells
```
public static final UpgradeType U_238_Shells
```
  - Ion_Thrusters
```
public static final UpgradeType Ion_Thrusters
```
  - Titan_Reactor
```
public static final UpgradeType Titan_Reactor
```
  - Ocular_Implants
```
public static final UpgradeType Ocular_Implants
```
  - Moebius_Reactor
```
public static final UpgradeType Moebius_Reactor
```
  - Apollo_Reactor
```
public static final UpgradeType Apollo_Reactor
```
  - Colossus_Reactor
```
public static final UpgradeType Colossus_Reactor
```
  - Ventral_Sacs
```
public static final UpgradeType Ventral_Sacs
```
  - Antennae
```
public static final UpgradeType Antennae
```
  - Pneumatized_Carapace
```
public static final UpgradeType Pneumatized_Carapace
```
  - Metabolic_Boost
```
public static final UpgradeType Metabolic_Boost
```
  - Adrenal_Glands
```
public static final UpgradeType Adrenal_Glands
```
  - Muscular_Augments
```
public static final UpgradeType Muscular_Augments
```
  - Grooved_Spines
```
public static final UpgradeType Grooved_Spines
```
  - Gamete_Meiosis
```
public static final UpgradeType Gamete_Meiosis
```
  - Metasynaptic_Node
```
public static final UpgradeType Metasynaptic_Node
```
  - Singularity_Charge
```
public static final UpgradeType Singularity_Charge
```
  - Leg_Enhancements
```
public static final UpgradeType Leg_Enhancements
```
  - Scarab_Damage
```
public static final UpgradeType Scarab_Damage
```
  - Reaver_Capacity
```
public static final UpgradeType Reaver_Capacity
```
  - Gravitic_Drive
```
public static final UpgradeType Gravitic_Drive
```
  - Sensor_Array
```
public static final UpgradeType Sensor_Array
```
  - Gravitic_Boosters
```
public static final UpgradeType Gravitic_Boosters
```
  - Khaydarin_Amulet
```
public static final UpgradeType Khaydarin_Amulet
```
  - Apial_Sensors
```
public static final UpgradeType Apial_Sensors
```
  - Gravitic_Thrusters
```
public static final UpgradeType Gravitic_Thrusters
```
  - Carrier_Capacity
```
public static final UpgradeType Carrier_Capacity
```
  - Khaydarin_Core
```
public static final UpgradeType Khaydarin_Core
```
  - Argus_Jewel
```
public static final UpgradeType Argus_Jewel
```
  - Argus_Talisman
```
public static final UpgradeType Argus_Talisman
```
  - Caduceus_Reactor
```
public static final UpgradeType Caduceus_Reactor
```
  - Chitinous_Plating
```
public static final UpgradeType Chitinous_Plating
```
  - Anabolic_Synthesis
```
public static final UpgradeType Anabolic_Synthesis
```
  - Charon_Boosters
```
public static final UpgradeType Charon_Boosters
```
  - Upgrade_60
```
public static final UpgradeType Upgrade_60
```
  - None
```
public static final UpgradeType None
```
  - Unknown
```
public static final UpgradeType Unknown
```
- Field Detail
  - id
```
public final int id
```
- Method Detail
  - values
```
public static UpgradeType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (UpgradeType c : UpgradeType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static UpgradeType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getRace
```
public Race getRace()
```
    Retrieves the race the upgrade is for. For example, UpgradeType.Terran_Infantry_Armor.getRace() will return Race.Terran.
    
    Returns:
    
    Race that this upgrade belongs to.
  - mineralPrice
```
public int mineralPrice()
```
  - mineralPrice
```
public int mineralPrice(int level)
```
    Returns the mineral price for the upgrade.
    
    Parameters:
    
    level - The next upgrade level.
    Upgrades start at level 0.
    
    Returns:
    
    The mineral cost of the upgrade for the given level.
  - mineralPriceFactor
```
public int mineralPriceFactor()
```
    The amount that the mineral price increases for each additional upgrade.
    
    Returns:
    
    The mineral cost added to the upgrade after each level.
  - gasPrice
```
public int gasPrice()
```
  - gasPrice
```
public int gasPrice(int level)
```
    Returns the vespene gas price for the first upgrade.
    
    Parameters:
    
    level - The next upgrade level.
    Upgrades start at level 0.
    
    Returns:
    
    The gas cost of the upgrade for the given level.
  - gasPriceFactor
```
public int gasPriceFactor()
```
    Returns the amount that the vespene gas price increases for each additional upgrade.
    
    Returns:
    
    The gas cost added to the upgrade after each level.
  - upgradeTime
```
public int upgradeTime()
```
  - upgradeTime
```
public int upgradeTime(int level)
```
    Returns the number of frames needed to research the first upgrade.
    
    Parameters:
    
    level - The next upgrade level. Upgrades start at level 0.
    
    Returns:
    
    The time cost of the upgrade for the given level.
  - upgradeTimeFactor
```
public int upgradeTimeFactor()
```
    Returns the number of frames that the upgrade time increases for each additional upgrade.
    
    Returns:
    
    The time cost added to the upgrade after each level.
  - whatUpgrades
```
public UnitType whatUpgrades()
```
    Returns the type of unit that researches the upgrade.
    
    Returns:
    
    The UnitType that is used to upgrade this type.
  - whatUses
```
public List<UnitType> whatUses()
```
    Returns the set of units that are affected by this upgrade.
    
    Returns:
    
    Set of unit types that passively use this upgrade type.
  - maxRepeats
```
public int maxRepeats()
```
    Returns the maximum number of times the upgrade can be researched.
    
    Returns:
    
    Maximum number of times this upgrade can be upgraded.
  - whatsRequired
```
public UnitType whatsRequired()
```
  - whatsRequired
```
public UnitType whatsRequired(int level)
```
    Returns the type of unit that is required for the upgrade. The player must have at least one of these units completed in order to start upgrading this upgrade.
    
    Parameters:
    
    level - The next upgrade level. Upgrades start at level 0.
    
    Returns:
    
    UnitType required to obtain this upgrade.

Enum UpgradeType

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Terran_Infantry_Armor

Terran_Vehicle_Plating

Terran_Ship_Plating

Zerg_Carapace

Zerg_Flyer_Carapace

Protoss_Ground_Armor

Protoss_Air_Armor

Terran_Infantry_Weapons

Terran_Vehicle_Weapons

Terran_Ship_Weapons

Zerg_Melee_Attacks

Zerg_Missile_Attacks

Zerg_Flyer_Attacks

Protoss_Ground_Weapons

Protoss_Air_Weapons

Protoss_Plasma_Shields

U_238_Shells

Ion_Thrusters

Titan_Reactor

Ocular_Implants

Moebius_Reactor

Apollo_Reactor

Colossus_Reactor

Ventral_Sacs

Antennae

Pneumatized_Carapace

Metabolic_Boost

Adrenal_Glands

Muscular_Augments

Grooved_Spines

Gamete_Meiosis

Metasynaptic_Node

Singularity_Charge

Leg_Enhancements

Scarab_Damage

Reaver_Capacity

Gravitic_Drive

Sensor_Array

Gravitic_Boosters

Khaydarin_Amulet

Apial_Sensors

Gravitic_Thrusters

Carrier_Capacity

Khaydarin_Core

Argus_Jewel

Argus_Talisman

Caduceus_Reactor

Chitinous_Plating

Anabolic_Synthesis

Charon_Boosters

Upgrade_60

None

Unknown

Field Detail

id

Method Detail

values

valueOf

getRace

mineralPrice

mineralPrice

mineralPriceFactor

gasPrice

gasPrice

gasPriceFactor

upgradeTime

upgradeTime

upgradeTimeFactor

whatUpgrades

whatUses

maxRepeats

whatsRequired

whatsRequired