The Battle for Wesnoth  1.15.2+dev
Public Member Functions | Private Member Functions | Private Attributes | List of all members
mapgen_lua_kernel Class Reference

#include <mapgen_lua_kernel.hpp>

Inheritance diagram for mapgen_lua_kernel:
Inheritance graph

Public Member Functions

 mapgen_lua_kernel (const config *vars)
 
virtual std::string my_name ()
 User-visible name of the lua kernel that they are talking to. More...
 
void user_config (const char *prog, const config &generator)
 
std::string create_map (const char *prog, const config &generator, boost::optional< uint32_t > seed)
 
config create_scenario (const char *prog, const config &generator, boost::optional< uint32_t > seed)
 
virtual uint32_t get_random_seed ()
 
std::mt19937 & get_default_rng ()
 
- Public Member Functions inherited from lua_kernel_base
 lua_kernel_base ()
 
virtual ~lua_kernel_base ()
 
void run_lua_tag (const config &cfg)
 Runs a [lua] tag. More...
 
void run (char const *prog, const std::string &name, int nArgs=0)
 Runs a plain script. More...
 
void throwing_run (char const *prog, const std::string &name, int nArgs, bool in_interpreter=false)
 Runs a plain script, but reports errors by throwing lua_error. More...
 
void interactive_run (char const *prog)
 Tests if a program resolves to an expression, and pretty prints it if it is, otherwise it runs it normally. More...
 
void load_package ()
 Loads the package library into lua environment. More...
 
void load_core ()
 Loads the "core" library into the Lua environment. More...
 
std::vector< std::string > get_global_var_names ()
 Get tab completion strings. More...
 
std::vector< std::string > get_attribute_names (const std::string &var_path)
 Gets all attribute names of an extended variable name. More...
 
const std::stringstream & get_log ()
 Access / manipulate logging of lua kernel activities. More...
 
void add_log (const char *str)
 
void clear_log ()
 
void set_external_log (external_log_type lg)
 
virtual void log_error (char const *msg, char const *context="Lua error")
 Error reporting mechanisms, used by virtual methods protected_call and load_string. More...
 
virtual void throw_exception (char const *msg, char const *context="Lua error")
 
lua_Stateget_state ()
 
void add_widget_definition (const std::string &type, const std::string &id)
 
int intf_show_lua_console (lua_State *L)
 

Private Member Functions

void run_generator (const char *prog, const config &generator)
 
int intf_get_variable (lua_State *L)
 

Private Attributes

boost::optional< uint32_t > random_seed_
 
boost::optional< std::mt19937 > default_rng_
 
const configvars_
 

Additional Inherited Members

- Public Types inherited from lua_kernel_base
using external_log_type = std::function< void(const std::string &)>
 
typedef std::function< void(char const *, char const *)> error_handler
 
- Static Public Member Functions inherited from lua_kernel_base
template<typename T >
static T & get_lua_kernel (lua_State *L)
 
- Protected Member Functions inherited from lua_kernel_base
int intf_print (lua_State *L)
 Replacement print function – instead of printing to std::cout, print to the command log. More...
 
bool protected_call (int nArgs, int nRets, error_handler)
 
bool load_string (char const *prog, const std::string &name, error_handler)
 
virtual bool protected_call (int nArgs, int nRets)
 
virtual bool load_string (char const *prog, const std::string &name)
 
int intf_dofile (lua_State *L)
 Loads and executes a Lua file. More...
 
int intf_require (lua_State *L)
 Loads and executes a Lua file, if there is no corresponding entry in wesnoth.package. More...
 
int intf_kernel_type (lua_State *L)
 
virtual int impl_game_config_get (lua_State *L)
 
virtual int impl_game_config_set (lua_State *L)
 
- Static Protected Member Functions inherited from lua_kernel_base
static bool protected_call (lua_State *L, int nArgs, int nRets, error_handler)
 
- Protected Attributes inherited from lua_kernel_base
lua_StatemState
 
command_log cmd_log_
 

Detailed Description

Definition at line 26 of file mapgen_lua_kernel.hpp.

Constructor & Destructor Documentation

◆ mapgen_lua_kernel()

mapgen_lua_kernel::mapgen_lua_kernel ( const config vars)

Member Function Documentation

◆ create_map()

std::string mapgen_lua_kernel::create_map ( const char *  prog,
const config generator,
boost::optional< uint32_t >  seed 
)

◆ create_scenario()

config mapgen_lua_kernel::create_scenario ( const char *  prog,
const config generator,
boost::optional< uint32_t >  seed 
)

◆ get_default_rng()

std::mt19937 & mapgen_lua_kernel::get_default_rng ( )

Definition at line 311 of file mapgen_lua_kernel.cpp.

References default_rng_, and get_random_seed().

Referenced by my_name().

◆ get_random_seed()

uint32_t mapgen_lua_kernel::get_random_seed ( )
virtual

Reimplemented from lua_kernel_base.

Definition at line 301 of file mapgen_lua_kernel.cpp.

References lua_kernel_base::get_random_seed(), and random_seed_.

Referenced by create_map(), create_scenario(), get_default_rng(), and my_name().

◆ intf_get_variable()

int mapgen_lua_kernel::intf_get_variable ( lua_State L)
private

Definition at line 256 of file mapgen_lua_kernel.cpp.

References luaL_checkstring, luaW_pushvariable(), and vars_.

Referenced by my_name().

◆ my_name()

virtual std::string mapgen_lua_kernel::my_name ( )
inlinevirtual

User-visible name of the lua kernel that they are talking to.

Reimplemented from lua_kernel_base.

Definition at line 30 of file mapgen_lua_kernel.hpp.

References create_map(), create_scenario(), randomness::generator, get_default_rng(), get_random_seed(), intf_get_variable(), run_generator(), and user_config().

◆ run_generator()

void mapgen_lua_kernel::run_generator ( const char *  prog,
const config generator 
)
private

◆ user_config()

void mapgen_lua_kernel::user_config ( const char *  prog,
const config generator 
)

Definition at line 251 of file mapgen_lua_kernel.cpp.

References run_generator().

Referenced by my_name(), and lua_map_generator::user_config().

Member Data Documentation

◆ default_rng_

boost::optional<std::mt19937> mapgen_lua_kernel::default_rng_
private

Definition at line 42 of file mapgen_lua_kernel.hpp.

Referenced by create_map(), create_scenario(), and get_default_rng().

◆ random_seed_

boost::optional<uint32_t> mapgen_lua_kernel::random_seed_
private

Definition at line 41 of file mapgen_lua_kernel.hpp.

Referenced by create_map(), create_scenario(), and get_random_seed().

◆ vars_

const config* mapgen_lua_kernel::vars_
private

Definition at line 43 of file mapgen_lua_kernel.hpp.

Referenced by intf_get_variable().


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