Package | Description |
---|---|
bwapi |
Modifier and Type | Method and Description |
---|---|
UnitType |
Unit.getBuildType()
Retrieves the building type that a @worker is about to construct.
|
UnitType |
Unit.getBuildType()
Retrieves the building type that a @worker is about to construct.
|
UnitType |
Race.getCenter()
Deprecated.
As of 4.2.0 due to naming inconsistency. Use #getResourceDepot instead.
See https://github.com/bwapi/bwapi/issues/621 for more information.
|
UnitType |
Race.getCenter()
Deprecated.
As of 4.2.0 due to naming inconsistency. Use #getResourceDepot instead.
See https://github.com/bwapi/bwapi/issues/621 for more information.
|
UnitType |
Unit.getInitialType()
Retrieves the initial type of the unit.
|
UnitType |
Unit.getInitialType()
Retrieves the initial type of the unit.
|
UnitType |
Race.getRefinery()
Retrieves the default structure UnitType for this Race that is used to harvest gas from @Geysers.
|
UnitType |
Race.getRefinery()
Retrieves the default structure UnitType for this Race that is used to harvest gas from @Geysers.
|
UnitType |
Race.getResourceDepot()
Retrieves the default resource depot
UnitType that workers of this race can
construct and return resources to. |
UnitType |
Race.getResourceDepot()
Retrieves the default resource depot
UnitType that workers of this race can
construct and return resources to. |
UnitType |
Race.getSupplyProvider()
Retrieves the default supply provider
UnitType for this race that is used to construct
units. |
UnitType |
Race.getSupplyProvider()
Retrieves the default supply provider
UnitType for this race that is used to construct
units. |
UnitType |
Unit.getTrainingQueueAt(int i)
Retrieves a unit type from a specific index in the queue of units this unit is training.
|
UnitType |
Unit.getTrainingQueueAt(int i)
Retrieves a unit type from a specific index in the queue of units this unit is training.
|
UnitType |
Race.getTransport()
Retrieves the default transport
UnitType for this race that is used to transport ground
units across the map. |
UnitType |
Race.getTransport()
Retrieves the default transport
UnitType for this race that is used to transport ground
units across the map. |
UnitType |
Unit.getType()
Retrieves the unit's type.
|
UnitType |
Unit.getType()
Retrieves the unit's type.
|
UnitType |
UnitCommand.getUnitType() |
UnitType |
UnitCommand.getUnitType() |
UnitType |
Race.getWorker()
Retrieves the default worker type for this
Race . |
UnitType |
Race.getWorker()
Retrieves the default worker type for this
Race . |
UnitType |
TechType.requiredUnit()
Retrieves the
UnitType required to research this technology. |
UnitType |
TechType.requiredUnit()
Retrieves the
UnitType required to research this technology. |
static UnitType |
UnitType.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static UnitType |
UnitType.valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static UnitType[] |
UnitType.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
static UnitType[] |
UnitType.values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
UnitType |
TechType.whatResearches()
Retrieves the
UnitType that can research this technology. |
UnitType |
TechType.whatResearches()
Retrieves the
UnitType that can research this technology. |
UnitType |
UpgradeType.whatsRequired() |
UnitType |
UpgradeType.whatsRequired() |
UnitType |
UpgradeType.whatsRequired(int level)
Returns the type of unit that is required for the upgrade.
|
UnitType |
UpgradeType.whatsRequired(int level)
Returns the type of unit that is required for the upgrade.
|
UnitType |
UpgradeType.whatUpgrades()
Returns the type of unit that researches the upgrade.
|
UnitType |
UpgradeType.whatUpgrades()
Returns the type of unit that researches the upgrade.
|
UnitType |
WeaponType.whatUses()
Retrieves the unit type that is intended to use this weapon type.
|
UnitType |
WeaponType.whatUses()
Retrieves the unit type that is intended to use this weapon type.
|
Modifier and Type | Method and Description |
---|---|
List<UnitType> |
UnitType.buildsWhat()
Retrieves the set of units that this unit type is capable of creating.
|
List<UnitType> |
UnitType.buildsWhat()
Retrieves the set of units that this unit type is capable of creating.
|
List<UnitType> |
Unit.getTrainingQueue()
Retrieves the list of unit types queued up to be trained.
|
List<UnitType> |
Unit.getTrainingQueue()
Retrieves the list of unit types queued up to be trained.
|
Map<UnitType,Integer> |
UnitType.requiredUnits()
Retrieves the immediate technology tree requirements to make this unit type.
|
Map<UnitType,Integer> |
UnitType.requiredUnits()
Retrieves the immediate technology tree requirements to make this unit type.
|
Pair<UnitType,Integer> |
UnitType.whatBuilds()
Obtains the source unit type that is used to build or train this unit type, as well as the
amount of them that are required.
|
Pair<UnitType,Integer> |
UnitType.whatBuilds()
Obtains the source unit type that is used to build or train this unit type, as well as the
amount of them that are required.
|
List<UnitType> |
TechType.whatUses()
Retrieves the set of all UnitTypes that are capable of using this ability.
|
List<UnitType> |
UpgradeType.whatUses()
Returns the set of units that are affected by this upgrade.
|
List<UnitType> |
UpgradeType.whatUses()
Returns the set of units that are affected by this upgrade.
|
List<UnitType> |
TechType.whatUses()
Retrieves the set of all UnitTypes that are capable of using this ability.
|
Modifier and Type | Method and Description |
---|---|
int |
Player.allUnitCount(UnitType unit)
Retrieves the total number of units that the player has.
|
int |
Player.allUnitCount(UnitType unit)
Retrieves the total number of units that the player has.
|
int |
Player.armor(UnitType unit)
Calculates the armor that a given unit type will have, including upgrades.
|
int |
Player.armor(UnitType unit)
Calculates the armor that a given unit type will have, including upgrades.
|
static UnitCommand |
UnitCommand.build(Unit unit,
TilePosition target,
UnitType type) |
static UnitCommand |
UnitCommand.build(Unit unit,
TilePosition target,
UnitType type) |
boolean |
Unit.build(UnitType type) |
boolean |
Unit.build(UnitType type) |
boolean |
Unit.build(UnitType type,
TilePosition target)
Orders the worker unit(s) to construct a structure at a target position.
|
boolean |
Unit.build(UnitType type,
TilePosition target)
Orders the worker unit(s) to construct a structure at a target position.
|
boolean |
Unit.buildAddon(UnitType type)
Orders the @Terran structure(s) to construct an add-on.
|
boolean |
Unit.buildAddon(UnitType type)
Orders the @Terran structure(s) to construct an add-on.
|
static UnitCommand |
UnitCommand.buildAddon(Unit unit,
UnitType type) |
static UnitCommand |
UnitCommand.buildAddon(Unit unit,
UnitType type) |
boolean |
Unit.canBuild(UnitType uType) |
boolean |
Unit.canBuild(UnitType uType) |
boolean |
Unit.canBuild(UnitType uType,
boolean checkCanIssueCommandType) |
boolean |
Unit.canBuild(UnitType uType,
boolean checkCanIssueCommandType) |
boolean |
Unit.canBuild(UnitType uType,
boolean checkCanIssueCommandType,
boolean checkCommandibility) |
boolean |
Unit.canBuild(UnitType uType,
boolean checkCanIssueCommandType,
boolean checkCommandibility) |
boolean |
Unit.canBuild(UnitType uType,
TilePosition tilePos) |
boolean |
Unit.canBuild(UnitType uType,
TilePosition tilePos) |
boolean |
Unit.canBuild(UnitType uType,
TilePosition tilePos,
boolean checkTargetUnitType) |
boolean |
Unit.canBuild(UnitType uType,
TilePosition tilePos,
boolean checkTargetUnitType) |
boolean |
Unit.canBuild(UnitType uType,
TilePosition tilePos,
boolean checkTargetUnitType,
boolean checkCanIssueCommandType) |
boolean |
Unit.canBuild(UnitType uType,
TilePosition tilePos,
boolean checkTargetUnitType,
boolean checkCanIssueCommandType) |
boolean |
Unit.canBuild(UnitType uType,
TilePosition tilePos,
boolean checkTargetUnitType,
boolean checkCanIssueCommandType,
boolean checkCommandibility)
Cheap checks for whether the unit is able to execute a build command.
|
boolean |
Unit.canBuild(UnitType uType,
TilePosition tilePos,
boolean checkTargetUnitType,
boolean checkCanIssueCommandType,
boolean checkCommandibility)
Cheap checks for whether the unit is able to execute a build command.
|
boolean |
Unit.canBuildAddon(UnitType uType) |
boolean |
Unit.canBuildAddon(UnitType uType) |
boolean |
Unit.canBuildAddon(UnitType uType,
boolean checkCanIssueCommandType) |
boolean |
Unit.canBuildAddon(UnitType uType,
boolean checkCanIssueCommandType) |
boolean |
Unit.canBuildAddon(UnitType uType,
boolean checkCanIssueCommandType,
boolean checkCommandibility)
Cheap checks for whether the unit is able to execute a buildAddon command.
|
boolean |
Unit.canBuildAddon(UnitType uType,
boolean checkCanIssueCommandType,
boolean checkCommandibility)
Cheap checks for whether the unit is able to execute a buildAddon command.
|
boolean |
Game.canBuildHere(TilePosition position,
UnitType type) |
boolean |
Game.canBuildHere(TilePosition position,
UnitType type) |
boolean |
Game.canBuildHere(TilePosition position,
UnitType type,
Unit builder) |
boolean |
Game.canBuildHere(TilePosition position,
UnitType type,
Unit builder) |
boolean |
Game.canBuildHere(TilePosition position,
UnitType type,
Unit builder,
boolean checkExplored)
Checks if the given unit type can be built at the given build tile position.
|
boolean |
Game.canBuildHere(TilePosition position,
UnitType type,
Unit builder,
boolean checkExplored)
Checks if the given unit type can be built at the given build tile position.
|
boolean |
Game.canMake(UnitType type) |
boolean |
Game.canMake(UnitType type) |
boolean |
Game.canMake(UnitType type,
Unit builder)
Checks all the requirements in order to make a given unit type for the current
player.
|
boolean |
Game.canMake(UnitType type,
Unit builder)
Checks all the requirements in order to make a given unit type for the current
player.
|
boolean |
Unit.canMorph(UnitType uType) |
boolean |
Unit.canMorph(UnitType uType) |
boolean |
Unit.canMorph(UnitType uType,
boolean checkCanIssueCommandType) |
boolean |
Unit.canMorph(UnitType uType,
boolean checkCanIssueCommandType) |
boolean |
Unit.canMorph(UnitType uType,
boolean checkCanIssueCommandType,
boolean checkCommandibility)
Cheap checks for whether the unit is able to execute a morph command.
|
boolean |
Unit.canMorph(UnitType uType,
boolean checkCanIssueCommandType,
boolean checkCommandibility)
Cheap checks for whether the unit is able to execute a morph command.
|
boolean |
Unit.canTrain(UnitType uType) |
boolean |
Unit.canTrain(UnitType uType) |
boolean |
Unit.canTrain(UnitType uType,
boolean checkCanIssueCommandType) |
boolean |
Unit.canTrain(UnitType uType,
boolean checkCanIssueCommandType) |
boolean |
Unit.canTrain(UnitType uType,
boolean checkCanIssueCommandType,
boolean checkCommandibility)
Cheap checks for whether the unit is able to execute a train command.
|
boolean |
Unit.canTrain(UnitType uType,
boolean checkCanIssueCommandType,
boolean checkCommandibility)
Cheap checks for whether the unit is able to execute a train command.
|
int |
Player.completedUnitCount(UnitType unit)
Retrieves the number of completed units that the player has.
|
int |
Player.completedUnitCount(UnitType unit)
Retrieves the number of completed units that the player has.
|
int |
Player.deadUnitCount(UnitType unit)
Retrieves the number units that have died for this player.
|
int |
Player.deadUnitCount(UnitType unit)
Retrieves the number units that have died for this player.
|
TilePosition |
Game.getBuildLocation(UnitType type,
TilePosition desiredPosition) |
TilePosition |
Game.getBuildLocation(UnitType type,
TilePosition desiredPosition) |
TilePosition |
Game.getBuildLocation(UnitType type,
TilePosition desiredPosition,
int maxRange) |
TilePosition |
Game.getBuildLocation(UnitType type,
TilePosition desiredPosition,
int maxRange) |
TilePosition |
Game.getBuildLocation(UnitType type,
TilePosition desiredPosition,
int maxRange,
boolean creep)
Retrieves a basic build position just as the default Computer AI would.
|
TilePosition |
Game.getBuildLocation(UnitType type,
TilePosition desiredPosition,
int maxRange,
boolean creep)
Retrieves a basic build position just as the default Computer AI would.
|
int |
Game.getDamageFrom(UnitType fromType,
UnitType toType) |
int |
Game.getDamageFrom(UnitType fromType,
UnitType toType) |
int |
Game.getDamageFrom(UnitType fromType,
UnitType toType,
Player fromPlayer) |
int |
Game.getDamageFrom(UnitType fromType,
UnitType toType,
Player fromPlayer) |
int |
Game.getDamageFrom(UnitType fromType,
UnitType toType,
Player fromPlayer,
Player toPlayer)
Calculates the damage received for a given player.
|
int |
Game.getDamageFrom(UnitType fromType,
UnitType toType,
Player fromPlayer,
Player toPlayer)
Calculates the damage received for a given player.
|
int |
Game.getDamageTo(UnitType toType,
UnitType fromType) |
int |
Game.getDamageTo(UnitType toType,
UnitType fromType) |
int |
Game.getDamageTo(UnitType toType,
UnitType fromType,
Player toPlayer) |
int |
Game.getDamageTo(UnitType toType,
UnitType fromType,
Player toPlayer) |
int |
Game.getDamageTo(UnitType toType,
UnitType fromType,
Player toPlayer,
Player fromPlayer)
Calculates the damage dealt for a given player.
|
int |
Game.getDamageTo(UnitType toType,
UnitType fromType,
Player toPlayer,
Player fromPlayer)
Calculates the damage dealt for a given player.
|
boolean |
Game.hasPower(int tileX,
int tileY,
int tileWidth,
int tileHeight,
UnitType unitType)
Checks if the given tile position if powered by an owned @Protoss_Pylon for an
optional unit type.
|
boolean |
Game.hasPower(int tileX,
int tileY,
int tileWidth,
int tileHeight,
UnitType unitType)
Checks if the given tile position if powered by an owned @Protoss_Pylon for an
optional unit type.
|
boolean |
Game.hasPower(int tileX,
int tileY,
UnitType unitType) |
boolean |
Game.hasPower(int tileX,
int tileY,
UnitType unitType) |
boolean |
Game.hasPower(TilePosition position,
int tileWidth,
int tileHeight,
UnitType unitType) |
boolean |
Game.hasPower(TilePosition position,
int tileWidth,
int tileHeight,
UnitType unitType) |
boolean |
Game.hasPower(TilePosition position,
UnitType unitType) |
boolean |
Game.hasPower(TilePosition position,
UnitType unitType) |
boolean |
Game.hasPowerPrecise(int x,
int y,
UnitType unitType)
Checks if the given pixel position is powered by an owned @Protoss_Pylon for an
optional unit type.
|
boolean |
Game.hasPowerPrecise(int x,
int y,
UnitType unitType)
Checks if the given pixel position is powered by an owned @Protoss_Pylon for an
optional unit type.
|
boolean |
Game.hasPowerPrecise(Position position,
UnitType unitType) |
boolean |
Game.hasPowerPrecise(Position position,
UnitType unitType) |
boolean |
Player.hasUnitTypeRequirement(UnitType unit) |
boolean |
Player.hasUnitTypeRequirement(UnitType unit) |
boolean |
Player.hasUnitTypeRequirement(UnitType unit,
int amount)
Verifies that this player satisfies a unit type requirement.
|
boolean |
Player.hasUnitTypeRequirement(UnitType unit,
int amount)
Verifies that this player satisfies a unit type requirement.
|
int |
Player.incompleteUnitCount(UnitType unit)
Retrieves the number of incomplete units that the player has.
|
int |
Player.incompleteUnitCount(UnitType unit)
Retrieves the number of incomplete units that the player has.
|
boolean |
UnitType.isSuccessorOf(UnitType type)
Checks if the current type is equal to the provided type, or a successor of the
provided type.
|
boolean |
UnitType.isSuccessorOf(UnitType type)
Checks if the current type is equal to the provided type, or a successor of the
provided type.
|
boolean |
Player.isUnitAvailable(UnitType unit)
Checks if a unit type can be created by the player.
|
boolean |
Player.isUnitAvailable(UnitType unit)
Checks if a unit type can be created by the player.
|
int |
Player.killedUnitCount(UnitType unit)
Retrieves the number units that the player has killed.
|
int |
Player.killedUnitCount(UnitType unit)
Retrieves the number units that the player has killed.
|
int |
Player.maxEnergy(UnitType unit)
Retrieves the maximum amount of energy that a unit type will have, taking the
player's energy upgrades into consideration.
|
int |
Player.maxEnergy(UnitType unit)
Retrieves the maximum amount of energy that a unit type will have, taking the
player's energy upgrades into consideration.
|
boolean |
Unit.morph(UnitType type)
Orders the unit(s) to morph into a different
UnitType . |
boolean |
Unit.morph(UnitType type)
Orders the unit(s) to morph into a different
UnitType . |
static UnitCommand |
UnitCommand.morph(Unit unit,
UnitType type) |
static UnitCommand |
UnitCommand.morph(Unit unit,
UnitType type) |
int |
Player.sightRange(UnitType unit)
Retrieves the sight range of a unit type, taking the player's sight range
upgrades into consideration.
|
int |
Player.sightRange(UnitType unit)
Retrieves the sight range of a unit type, taking the player's sight range
upgrades into consideration.
|
double |
Player.topSpeed(UnitType unit)
Retrieves the top speed of a unit type, taking the player's speed upgrades into
consideration.
|
double |
Player.topSpeed(UnitType unit)
Retrieves the top speed of a unit type, taking the player's speed upgrades into
consideration.
|
boolean |
Unit.train(UnitType type)
Orders the unit(s) to add a UnitType to its training queue, or morphs into the
UnitType if it is @Zerg. |
boolean |
Unit.train(UnitType type)
Orders the unit(s) to add a UnitType to its training queue, or morphs into the
UnitType if it is @Zerg. |
static UnitCommand |
UnitCommand.train(Unit unit,
UnitType type) |
static UnitCommand |
UnitCommand.train(Unit unit,
UnitType type) |
int |
Player.visibleUnitCount(UnitType unit)
Retrieves the total number of strictly visible units that the player has, even if
information on the player is unrestricted.
|
int |
Player.visibleUnitCount(UnitType unit)
Retrieves the total number of strictly visible units that the player has, even if
information on the player is unrestricted.
|
int |
Player.weaponDamageCooldown(UnitType unit)
Retrieves the weapon cooldown of a unit type, taking the player's attack speed
upgrades into consideration.
|
int |
Player.weaponDamageCooldown(UnitType unit)
Retrieves the weapon cooldown of a unit type, taking the player's attack speed
upgrades into consideration.
|
Modifier and Type | Method and Description |
---|---|
static UnitFilter |
UnitFilter.BuildType(Predicate<UnitType> c) |
static UnitFilter |
UnitFilter.BuildType(Predicate<UnitType> c) |
static UnitFilter |
UnitFilter.GetType(Predicate<UnitType> c) |
static UnitFilter |
UnitFilter.GetType(Predicate<UnitType> c) |
Copyright © 2022. All rights reserved.