org.openbw.bwapi4j.unit

Class PlayerUnitImpl

java.lang.Object

org.openbw.bwapi4j.unit.UnitImpl

org.openbw.bwapi4j.unit.PlayerUnitImpl

All Implemented Interfaces:

java.lang.Comparable<Unit>, PlayerUnit, Unit

Direct Known Subclasses:

BuildingImpl, Cocoon, Egg, Larva, MobileUnitImpl, NuclearMissile, SpecialUnit, Spell, SpiderMine

public abstract class PlayerUnitImpl
extends UnitImpl
implements PlayerUnit

Nested Class Summary

Nested classes/interfaces inherited from class org.openbw.bwapi4j.unit.UnitImpl

UnitImpl.TrainingSlot

Constructor Summary

Constructors

Constructor and Description
PlayerUnitImpl()

Method Summary

Modifier and Type	Method and Description
protected int	getAirWeaponCooldown(AirAttacker unit)
protected int	getAirWeaponDamage()
protected int	getAirWeaponMaxCooldown()
protected int	getAirWeaponMaxRange()
int	getArmor()
PlayerUnit	getBuildUnit()
int	getDamageFrom(PlayerUnit from)
int	getDamageTo(PlayerUnit to)
int	getGasPrice()
protected int	getGroundWeaponCooldown(GroundAttacker unit)
protected int	getGroundWeaponDamage()
protected int	getGroundWeaponMaxCooldown()
protected int	getGroundWeaponMaxRange()
int	getHitPoints()
int	getInitialHitPoints()
UnitCommandType	getLastCommand()
int	getLastCommandFrame()
int	getLastKnownHitPoints()
Position	getLastKnownPosition()
TilePosition	getLastKnownTilePosition()
protected int	getMaxAirHits()
protected int	getMaxEnergy()
protected int	getMaxGroundHits()
int	getMineralPrice()
Order	getOrder()
Unit	getOrderTarget()
Position	getOrderTargetPosition()
Player	getPlayer()
Order	getSecondaryOrder()
int	getShields()
int	getSightRange()
int	getSpellCooldown()
protected Unit	getTargetUnit()
protected double	getTopSpeed()
UnitStatCalculator	getUnitStatCalculator()
double	getVelocityX()
double	getVelocityY()
<T extends PlayerUnit> T	getWeakestUnitInRadius(int radius, java.util.Collection<T> units) Convenience method to be used e.g.
boolean	isAccelerating()
boolean	isAttackFrame()
boolean	isAttacking()
boolean	isBeingConstructed()
boolean	isBeingHealed()
boolean	isCloaked()
boolean	isCompleted()
boolean	isDetected()
boolean	isDetector()
boolean	isFlyer()
boolean	isIdle()
boolean	isInterruptible()
boolean	isIrradiated()
boolean	isLockedDown()
boolean	isMaelstrommed()
boolean	isPowered()
boolean	isStartingAttack()
boolean	isUnderAttack()
int	maxHitPoints()
int	maxShields()
boolean	rightClick(Position position, boolean queued) Perform the right-click command on a given position.
boolean	rightClick(Unit target, boolean queued) Perform the right-click command on a given unit.
int	tileHeight()
int	tileWidth()

Methods inherited from class org.openbw.bwapi4j.unit.UnitImpl

cancelResearch, cancelTrain, cancelTrain, cancelUpgrade, canResearch, canTrain, canUpgrade, compareTo, equals, exists, getAllUnits, getAngle, getBottom, getClosest, getCurrentFrame, getDamageEvaluator, getDistance, getDistance, getDistance, getId, getInitiallySpotted, getInitialPosition, getInitialTilePosition, getKillCount, getLastSpotted, getLeft, getMiddle, getPlayer, getPosition, getRallyPosition, getRallyUnit, getResearchInProgress, getRight, getSize, getTilePosition, getTop, getType, getUnit, getUnitsInRadius, getUpgradeInProgress, getX, getY, hashCode, height, isFlying, isSelected, issueCommand, isVisible, research, setRallyPoint, setRallyPoint, toString, train, upgrade, width

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openbw.bwapi4j.unit.Unit

exists, getAngle, getBottom, getClosest, getDistance, getDistance, getDistance, getId, getInitiallySpotted, getInitialPosition, getInitialTilePosition, getKillCount, getLastSpotted, getLeft, getMiddle, getPosition, getRight, getSize, getTilePosition, getTop, getType, getUnitsInRadius, getX, getY, height, isFlying, isSelected, isVisible, width

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

PlayerUnitImpl

public PlayerUnitImpl()

Method Detail

getBuildUnit

public PlayerUnit getBuildUnit()

Specified by:

getBuildUnit in interface PlayerUnit

getTargetUnit

protected Unit getTargetUnit()

getWeakestUnitInRadius

public <T extends PlayerUnit> T getWeakestUnitInRadius(int radius,
                                                       java.util.Collection<T> units)

Convenience method to be used e.g. when doing target-fire micro (just provide unit weapon range as radius).

Specified by:

getWeakestUnitInRadius in interface PlayerUnit

Parameters:

radius - pixel radius

units - units to check for distance

Returns:

weakest unit within given radius

rightClick

public boolean rightClick(Position position,
                          boolean queued)

Perform the right-click command on a given position.

Specified by:

rightClick in interface PlayerUnit

Parameters:

position - the position to right-click to

queued - true if command is queued, false else

Returns:

true if command is successful, false else

rightClick

public boolean rightClick(Unit target,
                          boolean queued)

Perform the right-click command on a given unit.

Specified by:

rightClick in interface PlayerUnit

Parameters:

target - the unit to right-click to

queued - true if command is queued, false else

Returns:

true if command is successful, false else

isCompleted

public boolean isCompleted()

Specified by:

isCompleted in interface PlayerUnit

maxHitPoints

public int maxHitPoints()

Specified by:

maxHitPoints in interface PlayerUnit

getHitPoints

public int getHitPoints()

Specified by:

getHitPoints in interface PlayerUnit

getUnitStatCalculator

public UnitStatCalculator getUnitStatCalculator()

getMaxEnergy

protected int getMaxEnergy()

getArmor

public int getArmor()

Specified by:

getArmor in interface PlayerUnit

maxShields

public int maxShields()

Specified by:

maxShields in interface PlayerUnit

getShields

public int getShields()

Specified by:

getShields in interface PlayerUnit

getSpellCooldown

public int getSpellCooldown()

Specified by:

getSpellCooldown in interface PlayerUnit

getPlayer

public Player getPlayer()

Specified by:

getPlayer in interface PlayerUnit

Overrides:

getPlayer in class UnitImpl

getInitialHitPoints

public int getInitialHitPoints()

Specified by:

getInitialHitPoints in interface PlayerUnit

getMineralPrice

public int getMineralPrice()

Specified by:

getMineralPrice in interface PlayerUnit

getGasPrice

public int getGasPrice()

Specified by:

getGasPrice in interface PlayerUnit

getLastKnownHitPoints

public int getLastKnownHitPoints()

Specified by:

getLastKnownHitPoints in interface PlayerUnit

getLastKnownPosition

public Position getLastKnownPosition()

Specified by:

getLastKnownPosition in interface PlayerUnit

getLastKnownTilePosition

public TilePosition getLastKnownTilePosition()

Specified by:

getLastKnownTilePosition in interface PlayerUnit

getSightRange

public int getSightRange()

Specified by:

getSightRange in interface PlayerUnit

isDetector

public boolean isDetector()

Specified by:

isDetector in interface PlayerUnit

isDetected

public boolean isDetected()

Specified by:

isDetected in interface PlayerUnit

isCloaked

public boolean isCloaked()

Specified by:

isCloaked in interface PlayerUnit

isFlyer

public boolean isFlyer()

Specified by:

isFlyer in interface PlayerUnit

isInterruptible

public boolean isInterruptible()

Specified by:

isInterruptible in interface PlayerUnit

tileWidth

public int tileWidth()

Specified by:

tileWidth in interface PlayerUnit

Specified by:

tileWidth in interface Unit

Overrides:

tileWidth in class UnitImpl

tileHeight

public int tileHeight()

Specified by:

tileHeight in interface PlayerUnit

Specified by:

tileHeight in interface Unit

Overrides:

tileHeight in class UnitImpl

getTopSpeed

protected double getTopSpeed()

getMaxGroundHits

protected int getMaxGroundHits()

getMaxAirHits

protected int getMaxAirHits()

getVelocityX

public double getVelocityX()

Specified by:

getVelocityX in interface PlayerUnit

getVelocityY

public double getVelocityY()

Specified by:

getVelocityY in interface PlayerUnit

isIdle

public boolean isIdle()

Specified by:

isIdle in interface PlayerUnit

isAccelerating

public boolean isAccelerating()

Specified by:

isAccelerating in interface PlayerUnit

isAttacking

public boolean isAttacking()

Specified by:

isAttacking in interface PlayerUnit

isAttackFrame

public boolean isAttackFrame()

Specified by:

isAttackFrame in interface PlayerUnit

isBeingConstructed

public boolean isBeingConstructed()

Specified by:

isBeingConstructed in interface PlayerUnit

isBeingHealed

public boolean isBeingHealed()

Specified by:

isBeingHealed in interface PlayerUnit

isIrradiated

public boolean isIrradiated()

Specified by:

isIrradiated in interface PlayerUnit

isLockedDown

public boolean isLockedDown()

Specified by:

isLockedDown in interface PlayerUnit

isMaelstrommed

public boolean isMaelstrommed()

Specified by:

isMaelstrommed in interface PlayerUnit

isStartingAttack

public boolean isStartingAttack()

Specified by:

isStartingAttack in interface PlayerUnit

isUnderAttack

public boolean isUnderAttack()

Specified by:

isUnderAttack in interface PlayerUnit

isPowered

public boolean isPowered()

Specified by:

isPowered in interface PlayerUnit

getGroundWeaponMaxRange

protected int getGroundWeaponMaxRange()

getGroundWeaponMaxCooldown

protected int getGroundWeaponMaxCooldown()

getGroundWeaponCooldown

protected int getGroundWeaponCooldown(GroundAttacker unit)

getGroundWeaponDamage

protected int getGroundWeaponDamage()

getAirWeaponMaxRange

protected int getAirWeaponMaxRange()

getAirWeaponMaxCooldown

protected int getAirWeaponMaxCooldown()

getAirWeaponCooldown

protected int getAirWeaponCooldown(AirAttacker unit)

getAirWeaponDamage

protected int getAirWeaponDamage()

getDamageTo

public int getDamageTo(PlayerUnit to)

Specified by:

getDamageTo in interface PlayerUnit

getDamageFrom

public int getDamageFrom(PlayerUnit from)

Specified by:

getDamageFrom in interface PlayerUnit

getOrder

public Order getOrder()

Specified by:

getOrder in interface PlayerUnit

Overrides:

getOrder in class UnitImpl

getOrderTarget

public Unit getOrderTarget()

Specified by:

getOrderTarget in interface PlayerUnit

Overrides:

getOrderTarget in class UnitImpl

getOrderTargetPosition

public Position getOrderTargetPosition()

Specified by:

getOrderTargetPosition in interface PlayerUnit

Overrides:

getOrderTargetPosition in class UnitImpl

getSecondaryOrder

public Order getSecondaryOrder()

Specified by:

getSecondaryOrder in interface PlayerUnit

Overrides:

getSecondaryOrder in class UnitImpl

getLastCommandFrame

public int getLastCommandFrame()

Specified by:

getLastCommandFrame in interface PlayerUnit

getLastCommand

public UnitCommandType getLastCommand()

Specified by:

getLastCommand in interface PlayerUnit