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 typedef u16 biome_t;  // copy from mg_biome.h to avoid an unnecessary include
  25
  26 class ModApiMapgen : public ModApiBase
  27 {
  28 private:
  29         // get_biome_id(biomename)
  30         // returns the biome id as used in biomemap and returned by 'get_biome_data()'
  31         static int l_get_biome_id(lua_State *L);
  32
  33         // get_biome_name(biome_id)
  34         // returns the biome name string
  35         static int l_get_biome_name(lua_State *L);
  36
  37         // get_heat(pos)
  38         // returns the heat at the position
  39         static int l_get_heat(lua_State *L);
  40
  41         // get_humidity(pos)
  42         // returns the humidity at the position
  43         static int l_get_humidity(lua_State *L);
  44
  45         // get_biome_data(pos)
  46         // returns a table containing the biome id, heat and humidity at the position
  47         static int l_get_biome_data(lua_State *L);
  48
  49         // get_mapgen_object(objectname)
  50         // returns the requested object used during map generation
  51         static int l_get_mapgen_object(lua_State *L);
  52
  53         // get_spawn_level(x = num, z = num)
  54         static int l_get_spawn_level(lua_State *L);
  55
  56         // get_mapgen_params()
  57         // returns the currently active map generation parameter set
  58         static int l_get_mapgen_params(lua_State *L);
  59
  60         // set_mapgen_params(params)
  61         // set mapgen parameters
  62         static int l_set_mapgen_params(lua_State *L);
  63
  64         // get_mapgen_setting(name)
  65         static int l_get_mapgen_setting(lua_State *L);
  66
  67         // set_mapgen_setting(name, value, override_meta)
  68         static int l_set_mapgen_setting(lua_State *L);
  69
  70         // get_mapgen_setting_noiseparams(name)
  71         static int l_get_mapgen_setting_noiseparams(lua_State *L);
  72
  73         // set_mapgen_setting_noiseparams(name, value, override_meta)
  74         static int l_set_mapgen_setting_noiseparams(lua_State *L);
  75
  76         // set_noiseparam_defaults(name, noiseparams, set_default)
  77         static int l_set_noiseparams(lua_State *L);
  78
  79         // get_noiseparam_defaults(name)
  80         static int l_get_noiseparams(lua_State *L);
  81
  82         // set_gen_notify(flags, {deco_id_table})
  83         static int l_set_gen_notify(lua_State *L);
  84
  85         // get_gen_notify()
  86         static int l_get_gen_notify(lua_State *L);
  87
  88         // get_decoration_id(decoration_name)
  89         // returns the decoration ID as used in gennotify
  90         static int l_get_decoration_id(lua_State *L);
  91
  92         // register_biome({lots of stuff})
  93         static int l_register_biome(lua_State *L);
  94
  95         // register_decoration({lots of stuff})
  96         static int l_register_decoration(lua_State *L);
  97
  98         // register_ore({lots of stuff})
  99         static int l_register_ore(lua_State *L);
 100
 101         // register_schematic({schematic}, replacements={})
 102         static int l_register_schematic(lua_State *L);
 103
 104         // clear_registered_biomes()
 105         static int l_clear_registered_biomes(lua_State *L);
 106
 107         // clear_registered_decorations()
 108         static int l_clear_registered_decorations(lua_State *L);
 109
 110         // clear_registered_schematics()
 111         static int l_clear_registered_schematics(lua_State *L);
 112
 113         // generate_ores(vm, p1, p2)
 114         static int l_generate_ores(lua_State *L);
 115
 116         // generate_decorations(vm, p1, p2)
 117         static int l_generate_decorations(lua_State *L);
 118
 119         // clear_registered_ores
 120         static int l_clear_registered_ores(lua_State *L);
 121
 122         // create_schematic(p1, p2, probability_list, filename)
 123         static int l_create_schematic(lua_State *L);
 124
 125         // place_schematic(p, schematic, rotation,
 126         //     replacements, force_placement, flagstring)
 127         static int l_place_schematic(lua_State *L);
 128
 129         // place_schematic_on_vmanip(vm, p, schematic, rotation,
 130         //     replacements, force_placement, flagstring)
 131         static int l_place_schematic_on_vmanip(lua_State *L);
 132
 133         // serialize_schematic(schematic, format, options={...})
 134         static int l_serialize_schematic(lua_State *L);
 135
 136         // read_schematic(schematic, options={...})
 137         static int l_read_schematic(lua_State *L);
 138
 139 public:
 140         static void Initialize(lua_State *L, int top);
 141
 142         static struct EnumString es_BiomeTerrainType[];
 143         static struct EnumString es_DecorationType[];
 144         static struct EnumString es_MapgenObject[];
 145         static struct EnumString es_OreType[];
 146         static struct EnumString es_Rotation[];
 147         static struct EnumString es_SchematicFormatType[];
 148         static struct EnumString es_NodeResolveMethod[];
 149 };