Modding:generator API (0.9.9.7) - Revision history

Epyon at 12:35, 11 August 2025

2025-08-11T12:35:30Z

Shark20061: Putting in 0997 info

2013-06-10T04:02:13Z

Putting in 0997 info

Show changes

Shark20061: moved Modding:Generator to Modding:generator API (0.9.9.7): Creating a redirect this way

2013-06-10T03:59:32Z

moved Modding:Generator to Modding:generator API (0.9.9.7): Creating a redirect this way

Game Hunter: somehow forgot generate_tiled_dungeon

2012-03-16T04:46:44Z

somehow forgot generate_tiled_dungeon

Game Hunter: blah whatever fixes

2012-01-27T04:30:47Z

blah whatever fixes

Game Hunter: quick fixes

2012-01-27T03:16:00Z

quick fixes

Game Hunter: trying new template

2012-01-27T03:12:28Z

trying new template

Show changes

Game Hunter: added descriptions (valkyrie functions still required)

2012-01-25T21:03:08Z

added descriptions (valkyrie functions still required)

Show changes

Game Hunter: lua functions in list form: descriptions to come

2012-01-25T17:21:27Z

lua functions in list form: descriptions to come

New page

The generator holds all of the ever-present functions used to create the random maps in DoomRL. It also contains a variety of helper functions, many of them useful if not vital to the creation of intricate

== API ==
{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Level Interface'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
|[[Modding:Coord|Coord]]|Generator.[[#generator_safe_empty_coord|safe_empty_coord]]()
|[[Modding:Coord|Coord]]|Generator.[[#generator_standard_empty_coord|standard_empty_coord]]()
|void|Generator.[[#generator_set_permanence|set_permanence]]([[Modding:Area|Area]] ar, '''boolean''' val, [[Modding:Cell|Cell]] tile)
|void|Generator.[[#generator_setup_ice_event|setup_ice_event]]()
|void|Generator.[[#generator_setup_perma_event|setup_perma_event]]()
|void|Generator.[[#generator_setup_alarm_event|setup_alarm_event]]()
|void|Generator.[[#generator_setup_deadly_air_event|setup_deadly_air_event]]()
|void|Generator.[[#generator_setup_nuke_event|setup_nuke_event]]()
|void|Generator.[[#generator_setup_flood_event|setup_flood_event]]()
|integer|Generator.[[#generator_being_weight|being_weight]]()
|integer|Generator.[[#generator_item_amount|item_amount]]()
|void|Generator.[[#generator_restore_walls|restore_walls]]()
|list|Generator.[[#generator_cell_set|cell_set]]('''list''' list)
|void|Generator.[[#generator_horiz_river|horiz_river]]([[Modding:Cell|Cell]] cell, '''integer''' width, '''boolean''' bridge)
|void|Generator.[[#generator_vert_river|vert_river]]([[Modding:Cell|Cell]] cell, '''integer''' width, '''boolean''' bridge, [[Modding:Coord|Coord]] pos)
|void|Generator.[[#generator_generate_rivers|generate_rivers]]('''boolean''' allow_horiz, '''boolean''' allow_more)
|void|Generator.[[#generator_drunkard_walk|drunkard_walk]]([[Modding:Coord|Coord]] start, '''integer''' steps, [[Modding:Cell|Cell]] cell, [[Modding:Cell|Cell]]'''List''' ignore, '''boolean''' break_on_edge)
|void|Generator.[[#generator_drunkard_walks|drunkard_walks]]('''integer''' amount, '''integer''' steps, [[Modding:Cell|Cell]] cell, [[Modding:Cell|Cell]]'''List''' ignore, '''boolean''' break_on_edge, [[Modding:Area|Area]] drunk_area)
|void|Generator.[[#generator_contd_drunkard_walks|contd_drunkard_walks]]('''integer''' amount, '''integer''' steps, [[Modding:Cell|Cell]] cell, [[Modding:Cell|Cell]] edges1, [[Modding:Cell|Cell]] edges2, [[Modding:Cell|Cell]]'''List''' ignore, '''boolean''' break_on_edge)
|void|Generator.[[#generator_plot_lines|plot_lines]]([[Modding:Coord|Coord]] where, [[Modding:Area|Area]] larea, '''boolean''' horiz, [[Modding:Cell|Cell]] cell, [[Modding:Cell|Cell]] block)
|void|Generator.[[#generator_maze_dungeon|maze_dungeon]]([[Modding:Cell|Cell]] floor_cell, [[Modding:Cell|Cell]] wall_cell, '''integer''' granularity, '''integer''' tries, '''integer''' minl, '''integer''' maxl)
|void|Generator.[[#generator_warehouse_fill|warehouse_fill]]([[Modding:Cell|Cell]] wall_cell, [[Modding:Area|Area]] fill_area, '''integer''' box_size, '''integer''' amount)
|void|Generator.[[#generator_add_room|add_room]]()
|boolean|Generator.[[#generator_add_rooms|add_rooms]]()
|[[Modding:Generator|Room]]|Generator.[[#generator_get_room|get_room]]('''integer''' min_size, '''integer''' max_x, '''integer''' max_y)
|void|Generator.[[#generator_generate_tiled|generate_tiled]]()
|void|Generator.[[#generator_generate_warehouse_dungeon|generate_warehouse_dungeon]]()
|void|Generator.[[#generator_generate_tiled_arena_dungeon|generate_tiled_arena_dungeon]]()
|void|Generator.[[#generator_generate_city_dungeon|generate_city_dungeon]]()
|void|Generator.[[#generator_generate_maze_dungeon|generate_maze_dungeon]]()
|void|Generator.[[#generator_generate_archi_dungeon|generate_archi_dungeon]]()
|void|Generator.[[#generator_generate_caves_dungeon|generate_caves_dungeon]]()
|void|Generator.[[#generator_generate_arena_dungeon|generate_arena_dungeon]]()
|void|Generator.[[#generator_generate_fluids|generate_fluids]]([[Modding:Area|Area]] drunk_area)
|void|Generator.[[#generator_generate_barrels|generate_barrels]]()
|void|Generator.[[#generator_generate_stairs|generate_stairs]]()
|void|Generator.[[#generator_generate_special_stairs|generate_special_stairs]]()
|void|Generator.[[#generator_generate_lever_room|generate_lever_room]]()
|void|Generator.[[#generator_generate_teleport_room|generate_teleport_room]]()
|void|Generator.[[#generator_generate_ammo_room|generate_ammo_room]]()
|void|Generator.[[#generator_generate_basain|generate_basain]]()
|void|Generator.[[#generator_generate_warehouse_room|generate_warehouse_room]]()
|void|Generator.[[#generator_generate_vault|generate_vault]]()
|void|Generator.[[#generator_add_room_feature|add_room_feature]]('''boolean''' no_monsters)
|void|Generator.[[#generator_handle_rooms|handle_rooms]]('''boolean''' no_monsters)
|void|Generator.[[#generator_place_player|place_player]]()
|void|Generator.[[#generator_roll_event|roll_event]]()
|void|Generator.[[#generator_reset|reset]]()
|}}
|}

@@ Line 1: / Line 1: @@
 ''This page is currently under construction.''
-The generator holds all of the ever-present functions used to create the random maps in DoomRL. It also contains a variety of helper functions, many of them useful if not vital to the creation of intricate and meticulous game design.
+The generator holds all of the ever-present functions used to create the random maps in DRL. It also contains a variety of helper functions, many of them useful if not vital to the creation of intricate and meticulous game design.
 == API ==
@@ Line 473: / Line 473: @@
 ----
 ;{{moddef|desc|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
-Creates rivers based on normal DoomRL river generation.
+Creates rivers based on normal DRL river generation.
 :''allow_horiz'': ''True'' allows horizontal rivers to be generated.  ''False'' will prevent the generation of horizontal rivers.
 :''allow_more'': ''True'' allows multiple vertical rivers.  ''False'' will prevent more than one vertical river from being placed.
 ----
 ;{{moddef|desc|generate_fluids|dot||Area|[where]}}
-Creates fluids based on normal DoomRL fluid generation.
+Creates fluids based on normal DRL fluid generation.
 :''where'': ''Optional.'' The area to generate fluids in.  If omitted, the area used will be the entire map minus the very edge.
 ----
 ;{{moddef|desc|generate_barrels|dot}}
-Creates barrels based on normal DoomRL barrel generation.
+Creates barrels based on normal DRL barrel generation.
 ----
 ;{{moddef|desc|generate_stairs|dot}}
-Creates the normal staircase based on normal DoomRL stair generation.
+Creates the normal staircase based on normal DRL stair generation.
 ----
 ;{{moddef|desc|generate_special_stairs|dot}}
-Creates the special staircase based on normal DoomRL special stair generation.  Whether a special staircase is placed depends on the level.special_exit value.
+Creates the special staircase based on normal DRL special stair generation.  Whether a special staircase is placed depends on the level.special_exit value.
 ----
 ;{{moddef|desc|place_player|dot}}

@@ Line 36: / Line 36: @@
    |{{modarg|void}}|{{moddef|list|generate_tiled|dot}}
    |{{modarg|void}}|{{moddef|list|generate_warehouse_dungeon|dot}}
    |{{modarg|void}}|{{moddef|list|generate_tiled_arena_dungeon|dot}}
    |{{modarg|void}}|{{moddef|list|generate_city_dungeon|dot}}
@@ Line 144: / Line 145: @@
 ;{{moddef|desc|generate_warehouse_dungeon|dot}}
 :Builds a "warehouse" level. This includes everything necessary to be played as a typical random level.
 ----
 ;{{moddef|desc|generate_tiled_arena_dungeon|dot}}

@@ Line 5: / Line 5: @@
   ! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Level Interface'''
   {{Table2Col
    |es=background: #333;
    |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
    |c2=padding:0px 2px;
@@ Line 28: / Line 28: @@
    |{{modarg|void}}|{{moddef|list|contd_drunkard_walks|dot||integer|amount|integer|steps|Cell|cell|Coord|edges1|Coord|edges2|Cell list|ignore|boolean|break_on_edge}}
    |{{modarg|void}}|{{moddef|list|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|Cell|cell|Cell list|block}}
-   |{{modarg|void}}|{{moddef|list|maze_dungeon|dot|Cell|floor_cell|Cell|wall_cell|integer|granularity|integer|tries|integer|minl|integer|maxl}}
+   |{{modarg|void}}|{{moddef|list|maze_dungeon|dot||Cell|floor_cell|Cell|wall_cell|integer|granularity|integer|tries|integer|minl|integer|maxl}}
    |{{modarg|void}}|{{moddef|list|warehouse_fill|dot||Cell|wall_cell|Area|fill_area|integer|box_size|integer|amount}}
    |{{modarg|void}}|{{moddef|list|warehouse_dungeon|dot}}
@@ Line 121: / Line 121: @@
 :Generates a line of ''cell'' tiles on the map, starting at ''where'' and extending to the boundaries of ''larea''. ''horiz'' set to true will produce horizontal lines: otherwise it will produce vertical lines. If a cell from ''block'' is found, the line will end prematurely at the end on which it was blocked.
 ----
-;{{moddef|desc|maze_dungeon|dot|Cell|floor_cell|Cell|wall_cell|integer|granularity|integer|tries|integer|minl|integer|maxl}}
+;{{moddef|desc|maze_dungeon|dot||Cell|floor_cell|Cell|wall_cell|integer|granularity|integer|tries|integer|minl|integer|maxl}}
 :Generates a map-wide maze, using ''wall_cell'' as the wall tiles and ''floor_cell'' as the floor tiles. Wall corridors are at least ''minl'' tiles apart and at most ''maxl'' tiles apart: ''granularity'' sets a rough complexity of the map. The number of walls attempted to be made is equal to ''tries''.
 ----

@@ Line 66: / Line 66: @@
 :Gives a coordinate that satisfies all empty flags other than EF_NOSAFE.
 ----
-;{{moddef|desc|set_permanence}}|dot||Area|ar|boolean|val|Cell|tile}}
+;{{moddef|desc|set_permanence|dot||Area|ar|boolean|val|Cell|tile}}
 :Adds the "frozen" level event to the map and records it in the mortem history. Levels with the frozen event change all walls into ice walls and all fluids into water.
 ----
@@ Line 76: / Line 76: @@
 ----
 ;{{moddef|desc|setup_alarm_event|dot}}
-:Adds the "alarm" level event to the map and records it in the mortem history. Levels with the alarm event set all non-player beings' [[Modding:Constants|Being Flags|BF_HUNTING]] flag to true.
+:Adds the "alarm" level event to the map and records it in the mortem history. Levels with the alarm event set all non-player beings' [[Modding:Constants#Being Flags|BF_HUNTING]] flag to true.
 ----
 ;{{moddef|desc|setup_deadly_air_event|dot||integer|step}}