map_generator.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2022
    by David White <dave@whitevine.net>
    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.
*/

#pragma once

class config;

#include "exceptions.hpp"
#include "map/location.hpp"
#include <optional>

#include <cstdint>

struct mapgen_exception : public game::error
{
    mapgen_exception(const std::string& msg)
    : game::error(msg)
    {}
};

class map_generator
{
public:
    virtual ~map_generator() {}

    /**
     * Returns true if the map generator has an interactive screen,
     * which allows the user to modify how the generator behaves.
     */
    virtual bool allow_user_config() const;

    /**
     * Display the interactive screen, which allows the user
     * to modify how the generator behaves.
     * (This function will not be called if allow_user_config() returns false).
     */
    virtual void user_config();

    /**
     * Returns a string identifying the generator by name.
     * The name should not contain spaces.
     */
    virtual std::string name() const = 0;

    /**
     * Return a friendly name for the generator
     * used to differentiate between different configs of the same generator
     */
    virtual std::string config_name() const = 0;

    /**
     * Creates a new map and returns it.
     * args may contain arguments to the map generator.
     */
    virtual std::string create_map(std::optional<uint32_t> randomseed = {}) = 0;

    virtual config create_scenario(std::optional<uint32_t> randomseed = {});
};