Package com.github.ocraft.s2client.bot.gateway

Class UnitInPool

java.lang.Object

com.github.ocraft.s2client.bot.gateway.UnitInPool

public class UnitInPool
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
UnitInPool(Tag tag)

Method Summary

Modifier and Type	Method	Description
void	dead()
boolean	equals(java.lang.Object o)
long	getLastSeenGameLoop()
Tag	getTag()
java.util.Optional<Unit>	getUnit()
int	hashCode()
boolean	isAlive()
static java.util.function.Predicate<UnitInPool>	isCarryingMinerals()	Helper function used to discover whether a unit is carrying minerals or not.
static java.util.function.Predicate<UnitInPool>	isCarryingVespene()	Helper function used to discover whether a unit is carrying vespene or not.
static java.util.function.Predicate<UnitInPool>	isUnit(UnitType type)
java.lang.String	toString()
Unit	unit()
UnitInPool	update(Unit unit)
UnitInPool	update(Unit unit, long gameLoop, boolean alive)

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitInPool

public UnitInPool(Tag tag)

Method Detail

update

public UnitInPool update(Unit unit,
                         long gameLoop,
                         boolean alive)

update

public UnitInPool update(Unit unit)

getTag

public Tag getTag()

getUnit

public java.util.Optional<Unit> getUnit()

unit

public Unit unit()

dead

public void dead()

isAlive

public boolean isAlive()

getLastSeenGameLoop

public long getLastSeenGameLoop()

isUnit

public static java.util.function.Predicate<UnitInPool> isUnit(UnitType type)

isCarryingMinerals

public static java.util.function.Predicate<UnitInPool> isCarryingMinerals()

Helper function used to discover whether a unit is carrying minerals or not. You could use this function in GetUnits to get all units carrying minerals:

 
 List<UnitInPool> units = observation().getUnits(Alliance.SELF, UnitInPool.isCarryingMinerals());
 
 

Returns:

Returns true if the unit is carrying minerals, false otherwise.

isCarryingVespene

public static java.util.function.Predicate<UnitInPool> isCarryingVespene()

Helper function used to discover whether a unit is carrying vespene or not. You could use this function in GetUnits to get all units carrying vespene:

 
 List<UnitInPool> units = observation().getUnits(Alliance.SELF, UnitInPool.isCarryingVespene);
 
 

Returns:

Returns true if the unit is carrying vespene, false otherwise.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object