Function command_result plugin_onstatechange

plugins/examples/skeleton.cpp:106–154

Called to notify the plugin about important state changes. Invoked with DF suspended, and always before the matching plugin_onupdate. More event codes may be added in the future.

// Invoked with DF suspended, and always before the matching plugin_onupdate.
// More event codes may be added in the future.
DFhackCExport command_result plugin_onstatechange(color_ostream &out, state_change_event event) {
    switch (event) {
        case SC_UNKNOWN:
            DEBUG(status,out).print("game state changed: SC_UNKNOWN\n");
            break;
        case SC_WORLD_LOADED:
            DEBUG(status,out).print("game state changed: SC_WORLD_LOADED\n");
            break;
        case SC_WORLD_UNLOADED:
            DEBUG(status,out).print("game state changed: SC_WORLD_UNLOADED\n");
            break;
        case SC_MAP_LOADED:
            DEBUG(status,out).print("game state changed: SC_MAP_LOADED\n");
            break;
        case SC_MAP_UNLOADED:
            DEBUG(status,out).print("game state changed: SC_MAP_UNLOADED\n");
            break;
        case SC_VIEWSCREEN_CHANGED:
        {
            auto vs = Gui::getCurViewscreen(true);
            string name = Core::getInstance().p->readClassName(*(void**)vs);
            if (name.starts_with("viewscreen_"))
                name = name.substr(11, name.size()-11-2);
            else if (dfhack_viewscreen::is_instance(vs)) {
                auto fs = Gui::getFocusStrings(vs);
                if (fs.size())
                    name = fs[0];
            }

            DEBUG(status,out).print("game state changed: SC_VIEWSCREEN_CHANGED ({})\n",
                name.c_str());
            break;
        }
        case SC_CORE_INITIALIZED:
            DEBUG(status,out).print("game state changed: SC_CORE_INITIALIZED\n");
            break;
        case SC_BEGIN_UNLOAD:
            DEBUG(status,out).print("game state changed: SC_BEGIN_UNLOAD\n");
            break;
        case SC_PAUSED:
            DEBUG(status,out).print("game state changed: SC_PAUSED\n");
            break;
        case SC_UNPAUSED:
            DEBUG(status,out).print("game state changed: SC_UNPAUSED\n");
            break;
    }

    return CR_OK;
}

// Whatever you put here will be done in each game tick/frame. Don't abuse it.
// Note that if the plugin implements the enabled API, this function is only called