handlers.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2021
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.

    See the COPYING file for more details.
*/

/**
 * @file
 * Define the handlers for the game's events mechanism.
 *
 * Events might be units moving or fighting, or when victory or defeat occurs.
 * A scenario's configuration file will define actions to take when certain events occur.
 * This module is responsible for tracking these definitions.
 */

#pragma once

#include "config.hpp"

#include <string>

class game_data;
class game_lua_kernel;

namespace game_events
{
struct queued_event;

class event_handler
{
public:
    event_handler(config&& cfg, bool is_menu_item, const std::vector<std::string>& types);

    const std::vector<std::string>& names() const
    {
        return types_;
    }

    bool disabled() const
    {
        return disabled_;
    }

    bool is_menu_item() const
    {
        return is_menu_item_;
    }

    /** Flag this handler as disabled. */
    void disable();

    /**
     * Handles the queued event, according to our WML instructions.
     *
     * @param[in]     event_info  Information about the event that needs handling.
     * @param[in]     lk The lua kernel to run the WML command.
     */
    void handle_event(const queued_event& event_info, game_lua_kernel& lk);

    const config& get_config() const
    {
        return cfg_;
    }

private:
    bool first_time_only_;
    bool is_menu_item_;
    bool disabled_;
    config cfg_;
    std::vector<std::string> types_;
};

}