map_generator Class Reference

#include <mapgen.hpp>

Inheritance diagram for map_generator:

List of all members.

Public Member Functions
virtual	~map_generator ()
virtual bool	allow_user_config () const =0
	Returns true iff the map generator has an interactive screen, which allows the user to modify how the generator behaves.
virtual void	user_config (display &disp)=0
	Display the interactive screen, which allows the user to modify how the generator behaves.
virtual std::string	name () const =0
	Returns a string identifying the generator by name.
virtual std::string	config_name () const =0
	Return a friendly name for the generator used to differentiate between different configs of the same generator.
virtual std::string	create_map (const std::vector< std::string > &args)=0
	Creates a new map and returns it.
virtual config	create_scenario (const std::vector< std::string > &args)

---

Detailed Description

Definition at line 36 of file mapgen.hpp.

---

Constructor & Destructor Documentation

virtual map_generator::~map_generator

(

)

[inline, virtual]

Definition at line 39 of file mapgen.hpp.

---

Member Function Documentation

virtual bool map_generator::allow_user_config

(

)

const [pure virtual]

Returns true iff the map generator has an interactive screen, which allows the user to modify how the generator behaves.

Implemented in cave_map_generator, and default_map_generator.

Referenced by gui2::teditor_generate_map::do_settings().

Here is the caller graph for this function:

virtual std::string map_generator::config_name

(

)

const [pure virtual]

Return a friendly name for the generator used to differentiate between different configs of the same generator.

Implemented in cave_map_generator, and default_map_generator.

Referenced by gui2::teditor_generate_map::update_current_generator_label().

Here is the caller graph for this function:

virtual std::string map_generator::create_map

(

const std::vector< std::string > &

args

)

[pure virtual]

Creates a new map and returns it.

args may contain arguments to the map generator.

Implemented in cave_map_generator, and default_map_generator.

Referenced by create_scenario(), and editor::context_manager::generate_map_dialog().

Here is the caller graph for this function:

config map_generator::create_scenario

(

const std::vector< std::string > &

args

)

[virtual]

Reimplemented in cave_map_generator, and default_map_generator.

Definition at line 42 of file mapgen.cpp.

References create_map().

Here is the call graph for this function:

virtual std::string map_generator::name

(

)

const [pure virtual]

Returns a string identifying the generator by name.

The name should not contain spaces.

Implemented in cave_map_generator, and default_map_generator.

Referenced by gui2::teditor_generate_map::update_current_generator_label().

Here is the caller graph for this function:

virtual void map_generator::user_config

(

display &

disp

)

[pure virtual]

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).

Implemented in cave_map_generator, and default_map_generator.

Referenced by gui2::teditor_generate_map::do_settings().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• mapgen.hpp
• mapgen.cpp