dfhack/plugins/flows.cpp

// This tool counts static tiles and active flows of water and magma.

#include "Core.h"
#include "Console.h"
#include "Export.h"
#include "PluginManager.h"

#include "DataDefs.h"
#include "df/world.h"
#include "df/map_block.h"
#include "df/tile_liquid.h"

using std::string;
using std::vector;
using namespace DFHack;
using namespace df::enums;

DFHACK_PLUGIN("flows");
REQUIRE_GLOBAL(world);

command_result df_flows (color_ostream &out, vector <string> & parameters)
{
    CoreSuspender suspend;

    int flow1 = 0, flow2 = 0, flowboth = 0, water = 0, magma = 0;
    out.print("Counting flows and liquids ...\n");

    for (size_t i = 0; i < world->map.map_blocks.size(); i++)
    {
        df::map_block *cur = world->map.map_blocks[i];
        if (cur->flags.bits.update_liquid)
            flow1++;
        if (cur->flags.bits.update_liquid_twice)
            flow2++;
        if (cur->flags.bits.update_liquid && cur->flags.bits.update_liquid_twice)
            flowboth++;
        for (int x = 0; x < 16; x++)
        {
            for (int y = 0; y < 16; y++)
            {
                // only count tiles with actual liquid in them
                if (cur->designation[x][y].bits.flow_size == 0)
                    continue;
                if (cur->designation[x][y].bits.liquid_type == tile_liquid::Magma)
                    magma++;
                if (cur->designation[x][y].bits.liquid_type == tile_liquid::Water)
                    water++;
            }
        }
    }

    out.print("Blocks with liquid_1=true: %d\n", flow1);
    out.print("Blocks with liquid_2=true: %d\n", flow2);
    out.print("Blocks with both:          %d\n", flowboth);
    out.print("Water tiles:               %d\n", water);
    out.print("Magma tiles:               %d\n", magma);
    return CR_OK;
}

DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
{
    commands.push_back(PluginCommand(
        "flows",
        "Counts map blocks with flowing liquids.",
        df_flows));
    return CR_OK;
}

DFhackCExport command_result plugin_shutdown ( color_ostream &out )
{
    return CR_OK;
}