org.openbw.bwapi4j.unit

Class Hatchery

java.lang.Object

org.openbw.bwapi4j.unit.UnitImpl

org.openbw.bwapi4j.unit.PlayerUnitImpl

org.openbw.bwapi4j.unit.BuildingImpl

org.openbw.bwapi4j.unit.Hatchery

All Implemented Interfaces:

java.lang.Comparable<Unit>, Building, Morphable, Organic, PlayerUnit, ResearchingFacility, ResourceDepot, SupplyProvider, Unit

Direct Known Subclasses:

Lair

public class Hatchery
extends BuildingImpl
implements Organic, ResearchingFacility, ResourceDepot, Morphable

Nested Class Summary

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

UnitImpl.TrainingSlot

Nested classes/interfaces inherited from interface org.openbw.bwapi4j.unit.ResearchingFacility

ResearchingFacility.ResearchInProgress, ResearchingFacility.UpgradeInProgress

Field Summary

Fields inherited from class org.openbw.bwapi4j.unit.BuildingImpl

probableConstructionStart

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Hatchery(UnitType unitType, int timeSpotted)

Method Summary

Modifier and Type	Method and Description
boolean	cancelResearch()
boolean	cancelUpgrade()
boolean	canResearch(TechType techType)
boolean	canUpgrade(UpgradeType upgradeType)
java.util.List<Larva>	getLarva() Retrieves a list of larvae present at this hatchery.
ResearchingFacility.ResearchInProgress	getResearchInProgress()
ResearchingFacility.UpgradeInProgress	getUpgradeInProgress()
boolean	isReadyForResources() Returns true if workers can deliver resources.
boolean	isResearching()
boolean	isUpgrading()
boolean	morph()
boolean	morph(UnitType type) Morphs this unit into the given unit type.
boolean	research(TechType techType)
boolean	researchBurrowing()
int	supplyProvided()
boolean	trainWorker()
boolean	upgrade(UpgradeType upgradeType)

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

cancelConstruction, getBuildTime, getLastKnownDistance, getLastKnownDistance, getLastKnownDistance, getProbableConstructionStart, getRemainingBuildTime

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

getAirWeaponCooldown, getAirWeaponDamage, getAirWeaponMaxCooldown, getAirWeaponMaxRange, getArmor, getBuildUnit, getDamageFrom, getDamageTo, getGasPrice, getGroundWeaponCooldown, getGroundWeaponDamage, getGroundWeaponMaxCooldown, getGroundWeaponMaxRange, getHitPoints, getInitialHitPoints, getLastCommand, getLastCommandFrame, getLastKnownHitPoints, getLastKnownPosition, getLastKnownTilePosition, getMaxAirHits, getMaxEnergy, getMaxGroundHits, getMineralPrice, getOrder, getOrderTarget, getOrderTargetPosition, getPlayer, getSecondaryOrder, getShields, getSightRange, getSpellCooldown, getTargetUnit, getTopSpeed, getUnitStatCalculator, getVelocityX, getVelocityY, getWeakestUnitInRadius, isAccelerating, isAttackFrame, isAttacking, isBeingConstructed, isBeingHealed, isCloaked, isCompleted, isDetected, isDetector, isFlyer, isIdle, isInterruptible, isIrradiated, isLockedDown, isMaelstrommed, isPowered, isStartingAttack, isUnderAttack, maxHitPoints, maxShields, rightClick, rightClick, tileHeight, tileWidth

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

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

Methods inherited from class java.lang.Object

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

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

cancelConstruction, getBuildTime, getLastKnownDistance, getLastKnownDistance, getLastKnownDistance, getProbableConstructionStart, getRemainingBuildTime

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

getArmor, getBuildUnit, getDamageFrom, getDamageTo, getGasPrice, getHitPoints, getInitialHitPoints, getLastCommand, getLastCommandFrame, getLastKnownHitPoints, getLastKnownPosition, getLastKnownTilePosition, getMineralPrice, getOrder, getOrderTarget, getOrderTargetPosition, getPlayer, getSecondaryOrder, getShields, getSightRange, getSpellCooldown, getVelocityX, getVelocityY, getWeakestUnitInRadius, isAccelerating, isAttackFrame, isAttacking, isBeingConstructed, isBeingHealed, isCloaked, isCompleted, isDetected, isDetector, isFlyer, isIdle, isInterruptible, isIrradiated, isLockedDown, isMaelstrommed, isPowered, isStartingAttack, isUnderAttack, maxHitPoints, maxShields, rightClick, rightClick, tileHeight, tileWidth

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

Hatchery

protected Hatchery(UnitType unitType,
                   int timeSpotted)

Method Detail

isReadyForResources

public boolean isReadyForResources()

Description copied from interface: ResourceDepot

Returns true if workers can deliver resources. Ie. it's completed, not flying, ...

Specified by:

isReadyForResources in interface ResourceDepot

trainWorker

public boolean trainWorker()

Specified by:

trainWorker in interface ResourceDepot

getLarva

public java.util.List<Larva> getLarva()

Retrieves a list of larvae present at this hatchery.

Returns:

list of larvae

researchBurrowing

public boolean researchBurrowing()

isUpgrading

public boolean isUpgrading()

Specified by:

isUpgrading in interface ResearchingFacility

isResearching

public boolean isResearching()

Specified by:

isResearching in interface ResearchingFacility

cancelResearch

public boolean cancelResearch()

Specified by:

cancelResearch in interface ResearchingFacility

Overrides:

cancelResearch in class UnitImpl

cancelUpgrade

public boolean cancelUpgrade()

Specified by:

cancelUpgrade in interface ResearchingFacility

Overrides:

cancelUpgrade in class UnitImpl

morph

public boolean morph(UnitType type)

Description copied from interface: Morphable

Morphs this unit into the given unit type. Be aware that "this" object will be obsolete after the call and a new object with the same Unit.getId() will be created.

Specified by:

morph in interface Morphable

Parameters:

type - the target type to morph to

Returns:

true if the morph command was successfully delivered to Broodwar, false if the command was denied (for example due to missing supply or resources).

morph

public boolean morph()

canResearch

public boolean canResearch(TechType techType)

Specified by:

canResearch in interface ResearchingFacility

Overrides:

canResearch in class UnitImpl

canUpgrade

public boolean canUpgrade(UpgradeType upgradeType)

Specified by:

canUpgrade in interface ResearchingFacility

Overrides:

canUpgrade in class UnitImpl

research

public boolean research(TechType techType)

Specified by:

research in interface ResearchingFacility

Overrides:

research in class UnitImpl

upgrade

public boolean upgrade(UpgradeType upgradeType)

Specified by:

upgrade in interface ResearchingFacility

Overrides:

upgrade in class UnitImpl

getUpgradeInProgress

public ResearchingFacility.UpgradeInProgress getUpgradeInProgress()

Specified by:

getUpgradeInProgress in interface ResearchingFacility

Overrides:

getUpgradeInProgress in class UnitImpl

getResearchInProgress

public ResearchingFacility.ResearchInProgress getResearchInProgress()

Specified by:

getResearchInProgress in interface ResearchingFacility

Overrides:

getResearchInProgress in class UnitImpl

supplyProvided

public int supplyProvided()

Specified by:

supplyProvided in interface SupplyProvider