dfhack/plugins/colonies.cpp

#include <dfhack/Core.h>
#include <dfhack/Console.h>
#include <dfhack/Export.h>
#include <dfhack/PluginManager.h>
#include <vector>
#include <string>
#include <dfhack/modules/Vermin.h>

using std::vector;
using std::string;
using namespace DFHack;
#include <DFHack.h>

DFhackCExport command_result colonies (Core * c, vector <string> & parameters);

DFhackCExport const char * plugin_name ( void )
{
    return "colonies";
}

DFhackCExport command_result plugin_init ( Core * c, std::vector <PluginCommand> &commands)
{
    commands.clear();
    commands.push_back(PluginCommand("colonies",
               "List or change wild colonies (ants hills and such)",
                colonies));
    return CR_OK;
}

DFhackCExport command_result plugin_shutdown ( Core * c )
{
    return CR_OK;
}

void destroyColonies(DFHack::SpawnPoints *points);
void convertColonies(DFHack::SpawnPoints *points, DFHack::Materials *Materials);
void showColonies(Core *c, DFHack::SpawnPoints *points,
                  DFHack::Materials *Materials);

DFhackCExport command_result colonies (Core * c, vector <string> & parameters)
{
    bool destroy = false;
    bool convert = false;
    bool help = false;

    for(int i = 0; i < parameters.size();i++)
    {
        if(parameters[i] == "kill")
            destroy = true;
        else if(parameters[i] == "bees")
            convert = true;
        else if(parameters[i] == "help" || parameters[i] == "?")
        {
            help = true;
        }
    }
    if(help)
    {
        c->con.print("Without any options, this command lists all the vermin colonies present.\n"
        "Options:\n"
        "kill   - destroy colonies\n"
        "bees   - turn colonies into honey bees\n"
        );
        return CR_OK;
    }
    if (destroy && convert)
    {
        c->con.printerr("Kill or make bees? DECIDE!\n");
        c->Resume();
        return CR_FAILURE;
    }
    c->Suspend();

    Vermin    * vermin    = c->getVermin();
    Materials * materials = c->getMaterials();

    SpawnPoints *points = vermin->getSpawnPoints();

    if(!points || !points->isValid())
    {
        c->con.printerr("vermin not supported for this DF version\n");
        c->Resume();
        return CR_FAILURE;
    }

    materials->ReadCreatureTypesEx();

    if (destroy)
        destroyColonies(points);
    else if (convert)
        convertColonies(points, materials);
    else
        showColonies(c, points, materials);

    delete points;

    vermin->Finish();
    materials->Finish();

    c->Resume();
    return CR_OK;
}

void destroyColonies(DFHack::SpawnPoints *points)
{
    uint32_t numSpawnPoints = points->size();
    for (uint32_t i = 0; i < numSpawnPoints; i++)
    {
        DFHack::t_spawnPoint sp;
        points->Read(i, sp);

        if (sp.in_use && DFHack::SpawnPoints::isWildColony(sp))
        {
            sp.in_use = false;
            points->Write(i, sp);
        }
    }
}

// Convert all colonies to honey bees.
void convertColonies(DFHack::SpawnPoints *points, DFHack::Materials *Materials)
{
    int bee_idx = -1;
    for (size_t i = 0; i < Materials->raceEx.size(); i++)
        if (Materials->raceEx[i].id == "HONEY_BEE")
        {
            bee_idx = i;
            break;
        }

    if (bee_idx == -1)
    {
        std::cerr << "Honey bees not present in game." << std::endl;
        return;
    }

    uint32_t numSpawnPoints = points->size();
    for (uint32_t i = 0; i < numSpawnPoints; i++)
    {
        DFHack::t_spawnPoint sp;
        points->Read(i, sp);

        if (sp.in_use && DFHack::SpawnPoints::isWildColony(sp))
        {
            sp.race = bee_idx;
            points->Write(i, sp);
        }
    }
}

void showColonies(Core *c, DFHack::SpawnPoints *points,
                  DFHack::Materials *Materials)
{
    uint32_t numSpawnPoints = points->size();
    int      numColonies    = 0;
    for (uint32_t i = 0; i < numSpawnPoints; i++)
    {
        DFHack::t_spawnPoint sp;

        points->Read(i, sp);

        if (sp.in_use && DFHack::SpawnPoints::isWildColony(sp))
        {
            numColonies++;
            string race="(no race)";
            if(sp.race != -1)
                race = Materials->raceEx[sp.race].id;

             c->con.print("Spawn point %u: %s at %d:%d:%d\n", i,
                          race.c_str(), sp.x, sp.y, sp.z);
        }
    }

    if (numColonies == 0)
        c->con << "No colonies present." << std::endl;
}