Base (BWAPI4J API)

All Known Implementing Classes:

BaseImpl
```
public interface Base
```
After Areas and ChokePoints, Bases are the third kind of object BWEM automatically computes from Brood War's maps. A Base is essentially a suggested location (intended to be optimal) to put a resource depot. It also provides information on the resources available, and some statistics. A Base always belongs to some Area. An Area may contain zero, one or several Bases. Like Areas and ChokePoints, the number and the addresses of Base instances remain unchanged.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Area`	`getArea()` Returns the area in which this base is located.
`java.util.List<Mineral>`	`getBlockingMinerals()` Returns the blocking minerals.
`Position`	`getCenter()` Returns the center position of `getLocation()`.
`java.util.List<Geyser>`	`getGeysers()` Returns the available geysers.
`TilePosition`	`getLocation()` Returns the position (top-left TilePosition) of the location for a resource depot.
`java.util.List<Mineral>`	`getMinerals()` Returns the available minerals.
`boolean`	`isStartingLocation()` Tests whether this base is a start location.

- Method Detail
  - isStartingLocation
```
boolean isStartingLocation()
```
    Tests whether this base is a start location.
    - Note: all players start at locations taken from MapData.getStartingLocations(),
    which doesn't mean all the locations in MapData.getStartingLocations() are actually used.
  - getArea
```
Area getArea()
```
    Returns the area in which this base is located.
  - getLocation
```
TilePosition getLocation()
```
    Returns the position (top-left TilePosition) of the location for a resource depot.
    - Note: If isStartingLocation() == true, it is guaranteed that the location corresponds exactly to one of MapData.getStartingLocations().
  - getCenter
```
Position getCenter()
```
    Returns the center position of getLocation().
  - getMinerals
```
java.util.List<Mineral> getMinerals()
```
    Returns the available minerals.
    - These minerals are assigned to this base (it is guaranteed that no other base provides them).
    - Note: The size of the returned list may decrease, as some of the minerals may get destroyed.
  - getGeysers
```
java.util.List<Geyser> getGeysers()
```
    Returns the available geysers.
    - These geysers are assigned to this Base (it is guaranteed that no other Base provides them).
    - Note: The size of the returned list will NOT decrease, as geysers never get destroyed.
  - getBlockingMinerals
```
java.util.List<Mineral> getBlockingMinerals()
```
    Returns the blocking minerals.
    - These are special minerals. They are placed at or near the resource depot location,
    thus blocking the building of a resource depot from being close to the resources.
    - So, before trying to build a resource depot, these minerals must be gathered first.
    - Fortunately, these are guaranteed to have their initialAmount() <= 8.
    - As an example of blocking minerals, see the two islands in Andromeda.scx.
    - Note: if isStartingLocation() == true, an empty list is returned.
    - Note: getBlockingMinerals() should not be confused with ChokePoint.getBlockingNeutral() and Neutral.isBlocking():
    The last two refer to a Neutral blocking a ChokePoint, not a Base.

Interface Base

Method Summary

Method Detail

isStartingLocation

getArea

getLocation

getCenter

getMinerals

getGeysers

getBlockingMinerals