Modding:generator API - Revision history

Epyon at 12:33, 11 August 2025

2025-08-11T12:33:46Z

Yaflhdztioxo: moved Modding:Generator API to Modding:generator API

2013-04-25T22:04:28Z

moved Modding:Generator API to Modding:generator API

Shark20061: /* Advanced Cell Handling Functions */ cha -> change

2013-04-25T19:24:43Z

‎Advanced Cell Handling Functions: cha -> change

Shark20061: /* Advanced Cell Handling Functions */ Missed a space.

2013-04-25T19:22:51Z

‎Advanced Cell Handling Functions: Missed a space.

Shark20061: /* Tile Handling Functions */ Missed an open brace.

2013-04-25T19:21:44Z

‎Tile Handling Functions: Missed an open brace.

Shark20061: /* Generator API Function List */ Second setup_explosion_event definition did not have optional brackets around content.

2013-04-25T19:10:45Z

‎Generator API Function List: Second setup_explosion_event definition did not have optional brackets around content.

Shark20061: All functions added, but there are some links needed for translation tables and tiles, so still under construction.

2013-04-25T19:08:29Z

All functions added, but there are some links needed for translation tables and tiles, so still under construction.

Show changes

Shark20061: Adding the rest of the advanced cell functions, still under construction.

2013-04-22T07:23:17Z

Adding the rest of the advanced cell functions, still under construction.

Shark20061: Adding MORE functions. A few fixes. Still under construction

2013-04-21T02:37:55Z

Adding MORE functions. A few fixes. Still under construction

Show changes

Shark20061: Adding more functions. Still under construction.

2013-04-20T23:44:05Z

Adding more functions. Still under construction.

Show changes

@@ 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 298: / Line 298: @@
 :''good'': Only this locations with this cell will be changed by the function.
 :''fill'': The cell to scatter around the area.
-:''count'': The number to attempt to place.  If the chosen location is not ''good'', then it will not cha it.  The final number placed may be less than ''count'' (or even 0), but never more.
+:''count'': The number to attempt to place.  If the chosen location is not ''good'', then it will not change it.  The final number placed may be less than ''count'' (or even 0), but never more.
 ----
 ;{{moddef|desc|scatter_blood|dot||Area|where|CellID|[good]|integer|count}}

@@ Line 289: / Line 289: @@
 :''where'': The starting point.
 :''larea'': The boundaries of the line.  The line will not extend past the edge of the area.
-:''horiz'': ''True''draws along the indicated X position of the ''where'' coordinate.  ''False'' draws along the indicated Y position of the ''where'' coordinate.
+:''horiz'': ''True'' draws along the indicated X position of the ''where'' coordinate.  ''False'' draws along the indicated Y position of the ''where'' coordinate.
 :''cell'': The cell that will be used to split the area.
 :''block'': The cell(s) that block the line plotting.  The drawn line will stop before hitting a coordinate with one of these cells.
@@ Line 326: / Line 326: @@
 :''where'': ''Optional.'' If specified, only cells in the area are changed.  If omitted, the function will change cells across the entire map.
 ----
 === Tile Handling Functions ===
 ;{{moddef|desc|create_translation|dot|Table|Table|code}}

@@ Line 327: / Line 327: @@
 ----
 === Tile Handling Functions ===
-;{moddef|desc|create_translation|dot|Table|Table|code}}
+;{{moddef|desc|create_translation|dot|Table|Table|code}}
 Parses a translation table.  Refer to this (will be linked soon) for more information.
 :''code'': The translation table.
@@ Line 368: / Line 368: @@
 :''code'': The translation table for all the tile possibilities.  Refer to this (will be linked soon) for more information.  All tiles use the same translation table.
 ----
 === Room Handling Functions ===
 ;{{moddef|desc|add_room|dot||Area|room|string|[class]}}

@@ Line 107: / Line 107: @@
    |{{modarg|void}}|{{moddef|list|setup_deadly_air_event|dot||integer|step}}
    |{{modarg|void}}|{{moddef|list|setup_explosion_event|dot||integer|step|integer|size|integer|dice|integer|[content]}}
-{{moddef|list|setup_explosion_event|dot||integer|step|Table|size|integer|dice|integer|content}}
+{{moddef|list|setup_explosion_event|dot||integer|step|Table|size|integer|dice|integer|[content]}}
    |{{modarg|void}}|{{moddef|list|setup_targeted_event|dot||integer|step}}
    |}}

@@ Line 50: / Line 50: @@
    |{{modarg|void}}|{{moddef|list|fill_edges|dot||CellID|what}}
    |{{modarg|Table}}|{{moddef|list|each|dot||CellID|what|Area|[where]}}
    |}}
 |}
@@ Line 196: / Line 208: @@
 :''where'': ''Optional.'' The area to restrict the search to.
 :'''Returns''': A table containing a list of [[Modding:Coord|Coord]] objects.
 ----