src/script/lua_api/l_mapgen.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include "lua_api/l_base.h"
  23
  24 class ModApiMapgen : public ModApiBase
  25 {
  26 private:
  27         // get_biome_id(biomename)
  28         // returns the biome id as used in biomemap and returned by 'get_biome_data()'
  29         static int l_get_biome_id(lua_State *L);
  30
  31         // get_biome_name(biome_id)
  32         // returns the biome name string
  33         static int l_get_biome_name(lua_State *L);
  34
  35         // get_heat(pos)
  36         // returns the heat at the position
  37         static int l_get_heat(lua_State *L);
  38
  39         // get_humidity(pos)
  40         // returns the humidity at the position
  41         static int l_get_humidity(lua_State *L);
  42
  43         // get_biome_data(pos)
  44         // returns a table containing the biome id, heat and humidity at the position
  45         static int l_get_biome_data(lua_State *L);
  46
  47         // get_mapgen_object(objectname)
  48         // returns the requested object used during map generation
  49         static int l_get_mapgen_object(lua_State *L);
  50
  51         // get_spawn_level(x = num, z = num)
  52         static int l_get_spawn_level(lua_State *L);
  53
  54         // get_mapgen_params()
  55         // returns the currently active map generation parameter set
  56         static int l_get_mapgen_params(lua_State *L);
  57
  58         // set_mapgen_params(params)
  59         // set mapgen parameters
  60         static int l_set_mapgen_params(lua_State *L);
  61
  62         // get_mapgen_setting(name)
  63         static int l_get_mapgen_setting(lua_State *L);
  64
  65         // set_mapgen_setting(name, value, override_meta)
  66         static int l_set_mapgen_setting(lua_State *L);
  67
  68         // get_mapgen_setting_noiseparams(name)
  69         static int l_get_mapgen_setting_noiseparams(lua_State *L);
  70
  71         // set_mapgen_setting_noiseparams(name, value, override_meta)
  72         static int l_set_mapgen_setting_noiseparams(lua_State *L);
  73
  74         // set_noiseparam_defaults(name, noiseparams, set_default)
  75         static int l_set_noiseparams(lua_State *L);
  76
  77         // get_noiseparam_defaults(name)
  78         static int l_get_noiseparams(lua_State *L);
  79
  80         // set_gen_notify(flags, {deco_id_table})
  81         static int l_set_gen_notify(lua_State *L);
  82
  83         // get_gen_notify()
  84         static int l_get_gen_notify(lua_State *L);
  85
  86         // get_decoration_id(decoration_name)
  87         // returns the decoration ID as used in gennotify
  88         static int l_get_decoration_id(lua_State *L);
  89
  90         // register_biome({lots of stuff})
  91         static int l_register_biome(lua_State *L);
  92
  93         // register_decoration({lots of stuff})
  94         static int l_register_decoration(lua_State *L);
  95
  96         // register_ore({lots of stuff})
  97         static int l_register_ore(lua_State *L);
  98
  99         // register_schematic({schematic}, replacements={})
 100         static int l_register_schematic(lua_State *L);
 101
 102         // clear_registered_biomes()
 103         static int l_clear_registered_biomes(lua_State *L);
 104
 105         // clear_registered_decorations()
 106         static int l_clear_registered_decorations(lua_State *L);
 107
 108         // clear_registered_schematics()
 109         static int l_clear_registered_schematics(lua_State *L);
 110
 111         // generate_ores(vm, p1, p2)
 112         static int l_generate_ores(lua_State *L);
 113
 114         // generate_decorations(vm, p1, p2)
 115         static int l_generate_decorations(lua_State *L);
 116
 117         // clear_registered_ores
 118         static int l_clear_registered_ores(lua_State *L);
 119
 120         // create_schematic(p1, p2, probability_list, filename)
 121         static int l_create_schematic(lua_State *L);
 122
 123         // place_schematic(p, schematic, rotation,
 124         //     replacements, force_placement, flagstring)
 125         static int l_place_schematic(lua_State *L);
 126
 127         // place_schematic_on_vmanip(vm, p, schematic, rotation,
 128         //     replacements, force_placement, flagstring)
 129         static int l_place_schematic_on_vmanip(lua_State *L);
 130
 131         // serialize_schematic(schematic, format, options={...})
 132         static int l_serialize_schematic(lua_State *L);
 133
 134 public:
 135         static void Initialize(lua_State *L, int top);
 136
 137         static struct EnumString es_BiomeTerrainType[];
 138         static struct EnumString es_DecorationType[];
 139         static struct EnumString es_MapgenObject[];
 140         static struct EnumString es_OreType[];
 141         static struct EnumString es_Rotation[];
 142         static struct EnumString es_SchematicFormatType[];
 143         static struct EnumString es_NodeResolveMethod[];
 144 };