Steamhammer’s new resource tracking code is short and largely independent of the rest of the program, so I decided to release it for anybody to borrow. If your bot is C++, you should be able to drop this in with little effort (using the results is up to you). If your bot is written in NeverHeardOfItScript, you can at least see how to do it. If you want, you may be able to get resource tracking into your bot before the next Steamhammer release.
ResourceInfo.zip includes ResourceInfo.cpp and its header ResourceInfo.h. The 2 files add up to 163 lines and have no dependencies beyond BWAPI (well, they are in namespace UAlbertaBot, but you can strip that out). One instance of ResourceInfo tracks the last known resource amount of one mineral patch or one geyser (for whatever reason, I chose to implement them both in the same class). I believe it handles all cases correctly. When a mineral patch mines out, its associated mineral patch unit disappears, and the code recognizes the missing patch and sets the amount to 0. A mineral patch that starts with 0 minerals causes no confusion. A geyser changes its unit type when a refinery is built on it, and then the associated unit changes entirely if the refinery is destroyed. The code understands all that. It correctly considers the gas amount inaccessible if there is an enemy refinery (I found a cute way to code it so that undoing the workaround is not a trivial one-line change).
There are different ways to integrate ResourceInfo into a program. In Steamhammer, I put it into the information manager. Here’s the declaration of the data structure to hold all the ResourceInfo instances:
// Track a resource container (mineral patch or geyser) by its initial static unit.
std::map<BWAPI::Unit, ResourceInfo> _resources;
It is a map from the static unit of each mineral patch or geyser to the corresponding ResourceInfo instance. It is initialized once on startup like this:
void InformationManager::initializeResources()
{
for (BWAPI::Unit patch : BWAPI::Broodwar->getStaticMinerals())
{
_resources.insert(std::pair<BWAPI::Unit, ResourceInfo>(patch, ResourceInfo(patch)));
}
for (BWAPI::Unit geyser : BWAPI::Broodwar->getStaticGeysers())
{
_resources.insert(std::pair<BWAPI::Unit, ResourceInfo>(geyser, ResourceInfo(geyser)));
}
}
Keeping separate data structures for minerals and gas would make as much sense, maybe more. Or you could associate each resource container with the base it belongs to, or however you want to organize it. For example, if all you want to know is how many minerals and gas were last known to exist at a given base, then you could give each base a vector of mineral ResourceInfo instances and another vector for gas, with no need for a map to look up individual patches and geysers. Steamhammer’s data structure is essentially global to allow central updating and general-purpose lookup.
Every frame, you have to update the ResourceInfo instances. It’s fast. With separate mineral and gas data structures, this step would be simpler.
// Update any visible mineral patches or vespene geysers with their remaining amounts.
void InformationManager::updateResources()
{
for (BWAPI::Unit patch : BWAPI::Broodwar->getStaticMinerals())
{
auto it = _resources.find(patch);
it->second.updateMinerals();
}
for (BWAPI::Unit geyser : BWAPI::Broodwar->getStaticGeysers())
{
auto it = _resources.find(geyser);
it->second.updateGas();
}
}
With Steamhammer’s _resources map, you look up a resource amount by its initial static unit. If you want error checking, throw instead of returning 0 on error.
// Return the last seen resource amount of a mineral patch or vespene geyser.
// NOTE Pass in the static unit of the resource container, or it won't work.
int InformationManager::getResourceAmount(BWAPI::Unit resource) const
{
auto it = _resources.find(resource);
if (it == _resources.end())
{
return 0;
}
return it->second.getAmount();
}
Each Base remembers its own mineral patches and geysers, and it can add up the values for you. No need to repeat that code. The only other piece is the debug drawing, so you can see what the subsystem knows. Might as well throw that in so you don’t have to write your own. It draws a currently visible resource’s amount in white, and an out-of-view resource’s last known amount in blue (mineral) or green (gas) with the last frame that the resource amount was updated.
void InformationManager::drawResourceAmounts() const
{
const BWAPI::Position offset(-20, -16);
const BWAPI::Position nextLineOffset(-24, -6);
for (const std::pair<BWAPI::Unit, ResourceInfo> & r : _resources)
{
BWAPI::Position xy = r.first->getInitialPosition();
if (r.second.isAccessible())
{
BWAPI::Broodwar->drawTextMap(xy + offset, "%c%d", white, r.second.getAmount());
}
else
{
char color = r.second.isMineralPatch() ? cyan : green;
BWAPI::Broodwar->drawTextMap(xy + offset, "%c%d", color, r.second.getAmount());
BWAPI::Broodwar->drawTextMap(xy + nextLineOffset, "%c@ %d", color, r.second.getFrame());
}
}
}
