DRL Wiki - User contributions [en]

Talk:Modding:Documentation

2013-06-27T21:40:38Z

Shark20061: weighttable page exists, not in main documentation yet. Moved to in progress section.

== 0.9.9.7 Documentation Update Progress ==

Current state of the documentation update:

To anyone who updates the documentation: Please note which pages you are working on or have updated. Thanks! -- [[User:Shark20061|Shark20061]] 21:51, 10 June 2013 (CEST)

=== Pages Updated ===

Place completed pages in this area with your name attached.

=== Pages In Progress ===

*[[Modding:being_API]] (Archived 0.9.9.6- at [[Modding:being_API_(0.9.9.6)]]) (Might be finished but need to check) -- [[User:Shark20061|Shark20061]]
*[[Modding:level_API]] (Archived 0.9.9.6- at [[Modding:level_API_(0.9.9.6)]]) (Still tweaking and fixing) -- [[User:Shark20061|Shark20061]]
*[[Modding:player_API]] (Header info missing, couple fixes left) -- [[User:Shark20061|Shark20061]]
*[[Modding:generator_API]] (Archived 0.9.9.6- at [[Modding:generator_API_(0.9.9.6)]]) (Missing links to weight table and needs constants moved in) -- [[User:Shark20061|Shark20061]]
*[[Modding:weighttable]] -- [[User:Shark20061|Shark20061]]

=== Pages Not Updated ===

*[[Modding:Module]] Last update: 0.9.9.4 (0.9.9.7 changes are in the talk page.)
*[[Modding:Thing]] Last update: 0.9.9.5?
*[[Modding:Item]] Last update: 0.9.9.5 (Should this also be sub-paged by item type?)
*[[Modding:Cell]] Last update: 0.9.9.5?
*[[Modding:Constants]] Last update: Various (Needs to be merged in with the objects/blueprint that they work with.)

=== Pages Without API Changes ===

All need to be split/moved to match new format anyway.
*[[Modding:Missile]] Last update: 0.9.9.6 -> [[Modding:missile]]
*[[Modding:ItemSet]] Last update: 0.9.9.5 -> [[Modding:itemset]]
*[[Modding:ModArray]] Last update: 0.9.9.5 -> [[Modding:modarray]]
*[[Modding:Affects]] Last update: 0.9.9.6 -> [[Modding:affect]]
*[[Modding:Coord]] Last update: 0.9.9.5 -> [[Modding:coord_API]] and [[Modding:coord_object]] OR just [[Modding:coord]]
*[[Modding:Area]] Last update: 0.9.9.5 -> [[Modding:area_API]] and [[Modding:area_object]] OR just [[Modding:area]]
*[[Modding:UI]] Last update: 0.9.9.6 -> [[Modding:ui]]
*[[Modding:Statistics]] Last update: 0.9.9.6 -> [[Modding:statistics]]
*[[Modding:Medal]] Last update: 0.9.9.5 -> [[Modding:medal]]

=== Pages Needed ===

*[[Modding:ai]]
*[[Modding:award]]
*[[Modding:badge]]
*[[Modding:challenge]] (Despite not being useful for modders yet)
*[[Modding:command]]
*[[Modding:core]]
*[[Modding:rankexp]] (Also despite not being useful for modders yet)
*[[Modding:rankskill]] (Again, also despite not being useful for modders yet)
*[[Modding:trait]]

*[[Modding:player_object]]
*[[Modding:blueprint_blueprint]]

=== Pages With Unknown Status ===

*[[Modding:being_blueprint]] Last update: 0.9.9.7
*[[Modding:being_object]] Last update: 0.9.9.7
*[[Modding:level_blueprint]] Last update: 0.9.9.7
*[[Modding:level_object]] Last update: 0.9.9.7
*[[Modding:sID]] Last update: 0.9.9.7

Dodging

2013-06-26T07:30:06Z

Shark20061: Fixed a minor mistake with the calculation.

{{infostrat switch}}
Monsters have a chance of targeting your previous position instead of your current one. The chance of an enemy firing wrong in this way is computed as follows:

(initial chance) + (distance chance)*(distance) + (20 [only if running]) + (bonuses)

Two things grant dodge bonuses:

*The [[hellrunner]] trait adds 15 to your dodge bonus for each rank.
*The assembly [[Tactical armor]] adds 10.

The effects of the dodge bonuses are multiplied together when from different sources. All levels of hellrunner are one source.

This is capped at 95%. If you have [[Dodgemaster]], you always dodge the first projectile per monster per attack. For initial and distance chance, refer to the table below.

{|
|-
! scope="col" | Attack type
! scope="col" | Initial chance (%)
! scope="col" | Distance chance (%)
|-
| scope="row" | [[pistol]]/[[chaingun]]
| 10 || 3
|-
| scope="row" | [[rocket launcher]]1(4)
| 30 || 5
|-
| scope="row" | [[plasma rifle]]
| 30 || 3
|-
| scope="row" | fireball1(1) ([[Imp]])
| 50 || 5
|-
| scope="row" | plasma ball1(1) ([[Cacodemon]])
| 50 || 4
|-
| scope="row" | acid ball1(1) ([[hell knight]])
| 50 || 5
|-
| scope="row" | acid ball1(2) ([[baron of hell]])
| 50 || 3
|-
| scope="row" | plasma burst ([[Arachnotron]])
| 20 || 4
|-
| scope="row" | homing rocket1(1) ,2 ([[Revenant]])
| 30 || 6
|-
| scope="row" | flame wall1(1) ,2 ([[Arch-vile]])
| 10 || 10
|-
| scope="row" | flame burst1(2) ([[Mancubus]])
| 100 || N/A
|}

1: Attack causes splash (radius indicated in parentheses)

2: Attack always lands on targeted tile

Comments:

*If you're moving parallel to the monster's line of fire, none of this matters and the chance of getting hit will depend only on the monster's to-hit chance.
*Mancubi fire three shots: one to each side and directly toward you. The side shots are typically fired in such a way that dodging is often impossible, given that the shots tend to hit anything in their path.
*Revenants and Arch-viles, with the potent combination of homing and splash, are basically guaranteed to damage you. The only means of truly avoiding these attacks is to have the [[Fireangel]] master trait.

Modding:weighttable

2013-06-11T17:13:51Z

Shark20061: Created page with "Weight tables are objects that choose an object from a list at random, using the provided weights as the relative probably for each choice. == Weight Table API == ;{{moddef|des..."

Weight tables are objects that choose an object from a list at random, using the provided weights as the relative probably for each choice.

== Weight Table API ==

;{{moddef|desc|weight_table.new||weight_table}}
Creates a new, empty weight table.
:'''Returns''': A reference to an empty weight table.
----
;{{moddef|desc|add|cln||<any>|object|integer|[weight]}}
Adds an item to the weighttable.
:''object'': The thing to add.
:''weight'': ''Optional.'' The weight to use for this object. If omitted, the object's own weight property will be used, or 1 is used if the object doesn't have a weight property.
----
;{{moddef|desc|size|cln}}
Gets the number of elements in this weight table.
:'''Returns''': The number of elements in the table.
----
;{{moddef|desc|roll|cln}}
Picks an object at random from the table using the indicated weights.
:'''Returns''': An object rolled at random.
----

== Weight Table Object ==

{{drltable|Properties |3|{{Table3Col
|es=background: #333;
|c1=font-family:monospace; text-align:right; vertical-align:top; padding:0px 2px;
|c2=vertical-align:top; padding:0px 2px;
|c3=padding:0px 2px;
|_elements|{{modarg|table}}|The list of elements in the weight table.
|_weights|{{modarg|table}}|The weights of each corresponding element.
|_weight|{{modarg|integer}}|The total weight of all elements in the table.
}}
}}

Talk:Modding:Documentation

2013-06-10T19:52:38Z

Shark20061: Modding:Constants, not Modding:Flags

== 0.9.9.7 Documentation Update Progress ==

Current state of the documentation update:

To anyone who updates the documentation: Please note which pages you are working on or have updated. Thanks! -- [[User:Shark20061|Shark20061]] 21:51, 10 June 2013 (CEST)

=== Pages Updated ===

Place completed pages in this area with your name attached.

=== Pages In Progress ===

*[[Modding:being_API]] (Archived 0.9.9.6- at [[Modding:being_API_(0.9.9.6)]]) (Might be finished but need to check) -- [[User:Shark20061|Shark20061]]
*[[Modding:level_API]] (Archived 0.9.9.6- at [[Modding:level_API_(0.9.9.6)]]) (Still tweaking and fixing) -- [[User:Shark20061|Shark20061]]
*[[Modding:player_API]] (Header info missing, couple fixes left) -- [[User:Shark20061|Shark20061]]
*[[Modding:generator_API]] (Archived 0.9.9.6- at [[Modding:generator_API_(0.9.9.6)]]) (Missing links to weight table and needs constants moved in) -- [[User:Shark20061|Shark20061]]

=== Pages Not Updated ===

*[[Modding:Module]] Last update: 0.9.9.4 (0.9.9.7 changes are in the talk page.)
*[[Modding:Thing]] Last update: 0.9.9.5?
*[[Modding:Item]] Last update: 0.9.9.5 (Should this also be sub-paged by item type?)
*[[Modding:Cell]] Last update: 0.9.9.5?
*[[Modding:Constants]] Last update: Various (Needs to be merged in with the objects/blueprint that they work with.)

=== Pages Without API Changes ===

All need to be split/moved to match new format anyway.
*[[Modding:Missile]] Last update: 0.9.9.6 -> [[Modding:missile]]
*[[Modding:ItemSet]] Last update: 0.9.9.5 -> [[Modding:itemset]]
*[[Modding:ModArray]] Last update: 0.9.9.5 -> [[Modding:modarray]]
*[[Modding:Affects]] Last update: 0.9.9.6 -> [[Modding:affect]]
*[[Modding:Coord]] Last update: 0.9.9.5 -> [[Modding:coord_API]] and [[Modding:coord_object]] OR just [[Modding:coord]]
*[[Modding:Area]] Last update: 0.9.9.5 -> [[Modding:area_API]] and [[Modding:area_object]] OR just [[Modding:area]]
*[[Modding:UI]] Last update: 0.9.9.6 -> [[Modding:ui]]
*[[Modding:Statistics]] Last update: 0.9.9.6 -> [[Modding:statistics]]
*[[Modding:Medal]] Last update: 0.9.9.5 -> [[Modding:medal]]

=== Pages Needed ===

*[[Modding:ai]]
*[[Modding:award]]
*[[Modding:badge]]
*[[Modding:challenge]] (Despite not being useful for modders yet)
*[[Modding:command]]
*[[Modding:core]]
*[[Modding:rankexp]] (Also despite not being useful for modders yet)
*[[Modding:rankskill]] (Again, also despite not being useful for modders yet)
*[[Modding:trait]]

*[[Modding:player_object]]
*[[Modding:blueprint_blueprint]]
*[[Modding:weighttable_object]]

=== Pages With Unknown Status ===

*[[Modding:being_blueprint]] Last update: 0.9.9.7
*[[Modding:being_object]] Last update: 0.9.9.7
*[[Modding:level_blueprint]] Last update: 0.9.9.7
*[[Modding:level_object]] Last update: 0.9.9.7
*[[Modding:sID]] Last update: 0.9.9.7

Talk:Modding:Documentation

2013-06-10T19:51:54Z

Shark20061: Documentation update progress

== 0.9.9.7 Documentation Update Progress ==

Current state of the documentation update:

To anyone who updates the documentation: Please note which pages you are working on or have updated. Thanks! -- [[User:Shark20061|Shark20061]] 21:51, 10 June 2013 (CEST)

=== Pages Updated ===

Place completed pages in this area with your name attached.

=== Pages In Progress ===

*[[Modding:being_API]] (Archived 0.9.9.6- at [[Modding:being_API_(0.9.9.6)]]) (Might be finished but need to check) -- [[User:Shark20061|Shark20061]]
*[[Modding:level_API]] (Archived 0.9.9.6- at [[Modding:level_API_(0.9.9.6)]]) (Still tweaking and fixing) -- [[User:Shark20061|Shark20061]]
*[[Modding:player_API]] (Header info missing, couple fixes left) -- [[User:Shark20061|Shark20061]]
*[[Modding:generator_API]] (Archived 0.9.9.6- at [[Modding:generator_API_(0.9.9.6)]]) (Missing links to weight table and needs constants moved in) -- [[User:Shark20061|Shark20061]]

=== Pages Not Updated ===

*[[Modding:Module]] Last update: 0.9.9.4 (0.9.9.7 changes are in the talk page.)
*[[Modding:Thing]] Last update: 0.9.9.5?
*[[Modding:Item]] Last update: 0.9.9.5 (Should this also be sub-paged by item type?)
*[[Modding:Cell]] Last update: 0.9.9.5?
*[[Modding:Flags]] Last update: Various (Needs to be merged in with the objects/blueprint that they work with.)

=== Pages Without API Changes ===

All need to be split/moved to match new format anyway.
*[[Modding:Missile]] Last update: 0.9.9.6 -> [[Modding:missile]]
*[[Modding:ItemSet]] Last update: 0.9.9.5 -> [[Modding:itemset]]
*[[Modding:ModArray]] Last update: 0.9.9.5 -> [[Modding:modarray]]
*[[Modding:Affects]] Last update: 0.9.9.6 -> [[Modding:affect]]
*[[Modding:Coord]] Last update: 0.9.9.5 -> [[Modding:coord_API]] and [[Modding:coord_object]] OR just [[Modding:coord]]
*[[Modding:Area]] Last update: 0.9.9.5 -> [[Modding:area_API]] and [[Modding:area_object]] OR just [[Modding:area]]
*[[Modding:UI]] Last update: 0.9.9.6 -> [[Modding:ui]]
*[[Modding:Statistics]] Last update: 0.9.9.6 -> [[Modding:statistics]]
*[[Modding:Medal]] Last update: 0.9.9.5 -> [[Modding:medal]]

=== Pages Needed ===

*[[Modding:ai]]
*[[Modding:award]]
*[[Modding:badge]]
*[[Modding:challenge]] (Despite not being useful for modders yet)
*[[Modding:command]]
*[[Modding:core]]
*[[Modding:rankexp]] (Also despite not being useful for modders yet)
*[[Modding:rankskill]] (Again, also despite not being useful for modders yet)
*[[Modding:trait]]

*[[Modding:player_object]]
*[[Modding:blueprint_blueprint]]
*[[Modding:weighttable_object]]

=== Pages With Unknown Status ===

*[[Modding:being_blueprint]] Last update: 0.9.9.7
*[[Modding:being_object]] Last update: 0.9.9.7
*[[Modding:level_blueprint]] Last update: 0.9.9.7
*[[Modding:level_object]] Last update: 0.9.9.7
*[[Modding:sID]] Last update: 0.9.9.7

Modding:level API (0.9.9.7)

2013-06-10T17:59:22Z

Shark20061: col -> cln to match template

''This page is currently under construction.''

{{#sub:{{PAGENAME}}|8|{{#if:{{#pos:{{PAGENAME}}| |8}}|{{#expr:{{#pos:{{PAGENAME}}| |8}} - 7|0}}}}}}

== API ==

Please note that the type "integer" indicates an numeric value without a decimal part. It does not indicate the range of acceptable values.

The argument type "CellID" may be the numeric or string ID of a cell.

The argument type "CellSet" may be the numeric ID, string ID, or a list of numeric and/or string IDs.

The argument types "Flag" and "Flags" expect a single [[Modding:Constants|flag constant]] of the indicated type, and a list of such flag constants, respectively.

The argument type "any" means any lua type.

An argument name in [square brackets] is an optional one. The function description will indicate how the function operates if it is omitted.

=== Table Parameters ===

Some of the functions in the Level API take a parameter in a special table format. Those functions have a parameter type of *ParamTable*. When calling these functions, the keys of the table given as the argument must '''exactly''' match the names given, although they may appear in any order. Details for which keys are looked for are provided in the function's description. Additional keys specified in these tables will be ignored.

=== Level API Function List ===
{|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 - Functions'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
||'''[[#Level Object Functions|Level Object Functions]]'''
|{{modarg|string}}|{{moddef|list|get_id|cln}}
|{{modarg|integer}}|{{moddef|list|get_uid|cln}}
|{{modarg|string}}|{{moddef|list|get_type|cln}}
|{{modarg|Area}}|{{moddef|list|get_area|cln}}
|{{modarg|object}}|{{moddef|list|get_parent|cln}}
|{{modarg|integer}}|{{moddef|list|get_child_count|cln}}
|{{modarg|table}}|{{moddef|list|children|cln||string|filter}}
|{{modarg|table}}|{{moddef|list|children_in_range|cln||Coord|where|integer|range|string|filter}}
|{{modarg|void}}|{{moddef|list|destroy|cln}}
||'''[[#Level Property Functions|Level Property Functions]]'''
|{{modarg|void}}|{{moddef|list|add_property|cln||any|key|any|val}}
|{{modarg|any}}|{{moddef|list|get_property|cln||any|key}}
|{{modarg|boolean}}|{{moddef|list|has_property|cln||any|key}}
|{{modarg|void}}|{{moddef|list|remove_property|cln||any|key}}
|{{modarg|void}}|{{moddef|list|set_property|cln||any|key|any|value}}
||'''[[#Cell Level Functions|Cell Level Functions]]'''
|{{modarg|CellID}}|{{moddef|list|get_cell|cln||Coord|where}}
|{{modarg|integer}}|{{moddef|list|raw_get_cell|cln||integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|set_cell|cln||Coord|where|CellID|what}}
|{{modarg|void}}|{{moddef|list|raw_set_cell|cln||integer|x|integer|y|integer|what}}
|{{modarg|integer}}|{{moddef|list|get_hp|cln||Coord|where}}
|{{modarg|void}}|{{moddef|list|set_hp|cln||Coord|where|integer|new_hp}}
|{{modarg|boolean}}|{{moddef|list|get_light_flag|cln||Flag|what|Coord|[where]}}
|{{modarg|void}}
{{modarg|void}}|{{moddef|list|set_light_flag|cln||Flag|what|boolean|[value]|Coord|[where]}}
{{moddef|list|set_light_flag|cln||Flag|what|boolean|[value]|Area|[where]}}
|{{modarg|boolean}}|{{moddef|list|is_visible|cln||Coord|a}}
|{{modarg|boolean}}|{{moddef|list|eye_contact|cln||Coord|a|Coord|b}}
|{{modarg|boolean}}|{{moddef|list|is_empty|cln||Coord|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|is_empty_area|cln||Area|where|Flags|reqs}}
||'''[[#Being Level Functions|Being Level Functions]]'''
|{{modarg|table}}|{{moddef|list|beings|cln}}
|{{modarg|table}}|{{moddef|list|beings_in_range|cln||Coord|where|integer|range}}
|{{modarg|Being}}|{{moddef|list|get_being|cln||Coord|where}}
|{{modarg|Being}}|{{moddef|list|drop_being|cln||Being|what|Coord|where}}
|{{modarg|void}}|{{moddef|list|drop_being_ext|cln||Being|being|Coord|where}}
|{{modarg|void}}|{{moddef|list|clear_being|cln||Coord|where|boolean|silent}}
|{{modarg|table}}|{{moddef|list|get_being_table|cln||integer|[danger]|table|[weights]|table|[reqs]|integer|[dmod]}}
|{{modarg|void}}|{{moddef|list|flood_monster|cln||*ParamTable*|args}}
|{{modarg|void}}|{{moddef|list|flood_monsters|cln||*ParamTable*|args}}
|{{modarg|BeingID}}|{{moddef|list|roll_being|cln||*ParamTable*|args}}
|{{modarg|void}}|{{moddef|list|summon|cln||BeingID|id|integer|[count]}}
{{moddef|list|summon|cln||*ParamTable*|args}}
||'''[[#Item Level Functions|Item Level Functions]]'''
|{{modarg|table}}|{{moddef|list|items|cln}}
|{{modarg|table}}|{{moddef|list|items_in_range|cln||Coord|where|integer|range}}
|{{modarg|Item}}|{{moddef|list|get_item|cln||Coord|where}}
|{{modarg|Item}}|{{moddef|list|drop_item|cln||string|what|Coord|where|boolean|[onfloor]}}
{{moddef|list|drop_item|cln||table|what|Coord|where|boolean|[onfloor]}}
|{{modarg|void}}|{{moddef|list|drop_item_ext|cln||table|item|Coord|where}}
{{moddef|list|drop_item_ext|cln||string|item|Coord|where}}
|{{modarg|void}}|{{moddef|list|try_destroy_item|cln||Coord|where}}
|{{modarg|table}}|{{moddef|list|get_item_table|cln||integer|[dlevel]|table|[weights]|table|[reqs]}}
|{{modarg|void}}|{{moddef|list|flood_items|cln||integer|amount}}
{{moddef|list|flood_items|cln||*ParamTable*|args}}
|{{modarg|ItemID}}|{{moddef|list|roll_item|cln||*ParamTable*|args}}
|{{modarg|Item}}|{{moddef|list|drop|cln||ItemID|id|integer|[count]}}
|{{modarg|Item}}|{{moddef|list|area_drop|cln||Area|where|ItemID|id|integer|[count]|boolean|[onfloor]}}
||'''[[#Miscellanous Functions|Miscellanous Functions]]'''
|{{modarg|void}}|{{moddef|list|explosion|cln||Coord|where|integer|size|integer|delay|integer|dice|integer|sides|Color|color|SoundID|[sound_id]|DamageType|[type]|ExplosionFlags|[flags]|CellID|[content]}}
|{{modarg|void}}|{{moddef|list|flood|cln||CellID|tile|Area|flood_area}}
|{{modarg|boolean}}|{{moddef|list|is_corpse|cln||Coord|c}}
|{{modarg|void}}|{{moddef|list|nuke|cln}}
|{{modarg|void}}|{{moddef|list|play_sound|cln||SoundID|sound_id|Coord|where}}
|{{modarg|void}}|{{moddef|list|player|cln||integer|x|integer|y}}
|{{modarg|boolean}}|{{moddef|list|push_cell|cln||Coord|c|Coord|target|boolean|[quiet]}}
|{{modarg|void}}|{{moddef|list|recalc_fluids|cln}}
|{{modarg|void}}|{{moddef|list|register_hook|cln||string|hookname|any|func}}
|}}
|}
=== Level Object Functions ===
;{{moddef|desc|get_id|cln|string}}
Gets the ID of the level.
:'''Returns''': The string ID of the level.
----
;{{moddef|desc|get_uid|cln|integer}}
Gets the unique ID (UID) of the level.
:'''Returns''': The numeric ID of the level.
----
;{{moddef|desc|get_type|cln|string}}
Gets the type of this object.
:'''Returns''': The string "level".
----
;{{moddef|desc|get_area|cln|Area}}
Gets the level's entire area.
:'''Returns''': An [[Modding:Area|Area]] object encompassing the entire map.
----
;{{moddef|desc|get_parent|cln|object}}
Gets the parent of this object.
:'''Returns''': Nil. Level has no parent object.
----
;{{moddef|desc|get_child_count|cln|integer}}
Gets the number of children this object is the parent of. All beings and items on the level are children of the level object.
:'''Returns''': Total number of beings and items on the map (being count will include the player).
----
;{{moddef|desc|children|cln}}
Gets a table containing each child object of level. All beings and items on the level are children of the level object.
:'''Returns''': A table of all beings and items on the map.
----
;{{moddef|desc|destroy|cln}}
Destroys the level object. ''You should not call this in your lua script.''
----
=== Level Property Functions ===
;{{moddef|desc|add_property|cln||any|key|any|value}}
Adds a user-defined property to the level object.
:''key'': The value to refer to the property by.
:''value'': The corresponding value of the property.
----
;{{moddef|desc|get_property|cln|any|any|key}}
Retrieves the value of a user-defined property.
:''key'': The property's key value, defined when it was added.
:'''Returns''': The current value of the property.
----
;{{moddef|desc|has_property|cln|boolean|any|key}}
Checks to see if the given property exists.
:''key'': The property key to check for.
:'''Returns''': ''True'' if the property exists, ''False'' if it does not.
----
;{{moddef|desc|remove_property|cln||any|key}}
Removes a property from the level object.
:''key'': The key of the property to remove.
----
;{{moddef|desc|set_property|cln||any|key|any|value}}
Assigns a new value to an existing property.
:''key'': The key of the property to change.
:''value'': The new value to assign to the property.
----
=== Cell Level Functions ===
;{{moddef|desc|get_cell|cln|CellID|Coord|where}}
Gets the cell at a specific map coordinate.
:''where'': The location to get.
:'''Returns''': The ID of the cell at the location.
----
;{{moddef|desc|raw_get_cell|cln|integer|integer|x|integer|y}}
Gets the cell ID at a specific map coordinate.
:''x'': The X position of the coordinate to get.
:''y'': The Y position of the coordinate to get.
:'''Returns''': The numeric ID of the cell at the coordinates.
----
;{{moddef|desc|set_cell|cln||Coord|where|CellID|what}}
Assigns a new cell to a map coordinate.
:''where'': The location to change.
:''what'': The cell to assign to the location.
----
;{{moddef|desc|raw_set_cell|cln||integer|x|integer|y|integer|what}}
Assigns a new cell to a map coordinate.
:''x'': The X position of the location to change.
:''y'': The Y position of the location to change.
:''what'': The numeric ID of the cell to assign.
----
;{{moddef|desc|get_hp|cln|integer|Coord|where}}
Gets the HP of the cell at the specified location.
:''where'': The coordinate to get the HP amount from.
:'''Returns''': The amount of HP the cell has.
----
;{{moddef|desc|set_hp|cln||Coord|where|integer|new_hp}}
Sets the HP of the cell at the specified location.
:''where'': The coordinate to set.
:''new_hp'': The new HP value to set for the coordinate.
----
;{{moddef|desc|get_light_flag|cln|boolean|Flag|what|Coord|where}}
Checks a cell for a certain light flag.
:''what'': The LightFlag (named constant that starts with LF) to check for. Refer to [[Modding:Constants#Light Flag|this]] for more info.
:''where'': The location to check.
:'''Returns''': ''True'' if the flag is set. ''False'' if it is not.
----
;{{moddef|desc|set_light_flag|cln||Flag|what|boolean|[value]|Coord|[where]}}
;{{moddef|desc|set_light_flag|cln||Flag|what|boolean|[value]|Area|[where]}}
Sets or unsets a LightFlag at a specified location or specified locations.
:''what'': The LightFlag (named constant that starts with LF) to check for. Refer to [[Modding:Constants#Light Flag|this]] for more info.
:''value'': ''Optional.'' ''True'' to set the flag, ''False'' to unset it. If omitted, the default is to set the flag.
:''where'': ''Optional.'' The coordinate or area to change. If an area is supplied, all cells in the area will have the flag set or unset. If omitted, the entire map will have the flag set or unset.
----
;{{moddef|desc|is_visible|cln|boolean|Coord|a}}
Determines if the player can see this space.
:''a'': The space to check.
:'''Returns''': ''True'' if the player can see it, ''False'' if the player cannot.
----
;{{moddef|desc|eye_contact|cln|boolean|Coord|a|Coord|b}}
Checks to see if two spaces can see each other. This check uses the monster vision algorithm, which is stricter than the player's vision algorithm.
:''a'': The first space to check.
:''b'': The second space to check.
:'''Returns''': ''True'' if the spaces are visible to each other, ''False'' if not.
----
;{{moddef|desc|is_empty|cln|boolean|Coord|where|Flags|reqs}}
Checks to see if the indicated cell is "empty", defining "empty" based on a list of criteria.
:''where'': The position to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the position cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the map position does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if the cell satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|is_empty_area|cln|boolean|Area|where|Flags|reqs}}
Checks to see if the indicated area is "empty", defining "empty" based on a list of criteria.
:''where'': The area to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the area cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the area does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if every cell in the area satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
=== Being Level Functions ===
;{{moddef|desc|beings|cln|table}}
Gets a table containing all of the beings on the level.
:'''Returns''': A table containing all beings on the level.
----
;{{moddef|desc|beings_in_range|cln|table|Coord|where|integer|range}}
Gets a table containing all of the beings within a certain distance of a location.
:''where'': The location to search around.
:''range'': The distance away from the location to get beings from.
:'''Returns''': A table containing the beings close enough to the location specified.
----
;{{moddef|desc|get_being|cln|Being|Coord|where}}
Gets the being at the specified coordinate.
:''where'': The location to get the being from.
:'''Returns''': The being at the location.
----
;{{moddef|desc|drop_being|cln|Being|BeingID|what|Coord|where}}
Places a being on the map.
:''what'': The id of the being to place.
:''where'': The location to attempt to drop the being. If there is already a being at that location, the being will be dropped nearby.
:'''Returns''': A reference to the being dropped.
----
;{{moddef|desc|drop_being_ext|cln||BeingID|being|Coord|where}}
Places a being on the map with modifications.
:''being'': A BeingID, or a table whose first field is a BeingID, followed by the changes to the beings properties in the form ''field = new_value''.
:''where'': The location to attempt to drop the being. If there is already a being at that location, the being will be dropped nearby.
----
;{{moddef|desc|clear_being|cln||Coord|where|boolean|silent}}
Removes a being from the map.
:''where'': The location to remove the being from.
:''silent'': If ''true'', the being will be removed without making any sounds or causing any messages. If ''false'', the being will act as though they were killed (complete with message and sound).
----
;{{moddef|desc|get_being_table|cln|table|integer|[dlevel]|table|[weights]|table|[reqs]|integer|[dmod]}}
Gets a weight table for beings and being groups, using the indicated criteria.
:''dlevel'': ''Optional.'' The depth to pull the list of beings for. Only beings and groups that have an equal or smaller min_level and an equal or larger max_level will be selected. The ''dmod'' parameter also modifies which beings will be picked. If omitted, the current danger level (which is usually the current depth) is used.
:''weights'': ''Optional.'' A table containing modifiers to weights. The keys of the table are ids, flags, or blueprint fields to look for. For example, "former" will match the being with the id "former" (that is, Former Humans). Suppling a being flag (such as BF_BOSS or BF_ENVIROSAFE) will look for that flag in the being prototype's flag list. Suppling a blueprint field will match all beings that have that field in their blueprint table, provided that the value of the field isn't ''nil'', ''false'', or 0. Each matched being will have its weight multiplied by the value supplied for that key. For example, <tt>"former" = 2</tt> will double the weight value of Former Humans, while <tt>"former" = 0.5</tt> will halve it. If a being matches multiple entries, all are applied. (for example, the table {BF_ENVIROSAFE = 2, "pain" = 2} will match Pain Elementals twice -- since both apply a double modifier to weight, Pain Elementals will now have 4 times the weight.) If omitted, no modifications are made to weights.
:''reqs'': ''Optional.'' A table containing requirements to check for. Only beings that meet all of the requirements will be included in the resulting weight table. The keys of the table are blueprint fields that must be matched. The value for each key in the table is either a single value, which only beings whose blueprint field key has the value supplied will match, or a table of values, which will match beings that have one or more of the supplied values if the value of the blueprint field isn't a table itself, or all of the values if it is. For example, if the reqs table is <tt>{ id = "former" }</tt> , it will match Former Human (since its id is "former"). If the reqs table has <tt>{ id = {"former", "sergeant", "captain" } }</tt>, Former Human, Former Sergeant, and Former Captain will be matched. If the reqs table has <tt>{ flags = { BF_BOSS, BF_ENVIROSAFE } }</tt>, this will return all the beings with both the enviro-safe flag and the boss flag (since the flags blueprint field is a table itself). If omitted, no beings or groups are excluded (aside from those already excluded by the dlevel and dmod parameters).
:''dmod'': The current dlevel is adjusted by the value here for the min_level check. This allows beings with a higher min_level to be selected on an earlier depth (if positive), or exclude beings with a higher min_level for extra levels (if negative). In other words, this enables monsters to spawn "out of depth". If omitted, the default is 3 if difficulty is medium (HMP), 6 if difficulty is hard or very hard (UV and N!), and 0 otherwise.
:'''Returns''': A weight table object.
----
;{{moddef|desc|flood_monster|cln||*ParamTable*|args}}
Places one or more of a single type of monster on the level.
:''args'': A table that looks for the following keys:
::''id'': The ID of the being to place.
::''danger'': The total amount of danger points worth of this monster to place. This field is optional if ''count'' is set. If both ''danger'' and ''count'' are set, the function will stop placing monsters when either ''danger'' or ''count'' is reached.
::''count'': The number of monsters to place. This field is optional if ''danger'' is set. If both ''danger'' and ''count'' are set, the function will stop placing monsters when either ''danger'' or ''count'' is reached.
::''flags'': ''Optional.'' A list of [[Modding:Constants#Empty_flags|EmptyFlags]] that determines where monsters are allowed to be placed. If omitted, the default list is { EF_NOBEINGS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN }.
----
;{{moddef|desc|flood_monsters|cln||*ParamTable*|args}}
Places monsters on the level.
:''args'': A table that looks for the following keys:
::''danger'': The total amount of danger points worth of monsters to place. This field is optional if ''amount'' is set. If both ''danger'' and ''amount'' are set, the function will stop placing monsters when either ''danger'' or ''amount'' is reached.
::''amount'': The number of monsters to place. This field is optional if ''danger'' is set. If both ''danger'' and ''amount'' are set, the function will stop placing monsters when either ''danger'' or ''amount'' is reached.
::''flags'': ''Optional.'' A list of [[Modding:Constants#Empty_flags|EmptyFlags]] that determines where monsters are allowed to be placed. If omitted, the default list is { EF_NOBEINGS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN }.
::''reqs'': ''Optional.'' See get_being_table for more info about this parameter.
----
;{{moddef|desc|roll_being|cln|BeingID|*ParamTable*|args}}
Picks an ID for a being out of a list.
:''args'': A table that looks for the following keys:
::''list'': A table with BeingIDs as keys and the weight for the being as the value. If this key is supplied, all other keys are ignored.
:: These next 4 keys create a being list using ''get_being_table'' if the ''list'' parameter is omitted. The ID will be selected from the resulting weight table. It will not pick a group.
::''level'': See the ''danger'' parameter for ''get_being_table''.
::''weights'': See the ''weights'' parameter for ''get_being_table''.
::''diffmod'': See the ''dmod'' parameter for ''get_being_table''.
::''reqs'': See the ''reqs'' parameter for ''get_being_table''.
----
;{{moddef|desc|summon|cln||BeingID|id|integer|[count]}}
Places a given number of a single being onto the map.
:''id'': The ID of the being to place.
:''count'': ''Optional.'' The number of that being to place. If omitted, only one being will be placed.
----
;{{moddef|desc|summon|cln||*ParamTable*|args}}
Places a given number of a single being onto the map.
:''args'': A table that looks for the following keys:
::''id'': The ID of the being to place.
::''count'': ''Optional.'' The number of that being to place. If omitted, only one being will be placed.
::''cell'': ''Optional.'' A cell or set of cells that are valid locations for placement of the being(s). If omitted, the beings can be placed on any cell.
::''area'': ''Optional.'' The area the beings can spawn in. If omitted, the area used is the entire map.
::''empty'': ''Optional.'' A list of [[Modding:Constants#Empty_flags|EmptyFlags]] that determines where monsters are allowed to be placed. If omitted, the default list is { EF_NOBEINGS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN } if ''cell'' is omitted, and { EF_NOBEINGS, EF_NOBLOCK } if ''cell'' is supplied.
----
=== Item Level Functions ===
;{{moddef|desc|items|cln|table}}
Gets a table containing all of the items on the level.
:'''Returns''': A table containing all items on the level.
----
;{{moddef|desc|items_in_range|cln|table|Coord|where|integer|range}}
Gets a table containing all of the items within a certain distance of a location.
:''where'': The location to search around.
:''range'': The distance away from the location to search around.
:'''Returns''': A table containing all of the items within range of the location.
----
;{{moddef|desc|get_item|cln|Item|Coord|where}}
Gets the item at a location.
:''where'': The location to retrieve the item from.
:'''Returns''': A reference to the Item at the location.
----
;{{moddef|desc|drop_item|cln|Item|string|what|Coord|where|boolean|[onfloor]}}
;{{moddef|desc|drop_item|cln|Item|Item|what|Coord|where|boolean|[onfloor]}}
Places an item on the map.
:''what'': The item to place. Either a string containing the ID of the item or a table representing an existing item.
:''where'': The location to place the item. If occupied, the nearest available location will be chosen.
:''onfloor'': ''Optional.'' If true, will apply the difficulty modifier to an ammo item that is placed. If false, the ammo item is placed with the given amount of ammo. If omitted, the default is false. This argument has no effect on non-ammo items.
:'''Returns''': A reference to the dropped item.
----
;{{moddef|desc|drop_item_ext|cln||table|item|Coord|where}}
;{{moddef|desc|drop_item_ext|cln||string|item|Coord|where}}
Places an item with modifications on the map.
:''what'': The item to place. Either a string containing the ID of the item or a table with the ItemID string as it's first value, followed by a table containing entries in the form of <tt>"item_property" = new_value</tt> as the second value.
:''where'': The location to place the item at. If occupied, the nearest available location will be chosen.
----
;{{moddef|desc|try_destroy_item|cln||Coord|where}}
Attempts to destroy the item in a specified location. This function will not destroy the item if the item has the flag IF_NODESTROY or IF_UNIQUE. To guarantee destruction of an item, call the item's :destroy() method.
:''where'': The location of the item to try to destroy.
----
;{{moddef|desc|get_item_table|cln|table|integer|[dlevel]|table|[weights]|table|[reqs]}}
Gets a weight table for items, using the indicated criteria.
:''dlevel'': ''Optional.'' The depth to pull the list of items for. If omitted, the value in ''level.danger_level'' is used.
:''weights'': ''Optional.'' A table containing modifiers to weights. The keys of the table are ids, flags, or blueprint fields to look for. For example, "smed" will match Small Med-Packs. Suppling an item flag (such as IF_UNIQUE or IF_SHOTGUN, or an ITEMTYPE value) will look for that flag in the item prototype's flag list. Suppling a blueprint field will match all items that have that field in their blueprint table, provided that the value isn't ''nil'', ''false'', or 0. Each matched item will have its weight multiplied by the value supplied for that key. For example, <tt>"smed" = 2</tt> will double the weight of Small Med-Packs, while <tt>"smed" = 0.5</tt> will halve it. If an item matches multiple entries, all are applied. (For example, the table {IF_UNIQUE = 2, "uberarmor" = 2} will match Berserker Armor twice -- since both apply a double modifier to weight, Berserker Armor would have 4 times the weight.) If omitted, no modifications are made to weights.
:''reqs'': ''Optional.'' A table containing requirements to check for. Only items that meet all of the requirements will be included in the resulting weight table. The keys of the table are blueprint fields that must be matched. The value for each key in the table is either a single value, which only items whose blueprint field key has the value supplied will match, or a table of values, which will match items that have one or more of the supplied values if the value of the blueprint field isn't a table itself, or all of the values if it is. For example, if the reqs table is <tt>{ id = "smed" }</tt>, it will match Small Med-Packs (since its id is "smed"). If the reqs table has <tt>{ id = {"smed", "lmed", "phase", "hphase" }</tt>, it will match Small Med-Packs, Large Med-Packs, Phase Devices, and Homing Phase Devices. If the reqs table has <tt>{ flags = {IF_UNIQUE, IF_SHOTGUN} }</tt>, this will match all unique shotguns (since the flags blueprint field is a table itself). If omitted, no items are excluded (aside from those already excluded by other factors, such as the ''dlevel'' parameter).
::NOTE: This function has a hidden limitation when trying to generate exotics and uniques. The function will not pick exotics if the ''danger_level'' of the level is less then the current difficulty (where ITYTD = 1 and N! = 5). The function will not pick uniques if the ''danger_level'' of the level is less than 3 more than the current difficulty (where ITYTD = 1 and N! = 5). If you need to generate exotics or uniques before the indicated ''danger_level'', you can add the needed items to the resulting table yourself using the <tt>:add(<object>)</tt> method on the returned weight table object. Other functions that use this function (such as ''flood_items'' and ''roll_item'') will also have this behavior.
:'''Returns''': A weight table object.
----
;{{moddef|desc|flood_items|cln||integer|amount}}
Places several different items on the level, using the default criteria.
:''amount'': The number of items to place on the level.
----
;{{moddef|desc|flood_items|cln||*ParamTable*|args}}
Places several different items on the level, using specific criteria.
:''args'': A table that looks for the following keys:
::''amount'': The number of items to place on the level.
::''level'', ''weights'', ''reqs'': ''All optional.'' See the ''get_item_table'' function for more info.
----
;{{moddef|desc|roll_item|cln||*ParamTable*|args}}
Picks an item at random using specified criteria.
:''args'': A table that looks for the following keys:
::''level'': ''Optional.'' Sent to ''get_item_table'' as the ''dlevel'' parameter. Refer to ''get_item_table'' for more info.
::''type'': ''Optional.'' A table containing one or more ITEMTYPE values. If supplied, only items that have one of the indicated types will be selected. If omitted, any item type can be picked.
::''weights'': ''Optional.'' Sent to ''get_item_table'' as the ''weights'' parameter. Refer to ''get_item_table'' for more info.
::''reqs'': ''Optional.'' Sent to ''get_item_table'' as the ''reqs'' parameter. Refer to ''get_item_table'' for more info.
::''unique_mod'': ''Optional.'' A multiplier to the weights of all unique items. If omitted, 1 is used.
::''exotic_mod'': ''Optional.'' A multiplier to the weights of all exotic items. If omitted, 1 is used.
::''special_mod'': ''Optional.'' A multiplier to the weights of all exotic and unique items. Combines with ''unique_mod'' and ''exotic_mod''. If omitted, 1 is used.
:'''Returns''': The ID of the rolled item.
----
;{{moddef|desc|drop|cln|Item|ItemID|id|integer|[count]}}
Places one or more of a specific item on the map.
:''id'': The ID of the item to place.
:''count'': ''Optional.'' The number of the item to place. If omitted, only 1 item will be placed.
:'''Returns''': A reference to the last item placed.
----
;{{moddef|desc|area_drop|cln|Item|Area|where|ItemID|id|integer|[count]|boolean|[onfloor]}}
Places one or more of a specific item on the map in an area.
:''where'': The area to confine the item drops to.
:''id'': The Id of the item to place.
:''count'': ''Optional.'' The number of the item to place. If omitted, only 1 item will be placed.
:''onfloor'': ''Optional.'' If true, will apply the difficulty modifier to an ammo item that is placed. If false, the ammo item is placed with the given amount of ammo. If omitted, the default is false. This argument has no effect on non-ammo items.
:'''Returns''': A reference to the last item placed.
=== Miscellanous Functions ===
;{{moddef|desc|explosion|cln||Coord|where|integer|size|integer|delay|integer|dice|integer|sides|Color|color|SoundID|[sound_id]|DamageType|[type]|ExplosionFlags|[flags]|CellID|[content]}}
Creates an explosion on the map.
:''where'': The location for the center of the explosion.
:''size'': The size of the explosion. If greater than 8, the explosion will be visible in all cells, including cells that are not currently in the player's vision.
:''delay'': The amount of time (in milliseconds) that each step of the explosion will take.
:''dice'': The number of dice to use for the damage. Enter 0 to prevent the explosion from dealing damage (for decoration explosions).
:''sides'': The number of sides for each die to use for the damage. Enter 0 to prevent the explosion from dealing damage (for decoration explosions).
:''color'': ''Optional.'' The color of the explosion. Not all colors will show. If omitted, a RED explosion will be used.
:''sound_id'': ''Optional.'' The ID of the sound to use for this explosion. If omitted, no sound is used.
:''type'': ''Optional.'' The type of damage this explosion deals. If omitted, the default is DAMAGE_FIRE.
:''flags'': ''Optional.'' A list of ExplosionFlags that will modify what the explosion applies to or how it applies. If omitted, no modifications are made to the explosion.
:''content'': ''Optional.'' The cell to fill cells in the explosion area with if the explosion hits a cell for more than 20 damage. If omitted, cells will not changed.
----
;{{moddef|desc|flood|cln||CellID|tile|Area|flood_area}}
Replaces non-wall tiles in an area with a different tile.
:''tile'': The cell to fill with. This does not have to be a fluid cell.
:''flood_area'': The area to fill.
----
;{{moddef|desc|is_corpse|cln|boolean|Coord|c}}
Indicates if a coordinate has a corpse cell or not.
:''c'': The location to check.
:'''Returns''': ''True'' if the coordinate is a corpse, ''False'' if it is not.
----
;{{moddef|desc|nuke|cln}}
Instantly nukes a level.
----
;{{moddef|desc|play_sound|cln||SoundID|sound_id|Coord|where}}
Plays a sound on the map.
:''sound_id'': The id of the sound to play.
:''where'': The location to play the sound at.
----
;{{moddef|desc|player|cln||integer|x|integer|y}}
Set the position of the player on the map.
:''x'': The x coordinate of the position to move the player to.
:''y'': The y coordinate of the position to move the player to.
----
;{{moddef|desc|push_cell|cln||Coord|c|Coord|target|boolean|[quiet]}}
Attempts to move a cell to a new location. (Swaps two cells.)
:''c'': The source coordinate.
:''target'': The destination coordinate.
:''quiet'': ''Optional.'' If ''True'', messages about success or failure as well as sounds that would play on success or failure are all suppressed. If ''False'', sounds and messages will happen as it would normally. If omitted, the default is ''False''.
----
;{{moddef|desc|recalc_fluids|cln}}
Recalculates fluid edges.
----
;{{moddef|desc|register_hook|cln||string|hookname|<any>|func}}
Registers a hook with this object.
:''hookname'': The name of the hook to register.
:''func'': The function to assign to the hook.
----

Modding:level API (0.9.9.7)

2013-06-10T17:59:03Z

Shark20061: col -> cln to match template

''This page is currently under construction.''

{{#sub:{{PAGENAME}}|8|{{#if:{{#pos:{{PAGENAME}}| |8}}|{{#expr:{{#pos:{{PAGENAME}}| |8}} - 7|0}}}}}}

== API ==

Please note that the type "integer" indicates an numeric value without a decimal part. It does not indicate the range of acceptable values.

The argument type "CellID" may be the numeric or string ID of a cell.

The argument type "CellSet" may be the numeric ID, string ID, or a list of numeric and/or string IDs.

The argument types "Flag" and "Flags" expect a single [[Modding:Constants|flag constant]] of the indicated type, and a list of such flag constants, respectively.

The argument type "any" means any lua type.

An argument name in [square brackets] is an optional one. The function description will indicate how the function operates if it is omitted.

=== Table Parameters ===

Some of the functions in the Level API take a parameter in a special table format. Those functions have a parameter type of *ParamTable*. When calling these functions, the keys of the table given as the argument must '''exactly''' match the names given, although they may appear in any order. Details for which keys are looked for are provided in the function's description. Additional keys specified in these tables will be ignored.

=== Level API Function List ===
{|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 - Functions'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
||'''[[#Level Object Functions|Level Object Functions]]'''
|{{modarg|string}}|{{moddef|list|get_id|cln}}
|{{modarg|integer}}|{{moddef|list|get_uid|cln}}
|{{modarg|string}}|{{moddef|list|get_type|cln}}
|{{modarg|Area}}|{{moddef|list|get_area|cln}}
|{{modarg|object}}|{{moddef|list|get_parent|cln}}
|{{modarg|integer}}|{{moddef|list|get_child_count|cln}}
|{{modarg|table}}|{{moddef|list|children|cln||string|filter}}
|{{modarg|table}}|{{moddef|list|children_in_range|cln||Coord|where|integer|range|string|filter}}
|{{modarg|void}}|{{moddef|list|destroy|cln}}
||'''[[#Level Property Functions|Level Property Functions]]'''
|{{modarg|void}}|{{moddef|list|add_property|cln||any|key|any|val}}
|{{modarg|any}}|{{moddef|list|get_property|cln||any|key}}
|{{modarg|boolean}}|{{moddef|list|has_property|cln||any|key}}
|{{modarg|void}}|{{moddef|list|remove_property|cln||any|key}}
|{{modarg|void}}|{{moddef|list|set_property|cln||any|key|any|value}}
||'''[[#Cell Level Functions|Cell Level Functions]]'''
|{{modarg|CellID}}|{{moddef|list|get_cell|cln||Coord|where}}
|{{modarg|integer}}|{{moddef|list|raw_get_cell|cln||integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|set_cell|cln||Coord|where|CellID|what}}
|{{modarg|void}}|{{moddef|list|raw_set_cell|cln||integer|x|integer|y|integer|what}}
|{{modarg|integer}}|{{moddef|list|get_hp|cln||Coord|where}}
|{{modarg|void}}|{{moddef|list|set_hp|cln||Coord|where|integer|new_hp}}
|{{modarg|boolean}}|{{moddef|list|get_light_flag|cln||Flag|what|Coord|[where]}}
|{{modarg|void}}
{{modarg|void}}|{{moddef|list|set_light_flag|cln||Flag|what|boolean|[value]|Coord|[where]}}
{{moddef|list|set_light_flag|cln||Flag|what|boolean|[value]|Area|[where]}}
|{{modarg|boolean}}|{{moddef|list|is_visible|cln||Coord|a}}
|{{modarg|boolean}}|{{moddef|list|eye_contact|cln||Coord|a|Coord|b}}
|{{modarg|boolean}}|{{moddef|list|is_empty|cln||Coord|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|is_empty_area|cln||Area|where|Flags|reqs}}
||'''[[#Being Level Functions|Being Level Functions]]'''
|{{modarg|table}}|{{moddef|list|beings|cln}}
|{{modarg|table}}|{{moddef|list|beings_in_range|cln||Coord|where|integer|range}}
|{{modarg|Being}}|{{moddef|list|get_being|cln||Coord|where}}
|{{modarg|Being}}|{{moddef|list|drop_being|cln||Being|what|Coord|where}}
|{{modarg|void}}|{{moddef|list|drop_being_ext|cln||Being|being|Coord|where}}
|{{modarg|void}}|{{moddef|list|clear_being|cln||Coord|where|boolean|silent}}
|{{modarg|table}}|{{moddef|list|get_being_table|cln||integer|[danger]|table|[weights]|table|[reqs]|integer|[dmod]}}
|{{modarg|void}}|{{moddef|list|flood_monster|cln||*ParamTable*|args}}
|{{modarg|void}}|{{moddef|list|flood_monsters|cln||*ParamTable*|args}}
|{{modarg|BeingID}}|{{moddef|list|roll_being|cln||*ParamTable*|args}}
|{{modarg|void}}|{{moddef|list|summon|cln||BeingID|id|integer|[count]}}
{{moddef|list|summon|cln||*ParamTable*|args}}
||'''[[#Item Level Functions|Item Level Functions]]'''
|{{modarg|table}}|{{moddef|list|items|cln}}
|{{modarg|table}}|{{moddef|list|items_in_range|cln||Coord|where|integer|range}}
|{{modarg|Item}}|{{moddef|list|get_item|cln||Coord|where}}
|{{modarg|Item}}|{{moddef|list|drop_item|cln||string|what|Coord|where|boolean|[onfloor]}}
{{moddef|list|drop_item|cln||table|what|Coord|where|boolean|[onfloor]}}
|{{modarg|void}}|{{moddef|list|drop_item_ext|cln||table|item|Coord|where}}
{{moddef|list|drop_item_ext|cln||string|item|Coord|where}}
|{{modarg|void}}|{{moddef|list|try_destroy_item|cln||Coord|where}}
|{{modarg|table}}|{{moddef|list|get_item_table|cln||integer|[dlevel]|table|[weights]|table|[reqs]}}
|{{modarg|void}}|{{moddef|list|flood_items|cln||integer|amount}}
{{moddef|list|flood_items|cln||*ParamTable*|args}}
|{{modarg|ItemID}}|{{moddef|list|roll_item|cln||*ParamTable*|args}}
|{{modarg|Item}}|{{moddef|list|drop|cln||ItemID|id|integer|[count]}}
|{{modarg|Item}}|{{moddef|list|area_drop|cln||Area|where|ItemID|id|integer|[count]|boolean|[onfloor]}}
||'''[[#Miscellanous Functions|Miscellanous Functions]]'''
|{{modarg|void}}|{{moddef|list|explosion|cln||Coord|where|integer|size|integer|delay|integer|dice|integer|sides|Color|color|SoundID|[sound_id]|DamageType|[type]|ExplosionFlags|[flags]|CellID|[content]}}
|{{modarg|void}}|{{moddef|list|flood|cln||CellID|tile|Area|flood_area}}
|{{modarg|boolean}}|{{moddef|list|is_corpse|cln||Coord|c}}
|{{modarg|void}}|{{moddef|list|nuke|cln}}
|{{modarg|void}}|{{moddef|list|play_sound|cln||SoundID|sound_id|Coord|where}}
|{{modarg|void}}|{{moddef|list|player|cln||integer|x|integer|y}}
|{{modarg|boolean}}|{{moddef|list|push_cell|cln||Coord|c|Coord|target|boolean|[quiet]}}
|{{modarg|void}}|{{moddef|list|recalc_fluids|cln}}
|{{modarg|void}}|{{moddef|list|register_hook|cln||string|hookname|any|func}}
|}}
|}
=== Level Object Functions ===
;{{moddef|desc|get_id|cln|string}}
Gets the ID of the level.
:'''Returns''': The string ID of the level.
----
;{{moddef|desc|get_uid|cln|integer}}
Gets the unique ID (UID) of the level.
:'''Returns''': The numeric ID of the level.
----
;{{moddef|desc|get_type|cln|string}}
Gets the type of this object.
:'''Returns''': The string "level".
----
;{{moddef|desc|get_area|cln|Area}}
Gets the level's entire area.
:'''Returns''': An [[Modding:Area|Area]] object encompassing the entire map.
----
;{{moddef|desc|get_parent|cln|object}}
Gets the parent of this object.
:'''Returns''': Nil. Level has no parent object.
----
;{{moddef|desc|get_child_count|cln|integer}}
Gets the number of children this object is the parent of. All beings and items on the level are children of the level object.
:'''Returns''': Total number of beings and items on the map (being count will include the player).
----
;{{moddef|desc|children|cln}}
Gets a table containing each child object of level. All beings and items on the level are children of the level object.
:'''Returns''': A table of all beings and items on the map.
----
;{{moddef|desc|destroy|cln}}
Destroys the level object. ''You should not call this in your lua script.''
----
=== Level Property Functions ===
;{{moddef|desc|add_property|cln||any|key|any|value}}
Adds a user-defined property to the level object.
:''key'': The value to refer to the property by.
:''value'': The corresponding value of the property.
----
;{{moddef|desc|get_property|cln|any|any|key}}
Retrieves the value of a user-defined property.
:''key'': The property's key value, defined when it was added.
:'''Returns''': The current value of the property.
----
;{{moddef|desc|has_property|cln|boolean|any|key}}
Checks to see if the given property exists.
:''key'': The property key to check for.
:'''Returns''': ''True'' if the property exists, ''False'' if it does not.
----
;{{moddef|desc|remove_property|cln||any|key}}
Removes a property from the level object.
:''key'': The key of the property to remove.
----
;{{moddef|desc|set_property|cln||any|key|any|value}}
Assigns a new value to an existing property.
:''key'': The key of the property to change.
:''value'': The new value to assign to the property.
----
=== Cell Level Functions ===
;{{moddef|desc|get_cell|cln|CellID|Coord|where}}
Gets the cell at a specific map coordinate.
:''where'': The location to get.
:'''Returns''': The ID of the cell at the location.
----
;{{moddef|desc|raw_get_cell|cln|integer|integer|x|integer|y}}
Gets the cell ID at a specific map coordinate.
:''x'': The X position of the coordinate to get.
:''y'': The Y position of the coordinate to get.
:'''Returns''': The numeric ID of the cell at the coordinates.
----
;{{moddef|desc|set_cell|cln||Coord|where|CellID|what}}
Assigns a new cell to a map coordinate.
:''where'': The location to change.
:''what'': The cell to assign to the location.
----
;{{moddef|desc|raw_set_cell|cln||integer|x|integer|y|integer|what}}
Assigns a new cell to a map coordinate.
:''x'': The X position of the location to change.
:''y'': The Y position of the location to change.
:''what'': The numeric ID of the cell to assign.
----
;{{moddef|desc|get_hp|cln|integer|Coord|where}}
Gets the HP of the cell at the specified location.
:''where'': The coordinate to get the HP amount from.
:'''Returns''': The amount of HP the cell has.
----
;{{moddef|desc|set_hp|cln||Coord|where|integer|new_hp}}
Sets the HP of the cell at the specified location.
:''where'': The coordinate to set.
:''new_hp'': The new HP value to set for the coordinate.
----
;{{moddef|desc|get_light_flag|cln|boolean|Flag|what|Coord|where}}
Checks a cell for a certain light flag.
:''what'': The LightFlag (named constant that starts with LF) to check for. Refer to [[Modding:Constants#Light Flag|this]] for more info.
:''where'': The location to check.
:'''Returns''': ''True'' if the flag is set. ''False'' if it is not.
----
;{{moddef|desc|set_light_flag|cln||Flag|what|boolean|[value]|Coord|[where]}}
;{{moddef|desc|set_light_flag|cln||Flag|what|boolean|[value]|Area|[where]}}
Sets or unsets a LightFlag at a specified location or specified locations.
:''what'': The LightFlag (named constant that starts with LF) to check for. Refer to [[Modding:Constants#Light Flag|this]] for more info.
:''value'': ''Optional.'' ''True'' to set the flag, ''False'' to unset it. If omitted, the default is to set the flag.
:''where'': ''Optional.'' The coordinate or area to change. If an area is supplied, all cells in the area will have the flag set or unset. If omitted, the entire map will have the flag set or unset.
----
;{{moddef|desc|is_visible|cln|boolean|Coord|a}}
Determines if the player can see this space.
:''a'': The space to check.
:'''Returns''': ''True'' if the player can see it, ''False'' if the player cannot.
----
;{{moddef|desc|eye_contact|cln|boolean|Coord|a|Coord|b}}
Checks to see if two spaces can see each other. This check uses the monster vision algorithm, which is stricter than the player's vision algorithm.
:''a'': The first space to check.
:''b'': The second space to check.
:'''Returns''': ''True'' if the spaces are visible to each other, ''False'' if not.
----
;{{moddef|desc|is_empty|cln|boolean|Coord|where|Flags|reqs}}
Checks to see if the indicated cell is "empty", defining "empty" based on a list of criteria.
:''where'': The position to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the position cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the map position does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if the cell satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|is_empty_area|cln|boolean|Area|where|Flags|reqs}}
Checks to see if the indicated area is "empty", defining "empty" based on a list of criteria.
:''where'': The area to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the area cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the area does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if every cell in the area satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
=== Being Level Functions ===
;{{moddef|desc|beings|cln|table}}
Gets a table containing all of the beings on the level.
:'''Returns''': A table containing all beings on the level.
----
;{{moddef|desc|beings_in_range|cln|table|Coord|where|integer|range}}
Gets a table containing all of the beings within a certain distance of a location.
:''where'': The location to search around.
:''range'': The distance away from the location to get beings from.
:'''Returns''': A table containing the beings close enough to the location specified.
----
;{{moddef|desc|get_being|cln|Being|Coord|where}}
Gets the being at the specified coordinate.
:''where'': The location to get the being from.
:'''Returns''': The being at the location.
----
;{{moddef|desc|drop_being|cln|Being|BeingID|what|Coord|where}}
Places a being on the map.
:''what'': The id of the being to place.
:''where'': The location to attempt to drop the being. If there is already a being at that location, the being will be dropped nearby.
:'''Returns''': A reference to the being dropped.
----
;{{moddef|desc|drop_being_ext|cln||BeingID|being|Coord|where}}
Places a being on the map with modifications.
:''being'': A BeingID, or a table whose first field is a BeingID, followed by the changes to the beings properties in the form ''field = new_value''.
:''where'': The location to attempt to drop the being. If there is already a being at that location, the being will be dropped nearby.
----
;{{moddef|desc|clear_being|cln||Coord|where|boolean|silent}}
Removes a being from the map.
:''where'': The location to remove the being from.
:''silent'': If ''true'', the being will be removed without making any sounds or causing any messages. If ''false'', the being will act as though they were killed (complete with message and sound).
----
;{{moddef|desc|get_being_table|cln|table|integer|[dlevel]|table|[weights]|table|[reqs]|integer|[dmod]}}
Gets a weight table for beings and being groups, using the indicated criteria.
:''dlevel'': ''Optional.'' The depth to pull the list of beings for. Only beings and groups that have an equal or smaller min_level and an equal or larger max_level will be selected. The ''dmod'' parameter also modifies which beings will be picked. If omitted, the current danger level (which is usually the current depth) is used.
:''weights'': ''Optional.'' A table containing modifiers to weights. The keys of the table are ids, flags, or blueprint fields to look for. For example, "former" will match the being with the id "former" (that is, Former Humans). Suppling a being flag (such as BF_BOSS or BF_ENVIROSAFE) will look for that flag in the being prototype's flag list. Suppling a blueprint field will match all beings that have that field in their blueprint table, provided that the value of the field isn't ''nil'', ''false'', or 0. Each matched being will have its weight multiplied by the value supplied for that key. For example, <tt>"former" = 2</tt> will double the weight value of Former Humans, while <tt>"former" = 0.5</tt> will halve it. If a being matches multiple entries, all are applied. (for example, the table {BF_ENVIROSAFE = 2, "pain" = 2} will match Pain Elementals twice -- since both apply a double modifier to weight, Pain Elementals will now have 4 times the weight.) If omitted, no modifications are made to weights.
:''reqs'': ''Optional.'' A table containing requirements to check for. Only beings that meet all of the requirements will be included in the resulting weight table. The keys of the table are blueprint fields that must be matched. The value for each key in the table is either a single value, which only beings whose blueprint field key has the value supplied will match, or a table of values, which will match beings that have one or more of the supplied values if the value of the blueprint field isn't a table itself, or all of the values if it is. For example, if the reqs table is <tt>{ id = "former" }</tt> , it will match Former Human (since its id is "former"). If the reqs table has <tt>{ id = {"former", "sergeant", "captain" } }</tt>, Former Human, Former Sergeant, and Former Captain will be matched. If the reqs table has <tt>{ flags = { BF_BOSS, BF_ENVIROSAFE } }</tt>, this will return all the beings with both the enviro-safe flag and the boss flag (since the flags blueprint field is a table itself). If omitted, no beings or groups are excluded (aside from those already excluded by the dlevel and dmod parameters).
:''dmod'': The current dlevel is adjusted by the value here for the min_level check. This allows beings with a higher min_level to be selected on an earlier depth (if positive), or exclude beings with a higher min_level for extra levels (if negative). In other words, this enables monsters to spawn "out of depth". If omitted, the default is 3 if difficulty is medium (HMP), 6 if difficulty is hard or very hard (UV and N!), and 0 otherwise.
:'''Returns''': A weight table object.
----
;{{moddef|desc|flood_monster|cln||*ParamTable*|args}}
Places one or more of a single type of monster on the level.
:''args'': A table that looks for the following keys:
::''id'': The ID of the being to place.
::''danger'': The total amount of danger points worth of this monster to place. This field is optional if ''count'' is set. If both ''danger'' and ''count'' are set, the function will stop placing monsters when either ''danger'' or ''count'' is reached.
::''count'': The number of monsters to place. This field is optional if ''danger'' is set. If both ''danger'' and ''count'' are set, the function will stop placing monsters when either ''danger'' or ''count'' is reached.
::''flags'': ''Optional.'' A list of [[Modding:Constants#Empty_flags|EmptyFlags]] that determines where monsters are allowed to be placed. If omitted, the default list is { EF_NOBEINGS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN }.
----
;{{moddef|desc|flood_monsters|cln||*ParamTable*|args}}
Places monsters on the level.
:''args'': A table that looks for the following keys:
::''danger'': The total amount of danger points worth of monsters to place. This field is optional if ''amount'' is set. If both ''danger'' and ''amount'' are set, the function will stop placing monsters when either ''danger'' or ''amount'' is reached.
::''amount'': The number of monsters to place. This field is optional if ''danger'' is set. If both ''danger'' and ''amount'' are set, the function will stop placing monsters when either ''danger'' or ''amount'' is reached.
::''flags'': ''Optional.'' A list of [[Modding:Constants#Empty_flags|EmptyFlags]] that determines where monsters are allowed to be placed. If omitted, the default list is { EF_NOBEINGS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN }.
::''reqs'': ''Optional.'' See get_being_table for more info about this parameter.
----
;{{moddef|desc|roll_being|cln|BeingID|*ParamTable*|args}}
Picks an ID for a being out of a list.
:''args'': A table that looks for the following keys:
::''list'': A table with BeingIDs as keys and the weight for the being as the value. If this key is supplied, all other keys are ignored.
:: These next 4 keys create a being list using ''get_being_table'' if the ''list'' parameter is omitted. The ID will be selected from the resulting weight table. It will not pick a group.
::''level'': See the ''danger'' parameter for ''get_being_table''.
::''weights'': See the ''weights'' parameter for ''get_being_table''.
::''diffmod'': See the ''dmod'' parameter for ''get_being_table''.
::''reqs'': See the ''reqs'' parameter for ''get_being_table''.
----
;{{moddef|desc|summon|cln||BeingID|id|integer|[count]}}
Places a given number of a single being onto the map.
:''id'': The ID of the being to place.
:''count'': ''Optional.'' The number of that being to place. If omitted, only one being will be placed.
----
;{{moddef|desc|summon|cln||*ParamTable*|args}}
Places a given number of a single being onto the map.
:''args'': A table that looks for the following keys:
::''id'': The ID of the being to place.
::''count'': ''Optional.'' The number of that being to place. If omitted, only one being will be placed.
::''cell'': ''Optional.'' A cell or set of cells that are valid locations for placement of the being(s). If omitted, the beings can be placed on any cell.
::''area'': ''Optional.'' The area the beings can spawn in. If omitted, the area used is the entire map.
::''empty'': ''Optional.'' A list of [[Modding:Constants#Empty_flags|EmptyFlags]] that determines where monsters are allowed to be placed. If omitted, the default list is { EF_NOBEINGS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN } if ''cell'' is omitted, and { EF_NOBEINGS, EF_NOBLOCK } if ''cell'' is supplied.
----
=== Item Level Functions ===
;{{moddef|desc|items|cln|table}}
Gets a table containing all of the items on the level.
:'''Returns''': A table containing all items on the level.
----
;{{moddef|desc|items_in_range|cln|table|Coord|where|integer|range}}
Gets a table containing all of the items within a certain distance of a location.
:''where'': The location to search around.
:''range'': The distance away from the location to search around.
:'''Returns''': A table containing all of the items within range of the location.
----
;{{moddef|desc|get_item|cln|Item|Coord|where}}
Gets the item at a location.
:''where'': The location to retrieve the item from.
:'''Returns''': A reference to the Item at the location.
----
;{{moddef|desc|drop_item|cln|Item|string|what|Coord|where|boolean|[onfloor]}}
;{{moddef|desc|drop_item|cln|Item|Item|what|Coord|where|boolean|[onfloor]}}
Places an item on the map.
:''what'': The item to place. Either a string containing the ID of the item or a table representing an existing item.
:''where'': The location to place the item. If occupied, the nearest available location will be chosen.
:''onfloor'': ''Optional.'' If true, will apply the difficulty modifier to an ammo item that is placed. If false, the ammo item is placed with the given amount of ammo. If omitted, the default is false. This argument has no effect on non-ammo items.
:'''Returns''': A reference to the dropped item.
----
;{{moddef|desc|drop_item_ext|cln||table|item|Coord|where}}
;{{moddef|desc|drop_item_ext|cln||string|item|Coord|where}}
Places an item with modifications on the map.
:''what'': The item to place. Either a string containing the ID of the item or a table with the ItemID string as it's first value, followed by a table containing entries in the form of <tt>"item_property" = new_value</tt> as the second value.
:''where'': The location to place the item at. If occupied, the nearest available location will be chosen.
----
;{{moddef|desc|try_destroy_item|cln||Coord|where}}
Attempts to destroy the item in a specified location. This function will not destroy the item if the item has the flag IF_NODESTROY or IF_UNIQUE. To guarantee destruction of an item, call the item's :destroy() method.
:''where'': The location of the item to try to destroy.
----
;{{moddef|desc|get_item_table|cln|table|integer|[dlevel]|table|[weights]|table|[reqs]}}
Gets a weight table for items, using the indicated criteria.
:''dlevel'': ''Optional.'' The depth to pull the list of items for. If omitted, the value in ''level.danger_level'' is used.
:''weights'': ''Optional.'' A table containing modifiers to weights. The keys of the table are ids, flags, or blueprint fields to look for. For example, "smed" will match Small Med-Packs. Suppling an item flag (such as IF_UNIQUE or IF_SHOTGUN, or an ITEMTYPE value) will look for that flag in the item prototype's flag list. Suppling a blueprint field will match all items that have that field in their blueprint table, provided that the value isn't ''nil'', ''false'', or 0. Each matched item will have its weight multiplied by the value supplied for that key. For example, <tt>"smed" = 2</tt> will double the weight of Small Med-Packs, while <tt>"smed" = 0.5</tt> will halve it. If an item matches multiple entries, all are applied. (For example, the table {IF_UNIQUE = 2, "uberarmor" = 2} will match Berserker Armor twice -- since both apply a double modifier to weight, Berserker Armor would have 4 times the weight.) If omitted, no modifications are made to weights.
:''reqs'': ''Optional.'' A table containing requirements to check for. Only items that meet all of the requirements will be included in the resulting weight table. The keys of the table are blueprint fields that must be matched. The value for each key in the table is either a single value, which only items whose blueprint field key has the value supplied will match, or a table of values, which will match items that have one or more of the supplied values if the value of the blueprint field isn't a table itself, or all of the values if it is. For example, if the reqs table is <tt>{ id = "smed" }</tt>, it will match Small Med-Packs (since its id is "smed"). If the reqs table has <tt>{ id = {"smed", "lmed", "phase", "hphase" }</tt>, it will match Small Med-Packs, Large Med-Packs, Phase Devices, and Homing Phase Devices. If the reqs table has <tt>{ flags = {IF_UNIQUE, IF_SHOTGUN} }</tt>, this will match all unique shotguns (since the flags blueprint field is a table itself). If omitted, no items are excluded (aside from those already excluded by other factors, such as the ''dlevel'' parameter).
::NOTE: This function has a hidden limitation when trying to generate exotics and uniques. The function will not pick exotics if the ''danger_level'' of the level is less then the current difficulty (where ITYTD = 1 and N! = 5). The function will not pick uniques if the ''danger_level'' of the level is less than 3 more than the current difficulty (where ITYTD = 1 and N! = 5). If you need to generate exotics or uniques before the indicated ''danger_level'', you can add the needed items to the resulting table yourself using the <tt>:add(<object>)</tt> method on the returned weight table object. Other functions that use this function (such as ''flood_items'' and ''roll_item'') will also have this behavior.
:'''Returns''': A weight table object.
----
;{{moddef|desc|flood_items|cln||integer|amount}}
Places several different items on the level, using the default criteria.
:''amount'': The number of items to place on the level.
----
;{{moddef|desc|flood_items|cln||*ParamTable*|args}}
Places several different items on the level, using specific criteria.
:''args'': A table that looks for the following keys:
::''amount'': The number of items to place on the level.
::''level'', ''weights'', ''reqs'': ''All optional.'' See the ''get_item_table'' function for more info.
----
;{{moddef|desc|roll_item|cln||*ParamTable*|args}}
Picks an item at random using specified criteria.
:''args'': A table that looks for the following keys:
::''level'': ''Optional.'' Sent to ''get_item_table'' as the ''dlevel'' parameter. Refer to ''get_item_table'' for more info.
::''type'': ''Optional.'' A table containing one or more ITEMTYPE values. If supplied, only items that have one of the indicated types will be selected. If omitted, any item type can be picked.
::''weights'': ''Optional.'' Sent to ''get_item_table'' as the ''weights'' parameter. Refer to ''get_item_table'' for more info.
::''reqs'': ''Optional.'' Sent to ''get_item_table'' as the ''reqs'' parameter. Refer to ''get_item_table'' for more info.
::''unique_mod'': ''Optional.'' A multiplier to the weights of all unique items. If omitted, 1 is used.
::''exotic_mod'': ''Optional.'' A multiplier to the weights of all exotic items. If omitted, 1 is used.
::''special_mod'': ''Optional.'' A multiplier to the weights of all exotic and unique items. Combines with ''unique_mod'' and ''exotic_mod''. If omitted, 1 is used.
:'''Returns''': The ID of the rolled item.
----
;{{moddef|desc|drop|cln|Item|ItemID|id|integer|[count]}}
Places one or more of a specific item on the map.
:''id'': The ID of the item to place.
:''count'': ''Optional.'' The number of the item to place. If omitted, only 1 item will be placed.
:'''Returns''': A reference to the last item placed.
----
;{{moddef|desc|area_drop|cln|Item|Area|where|ItemID|id|integer|[count]|boolean|[onfloor]}}
Places one or more of a specific item on the map in an area.
:''where'': The area to confine the item drops to.
:''id'': The Id of the item to place.
:''count'': ''Optional.'' The number of the item to place. If omitted, only 1 item will be placed.
:''onfloor'': ''Optional.'' If true, will apply the difficulty modifier to an ammo item that is placed. If false, the ammo item is placed with the given amount of ammo. If omitted, the default is false. This argument has no effect on non-ammo items.
:'''Returns''': A reference to the last item placed.
=== Miscellanous Functions ===
;{{moddef|desc|explosion|cln||Coord|where|integer|size|integer|delay|integer|dice|integer|sides|Color|color|SoundID|[sound_id]|DamageType|[type]|ExplosionFlags|[flags]|CellID|[content]}}
Creates an explosion on the map.
:''where'': The location for the center of the explosion.
:''size'': The size of the explosion. If greater than 8, the explosion will be visible in all cells, including cells that are not currently in the player's vision.
:''delay'': The amount of time (in milliseconds) that each step of the explosion will take.
:''dice'': The number of dice to use for the damage. Enter 0 to prevent the explosion from dealing damage (for decoration explosions).
:''sides'': The number of sides for each die to use for the damage. Enter 0 to prevent the explosion from dealing damage (for decoration explosions).
:''color'': ''Optional.'' The color of the explosion. Not all colors will show. If omitted, a RED explosion will be used.
:''sound_id'': ''Optional.'' The ID of the sound to use for this explosion. If omitted, no sound is used.
:''type'': ''Optional.'' The type of damage this explosion deals. If omitted, the default is DAMAGE_FIRE.
:''flags'': ''Optional.'' A list of ExplosionFlags that will modify what the explosion applies to or how it applies. If omitted, no modifications are made to the explosion.
:''content'': ''Optional.'' The cell to fill cells in the explosion area with if the explosion hits a cell for more than 20 damage. If omitted, cells will not changed.
----
;{{moddef|desc|flood|cln||CellID|tile|Area|flood_area}}
Replaces non-wall tiles in an area with a different tile.
:''tile'': The cell to fill with. This does not have to be a fluid cell.
:''flood_area'': The area to fill.
----
;{{moddef|desc|is_corpse|cln|boolean|Coord|c}}
Indicates if a coordinate has a corpse cell or not.
:''c'': The location to check.
:'''Returns''': ''True'' if the coordinate is a corpse, ''False'' if it is not.
----
;{{moddef|desc|nuke|cln}}
Instantly nukes a level.
----
;{{moddef|desc|play_sound|cln||SoundID|sound_id|Coord|where}}
Plays a sound on the map.
:''sound_id'': The id of the sound to play.
:''where'': The location to play the sound at.
----
;{{moddef|desc|player|cln||integer|x|integer|y}}
Set the position of the player on the map.
:''x'': The x coordinate of the position to move the player to.
:''y'': The y coordinate of the position to move the player to.
----
;{{moddef|desc|push_cell|cln||Coord|c|Coord|target|boolean|[quiet]}}
Attempts to move a cell to a new location. (Swaps two cells.)
:''c'': The source coordinate.
:''target'': The destination coordinate.
:''quiet'': ''Optional.'' If ''True'', messages about success or failure as well as sounds that would play on success or failure are all suppressed. If ''False'', sounds and messages will happen as it would normally. If omitted, the default is ''False''.
----
;{{moddef|desc|recalc_fluids|cln}}
Recalculates fluid edges.
----
;{{moddef|desc|register_hook|cln|string|hookname|<any>|func}}
Registers a hook with this object.
:''hookname'': The name of the hook to register.
:''func'': The function to assign to the hook.
----

Template:Moddef

2013-06-10T17:54:12Z

Shark20061: Final bugfix

<noinclude>
This is the prototypical template for expressing API functions. It works with the following args:
#Sets the type of expression. Currently there are two cases:
#*<tt>list</tt> is what's used in the table: it automatically comes with the necessary link for the description's anchor.
#*<tt>desc</tt> is what's used underneath the table: this provides the anchor that is linked to the list.
#Sets the function name. For example, if the function is called <tt>Level.place_tile</tt>, then this should be set to <tt>place_tile</tt>.
#Determines the function type. There are two cases:
#*<tt>dot</tt> is the dot form
#*<tt>cln</tt> is the colon form
#Sets the output argument, if any. Leaving this blank should always be done for <tt>list</tt> functions. You can include up to two comma-separated outputs.
#From here, input arguments are set. These are be handled in pairs: the first should be the arg type, while the second should be the arg name. You can include up to eight arg pairs in this manner.
Please note that this template is set up to include information based on the page name, so they can only be used on their appropriate pages. Thus, you can write being API functions using this template for the [[Modding:Being|being]] page, but not for the [[Modding:Coord|coord]] page.

See [[Template:Modarg]] for argument handling.
</noinclude>{{#ifeq:{{{1}}}|desc|{{Anchor|{{lc:{{#sub:{{PAGENAME}}|8|0}}}}_{{{2}}}}}
;}}{{#switch: {{#sub:{{PAGENAME}}|8|{{#if:{{#pos:{{PAGENAME}}| |8}}|{{#expr:{{#pos:{{PAGENAME}}| |8}} - 7|0}}}}}}
| area = {{#switch: {{{3}}} | dot = area. | cln = '''area'''<nowiki>:</nowiki>}}
| being = {{#switch: {{{3}}} | dot = being. | cln = '''being'''<nowiki>:</nowiki>}}
| coord = {{#switch: {{{3}}} | dot = coord. | cln = '''coord'''<nowiki>:</nowiki>}}
| generator = {{#switch: {{{3}}} | dot = generator. | cln = '''generator'''<nowiki>:</nowiki>}}
| item = {{#switch: {{{3}}} | dot = item. | cln = '''item'''<nowiki>:</nowiki>}}
| level = {{#switch: {{{3}}} | dot = Level. | cln = '''level'''<nowiki>:</nowiki>}}
| player = {{#switch: {{{3}}} | dot = player. | cln = '''player'''<nowiki>:</nowiki>}}
| thing = {{#switch: {{{3}}} | dot = thing. | cln = '''thing'''<nowiki>:</nowiki>}}
| ui = {{#switch: {{{3}}} | dot = ui. | cln = '''ui'''<nowiki>:</nowiki>}}

}}{{#switch: {{{1}}}
| list = [[#{{lc:{{#sub:{{PAGENAME}}|8|0}}}}_{{{2}}}|{{{2}}}]]
| desc = {{{2}}}
}}({{#if: {{{5|}}}|{{#if: {{{6|}}} | {{modarg|{{{5}}}}} {{{6}}}}}{{#if:{{{7|}}}|<nowiki>, </nowiki>{{#if: {{{8|}}} |{{modarg|{{{7}}}}} {{{8}}}}}}}{{#if:{{{9|}}}|<nowiki>, </nowiki>{{#if: {{{10|}}} |{{modarg|{{{9}}}}} {{{10}}}}}}}{{#if:{{{11|}}}|<nowiki>, </nowiki>{{#if: {{{12|}}} |{{modarg|{{{11}}}}} {{{12}}}}}}}{{#if:{{{13|}}}|<nowiki>, </nowiki>{{#if: {{{14|}}} |{{modarg|{{{13}}}}} {{{14}}}}}}}{{#if:{{{15|}}}|<nowiki>, </nowiki>{{#if: {{{16|}}} |{{modarg|{{{15}}}}} {{{16}}}}}}}{{#if:{{{17|}}}|<nowiki>, </nowiki>{{#if: {{{18|}}} |{{modarg|{{{17}}}}} {{{18}}}}}}}{{#if:{{{19|}}}|<nowiki>, </nowiki>{{#if: {{{20|}}} |{{modarg|{{{19}}}}} {{{20}}}}}}}{{#if:{{{21|}}}|<nowiki>, </nowiki>{{#if: {{{22|}}} |{{modarg|{{{21}}}}} {{{22}}}}}}}{{#if:{{{23|}}}|<nowiki>, </nowiki>{{#if: {{{24|}}} |{{modarg|{{{23}}}}} {{{24}}}}}}}}}){{#if: {{{4|}}}|<nowiki> </nowiki>→ {{#if: {{#pos:{{{4}}}|,}}|{{modarg|{{#explode:{{{4}}}|,|0}}}},{{modarg|{{#explode:{{{4}}}|,|1}}}}|{{modarg|{{{4}}}}} }} }}

Template:Moddef

2013-06-10T17:52:48Z

Shark20061: Still bugfixing

<noinclude>
This is the prototypical template for expressing API functions. It works with the following args:
#Sets the type of expression. Currently there are two cases:
#*<tt>list</tt> is what's used in the table: it automatically comes with the necessary link for the description's anchor.
#*<tt>desc</tt> is what's used underneath the table: this provides the anchor that is linked to the list.
#Sets the function name. For example, if the function is called <tt>Level.place_tile</tt>, then this should be set to <tt>place_tile</tt>.
#Determines the function type. There are two cases:
#*<tt>dot</tt> is the dot form
#*<tt>cln</tt> is the colon form
#Sets the output argument, if any. Leaving this blank should always be done for <tt>list</tt> functions. You can include up to two comma-separated outputs.
#From here, input arguments are set. These are be handled in pairs: the first should be the arg type, while the second should be the arg name. You can include up to eight arg pairs in this manner.
Please note that this template is set up to include information based on the page name, so they can only be used on their appropriate pages. Thus, you can write being API functions using this template for the [[Modding:Being|being]] page, but not for the [[Modding:Coord|coord]] page.

See [[Template:Modarg]] for argument handling.
</noinclude>{{#ifeq:{{{1}}}|desc|{{Anchor|{{lc:{{#sub:{{PAGENAME}}|8|0}}}}_{{{2}}}}}
;}}{{#switch: {{#sub:{{PAGENAME}}|8|{{#if:{{#pos:{{PAGENAME}}| |8}}|{{#expr:{{#pos:{{PAGENAME}}| |8}} - 7|0}}}}}}
| Modding:area = {{#switch: {{{3}}} | dot = area. | cln = '''area'''<nowiki>:</nowiki>}}
| Modding:being = {{#switch: {{{3}}} | dot = being. | cln = '''being'''<nowiki>:</nowiki>}}
| Modding:coord = {{#switch: {{{3}}} | dot = coord. | cln = '''coord'''<nowiki>:</nowiki>}}
| Modding:generator = {{#switch: {{{3}}} | dot = generator. | cln = '''generator'''<nowiki>:</nowiki>}}
| Modding:item = {{#switch: {{{3}}} | dot = item. | cln = '''item'''<nowiki>:</nowiki>}}
| Modding:level = {{#switch: {{{3}}} | dot = Level. | cln = '''level'''<nowiki>:</nowiki>}}
| Modding:player = {{#switch: {{{3}}} | dot = player. | cln = '''player'''<nowiki>:</nowiki>}}
| Modding:thing = {{#switch: {{{3}}} | dot = thing. | cln = '''thing'''<nowiki>:</nowiki>}}
| Modding:ui = {{#switch: {{{3}}} | dot = ui. | cln = '''ui'''<nowiki>:</nowiki>}}

}}{{#switch: {{{1}}}
| list = [[#{{lc:{{#sub:{{PAGENAME}}|8|0}}}}_{{{2}}}|{{{2}}}]]
| desc = {{{2}}}
}}({{#if: {{{5|}}}|{{#if: {{{6|}}} | {{modarg|{{{5}}}}} {{{6}}}}}{{#if:{{{7|}}}|<nowiki>, </nowiki>{{#if: {{{8|}}} |{{modarg|{{{7}}}}} {{{8}}}}}}}{{#if:{{{9|}}}|<nowiki>, </nowiki>{{#if: {{{10|}}} |{{modarg|{{{9}}}}} {{{10}}}}}}}{{#if:{{{11|}}}|<nowiki>, </nowiki>{{#if: {{{12|}}} |{{modarg|{{{11}}}}} {{{12}}}}}}}{{#if:{{{13|}}}|<nowiki>, </nowiki>{{#if: {{{14|}}} |{{modarg|{{{13}}}}} {{{14}}}}}}}{{#if:{{{15|}}}|<nowiki>, </nowiki>{{#if: {{{16|}}} |{{modarg|{{{15}}}}} {{{16}}}}}}}{{#if:{{{17|}}}|<nowiki>, </nowiki>{{#if: {{{18|}}} |{{modarg|{{{17}}}}} {{{18}}}}}}}{{#if:{{{19|}}}|<nowiki>, </nowiki>{{#if: {{{20|}}} |{{modarg|{{{19}}}}} {{{20}}}}}}}{{#if:{{{21|}}}|<nowiki>, </nowiki>{{#if: {{{22|}}} |{{modarg|{{{21}}}}} {{{22}}}}}}}{{#if:{{{23|}}}|<nowiki>, </nowiki>{{#if: {{{24|}}} |{{modarg|{{{23}}}}} {{{24}}}}}}}}}){{#if: {{{4|}}}|<nowiki> </nowiki>→ {{#if: {{#pos:{{{4}}}|,}}|{{modarg|{{#explode:{{{4}}}|,|0}}}},{{modarg|{{#explode:{{{4}}}|,|1}}}}|{{modarg|{{{4}}}}} }} }}

Template:Moddef

2013-06-10T17:45:08Z

Shark20061: Bugfixing

<noinclude>
This is the prototypical template for expressing API functions. It works with the following args:
#Sets the type of expression. Currently there are two cases:
#*<tt>list</tt> is what's used in the table: it automatically comes with the necessary link for the description's anchor.
#*<tt>desc</tt> is what's used underneath the table: this provides the anchor that is linked to the list.
#Sets the function name. For example, if the function is called <tt>Level.place_tile</tt>, then this should be set to <tt>place_tile</tt>.
#Determines the function type. There are two cases:
#*<tt>dot</tt> is the dot form
#*<tt>cln</tt> is the colon form
#Sets the output argument, if any. Leaving this blank should always be done for <tt>list</tt> functions. You can include up to two comma-separated outputs.
#From here, input arguments are set. These are be handled in pairs: the first should be the arg type, while the second should be the arg name. You can include up to eight arg pairs in this manner.
Please note that this template is set up to include information based on the page name, so they can only be used on their appropriate pages. Thus, you can write being API functions using this template for the [[Modding:Being|being]] page, but not for the [[Modding:Coord|coord]] page.

See [[Template:Modarg]] for argument handling.
</noinclude>{{#ifeq:{{{1}}}|desc|{{Anchor|{{lc:{{#sub:{{PAGENAME}}|8|0}}}}_{{{2}}}}}
;}}{{#switch: {{#sub:Modding<nowiki>:</nowiki>level API (0.9.9.7)xxxxxxxxxxxxx|7|{{#if:{{#pos:Modding<nowiki>:</nowiki>level API (0.9.9.7)xxxxxxxxxxxxx| |8}}|{{#expr:{{#pos:Modding<nowiki>:</nowiki>level API (0.9.9.7)xxxxxxxxxxxxx| |8}} - 7|0}}}}}}
| Modding:area = {{#switch: {{{3}}} | dot = area. | cln = '''area'''<nowiki>:</nowiki>}}
| Modding:being = {{#switch: {{{3}}} | dot = being. | cln = '''being'''<nowiki>:</nowiki>}}
| Modding:coord = {{#switch: {{{3}}} | dot = coord. | cln = '''coord'''<nowiki>:</nowiki>}}
| Modding:generator = {{#switch: {{{3}}} | dot = generator. | cln = '''generator'''<nowiki>:</nowiki>}}
| Modding:item = {{#switch: {{{3}}} | dot = item. | cln = '''item'''<nowiki>:</nowiki>}}
| Modding:level = {{#switch: {{{3}}} | dot = Level. | cln = '''level'''<nowiki>:</nowiki>}}
| Modding:player = {{#switch: {{{3}}} | dot = player. | cln = '''player'''<nowiki>:</nowiki>}}
| Modding:thing = {{#switch: {{{3}}} | dot = thing. | cln = '''thing'''<nowiki>:</nowiki>}}
| Modding:ui = {{#switch: {{{3}}} | dot = ui. | cln = '''ui'''<nowiki>:</nowiki>}}

}}{{#switch: {{{1}}}
| list = [[#{{lc:{{#sub:{{PAGENAME}}|8|0}}}}_{{{2}}}|{{{2}}}]]
| desc = {{{2}}}
}}({{#if: {{{5|}}}|{{#if: {{{6|}}} | {{modarg|{{{5}}}}} {{{6}}}}}{{#if:{{{7|}}}|<nowiki>, </nowiki>{{#if: {{{8|}}} |{{modarg|{{{7}}}}} {{{8}}}}}}}{{#if:{{{9|}}}|<nowiki>, </nowiki>{{#if: {{{10|}}} |{{modarg|{{{9}}}}} {{{10}}}}}}}{{#if:{{{11|}}}|<nowiki>, </nowiki>{{#if: {{{12|}}} |{{modarg|{{{11}}}}} {{{12}}}}}}}{{#if:{{{13|}}}|<nowiki>, </nowiki>{{#if: {{{14|}}} |{{modarg|{{{13}}}}} {{{14}}}}}}}{{#if:{{{15|}}}|<nowiki>, </nowiki>{{#if: {{{16|}}} |{{modarg|{{{15}}}}} {{{16}}}}}}}{{#if:{{{17|}}}|<nowiki>, </nowiki>{{#if: {{{18|}}} |{{modarg|{{{17}}}}} {{{18}}}}}}}{{#if:{{{19|}}}|<nowiki>, </nowiki>{{#if: {{{20|}}} |{{modarg|{{{19}}}}} {{{20}}}}}}}{{#if:{{{21|}}}|<nowiki>, </nowiki>{{#if: {{{22|}}} |{{modarg|{{{21}}}}} {{{22}}}}}}}{{#if:{{{23|}}}|<nowiki>, </nowiki>{{#if: {{{24|}}} |{{modarg|{{{23}}}}} {{{24}}}}}}}}}){{#if: {{{4|}}}|<nowiki> </nowiki>→ {{#if: {{#pos:{{{4}}}|,}}|{{modarg|{{#explode:{{{4}}}|,|0}}}},{{modarg|{{#explode:{{{4}}}|,|1}}}}|{{modarg|{{{4}}}}} }} }}

Template:Moddef

2013-06-10T15:07:47Z

Shark20061: Bugfix

<noinclude>
This is the prototypical template for expressing API functions. It works with the following args:
#Sets the type of expression. Currently there are two cases:
#*<tt>list</tt> is what's used in the table: it automatically comes with the necessary link for the description's anchor.
#*<tt>desc</tt> is what's used underneath the table: this provides the anchor that is linked to the list.
#Sets the function name. For example, if the function is called <tt>Level.place_tile</tt>, then this should be set to <tt>place_tile</tt>.
#Determines the function type. There are two cases:
#*<tt>dot</tt> is the dot form
#*<tt>cln</tt> is the colon form
#Sets the output argument, if any. Leaving this blank should always be done for <tt>list</tt> functions. You can include up to two comma-separated outputs.
#From here, input arguments are set. These are be handled in pairs: the first should be the arg type, while the second should be the arg name. You can include up to eight arg pairs in this manner.
Please note that this template is set up to include information based on the page name, so they can only be used on their appropriate pages. Thus, you can write being API functions using this template for the [[Modding:Being|being]] page, but not for the [[Modding:Coord|coord]] page.

See [[Template:Modarg]] for argument handling.
</noinclude>{{#ifeq:{{{1}}}|desc|{{Anchor|{{lc:{{#sub:{{PAGENAME}}|8|0}}}}_{{{2}}}}}
;}}{{#switch: {{#sub:{{PAGENAME}}|8|{{#expr: {{#if{{#pos:{{PAGENAME}}| |8}}|{{#pos:{{PAGENAME}}| |8}}|0}} - 8 }}}}
| area = {{#switch: {{{3}}} | dot = area. | cln = '''area'''<nowiki>:</nowiki>}}
| being = {{#switch: {{{3}}} | dot = being. | cln = '''being'''<nowiki>:</nowiki>}}
| coord = {{#switch: {{{3}}} | dot = coord. | cln = '''coord'''<nowiki>:</nowiki>}}
| generator = {{#switch: {{{3}}} | dot = generator. | cln = '''generator'''<nowiki>:</nowiki>}}
| item = {{#switch: {{{3}}} | dot = item. | cln = '''item'''<nowiki>:</nowiki>}}
| level = {{#switch: {{{3}}} | dot = Level. | cln = '''level'''<nowiki>:</nowiki>}}
| player = {{#switch: {{{3}}} | dot = player. | cln = '''player'''<nowiki>:</nowiki>}}
| thing = {{#switch: {{{3}}} | dot = thing. | cln = '''thing'''<nowiki>:</nowiki>}}
| ui = {{#switch: {{{3}}} | dot = ui. | cln = '''ui'''<nowiki>:</nowiki>}}

}}{{#switch: {{{1}}}
| list = [[#{{lc:{{#sub:{{PAGENAME}}|8|0}}}}_{{{2}}}|{{{2}}}]]
| desc = {{{2}}}
}}({{#if: {{{5|}}}|{{#if: {{{6|}}} | {{modarg|{{{5}}}}} {{{6}}}}}{{#if:{{{7|}}}|<nowiki>, </nowiki>{{#if: {{{8|}}} |{{modarg|{{{7}}}}} {{{8}}}}}}}{{#if:{{{9|}}}|<nowiki>, </nowiki>{{#if: {{{10|}}} |{{modarg|{{{9}}}}} {{{10}}}}}}}{{#if:{{{11|}}}|<nowiki>, </nowiki>{{#if: {{{12|}}} |{{modarg|{{{11}}}}} {{{12}}}}}}}{{#if:{{{13|}}}|<nowiki>, </nowiki>{{#if: {{{14|}}} |{{modarg|{{{13}}}}} {{{14}}}}}}}{{#if:{{{15|}}}|<nowiki>, </nowiki>{{#if: {{{16|}}} |{{modarg|{{{15}}}}} {{{16}}}}}}}{{#if:{{{17|}}}|<nowiki>, </nowiki>{{#if: {{{18|}}} |{{modarg|{{{17}}}}} {{{18}}}}}}}{{#if:{{{19|}}}|<nowiki>, </nowiki>{{#if: {{{20|}}} |{{modarg|{{{19}}}}} {{{20}}}}}}}{{#if:{{{21|}}}|<nowiki>, </nowiki>{{#if: {{{22|}}} |{{modarg|{{{21}}}}} {{{22}}}}}}}{{#if:{{{23|}}}|<nowiki>, </nowiki>{{#if: {{{24|}}} |{{modarg|{{{23}}}}} {{{24}}}}}}}}}){{#if: {{{4|}}}|<nowiki> </nowiki>→ {{#if: {{#pos:{{{4}}}|,}}|{{modarg|{{#explode:{{{4}}}|,|0}}}},{{modarg|{{#explode:{{{4}}}|,|1}}}}|{{modarg|{{{4}}}}} }} }}

Template:Moddef

2013-06-10T14:59:07Z

Shark20061: Making the template more robust.

<noinclude>
This is the prototypical template for expressing API functions. It works with the following args:
#Sets the type of expression. Currently there are two cases:
#*<tt>list</tt> is what's used in the table: it automatically comes with the necessary link for the description's anchor.
#*<tt>desc</tt> is what's used underneath the table: this provides the anchor that is linked to the list.
#Sets the function name. For example, if the function is called <tt>Level.place_tile</tt>, then this should be set to <tt>place_tile</tt>.
#Determines the function type. There are two cases:
#*<tt>dot</tt> is the dot form
#*<tt>cln</tt> is the colon form
#Sets the output argument, if any. Leaving this blank should always be done for <tt>list</tt> functions. You can include up to two comma-separated outputs.
#From here, input arguments are set. These are be handled in pairs: the first should be the arg type, while the second should be the arg name. You can include up to eight arg pairs in this manner.
Please note that this template is set up to include information based on the page name, so they can only be used on their appropriate pages. Thus, you can write being API functions using this template for the [[Modding:Being|being]] page, but not for the [[Modding:Coord|coord]] page.

See [[Template:Modarg]] for argument handling.
</noinclude>{{#ifeq:{{{1}}}|desc|{{Anchor|{{lc:{{#sub:{{PAGENAME}}|8|0}}}}_{{{2}}}}}
;}}{{#switch: {{#sub:{{PAGENAME}}|8|{{#expr: {{#if{{#pos:{{PAGENAME}}|" "|8}}||0}} - 8 }}}}
| area = {{#switch: {{{3}}} | dot = area. | cln = '''area'''<nowiki>:</nowiki>}}
| being = {{#switch: {{{3}}} | dot = being. | cln = '''being'''<nowiki>:</nowiki>}}
| coord = {{#switch: {{{3}}} | dot = coord. | cln = '''coord'''<nowiki>:</nowiki>}}
| generator = {{#switch: {{{3}}} | dot = generator. | cln = '''generator'''<nowiki>:</nowiki>}}
| item = {{#switch: {{{3}}} | dot = item. | cln = '''item'''<nowiki>:</nowiki>}}
| level = {{#switch: {{{3}}} | dot = Level. | cln = '''level'''<nowiki>:</nowiki>}}
| player = {{#switch: {{{3}}} | dot = player. | cln = '''player'''<nowiki>:</nowiki>}}
| thing = {{#switch: {{{3}}} | dot = thing. | cln = '''thing'''<nowiki>:</nowiki>}}
| ui = {{#switch: {{{3}}} | dot = ui. | cln = '''ui'''<nowiki>:</nowiki>}}

}}{{#switch: {{{1}}}
| list = [[#{{lc:{{#sub:{{PAGENAME}}|8|0}}}}_{{{2}}}|{{{2}}}]]
| desc = {{{2}}}
}}({{#if: {{{5|}}}|{{#if: {{{6|}}} | {{modarg|{{{5}}}}} {{{6}}}}}{{#if:{{{7|}}}|<nowiki>, </nowiki>{{#if: {{{8|}}} |{{modarg|{{{7}}}}} {{{8}}}}}}}{{#if:{{{9|}}}|<nowiki>, </nowiki>{{#if: {{{10|}}} |{{modarg|{{{9}}}}} {{{10}}}}}}}{{#if:{{{11|}}}|<nowiki>, </nowiki>{{#if: {{{12|}}} |{{modarg|{{{11}}}}} {{{12}}}}}}}{{#if:{{{13|}}}|<nowiki>, </nowiki>{{#if: {{{14|}}} |{{modarg|{{{13}}}}} {{{14}}}}}}}{{#if:{{{15|}}}|<nowiki>, </nowiki>{{#if: {{{16|}}} |{{modarg|{{{15}}}}} {{{16}}}}}}}{{#if:{{{17|}}}|<nowiki>, </nowiki>{{#if: {{{18|}}} |{{modarg|{{{17}}}}} {{{18}}}}}}}{{#if:{{{19|}}}|<nowiki>, </nowiki>{{#if: {{{20|}}} |{{modarg|{{{19}}}}} {{{20}}}}}}}{{#if:{{{21|}}}|<nowiki>, </nowiki>{{#if: {{{22|}}} |{{modarg|{{{21}}}}} {{{22}}}}}}}{{#if:{{{23|}}}|<nowiki>, </nowiki>{{#if: {{{24|}}} |{{modarg|{{{23}}}}} {{{24}}}}}}}}}){{#if: {{{4|}}}|<nowiki> </nowiki>→ {{#if: {{#pos:{{{4}}}|,}}|{{modarg|{{#explode:{{{4}}}|,|0}}}},{{modarg|{{#explode:{{{4}}}|,|1}}}}|{{modarg|{{{4}}}}} }} }}

Modding:generator API (0.9.9.7)

2013-06-10T04:02:13Z

Shark20061: Putting in 0997 info

''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.

== API ==

Please note that the type "integer" indicates an numeric value without a decimal part. It does not indicate the range of acceptable values.

The argument type "CellID" may be the numeric or string ID of a cell.

The argument type "CellSet" may be the numeric ID, string ID, or a list of numeric and/or string IDs.

The argument type "Flags" expects a list of [[Modding:Constants|flag constants]] of the indicated type.

An argument name in [square brackets] is an optional one. The function description will indicate how the function operates if it is omitted.

=== Generator API Function List ===

{|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"|'''Generator Interface - Functions'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
||'''[[#Basic Cell Handling Functions|Basic Cell Handling Functions]]'''
|{{modarg|integer}}|{{moddef|list|get_cell|dot||Coord|loc}}
|{{modarg|string}}|{{moddef|list|get_cell_id|dot||Coord|loc}}
|{{modarg|integer}}|{{moddef|list|fast_get_cell|dot||integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|set_cell|dot||Coord|loc|CellID|what}}
|{{modarg|void}}|{{moddef|list|fast_set_cell|dot||integer|x|integer|y|integer|what}}
||'''[[#Map Checking Functions|Map Checking Functions]]'''
|{{modarg|integer}}|{{moddef|list|around|dot||Coord|where|CellSet|what}}
|{{modarg|integer}}|{{moddef|list|cross_around|dot||Coord|where|CellSet|what}}
|{{modarg|boolean}}|{{moddef|list|is_empty|dot||Coord|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|is_empty_area|dot||Area|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|scan|dot||Area|where|CellID|good}}
||'''[[#Map Searching Functions|Map Searching Functions]]'''
|{{modarg|Coord}}|{{moddef|list|drop_coord|dot||Coord|where|Flags|reqs}}
|{{modarg|Coord}}|{{moddef|list|find_coord|dot||CellSet|what|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|random_coord|dot||Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_random_coord|dot||CellSet|what|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_empty_coord|dot||CellSet|what|Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|random_empty_coord|dot||Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_random_empty_coord|dot||CellSet|what|Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|safe_empty_coord|dot||Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|standard_empty_coord|dot}}
||'''[[#Advanced Cell Handling Functions|Advanced Cell Handling Functions]]'''
|{{modarg|void}}|{{moddef|list|fill|dot||CellID|what|Area|[where]}}
|{{modarg|void}}|{{moddef|list|fill_pattern|dot||Area|where|boolean|horiz|Table|line1|Table|[line2]}}
|{{modarg|void}}|{{moddef|list|fill_edges|dot||CellID|what}}
|{{modarg|Table}}|{{moddef|list|each|dot||CellID|what|Area|[where]}}
|{{modarg|void}}|{{moddef|list|set_blood|dot||Area|[where]|boolean|[value]|CellID|[what]}}
|{{modarg|void}}|{{moddef|list|set_permanence|dot||Area|[where]|boolean|[value]|CellID|[what]}}
|{{modarg|Table}}|{{moddef|list|cell_set|dot||CellSet|cells}}
|{{modarg|void}}|{{moddef|list|restore_walls|dot||CellID|wallCell|boolean|keepFluids}}
|{{modarg|void}}|{{moddef|list|plot_line|dot||Coord|where|boolean|horiz|CellID|cell|CellSet|block}}
|{{modarg|void}}|{{moddef|list|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|CellID|cell|CellSet|block}}
|{{modarg|void}}|{{moddef|list|scatter|dot||Area|where|CellID|good|CellID|fill|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_blood|dot||Area|where|CellID|[good]|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_put|dot||Area|where|Table|translation|string|tile|CellID|good|integer|count}}
|{{modarg|void}}|{{moddef|list|transmute|dot||CellID|to|CellSet|from|Area|[where]}}
|{{modarg|void}}|{{moddef|list|transmute_marker|dot||Flag|marker|CellID|To|Area|[where]}}
||'''[[#Tile Handling Functions|Tile Handling Functions]]'''
|{{modarg|Table}}|{{moddef|list|create_translation|dot||Table|code}}
|{{modarg|Tile}}|{{moddef|list|tile_new|dot||string|map|Table|translation}}
|{{modarg|void}}|{{moddef|list|tile_place|dot||Coord|where|Tile|what}}
|{{modarg|void}}|{{moddef|list|place_tile|dot||Table|translation|string|tile|integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|place_dungen_tile|dot||Table|code|Tile|tile|Coord|where}}
|{{modarg|void}}|{{moddef|list|place_symmetry_quad|dot||string|tile|Table|translation}}
|{{modarg|void}}|{{moddef|list|place_proto_map|dot||Coord|where|string|proto_map|string|proto_key|Table|code}}
||'''[[#Room Handling Functions|Room Handling Functions]]'''
|{{modarg|void}}|{{moddef|list|add_room|dot||Area|room|string|[class]}}
|{{modarg|void}}|{{moddef|list|add_rooms|dot}}
|{{modarg|Room}}|{{moddef|list|get_room|dot||integer|min_size|integer|max_x|integer|max_y|integer|max_area|string|[class]}}
|{{modarg|integer, integer}}|{{moddef|list|get_endpoints|dot||Coord|where|boolean|horiz|CellSet|what}}
|{{modarg|void}}|{{moddef|list|handle_rooms|dot||integer|count|boolean|no_monsters}}
||'''[[#Generation Algorithm Functions|Generation Algorithm Functions]]'''
|{{modarg|void}}|{{moddef|list|run_drunkard_walk|dot||Area|where|Coord|start|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]}}
|{{modarg|void}}|{{moddef|list|drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|[where]}}
|{{modarg|void}}|{{moddef|list|contd_drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|edges1|CellSet|edges2|CellSet|[ignore]|boolean|[stop_at_edge]}}
|{{modarg|void}}|{{moddef|list|warehouse_fill|dot||CellSet|fill|Area|where|integer|size|integer|count|integer|special_chance|CellSet|special}}
|{{modarg|void}}|{{moddef|list|place_blob|dot||Coord|start|integer|size|CellID|cell}}
||'''[[#Generator Helper Functions|Generator Helper Functions]]'''
|{{modarg|<value>, <value>}}|{{moddef|list|roll_pair|dot||Table|list}}
|{{modarg|integer}}|{{moddef|list|being_weight|dot}}
|{{modarg|integer}}|{{moddef|list|item_amount|dot}}
|{{modarg|void}}|{{moddef|list|horiz_river|dot||CellID|cell|integer|width|boolean|[bridge]}}
|{{modarg|void}}|{{moddef|list|vert_river|dot||CellID|cell|integer|width|boolean|bridge|integer|position}}
{{moddef|list|vert_river|dot||CellID|cell|integer|width|boolean|bridge|Coord|position}}
|{{modarg|void}}|{{moddef|list|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
|{{modarg|void}}|{{moddef|list|generate_fluids|dot||Area|[where]}}
|{{modarg|void}}|{{moddef|list|generate_barrels|dot}}
|{{modarg|void}}|{{moddef|list|generate_stairs|dot}}
|{{modarg|void}}|{{moddef|list|generate_special_stairs|dot}}
|{{modarg|void}}|{{moddef|list|place_player|dot}}
|{{modarg|void}}|{{moddef|list|run|dot||Generator|gen}}
|{{modarg|void}}|{{moddef|list|reset|dot}}
||'''[[#Dungeon Generation Functions|Dungeon Generation Functions]]'''
|{{modarg|void}}|{{moddef|list|generate_tiled|dot}}
|{{modarg|void}}|{{moddef|list|maze_dungeon|dot||CellID|floor|CellID|wall|integer|granularity|integer|tries|integer|min_size|integer|max_size}}
|{{modarg|void}}|{{moddef|list|generate_caves_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_caves_2_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_lava_dungeon|dot}}
||'''[[#Event Handler Functions|Event Handler Functions]]'''
|{{modarg|void}}|{{moddef|list|roll_event|dot}}
|{{modarg|void}}|{{moddef|list|setup_flood_event|dot||integer|direction|integer|step|CellID|cell}}
|{{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]}}
|{{modarg|void}}|{{moddef|list|setup_targeted_event|dot||integer|step}}
|}}
|}

=== Basic Cell Handling Functions ===
;{{moddef|desc|get_cell|dot|integer|Coord|loc}}
Gets the Numeric ID (NID) of the [[Modding:Cell|cell]] at a given map position.
:''loc'': The coordinates of the cell to get.
:'''Returns''': The NID of the cell.
----
;{{moddef|desc|get_cell_id|dot|string|Coord|loc}}
Gets the ID of the [[Modding:Cell|cell]] at a given map position.
:''loc'': The coordinates of the cell to get.
:'''Returns''': The string ID of the cell.
----
;{{moddef|desc|fast_get_cell|dot|integer|integer|x|integer|y}}
Gets the Numeric ID (NID) of the [[Modding:Cell|cell]] at a given map position.
:''x'': The X position of the cell to get.
:''y'': The Y position of the cell to get.
:'''Returns''': The NID of the cell.
----
;{{moddef|desc|set_cell|dot||Coord|loc|CellID|what}}
Assigns a [[Modding:Cell|cell]] to a map position.
:''loc'': The coordinates of the position to set.
:''what'': The ID of the cell to assign to the position.
----
;{{moddef|desc|fast_set_cell|dot||integer|x|integer|y|integer|what}}
Assigns a [[Modding:Cell|cell]] to a map position.
:''x'': The X position of the cell to set.
:''y'': The Y position of the cell to set.
:''what'': The NID (string IDs not allowed) of the cell to assign to the position.
----
=== Map Checking Functions ===
;{{moddef|desc|around|dot|integer|Coord|where|CellSet|what}}
Checks the positions adjacent to a location (including diagonally adjacent) and returns the number of cells that match one of the indicated cell IDs.
:''where'': The coordinate to check around. The coordinate sent in this way is not checked, only adjacent cells are.
:''what'': The cell(s) to check for.
:'''Returns''': The number of cells (from 0 to 8) that matched one of the ''what'' cell IDs.
----
;{{moddef|desc|cross_around|dot|integer|Coord|where|CellSet|what}}
Checks the positions adjacent to a location (but not diagonally adjacent) and returns the number of cells that match one of the indicated cell IDs.
:''where'': The coordinates to check around. The coordinate sent in this way is not checked, only adjacent cells are.
:''what'': The cell(s) to check for.
:'''Returns''': The number of cells (from 0 to 4) that matched one of the ''what'' cell IDs.
----
;{{moddef|desc|is_empty|dot|boolean|Coord|where|Flags|reqs}}
Checks to see if the indicated cell is "empty", defining "empty" based on a list of criteria.
:''where'': The position to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the position cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the map position does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if the cell satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|is_empty_area|dot|boolean|Area|where|Flags|reqs}}
Checks to see if the indicated area is "empty", defining "empty" based on a list of criteria.
:''where'': The area to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the area cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the area does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if every cell in the area satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|scan|dot|boolean|Area|where|CellID|good}}
Checks to see if the entire area is filled with a certain cell.
:''where'': The area to check.
:''good'': The cell to look for.
:'''Returns''': ''True'' if all cells in the area are ''good'', ''False'' otherwise.
----
=== Map Searching Functions ===
;{{moddef|desc|drop_coord|dot|Coord|Coord|where|Flags|reqs}}
Finds the nearest "empty" coordinate to a given coordinate, defining "empty" based on a list of criteria.
:''where'': The coordinate to try. If this coordinate is "empty", this coordinate will be returned.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': The nearest coordinate the satisfies the criteria. If the supplied coordinate meets the criteria, that coordinate will be returned. If not a nearby, random, coordinate will be checked.
----
;{{moddef|desc|find_coord|dot|Coord|CellSet|what|Area|[where]}}
Searches the map for the first coordinate containing one of the indicated cell IDs.
:''what'': The cell(s) to search for.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': The coordinates of the first position that contains one of the ''what'' cell IDs. The map is checked row by row starting from the top, going from left to right across each row.
----
;{{moddef|desc|random_coord|dot|Coord|Area|[where]}}
Searches for a random coordinate within the specified area.
:''where'': ''Optional.'' The area to restrict the coordinate to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate.
----
;{{moddef|desc|find_random_coord|dot|Coord|CellSet|what|Area|[where]}}
Searches for a random coordinate within the specified area that contains one of the specified cell IDs.
:''what'': The cell(s) to search for.
:''where'' : ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|find_empty_coord|dot|Coord|CellSet|what|Flags|reqs|Area|[where]}}
Searches the map for the first "empty" coordinate containing one of the indicated cell IDs, defining "empty" based on a list of criteria.
:''what'': The cell(s) to search for.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': The coordinates of the first position that meets the supplied criteria. The map is checked row by row starting from the top, going from left to right across each row.
----
;{{moddef|desc|random_empty_coord|dot|Coord|Flags|reqs|Area|[where]}}
Searches the map for a random coordinate that is "empty", defining "empty" based on a list of criteria.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the random coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|find_random_empty_coord|dot|Coord|CellSet|what|Flags|reqs|Area|[where]}}
Searches the map for a random "empty" coordinate containing one of the indicated cell IDs, defining "empty" based on a list of criteria.
:''what'': The cell(s) to search for.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the random coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|random_square|dot|Coord|CellSet|what}}
Searches for a random 3x3 area containing only specified cells.
:''what'': The cell(s) to search for.
:'''Returns''': The center coordinate of the random 3x3 area.
----
;{{moddef|desc|safe_empty_coord|dot|Coord|Area|[where]}}
Searches for a random coordinate that meets certain predetermined criteria.

The function will try to find a coordinate that does not contain a being, item, staircase, wall, harmful terrain, spawning restrictions (cells marked with LF_NOSPAWN), and is more than 5 spaces from the player (EF_NOBEINGS, EF_NOITEMS, EF_NOSTAIRS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN, and EF_NOSAFE). If a valid space isn't found, the function will ignore distance from the player (EF_NOSAFE). If a valid space still can't be found, the function will ignore stairs and harmful terrain (EF_NOSTAIRS and EF_NOHARM).
:''where'': ''Optional.'' The area to restrict the initial pass to. If a valid coordinate is not found within the area after ignoring stairs and harmful terrain, the search is restarted and expanded automatically to the entire map. If omitted, the entire map will be searched.
:'''Returns''': A random coordinate that meets the criteria.
----
;{{moddef|desc|standard_empty_coord|dot|Coord}}
Searches for a random coordinate that meets certain predetermined criteria.

The function will search for a coordinate that does not contain a being, item, staircase, wall, harmful terrain, or spawning restrictions (EF_NOBEINGS, EF_NOITEMS, EF_NOSTAIRS, EF_NOBLOCK, EF_NOHARM, and EF_NOSPAWN).
:'''Returns''': A random coordinate that meets the criteria.
----
=== Advanced Cell Handling Functions ===
;{{moddef|desc|fill|dot||CellID|what|Area|[where]}}
Fills an area of the map with a given cell.
:''what'': The cell to fill with.
:''where'': ''Optional.'' The area to fill with the cell. If omitted, the entire map will be filled.
----
;{{moddef|desc|fill_pattern|dot||Area|where|boolean|horiz|string|Table|line1|Table|[line2]}}
Fills an area of the map with a pattern of cells.
:''where'': The area to fill.
:''horiz'': If ''True'', the pattern will fill each row left to right, then move to the next row down in the area. If ''False'', the pattern will fill each column top to bottom, then move to the next column right in the area.
:''line1'': The pattern to fill with. If the pattern is shorter than the area size, the pattern will loop. The pattern does not restart at the end of a row or column.
:''line2'': ''Optional.'' If given, each time the end of row (if ''horiz'' is ''True'') or column (if ''horiz'' is ''False'') is reached, the function will switch to filling with the other pattern. That is, the first row will use ''line1'' then the second will use ''line2'', then the third will use ''line1'' again, etc.
----
;{{moddef|desc|fill_edges|dot||CellID|what}}
Fills the edges of the map with the given cell.
:''what'': The cell to fill with.
----
;{{moddef|desc|each|dot|Table|CellID|what|Area|[where]}}
Searches for a cell and returns a table containing every location it was found.
:''what'': The cell to search for.
:''where'': ''Optional.'' The area to restrict the search to.
:'''Returns''': A table containing a list of [[Modding:Coord|Coord]] objects.
----
;{{moddef|desc|set_blood|dot||Area|[where]|boolean|[value]|CellID|[what]}}
Adds blood to the map or removes blood from it.
:''where'': ''Optional.'' The area to affect. If omitted, the entire map will selected.
:''value'': ''Optional.'' ''True'' adds blood. ''False'' removes it. If omitted, the default is to add blood.
:''what'': ''Optional.'' If provided, only locations containing the given cell are affected. If omitted, all cells in the area are affected.
----
;{{moddef|desc|set_permanence|dot||Area|[where]|boolean|[value]|CellID|[what]}}
Makes cell permanent or removes their permanence.
:''where'': ''Optional.'' The area to affect. If omitted, the entire map will be selected.
:''value'': ''Optional.'' ''True'' adds permanence. ''False'' removes it. If omitted, the default is to add permanence.
:''what'': ''Optional.'' If provided, only locations containing the given cell are affected. If omitted, wall cells (which includes crate cells) are affected.
----
;{{moddef|desc|cell_set|dot|Table|CellSet|cells}}
Creates a cell group.
:''cells'': A list of cells to add to the group.
:'''Returns''': A cell group table.
----
;{{moddef|desc|restore_walls|dot||CellID|wallCell|boolean|keepFluids}}
Fixes the edge walls of the map.
:''wallCell'': The cell to fill the edge of the map with.
:''keepFluids'': ''True'' to maintain any fluid tiles on the edge of the map. ''False'' to overwrite them.
----
;{{moddef|desc|plot_line|dot||Coord|where|boolean|horiz|CellID|cell|CellSet|block}}
Splits an area into two at the indicated location.
:''where'': The starting point.
:''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.
----
;{{moddef|desc|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|CellID|cell|CellSet|block}}
Splits an area into two at the indicated location.
:''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.
:''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.
----
;{{moddef|desc|scatter|dot||Area|where|CellID|good|CellID|fill|integer|count}}
Randomly places a certain cell around the map.
:''where'': The area to scatter the cell in.
:''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 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}}
Randomly adds blood in an area.
:''where'': The area to scatter blood in.
:''good'': ''Optional.'' If defined, only locations with this cell will have blood added. If omitted, any location my have blood added.
:''count'': The number of attempts. On each attempt, a random cell in the area will be chosen to have blood added. The number of cell that will end up bloody may be less than ''count'' (or even 0), but never more.
----
;{{moddef|desc|scatter_put|dot||Area|where|Table|translation|string|tile|CellID|good|integer|count}}
Randomly adds a specified tile (a defined arrangement of cells) around the map.
:''where'': The area to scatter the tile in. The tiles will only be placed in locations entirely within the area.
:''translation'': A table with to be used with the ''tile'' argument. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string, one row of the tile per line, that lays out the arrangment of the cells. Refer to this (will be linked soon) for more information
:''good'': Only locations with this cell will be valid for the tile placement. If any coordinates of the selected placement area are not ''good'', the tile will not be placed at that location.
:''count'': The number of tiles to try to place. The placement will continue until this many have been placed, or 10,000 attempts have been made, whichever comes first.
----
;{{moddef|desc|transmute|dot||CellID|to|CellSet|from|Area|[where]}}
Changes all of one cell on the map to another cell.
:''to'': The cell that will replace the existing cells.
:''from'': The cell(s) that will be replaced.
:''where'': ''Optional.'' If specified, only cells in the area are changed. If omitted, the function will change cells across the entire map.
----
;{{moddef|desc|transmute_marker|dot||Flag|marker|CellID|To|Area|[where]}}
Changes all positions on the map that have a specified LightFlag (a named constant starting with "LF", no underscore) to another cell.
:''marker'': The LightFlag to check for. Only cells with this flag will be changed.
:''to'': The cell that will replace the existing cells.
:''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}}
Parses a translation table. Refer to this (will be linked soon) for more information.
:''code'': The translation table.
:'''Returns''': A parsed translation table.
----
;{{moddef|desc|tile_new|dot|Tile|string|map|Table|translation}}
Creates a new tile object.
:''map'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells. Refer to this (will be linked soon) for more information.
:''translation'': A table with to be used with the ''map'' argument. Refer to this (will be linked soon) for more information.
:'''Returns''': The new tile object.
----
;{{moddef|desc|tile_place|dot||Coord|where|Tile|what}}
Places the cells of the tile on the map.
:''where'': The coordinate that the upper-left of the tile should reside at.
:''what'': The tile object that will be placed.
----
;{{moddef|desc|place_tile|dot||Table|translation|string|tile|integer|x|integer|y}}
Combines the tile_new and tile_place functions together, by placing a tile using a string and translation table.
:''translation'': A table with to be used with the ''tile'' argument. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells. Refer to this (will be linked soon) for more information.
:''x'': The X position that the tile will be placed at.
:''y'': The Y position that the tile will be placed at.
----
;{{moddef|desc|place_dungen_tile|dot||Table|code|Tile|tile|Coord|where}}
Places an entire tile, including beings and items in the translation, on the map.
:''code'': The translation table. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells and indicate the positions of the beings and items. Refer to this (will be linked soon) for more information.
:''where'': The coordinate the tile will be placed at.
----
;{{moddef|desc|place_symmetry_quad|dot||string|tile|Table|translation}}
Takes a tile object and places it in all four corners. The tile object should be setup for the upper left corner and will be mirrored to the other corners. The tiles are placed one space from the map edge.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells and indicate the positions of the beings and items. Refer to this (will be linked soon) for more information.
:''translation'': The translation table. Refer to this (will be linked soon) for more information.
----
;{{moddef|desc|place_proto_map|dot||Coord|where|string|proto_map|string|proto_key|Table|code}}
Creates a map using multiple tile sets.
:''where'': The upper-left position of the map where the tiles will be layout from.
:''proto_map'': A string indicating the arrangement of the different pieces of the map. e.g., "ABCD", will lay out 4 different tiles with A on the far left and D on the far right.
:''proto_key'': A table containing, for each character in ''proto_map'', a table of the possible tiles for that section.
:''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]}}
Marks an area that can become a special room.
:''room'': The area of the room. This includes the walls.
:''class'': ''Optional.'' A string used to denote which room generators can be used on this room. If omitted, the class used is "closed".
----
;{{moddef|desc|add_rooms|dot}}
Finds all the areas that can be rooms on a map and adds them to the appropriate meta-map tables.
----
;{{moddef|desc|get_room|dot|Room|integer|min_size|integer|max_x|integer|max_y|integer|max_area|string|class}}
Selects a room given certain criteria.
:''min_size'': The smallest X and Y dimensions the room can be.
:''max_x'': The maximum width of the room.
:''max_y'': The maximum height of the room.
:''max_area'': The largest area the room can be.
:''class'': ''Optional.'' The string denoting which room classes are valid for this room generator. If omitted, "any" is used, which does not restrict the selection of rooms.
----
;{{moddef|desc|get_endpoints|dot|integer, integer|Coord|where|boolean|horiz|CellSet|what}}
Finds the ends of a line of cells.
:''where'': The starting coordinate.
:''horiz'': ''True'' checks horizontally. ''False'' checks vertically.
:''what'': The cell(s) that make up the line to check. The functions stops at the first cell '''not''' in this list.
:'''Returns''': Two integers. If ''horiz'' is ''True'', these are the X positions the line stops at. If ''horiz'' is ''False'', these are the Y positions the line stops at.
----
;{{moddef|desc|handle_rooms|dot||integer|count|boolean|no_monsters}}
Runs the rooms selection and setup process for a map.
:''count'': The number of rooms to attempt to place.
:''no_monsters'': ''True'' will exclude room generators that place monsters. ''False'' will not.
----
=== Generation Algorithm Functions ===
;{{moddef|desc|run_drunkard_walk|dot||Area|where|Coord|start|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|where}}
Runs an algorithm that walks to random adjacent spaces.
:''where'': The area that the algorithm will run in. If the algorithm tries to leave the area, it will stop early or will be pushed back in the area (''stop_at_edge'' will determine which of these happen).
:''start'': The location the algorithm will begin at.
:''steps'': The number of steps the algorithm will take. The number of spaces covered by the algorithm will be at most this number.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
----
;{{moddef|desc|drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|[where]}}
Runs multiple "drunken walk" algorithms.
:''amount'': The number of times to perform the algorithm.
:''steps'': The number of steps each run of the algorithm will take. The number of spaces covered by the algorithm will be at most the ''amount'' times the number of ''steps''.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
:''where'': ''Optional.'' The area the algorithm will run in. If the algorithm tries to leave the area, it will stop early or will be pushed back in the area (''stop_at_edge'' will determine which of these happen). If omitted, the default is entire area minus the very edge.
----
;{{moddef|desc|contd_drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|edges1|CellSet|edges2|CellSet|[ignore]|boolean|[stop_at_edge]}}
Runs multiple "drunken walk" algorithms starting at a space that doesn't have certain cells around it.
:''amount'': The number of times to perform the algorithm.
:''steps'': The number of steps each run of the algorithm will take. The number of spaces covered by the algorithm will be at most the ''amount'' times the number of ''steps''.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''edges1'': The algorithm will not start on a space with a cell listed here next to it.
:''edges2'': The algorithm will not start on a space with a cell listed here next to it.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
----
;{{moddef|desc|warehouse_fill|dot||CellID|fill|Area|where|integer|[size]|integer|[count]|integer|[special_chance]|CellID|[special]}}
Fills an area with random squares of cells.
:''fill'': The cell(s) to use for each square. If a list is given, one is chosen at random for each square.
:''where'': The area to fill.
:''size'': ''Optional.'' The size of the squares to use. If omitted, the default is 2.
:''count'': ''Optional.'' The number of attempts. If omitted, the default is 50.
:''special_chance'': ''Optional.'' A number indicating the probability of using a special list of cells to fill the square with instead of the ''fill'' list. The roll used for the chance is based on the ''size'' parameter. A number from 1 to (100 * ''size'') is chosen for each square and if the roll is less than the special_chance number, the ''special'' cell set is used to fill the square instead. If omitted, all squares will be filled from the ''fill'' set.
:''special'': ''Optional.'' The list of cells to use if the special set is to be used, based on ''special_chance''. If omitted, all squares will be filled from the ''fill'' set.
----
;{{moddef|desc|place_blob|dot||Coord|start|integer|size|CellID|cell}}
Fills an area by expanding to random edge coordinates.
:''start'': The position to start the blob at.
:''size'': The number of spaces to expand the blob to.
:''cell'': The cell to fill the blob area with.
----
=== Generator Helper Functions ===
;{{moddef|desc|roll_pair|dot|<value>, <value>|Table|list}}
Takes a list of values of any type and returns two different values randomly from the list.
:''list'': The list to choose from.
:'''Returns''': Two different values. If the list only contains one choice, it will be returned, but only once.
----
;{{moddef|desc|being_weight|dot}}
Gets the total danger level for the current dungeon level.
'''Returns''': The danger level for the current dungeon level. This value is calcuated using the current difficulty and ''level.danger_level''.
----
;{{moddef|desc|item_amount|dot}}
Gets the number of items to drop for the current dungeon level.
'''Returns''': The number of items to drop for the current dungeon level.
----
;{{moddef|desc|horiz_river|dot||CellID|cell|integer|width|boolean|[bridge]}}
Places a horizontal river on the map.
:''cell'': The cell to use for the river. It does not have to be a fluid cell.
:''width'': The width of the river.
:''bridge'': ''Optional.'' If ''True'', a 2 space wide bridge will be placed at a random coordinate on the river. If ''False'', no bridge will be placed. If omitted, the default is to not place a bridge.
----
;{{moddef|desc|vert_river|dot||CellID|cell|integer|width|boolean|bridge|integer|[position]}}
;{{moddef|desc|vert_river|dot||CellID|cell|integer|width|boolean|bridge|Coord|[position]}}
Places a vertical river on the map.
:''cell'': The cell to use for the river. It does not have to be a fluid cell.
:''width'': The width of the river.
:''bridge'': ''Optional.'' If ''True'', a 2 space wide bridge will be placed at a random coordinate on the river. If ''False'', no bridge will be placed. If omitted, the default is to not place a bridge.
:: NOTE: Because of a bug, a bridge will always be placed on the river, even if this value is set to ''False'' or omitted.
:''position'': A coordinate or an integer. If an integer is supplied, this is the X position of the river's left edge. If a coordinate is supplied, the river will start at this coordinate. If omitted, the river's left edge will be selected from between X = 19 to 58.
----
;{{moddef|desc|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
Creates rivers based on normal DoomRL 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.
:''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.
----
;{{moddef|desc|generate_stairs|dot}}
Creates the normal staircase based on normal DoomRL 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.
----
;{{moddef|desc|place_player|dot}}
Places the player on a random empty space.
----
;{{moddef|desc|run|dot||Generator|gen}}
Runs a generator object. These are stored in the generators table.
:''gen'': The generator object to run.
----
;{{moddef|desc|reset|dot}}
Resets the map.
----
=== Dungeon Generation Functions ===
;{{moddef|desc|generate_tiled|dot}}
Creates a tiled dungeon, also known as a "normal" dungeon. This only creates the layout, it does not place beings, items, stairs, barrels, or the player.
----
;{{moddef|desc|maze_dungeon|dot||CellID|floor|CellID|wall|integer|granularity|integer|tries|integer|min_size|integer|max_size}}
Creates a maze dungeon. This only creates the layout, it does not place beings, items, stairs, barrels, or the player.
:''floor'': The cell to use for the floor of the maze.
:''wall'': The cell to use for the wall of the maze.
:''granularity'': This denotes the size of the maze's paths.
:''tries'': Number of attempts to place a new wall in the maze.
:''min_size'': The smallest possible size of a wall.
:''max_size'': The largest possible size of a wall.
----
;{{moddef|desc|generate_caves_dungeon|dot}}
Runs the generation script for the cave dungeon. This is an all inclusive function, it also places all beings and items.
----
;{{moddef|desc|generate_caves_2_dungeon|dot}}
Runs the generation script for the cave-city dungeon. This is an all inclusive function, it also places all beings and items.
----
;{{moddef|desc|generate_lava_dungeon|dot}}
Runs the generation script for the lava dungeon. This is an all inclusive function, it also places all beings and items.
----
=== Event Handler Functions ===
;{{moddef|desc|roll_event|dot}}
Picks an event from the events table and sets it up.
----
;{{moddef|desc|setup_flood_event|dot||integer|direction|integer|step|CellID|cell}}
Runs the setup script for the flood event.
:''direction'': Use 1 to flood from the left. Use -1 to flood from the right.
:''step'': Number of turns (0.1 second intervals) between each flood step.
:''cell'': The cell to flood with. This does not have to be a fluid cell.
----
;{{moddef|desc|setup_deadly_air_event|dot||integer|step}}
Runs the setup script for the deadly air event.
:''step'': Number of turns between each "chill" (loss of HP).
----
;{{moddef|desc|setup_explosion_event|dot||integer|step|integer|size|integer|dice|integer|[content]}}
;{{moddef|desc|setup_explosion_event|dot||integer|step|Table|size|integer|dice|integer|[content]}}
Runs the setup script for the explosion event.
:''step'': Number of turns between each explosion.
:''size'': Either a number or a table of two numbers. Indicates the size of each explosion. If a table is supplied, the size is randomly chosen between the range supplied each time an explosion is created.
:''dice'': Number of d6 dice to use for the damage roll.
:''content'': ''Optional.'' The content to place in any space where the damage to a space is more than 20 points. If omitted, nothing will placed.
----
;{{moddef|desc|setup_targeted_event|dot||integer|step}}
Runs the setup script for the targeting event.
:''step'': Number of turns between each monster teleport.
----

Modding:generator API (0.9.9.6)

2013-06-10T04:00:22Z

Shark20061: Moving 0996 info here

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.

== 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;
|{{modarg|Coord}}|{{moddef|list|safe_empty_coord|dot}}
|{{modarg|Coord}}|{{moddef|list|standard_empty_coord|dot}}
|{{modarg|void}}|{{moddef|list|set_permanence|dot||Area|ar|boolean|val|Cell|tile}}
|{{modarg|void}}|{{moddef|list|setup_ice_event|dot}}
|{{modarg|void}}|{{moddef|list|setup_perma_event|dot}}
|{{modarg|void}}|{{moddef|list|setup_alarm_event|dot}}
|{{modarg|void}}|{{moddef|list|setup_deadly_air_event|dot||integer|step}}
|{{modarg|void}}|{{moddef|list|setup_nuke_event|dot||integer|minutes}}
|{{modarg|void}}|{{moddef|list|setup_flood_event|dot||integer|direction|integer|step|Cell|cell|boolean|pure}}
|{{modarg|integer}}|{{moddef|list|being_weight|dot}}
|{{modarg|integer}}|{{moddef|list|item_amount|dot}}
|{{modarg|void}}|{{moddef|list|restore_walls|dot||Cell|wall_cell|boolean|keep_fluids}}
|{{modarg|Cellset list}}|{{moddef|list|cell_set|dot||list|list}}
|{{modarg|void}}|{{moddef|list|horiz_river|dot||Cell|cell|integer|width|boolean|bridge}}
|{{modarg|void}}|{{moddef|list|vert_river|dot||Cell|cell|integer|width|boolean|bridge|Coord|pos}}
|{{modarg|void}}|{{moddef|list|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
|{{modarg|void}}|{{moddef|list|drunkard_walk|dot||Coord|start|integer|steps|Cell|cell|Cell list|ignore|boolean|break_on_edge}}
|{{modarg|void}}|{{moddef|list|drunkard_walks|dot||integer|amount|integer|steps|Cell|cell|Cell list|ignore|boolean|break_on_edge|Area|drunk_area}}
|{{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|warehouse_fill|dot||Cell|wall_cell|Area|fill_area|integer|box_size|integer|amount}}
|{{modarg|void}}|{{moddef|list|warehouse_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|add_room|dot||Area|room}}
|{{modarg|boolean}}|{{moddef|list|add_rooms|dot}}
|{{modarg|Room}}|{{moddef|list|get_room|dot||integer|min_size|integer|max_x|integer|max_y}}
|{{modarg|void}}|{{moddef|list|generate_tiled|dot}}
|{{modarg|void}}|{{moddef|list|generate_warehouse_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_tiled_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_tiled_arena_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_city_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_maze_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_archi_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_caves_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_arena_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_fluids|dot||Area|drunk_area}}
|{{modarg|void}}|{{moddef|list|generate_barrels|dot}}
|{{modarg|void}}|{{moddef|list|generate_stairs|dot}}
|{{modarg|void}}|{{moddef|list|generate_special_stairs|dot}}
|{{modarg|void}}|{{moddef|list|generate_lever_room|dot}}
|{{modarg|void}}|{{moddef|list|generate_teleport_room|dot}}
|{{modarg|void}}|{{moddef|list|generate_ammo_room|dot}}
|{{modarg|void}}|{{moddef|list|generate_basain|dot}}
|{{modarg|void}}|{{moddef|list|generate_warehouse_room|dot}}
|{{modarg|void}}|{{moddef|list|generate_vault|dot}}
|{{modarg|void}}|{{moddef|list|add_room_feature|dot||boolean|no_monsters}}
|{{modarg|void}}|{{moddef|list|handle_rooms|dot||boolean|no_monsters}}
|{{modarg|void}}|{{moddef|list|place_player|dot}}
|{{modarg|void}}|{{moddef|list|roll_event|dot}}
|{{modarg|void}}|{{moddef|list|reset|dot}}
|}}
|}

;{{moddef|desc|safe_empty_coord|dot}}
:Gives a coordinate that satisfies all [[Modding:Constants#Empty Flags|empty flags]]. If one cannot be found, another attempt is made that excludes EF_NOSAFE; if one still cannot be found, another attempt is made that additionally excludes EF_NOSTAIRS and EF_NOHARM.
----
;{{moddef|desc|standard_empty_coord|dot}}
:Gives a coordinate that satisfies all empty flags other than EF_NOSAFE.
----
;{{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.
----
;{{moddef|desc|setup_ice_event|dot}}
: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.
----
;{{moddef|desc|setup_perma_event|dot}}
:Adds the "sturdy" level event to the map and records it in the mortem history. Levels with the sturdy event set all wall tiles to be permanent.
----
;{{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.
----
;{{moddef|desc|setup_deadly_air_event|dot||integer|step}}
:Adds the "deadly air" event to the map and records it in the mortem history. Levels with the deadly air event cause all beings to lose hit points every '''step''' turns.
----
;{{moddef|desc|setup_nuke_event|dot||integer|minutes}}
:Adds the "armed nuke" event to the map and records it in the mortem history. Levels with the armed nuke event begin with a [[thermonuclear bomb]] set at the player's starting position, which will explode in ''minutes'' game minutes.
----
;{{moddef|desc|setup_flood_event|dot||integer|direction|integer|step|Cell|cell|boolean|pure}}
:Adds the "flood" event to the map and records it in the mortem history. Levels with the flood event are slowly filled with a fluid: ''direction'' determines whether the floor travels from the right (-1) or from the left (+1); every ''step'' turns, ''cell'' will replace all tiles in a next column to be flooded. Setting ''pure'' to false will move the player and stairs to opposite sides of the map, with the player nearest the flood.
----
;{{moddef|desc|being_weight|dot|integer}}
:Gives a value equal to the difficulty-adjusted weight of beings for a given danger level. These are the results used for the base game's monster generation parameters.
----
;{{moddef|desc|item_amount|dot|integer}}
:Gives a value equal to the number of items spawned for a given danger level. On level types where the this amount isn't preset, this is the result used for the base game's item generation parameters.
----
;{{moddef|desc|restore_walls|dot||Cell|wall_cell|boolean|keep_fluids}}
:Sets all cells on the edge of the map to ''wall_cell''. If ''keep_fluids'' is set to true, fluid tiles will be maintained but set as permanent.
----
;{{moddef|desc|cell_set|dot|Cellset list|list|list}}
:Creates a cellset for all cells in ''list''. The returned list functions just like any [[Modding:Constants#Cellsets|CELLSET constant]].
----
;{{moddef|desc|horiz_river|dot||Cell|cell|integer|width|boolean|bridge}}
:Adds a horizontal river to the map, created using ''cell'' tiles. ''width'' sets the tile-width of the river. If ''bridge'' is set to true, a non-fluid floor bridge will be created on the river.
----
;{{moddef|desc|vert_river|dot||Cell|cell|integer|width|boolean|bridge|Coord|pos}}
;{{moddef|desc|vert_river|dot||Cell|cell|integer|width|boolean|bridge|integer|pos}}
:Adds a vertical river to the map, created using ''cell'' tiles. ''width'' sets the tile-width of the river, and ''pos'' sets the starting position of the river. If ''pos'' is given as an integer, then the starting y-coordinate of the river is at the top of the map. If ''bridge'' is set to true, a non-fluid floor bridge will be created on the river.
----
;{{moddef|desc|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
:Generates a random number of horizontal and vertical rivers on the map. See [[Fluids#Rivers|Rivers]] for more information. The fluid type varies with map depth.
----
;{{moddef|desc|drunkard_walk|dot||Coord|start|integer|steps|Cell|cell|Cell list|ignore|boolean|break_on_edge}}
:Generates ''cell'' tiles according to a drunken walk algorithm. It travels ''steps'' times, starting at the coordinate ''start''. Any cells in ''ignore'' will not be set over but the algorithm will still continue. If ''break_on_edge'' is set to true, the drunken walk will stop if it hits a map border: otherwise it will continue, clamping cells within the map as necessary.
----
;{{moddef|desc|drunkard_walks|dot||integer|amount|integer|steps|Cell|cell|Cell list|ignore|boolean|break_on_edge|Area|drunk_area}}
:As Generator.drunkard_walk, but repeated ''amount'' times. Additionally, rather than specifically a starting position, all walks are chosen from a random coordinate within ''drunk_area''.
----
;{{moddef|desc|contd_drunkard_walks|dot||integer|amount|integer|steps|Cell|cell|Coord|edges1|Coord|edges2|Cell list|ignore|boolean|break_on_edge}}
:As Generator.drunkard_walks, but rather than limiting the walk's starting position, the walk will stop prematurely if it has reached the x- or y-coordinates of both ''edges1'' and ''edges2''.
----
;{{moddef|desc|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|Cell|cell|Cell list|block}}
: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}}
: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''.
----
;{{moddef|desc|warehouse_fill|dot||Cell|wall_cell|Area|fill_area|integer|box_size|integer|amount}}
:Generates ''wall_cell'' tiles in the shape of a square within ''fill_area''. ''boxsize'' sets the size of the side of a box, and ''amount'' sets the number of tries for boxes to be added.
----
;{{moddef|desc|warehouse_dungeon|dot}}
:Generates a map-wide warehouse setting. Warehouse dungeons are divided into three large rooms, each attempting 50 tries with boxes of side length 3.
----
;{{moddef|desc|add_room|dot||Area|room}}
:Adds ''room'' to the Generator.room_list and Generator.room_meta lists. This is used in conjunction with room generation functions.
----
;{{moddef|desc|add_rooms|dot|boolean}}
:As Generator.add_room, but locates all rooms on the map and adds them to Generator.room_list and Generator.room_meta instead.
----
;{{moddef|desc|get_room|dot|Room|integer|min_size|integer|max_x|integer|max_y}}
:Finds a room that contains at least ''min_size'' in both height and width, and has a width and height no bigger than ''max_x'' and ''max_y'', respectively.
----
;{{moddef|desc|generate_tiled|dot}}
:Generates a "normal" map. Normal levels are divided randomly into rectangular rooms.
----
;{{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_dungeon|dot}}
:Builds a "normal" level. This includes everything necessary to be played as a typical random level.
----
;{{moddef|desc|generate_tiled_arena_dungeon|dot}}
:Builds a "single-monster" level. This includes everything necessary to be played as a typical random level.
----
;{{moddef|desc|generate_city_dungeon|dot}}
:Builds a "city" level. This includes everything necessary to be played as a typical random level.
----
;{{moddef|desc|generate_maze_dungeon|dot}}
:Builds a "maze" level. This includes everything necessary to be played as a typical random level.
----
;{{moddef|desc|generate_archi_dungeon|dot}}
:Builds an "archi" level. This includes everything necessary to be played as a typical random level.
----
;{{moddef|desc|generate_caves_dungeon|dot}}
:Builds a "cave" level. This includes everything necessary to be played as a typical random level.
----
;{{moddef|desc|generate_arena_dungeon|dot}}
:Builds an "arena" level. This includes everything necessary to be played as a typical random level.
----
;{{moddef|desc|generate_fluids|dot||Area|drunk_area}}
:Generates all non-river fluids on the map using drunken walks, within ''drunk_area''. The fluid type varies with danger level.
----
;{{moddef|desc|generate_barrels|dot}}
:Generates all barrels on the map, The barrel type varies with danger level.
----
;{{moddef|desc|generate_stairs|dot}}
:Generates stairs on the map.
----
;{{moddef|desc|generate_special_stairs|dot}}
:Generates special stairs on the map, if a special level exists at the current map depth.
----
;{{moddef|desc|generate_lever_room|dot}}
:Finds a room of appropriate size and adjusts it into a lever room.
----
;{{moddef|desc|generate_teleport_room|dot}}
:Finds a room of appropriate size and adjusts it into a teleporter room.
----
;{{moddef|desc|generate_ammo_room|dot}}
:Finds a room of appropriate size and adjusts it into an ammo room. The type of ammo varies with danger level.
----
;{{moddef|desc|generate_basain|dot}}
:Finds a room of appropriate size and adjusts it into a room filled with fluid.
----
;{{moddef|desc|generate_warehouse_room|dot}}
:Finds a room of appropriate size and adjusts it into a room with boxes (as Generator.warehouse_fill).
----
;{{moddef|desc|generate_vault|dot}}
:Finds a room of appropriate size and adjust it into a vault. The monsters, items, and type of vault vary with danger level.
----
;{{moddef|desc|add_room_feature|dot||boolean|no_monsters}}
:Randomly selects a room generation function to be added to the map. ''no_monsters'' set to true excludes the possibility of a vault room being generated.
----
;{{moddef|desc|handle_rooms|dot||boolean|no_monsters}}
:Generates up to seven special rooms on the map and restores walls that were otherwise removed as a result of the room generation.
----
;{{moddef|desc|place_player|dot}}
:Adds to player to the map.
----
;{{moddef|desc|roll_event|dot}}
:Randomly select a level event function to be added to the map.
----
;{{moddef|desc|reset|dot}}
:Clears all generation properties and hooks, and changes the map into one bordered with the level style's walls and otherwise filled with the level style's floors.

Modding:generator API (0.9.9.7)

2013-06-10T03:59:32Z

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

Modding:Generator

2013-06-10T03:59:32Z

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

#REDIRECT [[Modding:generator API (0.9.9.7)]]

Talk:Modding:Module

2013-06-10T00:56:14Z

Shark20061: Created page with "== Module Changes for 0.9.9.7 == New module meta-data fields and the version they were introduced: ''gsupport'' (0.9.9.5): Boolean value. ''True'' marks this module as Graphic..."

== Module Changes for 0.9.9.7 ==

New module meta-data fields and the version they were introduced:

''gsupport'' (0.9.9.5): Boolean value. ''True'' marks this module as Graphics-Supported. ''False'' or omit it and a warning will appear when someone tries to run this module in graphics mode.

''klass'' (0.9.9.7): Integer value. Forces the player to be a certain class. 1 = Marine, 2 = Scout, 3 = Technician, 4 = "Solider" (used to implement classic mode -- No master traits or special bonuses).

''award'' (0.9.9.7): Table. Has two fields: ''name'', which is the friendly and ID name of the award, and ''levels'', which is another table. The levels table consists of 1 or more tables that each have two fields: ''name'', the displayed name for this level of the award, and ''desc'', the description on how to earn it. These should be placed in order of increasing prestige (the best award level should be last). The classic mode award table is shown as an example:

award = {
name = "Classicist",
levels = {
{ name = "Bronze", desc = "Complete on ITYTD" },
{ name = "Silver", desc = "Complete on HMP" },
{ name = "Gold", desc = "Complete on UV" },
{ name = "Platinum", desc = "Complete on UV/100%" },
{ name = "Diamond", desc = "Complete on N!/90%" },
{ name = "Angelic", desc = "Complete on N! w/o damage" },
},
},

Modding:being API (0.9.9.7)

2013-06-09T21:12:47Z

Shark20061: Updating with 0997 info

''This page is currently under construction.''

== API ==

Please note that the type "integer" indicates an numeric value without a decimal part. It does not indicate the range of acceptable values.

An argument name in [square brackets] is an optional one. The function description will indicate how the function operates if it is omitted.

The [[Modding:Thing#API|Thing API]] can also be used with beings.

=== Being API Function List ===

{|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"|Being Interface
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
|{{modarg|Being}}|{{moddef|list|new|dot||BeingID|id}}
|{{modarg|void}}|{{moddef|list|kill|cln||boolean|[overkill]}}
|{{modarg|void}}|{{moddef|list|ressurect|cln||integer|range}}
|{{modarg|void}}|{{moddef|list|apply_damage|cln||integer|amount|BodyTarget|target|DamageType|[type]}}
|{{modarg|void}}|{{moddef|list|get_name|cln||boolean|[known]|boolean|[capitalize]}}
|{{modarg|table}}|{{moddef|list|inv_items|cln}}
|{{modarg|Item}}|{{moddef|list|get_eq_item|cln||EquipSlot|slot}}
|{{modarg|void}}|{{moddef|list|set_eq_item|cln||EquipSlot|slot|Item|item}}
|{{modarg|boolean}}|{{moddef|list|add_inv_item|cln||Item|item}}
|{{modarg|void}}|{{moddef|list|play_sound|cln||SoundID|sound}}
|{{modarg|integer}}|{{moddef|list|get_total_resistance|cln||ResistType|resist|BodyTarget|[target]}}
|{{modarg|boolean}}|{{moddef|list|quick_swap|cln}}
|{{modarg|boolean}}|{{moddef|list|pickup|cln}}
|{{modarg|boolean}}|{{moddef|list|unload|cln||Item|item}}
|{{modarg|boolean}}|{{moddef|list|drop|cln||Item|item}}
|{{modarg|boolean}}|{{moddef|list|use|cln||Item|item}}
|{{modarg|boolean}}|{{moddef|list|wear|cln||Item|item}}
|{{modarg|boolean}}|{{moddef|list|attack|cln||Being|target}}
|{{modarg|boolean}}|{{moddef|list|attack|cln||Coord|target}}
|{{modarg|boolean}}|{{moddef|list|fire|cln||Coord|target|Item|weapon}}
|{{modarg|boolean}}|{{moddef|list|fire|cln||Coord|target|Item|weapon}}
|{{modarg|boolean}}|{{moddef|list|reload|cln}}
|{{modarg|boolean}}|{{moddef|list|alt_reload|cln}}
|{{modarg|integer}}, {{modarg|Coord}}|{{moddef|list|direct_seek|cln||Coord|dest}}
|{{modarg|void}}|{{moddef|list|relocate|cln||Coord|dest}}
|{{modarg|boolean}}|{{moddef|list|path_find|cln||Coord|dest|integer|cutoff|integer|maximum}}
|{{modarg|integer}}, {{modarg|Coord}} or {{modarg|boolean}}|{{moddef|list|path_next|cln}}
|{{modarg|Coord}}|{{moddef|list|flock_target|cln||integer|range|integer|mind|integer|maxd}}
|{{modarg|void}}|{{moddef|list|msg|cln||string|msg_player|string|msg_being}}
|{{modarg|Item}}|{{moddef|list|select_slot_by_letter|cln||string|letter}}
|{{modarg|void}}|{{moddef|list|phase|cln||CellID|[cell]}}
|{{modarg|void}}|{{moddef|list|spawn|cln||BeingID|monster}}
|{{modarg|boolean}}|{{moddef|list|act|cln||Coord|coord}}
|{{modarg|boolean}}|{{moddef|list|eye_contact|cln||Coord|other}}
|{{modarg|boolean}}|{{moddef|list|eye_contact|cln||Thing|other}}
|{{modarg|boolean}}|{{moddef|list|in_sight|cln||Coord|other}}
|{{modarg|boolean}}|{{moddef|list|in_sight|cln||Thing|other}}
|{{modarg|boolean}}|{{moddef|list|is_player|cln}}
|{{modarg|integer}}|{{moddef|list|set_items|cln||SetID|set}}
|{{modarg|void}}|{{moddef|list|nuke|cln||integer|[time]}}
|{{modarg|Item}}, {{modarg|boolean}}|{{moddef|list|pick_mod_item|cln||string|modletter|integer|techbonus}}
|}}
|}

=== Being API Function Descriptions ===
;{{moddef|desc|new|dot|Being|BeingID|id}}
Creates a new being object from the specified blueprint.
:''id'': The ID of the being to create.
:'''Returns''': A reference to the new being object.
----
;{{moddef|desc|kill|cln||boolean|[overkill]}}
Kills the being.
:''overkill'': ''Optional.'' If ''True'', the being will be gibbed (extra blood, inventory will not drop, and a corpse will not be placed). If ''False'' the being will be killed normally. If omitted, the being will be killed normally.
----
;{{moddef|desc|ressurect|cln||integer|range}}
Resurrects the nearest eligble corpse in sight of the calling being. Handles all message output.
:''range'': The maximum distance (in terms of movement) that a corpse can be in order to be eligble for resurrection.
NOTE: The function name is a misspelling.
----
;{{moddef|desc|apply_damage|cln||integer|amount|BodyTarget|target|DamageType|[type]}}
Deals damage to the being.
:''amount'': The amount of damage the attack does. This is not necessarily the amount of HP the being will lose; the being's resistance and armor may apply against this value.
:''target'': One of TARGET_INTERNAL, TARGET_TORSO, or TARGET_FEET. TARGET_INTERNAL only uses the target's internal armor and resistances (equipment, for the most part, will be ignored). TARGET_TORSO uses the item in the armor slot to help reduce the damage, and TARGET_FEET uses the item in the boots slot to help reduce the damage.
:''DamageType'': ''Optional.'' One of the named constants starting with "DAMAGE_". Indicates the type of damage being dealt, which influences the properties and effects the damage has on the target. If omitted, DAMAGE_BULLET will be used.
----
;{{moddef|desc|get_name|cln||boolean|[known]|boolean|[capitalize]}}
Returns the name of the being, with the appropriate preposition.
:''known'': ''Optional.'' If ''true'', the being will not use an article (a, an, or the) when getting the name string. If ''false'', an article (a, an, or the) will be appended to the front of the name. If omitted, the default is to use an article. BF_UNIQUENAME determines when "the" is used instead of "a" or "an".
:''capitalize'': ''Optional.'' If ''true'', the name of the being will be capitalized. If ''false'', it will not be adjusted. If omitted, the default is to not adjust.
----
;{{moddef|desc|inv_items|cln|table}}
Gets an iterator over the items in the being's inventory.
:'''Returns''': A table containing references to each item in the being's inventory.
----
;{{moddef|desc|get_eq_item|cln|Item|EquipSlot|slot}}
Retrieves the item in the indicated equipment slot. Equivalent to "being.eq.''slotname''", where ''slotname'' is "weapon", "armor", "boots", or "prepared".
:''slot'': One of SLOT_WEAPON, SLOT_ARMOR, SLOT_BOOTS, or SLOT_PREPARED.
:'''Returns''': A reference to the item equipped in the indicated slot.
----
;{{moddef|desc|set_eq_item|cln||EquipSlot|slot|Item|item}}
Equips an item to the being. Equivalent to "being.eq.''slotname'' = ''item''", where slotname is "weapon", "armor", "boots", or "prepared".
:''slot'': One of SLOT_WEAPON, SLOT_ARMOR, SLOT_BOOTS, or SLOT_PREPARED.
:''item'': The item to equip to the slot. If there is a different item in the slot already, it will be destroyed. If nil, the equipped item is destroyed.
----
;{{moddef|desc|add_inv_item|cln||Item|item}}
Adds an item to the being's inventory.
:''item'': The item to add.
:'''Returns''': ''True'' if the item was added. ''False'' if the being's inventory is full.
----
;{{moddef|desc|play_sound|cln||SoundID|sound}}
Plays a sound at the being's location.
:''sound'': The sound to play.
----
;{{moddef|desc|get_total_resistance|cln|integer|ResistType|resist|BodyTarget|[target]}}
Gets the total resistance for being, given the resistance type and target.
:''resist'': The resistance to get the value for.
:''target'': ''Optional.'' One of TARGET_INTERNAL, TARGET_TORSO, or TARGET_FEET. TARGET_INTERNAL only uses the target's internal resistance (equipment, for the most part, will be ignored). TARGET_TORSO uses the item in the armor slot to calculate resistance, and TARGET_FEET uses the item in the boots slot to calculate resistance. If omitted, TARGET_TORSO is used.
----
;{{moddef|desc|quick_swap|cln|boolean}}
Switches the weapon in the "weapon" slot with the one in the "prepared" slot. Expends energy on success.
:'''Returns''': ''True'' if the swap worked. ''False'' if it failed.
----
;{{moddef|desc|pickup|cln|boolean}}
Attempts to pickup the item at the being's current location. Expends energy on success.
:'''Returns''': ''True'' if the pickup succeeded, ''False'' if it failed.
----
;{{moddef|desc|unload|cln|boolean|Item|item}}
Attempts to unload the indicated item. Expends energy on success.
:''item'': The item to try to unload.
:'''Returns''': ''True'' if the unloading succeeded, ''False'' if it failed.
----
;{{moddef|desc|drop|cln|boolean|Item|item}}
Attempts to drop an item. Expends energy on success.
:''item'': The item to try to drop.
:'''Returns''': ''True'' if the drop succeeded, ''False'' if it failed.
----
;{{moddef|desc|use|cln|boolean|Item|item}}
Attempts to use an item. Expends energy on success.
:''item'': The item to try to use.
:'''Returns''': ''True'' if the use succeeded. ''False'' if it failed.
----
;{{moddef|desc|wear|cln|boolean|Item|item}}
Attempts to equip an item. Expends energy on success.
:''item'': The item to try to wear.
:'''Returns''': ''True'' if the item was worn. ''False'' if the command failed.
----
;{{moddef|desc|attack|cln|boolean|Being|target}}
;{{moddef|desc|attack|cln|boolean|Coord|target}}
Attempts to attack something. Expends energy on success.
:''target'': A being or a location to attack.
:'''Returns''': ''True'' if the attack was attempted. ''False'' if the being couldn't attack.
----
;{{moddef|desc|fire|cln|boolean|Coord|target|Item|weapon}}
Attempts to fire a weapon at something. Expends energy on success.
:''target'': The location to fire at.
:''weapon'': The item to fire at the location with.
:'''Returns''': ''True'' if the weapon was fired. ''False'' if it failed.
----
;{{moddef|desc|fire|cln|boolean|Coord|target|Item|weapon}}
Attempts to fire a weapon using its alternate fire mode.
:''target'': The location to fire at.
:''weapon'': The item to fire at the location with.
:'''Returns''': ''True'' if the weapon was fired. ''False'' if it failed.
----
;{{moddef|desc|reload|cln|boolean}}
Attempts to reload the equipped weapon.
:'''Returns''': ''True'' if the weapon was loaded with at least 1 ammo. ''False'' if the weapon didn't get any ammo put in it at all.
----
;{{moddef|desc|alt_reload|cln|boolean}}
Attemptes to reload the equipped weapon using its alternate reload.
:'''Returns''': ''True'' if the weapon was loaded with at least 1 ammo. ''False'' if the weapon didn't get any ammo put in it at all.
----
;{{moddef|desc|direct_seek|cln|integer, Coord|Coord|dest}}
Attempts to move directly toward a location. Expends energy only on a successful move. The being will try moving around objects in its way. It will only move at most 1 space for each time this is called.
:''dest'': The location to attempt to move toward.
:'''Returns''': An integer, representing the result of the move, and a Coord, holding the previous location of the being. The integer can be 0 (MOVEOK), 1 (MOVEBLOCK), 2 (MOVEDOOR), or 3 (MOVEBEING). 0 means the move was successful, and energy was expended. 1 means there was a wall in the way. 2 means there was door or other CF_OPENABLE cell in the way. 3 means a being was in the way.
----
;{{moddef|desc|relocate|cln||Coord|dest}}
Moves the being to the indicated location, with animations.
:''dest'': The location to move the being to.
----
;{{moddef|desc|path_find|cln|boolean|Coord|dest|integer|cutoff|integer|maximum}}
Search for a path to the indicated location. Pathfinding is a time intensive procedure, use conservatively.
:''dest'': The location to find a path to.
:''cutoff'': A path finding parameter. The search is aborted if this number of positions are checked without getting closer to the target destination. DoomRL uses 10 for normal enemies and 40 for bosses. Larger values may cause the algorithm to take longer.
:''maximum'': A path finding parameter. The search is aborted if this number of positions are checked without reaching the target. DoomRL uses 40 for normal enemies and 200 for bosses. Larger values may cause the algorithm to take longer.
:'''Returns''': ''True'' if a path was found, ''False'' if not.
----
;{{moddef|desc|path_next|cln|integer, Coord}} or '''boolean'''
Moves the being to the next space on the found path.
:'''Returns''': If there is a valid path, an integer, representing the result of the move, and a Coord, holding the previous location of the being, are returned. The integer can be 0 (MOVEOK), 1 (MOVEBLOCK), 2 (MOVEDOOR), or 3 (MOVEBEING). 0 means the move was successful, and energy was expended. 1 means there was a wall in the way. 2 means there was door or other CF_OPENABLE cell in the way. 3 means a being was in the way. If there was no valid path to move along, the boolean value ''False'' is returned instead.
----
;{{moddef|desc|flock_target|cln|Coord|integer|range|integer|mind|integer|maxd}}
Assigns a coord based on other beings of the same type.
:''range'': The distance to check.
:''mind'': Matching beings will try to keep this much distance between them.
:''maxd'': Matching beings will try to be at least this close to each other.
:'''Returns''': A coordinate. If the beings are ''mind'' away or closer, the coordinate will be away from the closest matching being. If the beings are ''maxd'' away or farther, the coordinate will be the location of the closest being. Otherwise, the coordinate is a random position within ''range''.
----
;{{moddef|desc|msg|cln||string|msg_player|string|msg_being}}
Prints a message depending on the status of the subject of the message.
:''msg_player'': ''Optional.'' If the calling being is the player, this message will be printed. If omitted, no message is printed if called by the player.
:''msg_being'': ''Optional.'' If the calling being is not the player, but is in the player's vision, this message will be printed. If omitted, no message is printed if called by a visible non-player being.
----
;{{moddef|desc|select_slot_by_letter|cln|Item|string|letter}}
Gets the slot based on the character entered.
:''letter'': A single character string.
:'''Returns''': If letter is "a", the item in the armor slot is returned. If letter is "b", the item in the boots slot is returned. If letter is "w", the item in the weapon slot is returned. If letter is "p", the item in the prepared slot is returned. Otherwise, nil is returned.
----
;{{moddef|desc|phase|cln||CellID|[cell]}}
Teleports the being to a new cell.
:''cell'': ''Optional.'' A cell id to search for. If multiple cells of that id are on the level, one is picked at random. If omitted, any cell empty of beings, items, stairs, walls, hazardous terrain, or LFNOSPAWN can be selected.
----
;{{moddef|desc|spawn|cln||BeingID|monster}}
Summons monsters around this being. Monsters summoned this way grant no experience to the player (that is, BF_NOEXP is set on the spawned beings).
:''monster'': The ID of the being to spawn.
----
;{{moddef|desc|act|cln|boolean|Coord|coord}}
Makes the being interact with the indicated location.
:''coord'': The location to interact with.
:'''Returns''': ''True'' if the action was successful, ''False'' if not.
----
;{{moddef|desc|eye_contact|cln|boolean|Coord|other}}
;{{moddef|desc|eye_contact|cln|boolean|Thing|other}}
Checks if something is visible from this being's location.
:''other'': A Coord, Being, or Item whose position will be checked.
:'''Returns''': ''True'' if the being can see the checked object or location, ''False'' if not.
----
;{{moddef|desc|in_sight|cln|boolean|Coord|other}}
;{{moddef|desc|in_sight|cln|boolean|Thing|other}}
Checks to see if something can be from the being's location. If the being is the player, the player's vision algorithm is used. Otherwise, the being's eye_contact algorithm is used.
:''other'': A Coord, Being, or Item whose position will be checked.
:'''Returns''': ''True'' if the object is visible, ''False'' if not.
----
;{{moddef|desc|is_player|cln|boolean}}
Returns whether this being is the player or not.
:'''Returns''': ''True'' if this being is the player. ''False'' if it is not.
----
;{{moddef|desc|set_items|cln|integer|SetID|set}}
Gets the number of items worn by the being that are part of a set.
:''set'': The set to check.
:'''Returns''': The number of items of that set worn by this being.
----
;{{moddef|desc|nuke|cln||integer|[time]}}
Creates a nuke under the being and sets the nuke timer.
:''time'': ''Optional.'' The number of game turns the the nuke will go off in. If omitted, the default is 1.
----
;{{moddef|desc|pick_mod_item|cln|Item, boolean|string|modletter|integer|techbonus}}
Performs the choice, check, and attachment of a mod to an item. Only the player can call this function.
:''modletter'': The letter representing the mod being attached. Standard DoomRL mod letters are:
Agility: A Tech: T Bulk: B Power: P
Sniper: S Firestorm: F Nano: N Onyx: O
Custom modpacks should use different letters.
:''techbonus'': The number of points of tech bonus the being has. DoomRL uses the Whizkid level for this number.
:'''Returns''': An Item and a boolean. The Item returned is the resulting item after being modded with the mod pack, unless an assembly (mod array) was matched and accepted. The boolean value is ''True'' if the modding was successful or ''False'' if it was not. If the boolean value is ''False'' or the Item was turned into an assembly, Nil is returned instead of the item.
----

Modding:being API (0.9.9.6)

2013-06-09T20:22:14Z

Shark20061: Copying 0.9.9.6 data here.

== API ==
The [[Modding:Thing#API|Thing API]] can also be used with beings.

{|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"|Being Interface
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
|[[Modding:Being|Being]]|being.[[#being_new|new]]([[Modding:Being|Being ID]] id)
|'''void'''|[[Modding:Being|Being]]:[[#being_destroy|destroy]]('''boolean''' silent)
|'''void'''|[[Modding:Being|Being]]:[[#being_kill|kill]]('''boolean''' overkill)
|'''void'''|[[Modding:Being|Being]]:[[#being_ressurect|ressurect]]('''integer''' rrange)
|'''void'''|[[Modding:Being|Being]]:[[#being_apply_damage|apply_damage]]('''integer''' damage, [[Modding:Constants#BodyTarget|BodyTarget]] target, [[Modding:Constants#DamageType|DamageType]] damageType)
|'''string'''|[[Modding:Being|Being]]:[[#being_get_name|get_name]]('''boolean''' known, '''boolean''' capitalized)
|[[Modding:Item|Item]]|[[Modding:Being|Being]]:[[#being_get_inv_item|get_inv_item]]('''integer''' slot)
|'''void'''|[[Modding:Being|Being]]:[[#being_set_inv_item|set_inv_item]]('''integer''' slot, [[Modding:Item|Item]] item)
|[[Modding:Item|Item]]|[[Modding:Being|Being]]:[[#being_get_eq_item|get_eq_item]]([[Modding:Constants#Equip Slots|Equip Slot]] slot)
|'''void'''|[[Modding:Being|Being]]:[[#being_set_eq_item|set_eq_item]]([[Modding:Constants#Equip Slots|Equip Slot]] slot, [[Modding:Item|Item]] item)
|'''void'''|[[Modding:Being|Being]]:[[#being_play_sound|play_sound]]('''Sound ID''' sound)
|'''integer'''|[[Modding:Being|Being]]:[[#being_get_total_resistance|get_total_resistance]]([[Modding:Constants#Resistance|Resistance]] resistance, [[Modding:Constants#BodyTarget|BodyTarget]] target)
|'''boolean'''|[[Modding:Being|Being]]:[[#being_use|use]]('''integer''' slot)
|'''boolean'''|[[Modding:Being|Being]]:[[#being_wear|wear]]('''integer''' slot)
|'''boolean'''|[[Modding:Being|Being]]:[[#being_pickup|pickup]]([[Modding:Coord|Coord]] pos)
|'''void'''|[[Modding:Being|Being]]:[[#being_attack|attack]]([[Modding:Coord|Coord]] or [[Modding:Being|Being]] target)
|'''void'''|[[Modding:Being|Being]]:[[#being_fire|fire]]([[Modding:Coord|Coord]] target, [[Modding:Item|Item]] weapon)
|'''boolean'''|[[Modding:Being|Being]]:[[#being_reload|reload]]()
|'''integer'''|[[Modding:Being|Being]]:[[#being_direct_seek|direct_seek]]([[Modding:Coord|Coord]] target)
|'''boolean'''|[[Modding:Being|Being]]:[[#being_path_find|path_find]]([[Modding:Coord|Coord]] target, '''integer''' cutoff, '''integer''' maximum)
|'''integer'''|[[Modding:Being|Being]]:[[#being_path_next|path_next]]()
|[[Modding:Coord|Coord]]|[[Modding:Being|Being]]:[[#being_flock_target|flock_target]]('''integer''' range, '''integer''' mind, '''integer''' maxd)
|'''void'''|[[Modding:Being|Being]]:[[#being_msg|msg]]('''string''' msg_player, '''string''' msg_being)
|[[Modding:Item|Item]]|[[Modding:Being|Being]]:[[#being_select_slot_by_letter|select_slot_by_letter]]('''string''' letter)
|'''void'''|[[Modding:Being|Being]]:[[#being_phase|phase]]([[Modding:Cell|Cell ID]] cell)
|'''void'''|[[Modding:Being|Being]]:[[#being_spawn|spawn]]([[Modding:Being|Being ID]] being)
|'''boolean'''|[[Modding:Being|Being]]:[[#being_is_visible|is_visible]]()
|'''boolean'''|[[Modding:Being|Being]]:[[#being_is_player|is_player]]()
|'''integer'''|[[Modding:Being|Being]]:[[#being_set_items|set_items]]([[Modding:ItemSet|ItemSet]] set)
|'''void'''|[[Modding:Being|Being]]:[[#being_nuke|nuke]]('''integer''' time)
|[[Modding:Item|Item]], '''boolean'''|[[Modding:Being|Being]]:[[#being_pick_mod_item|pick_mod_item]]('''string''' modletter, '''integer''' techbonus)
|}}
|}

{{Anchor|being_new}}
;being.new([[Modding:Being|Being ID]] id) → [[Modding:Being|Being]]
:This creates a newly allocated being of the appropriate type. The being won't exist on the map until it is placed by e.g. Level.drop_being.
----
{{Anchor|being_destroy}}
;[[Modding:Being|Being]]:destroy('''boolean''' silent)
:Deallocates the memory associated with the being and removes it from the level (if applicable). The normal results of killing a being (e.g. leaving a corpse) are ignored. The ''silent'' parameter is optional. If true, applicable OnKill and OnKillAll hooks and events will also be ignored.
----
{{Anchor|being_kill}}
;[[Modding:Being|Being]]:kill('''boolean''' overkill)
:Kills the being. If the optional ''overkill'' parameter is true, then the being will be gibbed.
----
{{Anchor|being_ressurect}}
;[[Modding:Being|Being]]:ressurect('''integer''' rrange)
:Resurrects a single corpse that is found within a square of side-length 2 × ''rrange'' + 1, centered around the being. Nearer corpses are preferred. The corpse must not have another being standing on it and must be within sight of the being (as determined by the enemy line-of-sight algorithm). The resurrected being (if any) will have BF_NOEXP set. Messages are included.
----
{{Anchor|being_apply_damage}}
;[[Modding:Being|Being]]:apply_damage('''integer''' damage, [[Modding:Constants#BodyTarget|BodyTarget]] target, [[Modding:Constants#DamageType|DamageType]] damageType)
:Deals damage to the being using the given body target and damage type. (The default damage type is bullet damage.)
----
{{Anchor|being_get_name}}
;[[Modding:Being|Being]]:get_name('''boolean''' known, '''boolean''' capitalized) → '''string'''
:Returns the name of the being. If ''known'' is true, "the" is added, otherwise "a" or "an" is added. If BF_UNIQUENAME is set for the being, then no article is used in either case. If ''capitalized'' is true, then the first letter will be capitalized.
----
{{Anchor|being_get_inv_item}}
;[[Modding:Being|Being]]:get_inv_item('''integer''' slot) → [[Modding:Item|Item]]
;[[Modding:Being|Being]].inv['''integer''' slot] → [[Modding:Item|Item]]
:Returns the item in the given slot in the being's inventory. If the slot is empty, nil is returned instead.
----
{{Anchor|being_set_inv_item}}
;[[Modding:Being|Being]]:set_inv_item('''integer''' slot, [[Modding:Item|Item]] item)
;[[Modding:Being|Being]].inv['''integer''' slot] = [[Modding:Item|Item]] item
:Sets the given slot in the being's inventory to the given item. If the slot wasn't empty before, the previous constents are lost.
----
{{Anchor|being_get_eq_item}}
;[[Modding:Being|Being]]:get_eq_item([[Modding:Constants#Equip Slots|Equip Slot]] slot) → [[Modding:Item|Item]]
;[[Modding:Being|Being]].eq[[[Modding:Constants#Equip Slots|Equip Slot]] slot] → [[Modding:Item|Item]]
:Returns the item in the given equipment slot of the being. If the slot is empty, nil is returned instead. There are additional shorthands for each equipment slot: the ''eq'' table has .weapon, .prepared, .armor, and .boots fields.
----
{{Anchor|being_set_eq_item}}
;[[Modding:Being|Being]]:set_eq_item([[Modding:Constants#Equip Slots|Equip Slot]] slot, [[Modding:Item|Item]] item)
;[[Modding:Being|Being]].eq[[[Modding:Constants#Equip Slots|Equip Slot]] slot] = [[Modding:Item|Item]] item
:Sets the being's equipment slot to the given item. Any item that was previously in that slot is lost. There are additional shorthands for each equipment slot: the ''eq'' table has .weapon, .prepared, .armor, and .boots fields.
----
{{Anchor|being_play_sound}}
;[[Modding:Being|Being]]:play_sound('''Sound ID''' sound)
:Plays the given sound as if it came from the being's position.
----
{{Anchor|being_get_total_resistance}}
;[[Modding:Being|Being]]:get_total_resistance([[Modding:Constants#Resistance|Resistance]] resistance, [[Modding:Constants#BodyTarget|BodyTarget]] target) → '''integer'''
:Calculates the being's effective resistance against attacks of the given target (default is body). This accounts for inherent resists as well as equipment bonuses.
----
{{Anchor|being_use}}
;[[Modding:Being|Being]]:use('''integer''' slot) → '''boolean'''
;[[Modding:Being|Being]]:use([[Modding:Item|Item]] item) → '''boolean'''
:This makes the being use the given consumable item from its inventory. The function always returns false. (Bug: it is supposed to return true on success.)
----
{{Anchor|being_wear}}
;[[Modding:Being|Being]]:wear('''integer''' slot) → '''boolean'''
;[[Modding:Being|Being]]:wear([[Modding:Item|Item]] item) → '''boolean'''
:This makes the being wear the given eqipment from its inventory. Returns true on success and false on failure.
----
{{Anchor|being_pickup}}
;[[Modding:Being|Being]]:pickup([[Modding:Coord|Coord]] pos) → '''boolean'''
:This makes the being pick up the item at the given position. ''pos'' is optional; it defaults to the being's position. Returns true on success and false on failure.
----
{{Anchor|being_attack}}
;[[Modding:Being|Being]]:attack([[Modding:Coord|Coord]] or [[Modding:Being|Being]] target)
:This makes the being do a standard melee attack against the targeted being or coord.
----
{{Anchor|being_fire}}
;[[Modding:Being|Being]]:fire([[Modding:Coord|Coord]] target, [[Modding:Item|Item]] weapon)
:This makes the being fire at ''target'' with ''weapon''.
----
{{Anchor|being_reload}}
;[[Modding:Being|Being]]:reload() → '''boolean'''
:This makes the being reload its currently equipped weapon. The return value is true if there being had at least some of the appropriate ammo to attempt reloading with.
----
{{Anchor|being_direct_seek}}
;[[Modding:Being|Being]]:direct_seek([[Modding:Coord|Coord]] target) → '''integer'''
:This makes the being take a step towards the target. The being will always try to travel in a direct path. The return value is either 0, 1, 2, or 3. 0 indicates success, 1 indicates that a wall blocked the move, 2 indicates that a door blocked the move, and 3 indicates that a being blocked the move.
----
{{Anchor|being_path_find}}
;[[Modding:Being|Being]]:path_find([[Modding:Coord|Coord]] target, '''integer''' cutoff, '''integer''' maximum) → '''boolean'''
:This attempts to calculate a path between the being and ''target''. The ''cutoff'' and ''maximum'' parameters are somewhat technical, but basically they indicate how much time should be spend searching for a path. DoomRL uses 40, 200 for bosses and 10, 40 for normal enemies. The path will be remembered by the being, and can be followed using path_next. Modders should keep in mind that path-finding is a somewhat expensive operation, especially for large ''cutoff'' and ''maximum''. The return value indicates whether a path was found. Even if no path was found, a path will be loaded that will try to take the being closer to the target (although this path may be empty). This uses the AStar searching algorithm using Euclidean distance as a heuristic. The search is aborted if ''maximum'' nodes are expanded without finding the target or it ''cutoff'' nodes are expanded without getting closer to the target. When aborted, a path is created to the closest expanded node to the target in terms of the heuristic.
----
{{Anchor|being_path_next}}
;[[Modding:Being|Being]]:path_next() → '''integer'''
:This causes the being to take a step along the path last calculated by path_find. The return value follows the pattern of direct_seek.
----
{{Anchor|being_flock_target}}
;[[Modding:Being|Being]]:flock_target('''integer''' range, '''integer''' mind, '''integer''' maxd) → [[Modding:Coord|Coord]]
:This looks for the closest being of the same type to the being (within a square ''range''). If the being is farther than ''maxd'' away, then its position is returned. If it is closer than ''mind'', then a position opposite from the closest with respect to the being is returned. Otherwise (or if there is no nearby being of the same type), a random coord from the scanning area is returned.
----
{{Anchor|being_msg}}
;[[Modding:Being|Being]]:msg('''string''' msg_player, '''string''' msg_being)
:If the being is the player, then ''msg_player'' is displayed. If the being is not the player, but visible to the player, the ''msg_being'' is displayed. If either message is nil it is ignored.
----
{{Anchor|being_select_slot_by_letter}}
;[[Modding:Being|Being]]:select_slot_by_letter('''string''' letter) → [[Modding:Item|Item]]
:Returns the one of the being's equipment where "a" is for armor, "b" is for boots, "w" is for weapon, and "p" is for the prepared slot. If the slot is empty, nil is returned.
----
{{Anchor|being_phase}}
;[[Modding:Being|Being]]:phase([[Modding:Cell|Cell ID]] cell)
:If ''cell'' is omitted, then the being is displaced randomly as if it used a [[phase device]] (without the flashy interface stuff). If the cell is included, the being is displaced to a random cell of the given cell id. If the chosen cell is occupied, a nearby cell is used. If no such cell exists, a random cell is chosen.
----
{{Anchor|being_spawn}}
;[[Modding:Being|Being]]:spawn([[Modding:Being|Being ID]] being)
;[[Modding:Being|Being]]:spawn([[Modding:Being|Being]] being)
:Drops a new being of the appropriate type (or the given being) nearby. The dropped being is set with the BF_NOEXP flag.
----
{{Anchor|being_is_visible}}
;[[Modding:Being|Being]]:is_visible() → '''boolean'''
:Determines if the player can see the being.
----
{{Anchor|being_is_player}}
;[[Modding:Being|Being]]:is_player() → '''boolean'''
:Determines if the being is the player.
----
{{Anchor|being_set_items}}
;[[Modding:Being|Being]]:set_items([[Modding:ItemSet|ItemSet]] set) → '''integer'''
:Counts the number of the being's equipped items that belong to the given set.
----
{{Anchor|being_nuke}}
;[[Modding:Being|Being]]:nuke('''integer''' time)
:Sets the nuke timer to ''time'' and changes the cell under the being to the nuke cell. By default, ''time'' is 1. (Setting the nuke time to 0 will disable the countdown.)
----
{{Anchor|being_pick_mod_item}}
;[[Modding:Being|Being]]:pick_mod_item('''string''' modletter, '''integer''' techbonus) → [[Modding:Item|Item]], '''boolean'''
:This only works for the player. This gives the player the item select menu used by mods, and calculates whether the mod is legal (using the given ''techbonus''). This includes assembly checking. The first return value is the item on success. The second return value is true on

Modding:player API

2013-05-30T21:43:15Z

Shark20061: Redirected page to Modding:player API (0.9.9.7)

#REDIRECT [[Modding:player_API_(0.9.9.7)]]

Modding:player API (0.9.9.7)

2013-05-30T21:37:40Z

Shark20061: Created page with "''This page is currently under construction.'' You can also use the being API and thing API with the player, since it is also a being. {|class="wikitable" style="border: 2px so..."

''This page is currently under construction.''

You can also use the being API and thing API with the player, since it is also a being.

{|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"|Player Interface
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
|{{modarg|void}}|{{moddef|list|set_affect|col||AffectID|id|integer|duration}}
|{{modarg|integer}}|{{moddef|list|get_affect_time|cln||AffectID|id}}
|{{modarg|void}}|{{moddef|list|remove_affect|cln||AffectID|id}}
|{{modarg|boolean}}|{{moddef|list|is_affect|cln||AffectID|id}}
|{{modarg|void}}|{{moddef|list|add_exp|cln||integer|xp}}
|{{modarg|boolean}}|{{moddef|list|has_won|cln}}
|{{modarg|integer}}|{{moddef|list|get_trait|cln||TraitID}}
|{{modarg|string}}|{{moddef|list|get_trait_hist|cln}}
|{{modarg|void}}|{{moddef|list|power_backpack|cln}}
|{{modarg|void}}|{{moddef|list|win|cln}}
|{{modarg|void}}|{{moddef|list|continue_game|cln}}
|{{modarg|void}}|{{moddef|list|choose_trait|cln}}
|{{modarg|void}}|{{moddef|list|level_up|cln}}
|{{modarg|void}}|{{moddef|list|exit|cln||string|[next]}}
|{{modarg|void}}|{{moddef|list|exit|cln||integer|[next]}}
|{{modarg|void}}|{{moddef|list|quick_weapon|cln||ItemID|id}}
|{{modarg|void}}|{{moddef|list|set_inv_size|cln||integer|size}}
|{{modarg|void}}|{{moddef|list|mortem_print|cln||string|line}}
|{{modarg|void}}|{{moddef|list|remove_medals|cln||table|medallist}}
|{{modarg|void}}|{{moddef|list|remove_award|cln||AwardID|award}}
|{{modarg|void}}|{{moddef|list|set_award|cln||AwardID|award|integer|level}}
|{{modarg|boolean}}|{{moddef|list|has_award|cln||AwardID|award|integer|level}}
|{{modarg|integer}}|{{moddef|list|get_award|cln||AwardID|award}}
|{{modarg|void}} |{{moddef|list|remove_medal|cln||MedalID|medal}}
|{{modarg|void}} |{{moddef|list|add_medal|cln||MedalID|medal}}
|{{modarg|boolean}}|{{moddef|list|has_medal|cln||MedalID|medal}}
|{{modarg|void}} |{{moddef|list|remove_badge|cln||BadgeID|badge}}
|{{modarg|void}} |{{moddef|list|add_badge|cln||BadgeID|badge}}
|{{modarg|boolean}}|{{moddef|list|has_badge|cln||BadgeID|badge}}
|{{modarg|void}} |{{moddef|list|remove_assembly|cln||ModArrayID|assembly}}
|{{modarg|void}} |{{moddef|list|add_assembly|cln||ModArrayID|assembly}}
|{{modarg|boolean}}|{{moddef|list|has_assembly|cln||ModArrayID|assembly}}
|{{modarg|void}} |{{moddef|list|remove_found_item|cln||ItemID|item}}
|{{modarg|void}} |{{moddef|list|add_found_item|cln||ItemID|item}}
|{{modarg|boolean}}|{{moddef|list|has_found_item|cln||ItemID|item}}
|{{modarg|void}} |{{moddef|list|add_history|cln||string|line}}
|}}
|}
----
;{{moddef|desc|set_affect|col||AffectID|id|integer|duration}}
Adds the indicated affect to the player.
:''id'': The ID of the affect to add.
:''duration'': The number of actions to add the affect for. If the affect is already active, the duration is extended by this amount.
----
;{{moddef|desc|get_affect_time|cln|integer|AffectID|id}}
Gets the remaining duration of the indicated affect.
:''id'': The ID of the affect to get the duration for.
:'''Returns''': The remaining duration of the affect.
----
;{{moddef|desc|remove_affect|cln||AffectID|id}}
Removes the indicated affect from the player.
:''id'': The ID of the affect to remove.
----
;{{moddef|desc|is_affect|cln|boolean|AffectID|id}}
Checks to see if the given affect is active on the player.
:''id'': The ID of the affect to check for.
:'''Returns''': ''True'' if the affect is currently active on the player, ''False'' if not.
----
;{{moddef|desc|add_exp|cln||integer|xp}}
Gives the player extra experience points.
:''xp'': The amount of experience to add.
----
;{{moddef|desc|has_won|cln|boolean}}
Indicates whether the player has won or not.
:'''Returns''': ''True'' if the player has won the game, ''False'' if not.
----
;{{moddef|desc|get_trait|cln|integer|TraitID}}
integer player:get_trait ( integer trait )
Gets the current level of a given trait.
:''trait'': The trait to get the level for.
:'''Returns''': The level of the trait.
----
;{{moddef|desc|get_trait_hist|cln|string}}
Gets the history string for the player's traits ("Iro->Iro->HR").
:'''Returns''': The history string.
----
;{{moddef|desc|power_backpack|cln}}
Gives the player the BF_BACKPACK flag and re-packs the ammo items in the inventory.
----
;{{moddef|desc|win|cln}}
Makes the player win the game and ends the game at the end of the turn.
----
;{{moddef|desc|continue_game|cln}}
Stops the game from ending at the end of the turn.
----
;{{moddef|desc|choose_trait|cln}}
Opens the trait menu and allows the player to pick a new trait.
----
;{{moddef|desc|level_up|cln}}
Increments the player's level count, calls the level up hooks, opens the trait menu, and prints the appropriate messages.
----
;{{moddef|desc|exit|cln||string|[next]}}
;{{moddef|desc|exit|cln||integer|[next]}}
Leaves the current level and goes to the specified level.
:''next'': ''Optional.'' The string ID of the special level to go to, or the number of the level in the episode to exit to. If omitted, the default is to go to the next numbered level in the episode.
----
;{{moddef|desc|quick_weapon|cln||ItemID|id}}
Quick-swaps the equipped weapon with indicated weapon ID, if it is in the player's inventory.
:''id'': The id of the weapon to swap to.
----
;{{moddef|desc|set_inv_size|cln||integer|size}}
Sets the number of usable slots in the player's inventory.
:''size'': A number from 1 to MAX_INV_SIZE to set the number of available slots to.
----
;{{moddef|desc|mortem_print|cln||string|line}}
Writes a line of the mortem. Can only be used while printing the mortem.
:''line'': The text to write.
----
;{{moddef|desc|remove_medals|cln||table|medallist}}
Removes specified medals from the player's earned medals list.
:''medallist'': The list of medals to remove.
----
;{{moddef|desc|remove_award|cln||AwardID|award}}
Removes a custom award from the player's data.
:''award'': The award to remove.
----
;{{moddef|desc|set_award|cln||AwardID|award|integer|level}}
Grants the indicated award to the player.
:''award'': The award to give.
:''level'': The quality level of the award to give.
----
;{{moddef|desc|has_award|cln|boolean|AwardID|award|integer|level}}
Indicates if the player has earned the specified award.
:''award'': The award to check for.
:''level'': The minimum quality level of the award to check for.
:'''Returns''': ''True'' if the player has at least the given level of the given award, ''False'' otherwise.
----
;{{moddef|desc|get_award|cln|integer|AwardID|award}}
Gets the quality level of a specified award.
:''award'': The award to look for.
:'''Returns''': The current level of the award earned. 0 is returned if the award has not been earned at all.
----
;{{moddef|desc|remove_medal|cln||MedalID|medal}}
Removes a medal from the player's earned medals.
:''medal'': The medal to remove.
----
;{{moddef|desc|add_medal|cln||MedalID|medal}}
Grants a medal to the player.
:''medal'': The medal to give.
----
;{{moddef|desc|has_medal|cln|boolean|MedalID|medal}}
Checks if the player has a specified medal.
:''medal'': The medal to check for.
:'''Returns''': ''True'' if the player has earned the medal, ''False'' if they have not.
----
;{{moddef|desc|remove_badge|cln||BadgeID|badge}}
Removes a badge from the player's earned badges.
:''badge'': The badge to remove.
----
;{{moddef|desc|add_badge|cln||BadgeID|badge}}
Grants a badge to the player.
:''badge'': The badge to add.
----
;{{moddef|desc|has_badge|cln|boolean|BadgeID|badge}}
Checks to see if the player has the specified badge.
:''badge'': The badge to check for.
:'''Returns''': ''True'' if the player has earned the indicated badge, ''False'' if not.
----
;{{moddef|desc|remove_assembly|cln||ModArrayID|assembly}}
Removes an assembly from the list of created assemblies.
:''assembly'': The assembly to remove.
----
;{{moddef|desc|add_assembly|cln||ModArrayID|assembly}}
Adds an assembly to the list of created assemblies.
:''assembly'': The assembly to add.
----
;{{moddef|desc|has_assembly|cln|boolean|ModArrayID|assembly}}
Checks to see if the player has the specified assembly in the list of created assemblies.
:''assembly'': The assembly to check for.
:'''Returns''': ''True'' if the assembly is in the list, ''False'' if it is not.
----
;{{moddef|desc|remove_found_item|cln||ItemID|item}}
Removes the indicated item from the list of found items.
:''item'': The item to remove.
----
;{{moddef|desc|add_found_item|cln||ItemID|item}}
Adds the indicated item to the list of found items.
:''item'': The item to add.
----
;{{moddef|desc|has_found_item|cln|boolean|ItemID|item}}
Checks to see if the player has the indicated item.
:''item'': The item to check for.
:'''Returns''': ''True'' if the player has found the item, ''False'' if they have not.
----
;{{moddef|desc|add_history|cln||string|line}}
Adds a line to the history section of the mortem. Can be called anywhere prior to the end of printing the mortem.
:''line'': The line of text to add. Use "@1" in the string to insert the current depth.
----

Modding:level API (0.9.9.7)

2013-05-24T15:01:49Z

Shark20061: Replacing old information with new, old info moved to (0.9.9.6) page.

''This page is currently under construction.''

== API ==

Please note that the type "integer" indicates an numeric value without a decimal part. It does not indicate the range of acceptable values.

The argument type "CellID" may be the numeric or string ID of a cell.

The argument type "CellSet" may be the numeric ID, string ID, or a list of numeric and/or string IDs.

The argument types "Flag" and "Flags" expect a single [[Modding:Constants|flag constant]] of the indicated type, and a list of such flag constants, respectively.

The argument type "any" means any lua type.

An argument name in [square brackets] is an optional one. The function description will indicate how the function operates if it is omitted.

=== Table Parameters ===

Some of the functions in the Level API take a parameter in a special table format. Those functions have a parameter type of *ParamTable*. When calling these functions, the keys of the table given as the argument must '''exactly''' match the names given, although they may appear in any order. Details for which keys are looked for are provided in the function's description. Additional keys specified in these tables will be ignored.

=== Level API Function List ===
{|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 - Functions'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
||'''[[#Level Object Functions|Level Object Functions]]'''
|{{modarg|string}}|{{moddef|list|get_id|col}}
|{{modarg|integer}}|{{moddef|list|get_uid|col}}
|{{modarg|string}}|{{moddef|list|get_type|col}}
|{{modarg|Area}}|{{moddef|list|get_area|col}}
|{{modarg|object}}|{{moddef|list|get_parent|col}}
|{{modarg|integer}}|{{moddef|list|get_child_count|col}}
|{{modarg|table}}|{{moddef|list|children|col||string|filter}}
|{{modarg|table}}|{{moddef|list|children_in_range|col||Coord|where|integer|range|string|filter}}
|{{modarg|void}}|{{moddef|list|destroy|col}}
||'''[[#Level Property Functions|Level Property Functions]]'''
|{{modarg|void}}|{{moddef|list|add_property|col||any|key|any|val}}
|{{modarg|any}}|{{moddef|list|get_property|col||any|key}}
|{{modarg|boolean}}|{{moddef|list|has_property|col||any|key}}
|{{modarg|void}}|{{moddef|list|remove_property|col||any|key}}
|{{modarg|void}}|{{moddef|list|set_property|col||any|key|any|value}}
||'''[[#Cell Level Functions|Cell Level Functions]]'''
|{{modarg|CellID}}|{{moddef|list|get_cell|col||Coord|where}}
|{{modarg|integer}}|{{moddef|list|raw_get_cell|col||integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|set_cell|col||Coord|where|CellID|what}}
|{{modarg|void}}|{{moddef|list|raw_set_cell|col||integer|x|integer|y|integer|what}}
|{{modarg|integer}}|{{moddef|list|get_hp|col||Coord|where}}
|{{modarg|void}}|{{moddef|list|set_hp|col||Coord|where|integer|new_hp}}
|{{modarg|boolean}}|{{moddef|list|get_light_flag|col||Flag|what|Coord|[where]}}
|{{modarg|void}}
{{modarg|void}}|{{moddef|list|set_light_flag|col||Flag|what|boolean|[value]|Coord|[where]}}
{{moddef|list|set_light_flag|col||Flag|what|boolean|[value]|Area|[where]}}
|{{modarg|boolean}}|{{moddef|list|is_visible|col||Coord|a}}
|{{modarg|boolean}}|{{moddef|list|eye_contact|col||Coord|a|Coord|b}}
|{{modarg|boolean}}|{{moddef|list|is_empty|col||Coord|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|is_empty_area|col||Area|where|Flags|reqs}}
||'''[[#Being Level Functions|Being Level Functions]]'''
|{{modarg|table}}|{{moddef|list|beings|col}}
|{{modarg|table}}|{{moddef|list|beings_in_range|col||Coord|where|integer|range}}
|{{modarg|Being}}|{{moddef|list|get_being|col||Coord|where}}
|{{modarg|Being}}|{{moddef|list|drop_being|col||Being|what|Coord|where}}
|{{modarg|void}}|{{moddef|list|drop_being_ext|col||Being|being|Coord|where}}
|{{modarg|void}}|{{moddef|list|clear_being|col||Coord|where|boolean|silent}}
|{{modarg|table}}|{{moddef|list|get_being_table|col||integer|[danger]|table|[weights]|table|[reqs]|integer|[dmod]}}
|{{modarg|void}}|{{moddef|list|flood_monster|col||*ParamTable*|args}}
|{{modarg|void}}|{{moddef|list|flood_monsters|col||*ParamTable*|args}}
|{{modarg|BeingID}}|{{moddef|list|roll_being|col||*ParamTable*|args}}
|{{modarg|void}}|{{moddef|list|summon|col||BeingID|id|integer|[count]}}
{{moddef|list|summon|col||*ParamTable*|args}}
||'''[[#Item Level Functions|Item Level Functions]]'''
|{{modarg|table}}|{{moddef|list|items|col}}
|{{modarg|table}}|{{moddef|list|items_in_range|col||Coord|where|integer|range}}
|{{modarg|Item}}|{{moddef|list|get_item|col||Coord|where}}
|{{modarg|Item}}|{{moddef|list|drop_item|col||string|what|Coord|where|boolean|[onfloor]}}
{{moddef|list|drop_item|col||table|what|Coord|where|boolean|[onfloor]}}
|{{modarg|void}}|{{moddef|list|drop_item_ext|col||table|item|Coord|where}}
{{moddef|list|drop_item_ext|col||string|item|Coord|where}}
|{{modarg|void}}|{{moddef|list|try_destroy_item|col||Coord|where}}
|{{modarg|table}}|{{moddef|list|get_item_table|col||integer|[dlevel]|table|[weights]|table|[reqs]}}
|{{modarg|void}}|{{moddef|list|flood_items|col||integer|amount}}
{{moddef|list|flood_items|col||*ParamTable*|args}}
|{{modarg|ItemID}}|{{moddef|list|roll_item|col||*ParamTable*|args}}
|{{modarg|Item}}|{{moddef|list|drop|col||ItemID|id|integer|[count]}}
|{{modarg|Item}}|{{moddef|list|area_drop|col||Area|where|ItemID|id|integer|[count]|boolean|[onfloor]}}
||'''[[#Miscellanous Functions|Miscellanous Functions]]'''
|{{modarg|void}}|{{moddef|list|explosion|col||Coord|where|integer|size|integer|delay|integer|dice|integer|sides|Color|color|SoundID|[sound_id]|DamageType|[type]|ExplosionFlags|[flags]|CellID|[content]}}
|{{modarg|void}}|{{moddef|list|flood|col||CellID|tile|Area|flood_area}}
|{{modarg|boolean}}|{{moddef|list|is_corpse|col||Coord|c}}
|{{modarg|void}}|{{moddef|list|nuke|col}}
|{{modarg|void}}|{{moddef|list|play_sound|col||SoundID|sound_id|Coord|where}}
|{{modarg|void}}|{{moddef|list|player|col||integer|x|integer|y}}
|{{modarg|boolean}}|{{moddef|list|push_cell|col||Coord|c|Coord|target|boolean|[quiet]}}
|{{modarg|void}}|{{moddef|list|recalc_fluids|col}}
|{{modarg|void}}|{{moddef|list|register_hook|col||string|hookname|any|func}}
|}}
|}
=== Level Object Functions ===
;{{moddef|desc|get_id|col|string}}
Gets the ID of the level.
:'''Returns''': The string ID of the level.
----
;{{moddef|desc|get_uid|col|integer}}
Gets the unique ID (UID) of the level.
:'''Returns''': The numeric ID of the level.
----
;{{moddef|desc|get_type|col|string}}
Gets the type of this object.
:'''Returns''': The string "level".
----
;{{moddef|desc|get_area|col|Area}}
Gets the level's entire area.
:'''Returns''': An [[Modding:Area|Area]] object encompassing the entire map.
----
;{{moddef|desc|get_parent|col|object}}
Gets the parent of this object.
:'''Returns''': Nil. Level has no parent object.
----
;{{moddef|desc|get_child_count|col|integer}}
Gets the number of children this object is the parent of. All beings and items on the level are children of the level object.
:'''Returns''': Total number of beings and items on the map (being count will include the player).
----
;{{moddef|desc|children|col}}
Gets a table containing each child object of level. All beings and items on the level are children of the level object.
:'''Returns''': A table of all beings and items on the map.
----
;{{moddef|desc|destroy|col}}
Destroys the level object. ''You should not call this in your lua script.''
----
=== Level Property Functions ===
;{{moddef|desc|add_property|col||any|key|any|value}}
Adds a user-defined property to the level object.
:''key'': The value to refer to the property by.
:''value'': The corresponding value of the property.
----
;{{moddef|desc|get_property|col|any|any|key}}
Retrieves the value of a user-defined property.
:''key'': The property's key value, defined when it was added.
:'''Returns''': The current value of the property.
----
;{{moddef|desc|has_property|col|boolean|any|key}}
Checks to see if the given property exists.
:''key'': The property key to check for.
:'''Returns''': ''True'' if the property exists, ''False'' if it does not.
----
;{{moddef|desc|remove_property|col||any|key}}
Removes a property from the level object.
:''key'': The key of the property to remove.
----
;{{moddef|desc|set_property|col||any|key|any|value}}
Assigns a new value to an existing property.
:''key'': The key of the property to change.
:''value'': The new value to assign to the property.
----
=== Cell Level Functions ===
;{{moddef|desc|get_cell|col|CellID|Coord|where}}
Gets the cell at a specific map coordinate.
:''where'': The location to get.
:'''Returns''': The ID of the cell at the location.
----
;{{moddef|desc|raw_get_cell|col|integer|integer|x|integer|y}}
Gets the cell ID at a specific map coordinate.
:''x'': The X position of the coordinate to get.
:''y'': The Y position of the coordinate to get.
:'''Returns''': The numeric ID of the cell at the coordinates.
----
;{{moddef|desc|set_cell|col||Coord|where|CellID|what}}
Assigns a new cell to a map coordinate.
:''where'': The location to change.
:''what'': The cell to assign to the location.
----
;{{moddef|desc|raw_set_cell|col||integer|x|integer|y|integer|what}}
Assigns a new cell to a map coordinate.
:''x'': The X position of the location to change.
:''y'': The Y position of the location to change.
:''what'': The numeric ID of the cell to assign.
----
;{{moddef|desc|get_hp|col|integer|Coord|where}}
Gets the HP of the cell at the specified location.
:''where'': The coordinate to get the HP amount from.
:'''Returns''': The amount of HP the cell has.
----
;{{moddef|desc|set_hp|col||Coord|where|integer|new_hp}}
Sets the HP of the cell at the specified location.
:''where'': The coordinate to set.
:''new_hp'': The new HP value to set for the coordinate.
----
;{{moddef|desc|get_light_flag|col|boolean|Flag|what|Coord|where}}
Checks a cell for a certain light flag.
:''what'': The LightFlag (named constant that starts with LF) to check for. Refer to [[Modding:Constants#Light Flag|this]] for more info.
:''where'': The location to check.
:'''Returns''': ''True'' if the flag is set. ''False'' if it is not.
----
;{{moddef|desc|set_light_flag|col||Flag|what|boolean|[value]|Coord|[where]}}
;{{moddef|desc|set_light_flag|col||Flag|what|boolean|[value]|Area|[where]}}
Sets or unsets a LightFlag at a specified location or specified locations.
:''what'': The LightFlag (named constant that starts with LF) to check for. Refer to [[Modding:Constants#Light Flag|this]] for more info.
:''value'': ''Optional.'' ''True'' to set the flag, ''False'' to unset it. If omitted, the default is to set the flag.
:''where'': ''Optional.'' The coordinate or area to change. If an area is supplied, all cells in the area will have the flag set or unset. If omitted, the entire map will have the flag set or unset.
----
;{{moddef|desc|is_visible|col|boolean|Coord|a}}
Determines if the player can see this space.
:''a'': The space to check.
:'''Returns''': ''True'' if the player can see it, ''False'' if the player cannot.
----
;{{moddef|desc|eye_contact|col|boolean|Coord|a|Coord|b}}
Checks to see if two spaces can see each other. This check uses the monster vision algorithm, which is stricter than the player's vision algorithm.
:''a'': The first space to check.
:''b'': The second space to check.
:'''Returns''': ''True'' if the spaces are visible to each other, ''False'' if not.
----
;{{moddef|desc|is_empty|col|boolean|Coord|where|Flags|reqs}}
Checks to see if the indicated cell is "empty", defining "empty" based on a list of criteria.
:''where'': The position to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the position cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the map position does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if the cell satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|is_empty_area|col|boolean|Area|where|Flags|reqs}}
Checks to see if the indicated area is "empty", defining "empty" based on a list of criteria.
:''where'': The area to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the area cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the area does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if every cell in the area satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
=== Being Level Functions ===
;{{moddef|desc|beings|col|table}}
Gets a table containing all of the beings on the level.
:'''Returns''': A table containing all beings on the level.
----
;{{moddef|desc|beings_in_range|col|table|Coord|where|integer|range}}
Gets a table containing all of the beings within a certain distance of a location.
:''where'': The location to search around.
:''range'': The distance away from the location to get beings from.
:'''Returns''': A table containing the beings close enough to the location specified.
----
;{{moddef|desc|get_being|col|Being|Coord|where}}
Gets the being at the specified coordinate.
:''where'': The location to get the being from.
:'''Returns''': The being at the location.
----
;{{moddef|desc|drop_being|col|Being|BeingID|what|Coord|where}}
Places a being on the map.
:''what'': The id of the being to place.
:''where'': The location to attempt to drop the being. If there is already a being at that location, the being will be dropped nearby.
:'''Returns''': A reference to the being dropped.
----
;{{moddef|desc|drop_being_ext|col||BeingID|being|Coord|where}}
Places a being on the map with modifications.
:''being'': A BeingID, or a table whose first field is a BeingID, followed by the changes to the beings properties in the form ''field = new_value''.
:''where'': The location to attempt to drop the being. If there is already a being at that location, the being will be dropped nearby.
----
;{{moddef|desc|clear_being|col||Coord|where|boolean|silent}}
Removes a being from the map.
:''where'': The location to remove the being from.
:''silent'': If ''true'', the being will be removed without making any sounds or causing any messages. If ''false'', the being will act as though they were killed (complete with message and sound).
----
;{{moddef|desc|get_being_table|col|table|integer|[dlevel]|table|[weights]|table|[reqs]|integer|[dmod]}}
Gets a weight table for beings and being groups, using the indicated criteria.
:''dlevel'': ''Optional.'' The depth to pull the list of beings for. Only beings and groups that have an equal or smaller min_level and an equal or larger max_level will be selected. The ''dmod'' parameter also modifies which beings will be picked. If omitted, the current danger level (which is usually the current depth) is used.
:''weights'': ''Optional.'' A table containing modifiers to weights. The keys of the table are ids, flags, or blueprint fields to look for. For example, "former" will match the being with the id "former" (that is, Former Humans). Suppling a being flag (such as BF_BOSS or BF_ENVIROSAFE) will look for that flag in the being prototype's flag list. Suppling a blueprint field will match all beings that have that field in their blueprint table, provided that the value of the field isn't ''nil'', ''false'', or 0. Each matched being will have its weight multiplied by the value supplied for that key. For example, <tt>"former" = 2</tt> will double the weight value of Former Humans, while <tt>"former" = 0.5</tt> will halve it. If a being matches multiple entries, all are applied. (for example, the table {BF_ENVIROSAFE = 2, "pain" = 2} will match Pain Elementals twice -- since both apply a double modifier to weight, Pain Elementals will now have 4 times the weight.) If omitted, no modifications are made to weights.
:''reqs'': ''Optional.'' A table containing requirements to check for. Only beings that meet all of the requirements will be included in the resulting weight table. The keys of the table are blueprint fields that must be matched. The value for each key in the table is either a single value, which only beings whose blueprint field key has the value supplied will match, or a table of values, which will match beings that have one or more of the supplied values if the value of the blueprint field isn't a table itself, or all of the values if it is. For example, if the reqs table is <tt>{ id = "former" }</tt> , it will match Former Human (since its id is "former"). If the reqs table has <tt>{ id = {"former", "sergeant", "captain" } }</tt>, Former Human, Former Sergeant, and Former Captain will be matched. If the reqs table has <tt>{ flags = { BF_BOSS, BF_ENVIROSAFE } }</tt>, this will return all the beings with both the enviro-safe flag and the boss flag (since the flags blueprint field is a table itself). If omitted, no beings or groups are excluded (aside from those already excluded by the dlevel and dmod parameters).
:''dmod'': The current dlevel is adjusted by the value here for the min_level check. This allows beings with a higher min_level to be selected on an earlier depth (if positive), or exclude beings with a higher min_level for extra levels (if negative). In other words, this enables monsters to spawn "out of depth". If omitted, the default is 3 if difficulty is medium (HMP), 6 if difficulty is hard or very hard (UV and N!), and 0 otherwise.
:'''Returns''': A weight table object.
----
;{{moddef|desc|flood_monster|col||*ParamTable*|args}}
Places one or more of a single type of monster on the level.
:''args'': A table that looks for the following keys:
::''id'': The ID of the being to place.
::''danger'': The total amount of danger points worth of this monster to place. This field is optional if ''count'' is set. If both ''danger'' and ''count'' are set, the function will stop placing monsters when either ''danger'' or ''count'' is reached.
::''count'': The number of monsters to place. This field is optional if ''danger'' is set. If both ''danger'' and ''count'' are set, the function will stop placing monsters when either ''danger'' or ''count'' is reached.
::''flags'': ''Optional.'' A list of [[Modding:Constants#Empty_flags|EmptyFlags]] that determines where monsters are allowed to be placed. If omitted, the default list is { EF_NOBEINGS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN }.
----
;{{moddef|desc|flood_monsters|col||*ParamTable*|args}}
Places monsters on the level.
:''args'': A table that looks for the following keys:
::''danger'': The total amount of danger points worth of monsters to place. This field is optional if ''amount'' is set. If both ''danger'' and ''amount'' are set, the function will stop placing monsters when either ''danger'' or ''amount'' is reached.
::''amount'': The number of monsters to place. This field is optional if ''danger'' is set. If both ''danger'' and ''amount'' are set, the function will stop placing monsters when either ''danger'' or ''amount'' is reached.
::''flags'': ''Optional.'' A list of [[Modding:Constants#Empty_flags|EmptyFlags]] that determines where monsters are allowed to be placed. If omitted, the default list is { EF_NOBEINGS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN }.
::''reqs'': ''Optional.'' See get_being_table for more info about this parameter.
----
;{{moddef|desc|roll_being|col|BeingID|*ParamTable*|args}}
Picks an ID for a being out of a list.
:''args'': A table that looks for the following keys:
::''list'': A table with BeingIDs as keys and the weight for the being as the value. If this key is supplied, all other keys are ignored.
:: These next 4 keys create a being list using ''get_being_table'' if the ''list'' parameter is omitted. The ID will be selected from the resulting weight table. It will not pick a group.
::''level'': See the ''danger'' parameter for ''get_being_table''.
::''weights'': See the ''weights'' parameter for ''get_being_table''.
::''diffmod'': See the ''dmod'' parameter for ''get_being_table''.
::''reqs'': See the ''reqs'' parameter for ''get_being_table''.
----
;{{moddef|desc|summon|col||BeingID|id|integer|[count]}}
Places a given number of a single being onto the map.
:''id'': The ID of the being to place.
:''count'': ''Optional.'' The number of that being to place. If omitted, only one being will be placed.
----
;{{moddef|desc|summon|col||*ParamTable*|args}}
Places a given number of a single being onto the map.
:''args'': A table that looks for the following keys:
::''id'': The ID of the being to place.
::''count'': ''Optional.'' The number of that being to place. If omitted, only one being will be placed.
::''cell'': ''Optional.'' A cell or set of cells that are valid locations for placement of the being(s). If omitted, the beings can be placed on any cell.
::''area'': ''Optional.'' The area the beings can spawn in. If omitted, the area used is the entire map.
::''empty'': ''Optional.'' A list of [[Modding:Constants#Empty_flags|EmptyFlags]] that determines where monsters are allowed to be placed. If omitted, the default list is { EF_NOBEINGS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN } if ''cell'' is omitted, and { EF_NOBEINGS, EF_NOBLOCK } if ''cell'' is supplied.
----
=== Item Level Functions ===
;{{moddef|desc|items|col|table}}
Gets a table containing all of the items on the level.
:'''Returns''': A table containing all items on the level.
----
;{{moddef|desc|items_in_range|col|table|Coord|where|integer|range}}
Gets a table containing all of the items within a certain distance of a location.
:''where'': The location to search around.
:''range'': The distance away from the location to search around.
:'''Returns''': A table containing all of the items within range of the location.
----
;{{moddef|desc|get_item|col|Item|Coord|where}}
Gets the item at a location.
:''where'': The location to retrieve the item from.
:'''Returns''': A reference to the Item at the location.
----
;{{moddef|desc|drop_item|col|Item|string|what|Coord|where|boolean|[onfloor]}}
;{{moddef|desc|drop_item|col|Item|Item|what|Coord|where|boolean|[onfloor]}}
Places an item on the map.
:''what'': The item to place. Either a string containing the ID of the item or a table representing an existing item.
:''where'': The location to place the item. If occupied, the nearest available location will be chosen.
:''onfloor'': ''Optional.'' If true, will apply the difficulty modifier to an ammo item that is placed. If false, the ammo item is placed with the given amount of ammo. If omitted, the default is false. This argument has no effect on non-ammo items.
:'''Returns''': A reference to the dropped item.
----
;{{moddef|desc|drop_item_ext|col||table|item|Coord|where}}
;{{moddef|desc|drop_item_ext|col||string|item|Coord|where}}
Places an item with modifications on the map.
:''what'': The item to place. Either a string containing the ID of the item or a table with the ItemID string as it's first value, followed by a table containing entries in the form of <tt>"item_property" = new_value</tt> as the second value.
:''where'': The location to place the item at. If occupied, the nearest available location will be chosen.
----
;{{moddef|desc|try_destroy_item|col||Coord|where}}
Attempts to destroy the item in a specified location. This function will not destroy the item if the item has the flag IF_NODESTROY or IF_UNIQUE. To guarantee destruction of an item, call the item's :destroy() method.
:''where'': The location of the item to try to destroy.
----
;{{moddef|desc|get_item_table|col|table|integer|[dlevel]|table|[weights]|table|[reqs]}}
Gets a weight table for items, using the indicated criteria.
:''dlevel'': ''Optional.'' The depth to pull the list of items for. If omitted, the value in ''level.danger_level'' is used.
:''weights'': ''Optional.'' A table containing modifiers to weights. The keys of the table are ids, flags, or blueprint fields to look for. For example, "smed" will match Small Med-Packs. Suppling an item flag (such as IF_UNIQUE or IF_SHOTGUN, or an ITEMTYPE value) will look for that flag in the item prototype's flag list. Suppling a blueprint field will match all items that have that field in their blueprint table, provided that the value isn't ''nil'', ''false'', or 0. Each matched item will have its weight multiplied by the value supplied for that key. For example, <tt>"smed" = 2</tt> will double the weight of Small Med-Packs, while <tt>"smed" = 0.5</tt> will halve it. If an item matches multiple entries, all are applied. (For example, the table {IF_UNIQUE = 2, "uberarmor" = 2} will match Berserker Armor twice -- since both apply a double modifier to weight, Berserker Armor would have 4 times the weight.) If omitted, no modifications are made to weights.
:''reqs'': ''Optional.'' A table containing requirements to check for. Only items that meet all of the requirements will be included in the resulting weight table. The keys of the table are blueprint fields that must be matched. The value for each key in the table is either a single value, which only items whose blueprint field key has the value supplied will match, or a table of values, which will match items that have one or more of the supplied values if the value of the blueprint field isn't a table itself, or all of the values if it is. For example, if the reqs table is <tt>{ id = "smed" }</tt>, it will match Small Med-Packs (since its id is "smed"). If the reqs table has <tt>{ id = {"smed", "lmed", "phase", "hphase" }</tt>, it will match Small Med-Packs, Large Med-Packs, Phase Devices, and Homing Phase Devices. If the reqs table has <tt>{ flags = {IF_UNIQUE, IF_SHOTGUN} }</tt>, this will match all unique shotguns (since the flags blueprint field is a table itself). If omitted, no items are excluded (aside from those already excluded by other factors, such as the ''dlevel'' parameter).
::NOTE: This function has a hidden limitation when trying to generate exotics and uniques. The function will not pick exotics if the ''danger_level'' of the level is less then the current difficulty (where ITYTD = 1 and N! = 5). The function will not pick uniques if the ''danger_level'' of the level is less than 3 more than the current difficulty (where ITYTD = 1 and N! = 5). If you need to generate exotics or uniques before the indicated ''danger_level'', you can add the needed items to the resulting table yourself using the <tt>:add(<object>)</tt> method on the returned weight table object. Other functions that use this function (such as ''flood_items'' and ''roll_item'') will also have this behavior.
:'''Returns''': A weight table object.
----
;{{moddef|desc|flood_items|col||integer|amount}}
Places several different items on the level, using the default criteria.
:''amount'': The number of items to place on the level.
----
;{{moddef|desc|flood_items|col||*ParamTable*|args}}
Places several different items on the level, using specific criteria.
:''args'': A table that looks for the following keys:
::''amount'': The number of items to place on the level.
::''level'', ''weights'', ''reqs'': ''All optional.'' See the ''get_item_table'' function for more info.
----
;{{moddef|desc|roll_item|col||*ParamTable*|args}}
Picks an item at random using specified criteria.
:''args'': A table that looks for the following keys:
::''level'': ''Optional.'' Sent to ''get_item_table'' as the ''dlevel'' parameter. Refer to ''get_item_table'' for more info.
::''type'': ''Optional.'' A table containing one or more ITEMTYPE values. If supplied, only items that have one of the indicated types will be selected. If omitted, any item type can be picked.
::''weights'': ''Optional.'' Sent to ''get_item_table'' as the ''weights'' parameter. Refer to ''get_item_table'' for more info.
::''reqs'': ''Optional.'' Sent to ''get_item_table'' as the ''reqs'' parameter. Refer to ''get_item_table'' for more info.
::''unique_mod'': ''Optional.'' A multiplier to the weights of all unique items. If omitted, 1 is used.
::''exotic_mod'': ''Optional.'' A multiplier to the weights of all exotic items. If omitted, 1 is used.
::''special_mod'': ''Optional.'' A multiplier to the weights of all exotic and unique items. Combines with ''unique_mod'' and ''exotic_mod''. If omitted, 1 is used.
:'''Returns''': The ID of the rolled item.
----
;{{moddef|desc|drop|col|Item|ItemID|id|integer|[count]}}
Places one or more of a specific item on the map.
:''id'': The ID of the item to place.
:''count'': ''Optional.'' The number of the item to place. If omitted, only 1 item will be placed.
:'''Returns''': A reference to the last item placed.
----
;{{moddef|desc|area_drop|col|Item|Area|where|ItemID|id|integer|[count]|boolean|[onfloor]}}
Places one or more of a specific item on the map in an area.
:''where'': The area to confine the item drops to.
:''id'': The Id of the item to place.
:''count'': ''Optional.'' The number of the item to place. If omitted, only 1 item will be placed.
:''onfloor'': ''Optional.'' If true, will apply the difficulty modifier to an ammo item that is placed. If false, the ammo item is placed with the given amount of ammo. If omitted, the default is false. This argument has no effect on non-ammo items.
:'''Returns''': A reference to the last item placed.
=== Miscellanous Functions ===
;{{moddef|desc|explosion|col||Coord|where|integer|size|integer|delay|integer|dice|integer|sides|Color|color|SoundID|[sound_id]|DamageType|[type]|ExplosionFlags|[flags]|CellID|[content]}}
Creates an explosion on the map.
:''where'': The location for the center of the explosion.
:''size'': The size of the explosion. If greater than 8, the explosion will be visible in all cells, including cells that are not currently in the player's vision.
:''delay'': The amount of time (in milliseconds) that each step of the explosion will take.
:''dice'': The number of dice to use for the damage. Enter 0 to prevent the explosion from dealing damage (for decoration explosions).
:''sides'': The number of sides for each die to use for the damage. Enter 0 to prevent the explosion from dealing damage (for decoration explosions).
:''color'': ''Optional.'' The color of the explosion. Not all colors will show. If omitted, a RED explosion will be used.
:''sound_id'': ''Optional.'' The ID of the sound to use for this explosion. If omitted, no sound is used.
:''type'': ''Optional.'' The type of damage this explosion deals. If omitted, the default is DAMAGE_FIRE.
:''flags'': ''Optional.'' A list of ExplosionFlags that will modify what the explosion applies to or how it applies. If omitted, no modifications are made to the explosion.
:''content'': ''Optional.'' The cell to fill cells in the explosion area with if the explosion hits a cell for more than 20 damage. If omitted, cells will not changed.
----
;{{moddef|desc|flood|col||CellID|tile|Area|flood_area}}
Replaces non-wall tiles in an area with a different tile.
:''tile'': The cell to fill with. This does not have to be a fluid cell.
:''flood_area'': The area to fill.
----
;{{moddef|desc|is_corpse|col|boolean|Coord|c}}
Indicates if a coordinate has a corpse cell or not.
:''c'': The location to check.
:'''Returns''': ''True'' if the coordinate is a corpse, ''False'' if it is not.
----
;{{moddef|desc|nuke|col}}
Instantly nukes a level.
----
;{{moddef|desc|play_sound|col||SoundID|sound_id|Coord|where}}
Plays a sound on the map.
:''sound_id'': The id of the sound to play.
:''where'': The location to play the sound at.
----
;{{moddef|desc|player|col||integer|x|integer|y}}
Set the position of the player on the map.
:''x'': The x coordinate of the position to move the player to.
:''y'': The y coordinate of the position to move the player to.
----
;{{moddef|desc|push_cell|col||Coord|c|Coord|target|boolean|[quiet]}}
Attempts to move a cell to a new location. (Swaps two cells.)
:''c'': The source coordinate.
:''target'': The destination coordinate.
:''quiet'': ''Optional.'' If ''True'', messages about success or failure as well as sounds that would play on success or failure are all suppressed. If ''False'', sounds and messages will happen as it would normally. If omitted, the default is ''False''.
----
;{{moddef|desc|recalc_fluids|col}}
Recalculates fluid edges.
----
;{{moddef|desc|register_hook|col|string|hookname|<any>|func}}
Registers a hook with this object.
:''hookname'': The name of the hook to register.
:''func'': The function to assign to the hook.
----

Modding:level API (0.9.9.6)

2013-05-24T14:53:51Z

Shark20061: Putting the documentation for the older versions here

This page is pending. The below is a dump from earlier versions.

== API ==
{{drltable|Level Interface|2|{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
|{{modarg|value}}|{{moddef|list|property_get|dot||string|property}}
|{{modarg|void}}|{{moddef|list|property_set|dot|string|property|value|value}}
|{{modarg|boolean}}|{{moddef|list|flag_get|dot||Level Flag|flag}}
|{{modarg|void}}|{{moddef|list|flag_set|dot||Level Flag|flag|boolean|value}}
|{{modarg|value}}|{{moddef|list|roll_weight|dot||list|list|integer|sum}}
|{{modarg|integer}}|{{moddef|list|weight_list_sum|dot||list|list}}
|{{modarg|void}}|{{moddef|list|place_tile|dot||table|translation|string|tile|integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|player|dot||integer|x|integer|y}}
|{{modarg|integer}}|{{moddef|list|result|dot||integer|value}}
|{{modarg|boolean}}|{{moddef|list|eye_contact|dot||Coord|c1|Coord|c2}}
|{{modarg|boolean}}|{{moddef|list|is_visible|dot||Coord|position}}
|{{modarg|void}}|{{moddef|list|nuke|dot}}
|{{modarg|void}}|{{moddef|list|explosion|dot||Coord|position|integer|radius|integer|delay|integer|damage_dice|integer|damage_sides|Color|color|Sound ID|sound|DamageType|damagetype|ExplosionFlag List|flags|Cell ID|content}}
||'''Cell-specific functions'''
|{{modarg|boolean}}|{{moddef|list|light_flag_get|dot||Coord|position|LightFlag|flag}}
|{{modarg|void}}|{{moddef|list|light_flag_set|dot||Coord|position|LightFlag|flag|boolean|value}}
|{{modarg|integer}}|{{moddef|list|hp_get|dot||Coord|position}}
|{{modarg|void}}|{{moddef|list|hp_set|dot||Coord|position|integer|value}}
|{{modarg|boolean}}|{{moddef|list|is_corpse|dot||Coord|position}}
|{{modarg|boolean}}|{{moddef|list|scan|dot||Area|scan_area|Cell ID|good}}
|{{modarg|void}}|{{moddef|list|fill|dot||Cell ID|cell|Area|fill_area}}
|{{modarg|void}}|{{moddef|list|flood|dot||Cell ID|tile|Area|flood_area}}
|{{modarg|void}}|{{moddef|list|scatter|dot||Area|scatter_area|Cell ID|good|Cell ID|fill|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_put|dot||Area|scatter_area|table|translation|string|tile|Cell ID|good|integer|count}}
|{{modarg|boolean}}|{{moddef|list|push_cell|dot||Coord|c|Coord|target|boolean|quiet}}
||'''Being-specific functions'''
|{{modarg|Being}}|{{moddef|list|get_being|dot||integer|index}}
|{{modarg|Being}}|{{moddef|list|get_being_by_uid|dot||integer|uid}}
|{{modarg|Being}}|{{moddef|list|drop_being|dot||Being ID|bid|Coord|position}}
|{{modarg|void}}|{{moddef|list|drop_being_ext|dot||table|being|Coord|position}}
|{{modarg|Being}}|{{moddef|list|summon|dot||Being ID|bid|integer|count}}
|{{modarg|Being}}|{{moddef|list|area_summon|dot||Area|where|Being ID|bid|integer|count}}
|{{modarg|void}}|{{moddef|list|clear_being|dot||Coord|position}}
|{{modarg|list}}, {{modarg|integer}}|{{moddef|list|get_being_list|dot}}
|[[Modding:Being|Being ID]]|{{moddef|list|random_being|dot}}
|{{modarg|void}}|{{moddef|list|flood_monster|dot||Being ID|bid|integer|amount}}
|{{modarg|void}}|{{moddef|list|flood_monsters|dot||integer|amount}}
|{{modarg|Being iterator}}|{{moddef|list|beings|dot}}
|{{modarg|Being iterator}}|{{moddef|list|beings_in_range|dot||Coord|position|integer|range}}
||'''Item-specific functions'''
|{{modarg|Item}}|{{moddef|list|get_item|dot||integer|index}}
|{{modarg|Item}}|{{moddef|list|get_item_by_uid|dot||integer|uid}}
|{{modarg|Item}}|{{moddef|list|drop_item|dot||Item ID|iid|Coord|position}}
|{{modarg|void}}|{{moddef|list|drop_item_ext|dot||table|item|Coord|position}}
|{{modarg|Item}}|{{moddef|list|drop|dot||Item ID|iid|integer|count}}
|{{modarg|Item}}|{{moddef|list|area_drop|dot||Area|where|Item ID|iid|integer|count}}
|{{modarg|void}}|{{moddef|list|try_destroy_item|dot||Coord|c}}
|{{modarg|list}}, {{modarg|integer}}|{{moddef|list|get_item_list|dot||integer|max_level|integer|unique_mult}}
|[[Modding:Item|Item ID]]|{{moddef|list|roll_item_type|dot||ItemType list|itypes|integer|max_level|integer|unique_mod}}
|[[Modding:Item|Item ID]]|{{moddef|list|roll_item|dot||integer|max_level|integer|unique_mod}}
|{{modarg|void}}|{{moddef|list|flood_items|dot||integer|amount|}}
|{{modarg|Item iterator}}|{{moddef|list|items|dot}}
|{{modarg|Item iterator}}|{{moddef|list|items_in_range|dot||Coord|position|integer|range}}
}}
}}

{{moddef|desc|property_get|dot|value|string|property}}
:Gets the value of the given level property. It is preferred to use the Lua dot indexing syntax instead.
----
{{moddef|desc|property_set|dot|string|property|value|value}}
:Sets the given level property to the given value. It is preferred to use the Lua dot indexing syntax instead.
----
{{moddef|desc|flag_get|dot|boolean|Level Flag|flag}}
;Level.flags[[[Modding:Constants#Level Flags|Level Flag]] flag] → '''boolean'''
:Determines the current state of the given level flag.
----
{{moddef|desc|flag_set|dot||Level Flag|flag|boolean|value}}
;Level.flags[[[Modding:Constants#Level Flags|Level Flag]] flag] = '''boolean''' value
:Sets the given level flag to the given value.
----
{{moddef|desc|roll_weight|dot|value|list|list|integer|sum}}
:Randomly chooses an item from the list according to the weight property of the list items. Sum must be the sum of the weights of all the list items.
----
{{moddef|desc|weight_list_sum|dot|integer|list|list}}
:Returns the sum of the weight properties of all the items in the list.
----
{{moddef|desc|place_tile|dot||table|translation|string|tile|integer|x|integer|y}}
:Places the map tile given by ''translation'' and ''tile'' on the map at the position given by ''x'' and ''y''. ''translation'' should be a table that maps single character strings to either cell ids, or to tables. These tables have their first array element be a cell id, but they may also contain a being and''or'' item key that is mapped to a being or item id respectively. Level.drop_being_ext and Level.drop_item_ext syntax is allowed. ''tile'' should be a string of characters that are defined in ''translation''. Line breaks correspond to line breaks on the map.
----
{{moddef|desc|player|dot||integer|x|integer|y}}
:Sets the initial position of the player for a special or scripted level. This should be called in the Create hook; after that it has no meaningful effect.
----
{{moddef|desc|result|dot|integer|integer|value}}
:If ''value'' is given, updates the level's status and returns nil. If ''value'' is omitted, returns the current status.
----
{{moddef|desc|eye_contact|dot|boolean|Coord|c1|Coord|c2}}
:Determines whether or not there is a line-of-sight path between '''c1''' and '''c2'''. This calculation ignores light flags (such that two beings can have eye contact even if they aren't visible to each other).
----
{{moddef|desc|is_visible|dot|boolean|Coord|position}}
:Determines if the given position is visible to the player.
----
{{moddef|desc|nuke|dot}}
:Triggers an immediate nuclear explosion as from a [[thermonuclear bomb]].
----
{{moddef|desc|explosion|dot||Coord|position|integer|radius|integer|delay|integer|damage_dice|integer|damage_sides|Color|color|Sound ID|sound|DamageType|damagetype|ExplosionFlag List|flags|Cell ID|content}}
:Creates an [[explosions|explosion]] centered at the given position with the given parameters. ''radius'' is the size of the explosion. ''delay'' is the delay in milliseconds between animation frames (typically this is around 40). ''damage_dice'' and ''damage_sides'' determine the damage roll for the explosion. For a no-damage explosion, both should be 0. The default damage type is fire. ''content'' determines the cell that is randomly created wherever the explosion does enough damage. By default, there are no flags and there is no content. Only some colors are supported, and these are automatically translated into 3 color combinations used by the explosion animation. The supported colors are LIGHTBLUE, BLUE, MAGENTA, GREEN, LIGHTRED, YELLOW, and the default RED.
----
{{moddef|desc|light_flag_get|dot|boolean|Coord|position|LightFlag|flag}}
;Level.light[[[Modding:Coord|Coord]] position][[[Modding:Constants#LightFlag|LightFlag]] flag] → '''boolean'''
:Gets the value of the given light flag at the given position.
----
{{moddef|desc|light_flag_set|dot||Coord|position|LightFlag|flag|boolean|value}}
;Level.light[[[Modding:Coord|Coord]] position][[[Modding:Constants#LightFlag|LightFlag]] flag] = '''boolean''' value
;Level.light[[[Modding:Constants#LightFlag|LightFlag]] flag] = '''boolean''' value
:Sets the value of the given light flag at the given position. For the syntax without a position, the light flag will be set at every position on the map.
----
{{moddef|desc|hp_get|dot|integer|Coord|position}}
;Level.hp[[[Modding:Coord|Coord]] position] → '''integer'''
:Gets the current hp of the cell at the given position.
----
{{moddef|desc|hp_set|dot||Coord|position|integer|value}}
;Level.hp[[[Modding:Coord|Coord]] position] = '''integer''' value
:Sets the current hp of the cell at the given position. Setting hp to 0 won't destroy a cell.
----
{{moddef|desc|is_corpse|dot|boolean|Coord|position}}
:Determines whether the given position has a corpse in it. This counts the cell with id "corpse" as a corpse even though it otherwise isn't a corpse as far as the engine is concerned.
----
{{moddef|desc|scan|dot|boolean|Area|scan_area|Cell ID|good}}
:Determines if every cell in ''scan_area'' is ''good''.
----
{{moddef|desc|fill|dot||Cell ID|cell|Area|fill_area}}
:Sets every cell in the given area to the area. ''fill_area'' is optional; it defaults to the full map.
----
{{moddef|desc|flood|dot||Cell ID|tile|Area|flood_area}}
:Changes CELLSET_FLOORS and CF_LIQUID tiles in the area to ''tile''. If ''tile'' has CF_HAZARD, then it will destroy items.
----
{{moddef|desc|scatter|dot||Area|scatter_area|Cell ID|good|Cell ID|fill|integer|count}}
:Chooses ''count'' random tiles in ''scatter_area'' (possibly with duplicates) and sets any chosen cells that are ''good'' to ''fill''.
----
{{moddef|desc|scatter_put|dot||Area|scatter_area|table|translation|string|tile|Cell ID|good|integer|count}}
:Chooses ''count'' random subareas with upper-left corner in ''scatter_area'' of the size appropriate of ''tile'' (using the first line length and number of lines to define a rectangular area). There may be duplicates or overlaps. For each subarea, if the area is already filled with ''good'', then it is replaced with ''tile'' (according to ''translation''). See Level.place_tile for the semantics of ''translation'' and ''tile''.
----
{{moddef|desc|push_cell|dot|boolean|Coord|c|Coord|target|boolean|quiet}}
:Swaps the content of the cells located in '''c''' and '''target''': this will only occur successfully if '''target''' is a part of CELLSET_FLOORS. If '''target''' has the CF_HAZARD flag, the cell on '''c''' activates its OnDestroy hook. '''quiet''', when set to true, includes messages (mostly specific to barrels, the only object pushed in the base game).
----
{{moddef|desc|get_being|dot|Being|integer|index}}
:Returns the being at the given index in the sparse being array. A being's index won't change as long as it is in the array.
----
{{moddef|desc|get_being_by_uid|dot|Being|integer|uid}}
:Returns the being with the given uid, or nil if that being doesn't exist or has been removed from the map.
----
{{moddef|desc|drop_being|dot|Being|Being ID|bid|Coord|position}}
:Drops a newly created being in the given position. ''bid'' can also be an actual being object, although this should not be used for beings that are already on the map. If the position is occupied, the being will be dropped nearby. The dropped being is returned. If the function fails, nil is returned.
----
{{moddef|desc|drop_being_ext|dot||table|being|Coord|position}}
:As Level.drop_being, except additional values are accetable for ''being'' as Level.drop_item_ext.
----
{{moddef|desc|summon|dot|Being|Being ID|bid|integer|count}}
:Creates new beings of the type given by ''bid'' and amount given by ''count'' and scatters them around the map. The last dropped being (if any) is returned. ''count'' is optional and defaults to 1.
----
{{moddef|desc|area_summon|dot|Being|Area|where|Being ID|bid|integer|count}}
:As Level.summon, but all the summoned beings are randomly placed in ''where'' rather than scattered across the whole map.
----
{{moddef|desc|clear_being|dot||Coord|position}}
{{moddef|desc|clear_being|dot||integer|index}}
:Removes an item from the map at the given position, or from the given index in the item array.
----
{{moddef|desc|get_being_list|dot|list,integer}}
:Returns the list and sum (ready to be used with [[#level_roll_weight|Level.roll_weight]]) for beings and beings groups according to Level.danger_level and DIFFICULTY. The result is cached.
----
{{moddef|desc|random_being|dot|Being ID}}
:Returns a random being chosen according to weights from the current level's list. This will never choose a group. The returned id is always a string id.
----
{{moddef|desc|flood_monster|dot||Being ID|bid|integer|amount}}
:Add the given monster type to the level in an amount specified by the total danger value ''amount'' (so it scales appropriately with Level.flood_monsters).
----
{{moddef|desc|flood_monsters|dot||integer|amount}}
:Adds monsters to the level using the normal algorithm for random levels. The ''amount'' is a total danger value such as a value returned by Generator.being_weight.
----
{{moddef|desc|beings|dot|Being iterator}}
:Gives an iterator over all beings in the level.
----
{{moddef|desc|beings_in_range|dot|Being iterator|Coord|position|integer|range}}
:Gives an iterator over all beings within '''range''' units of [[distance]] from '''position''' in the level.
----
{{moddef|desc|get_item|dot|Item|integer|index}}
:Returns the item at the given index in the sparse item array. An item's index won't change as long as it is in the array.
----
{{moddef|desc|get_item_by_uid|dot|Item|integer|uid}}
:Returns the item with the given uid, or nil if that item doesn't exist or has been removed from the map.
----
{{moddef|desc|drop_item|dot|Item|Item ID|iid|Coord|position}}
:Drops a newly created item in the given position. ''iid'' can also be an actual item object, although this should not be used for items that are already on the map. If the position is occupied, the item will be dropped nearby. The dropped item is returned. If the function fails, nil is returned.
----
{{moddef|desc|drop_item_ext|dot||table|item|Coord|position}}
:As Level.drop_item, except additional values are acceptable for ''item''. If ''item'' is a table, the first list element is passed used to determine which item to drop. For other key-value pairs in the table, the property of the dropped item that corresponds to the key will be set to the value.
----
{{moddef|desc|drop|dot|Item|Item ID|iid|integer|count}}
:Creates new items of the type given by ''iid'' and amount given by ''count'' and scatters them around the map. The last dropped item (if any) is returned. ''count'' is optional and defaults to 1.
----
{{moddef|desc|area_drop|dot|Item|Area|where|Item ID|iid|integer|count}}
:As Level.drop, but all dropped items are randomly placed in ''where'' rather than scattered across the whole map.
----
{{moddef|desc|try_destroy_item|dot||Coord|c}}
:Destroys an item at '''position''', if there is one to be found.
----
{{moddef|desc|get_item_list|dot|list,integer|integer|max_level|integer|unique_mult}}
:Returns the list and sum (ready to be used with [[#level_roll_weight|Level.roll_weight]]) for items according to ''max_level'', and ''unique_mult''. ''max_level'' defaults to Level.danger_level, and is used to determine which items fall in the proper level range. Unique items' weights are multiplied by ''unique_mult'' (which defaults to 1). The result is cached.
----
{{moddef|desc|roll_item_type|dot|Item ID|ItemType list|itypes|integer|max_level|integer|unique_mod}}
:Returns a random item chosen from among the given item types according to weights from the list specified by ''max_level'' and ''unique_mod''. The returned id is always a string id.
----
{{moddef|desc|roll_item|dot|Item ID|integer|max_level|integer|unique_mod}}
:As Level.roll_item_type, but the item type of the result isn't restricted.
----
{{moddef|desc|flood_items|dot||integer|amount|}}
:Adds items to the level according to the normal algorithm for random levels (not counting special features). The number of items is given by ''amount''.
----
{{moddef|desc|items|dot|Item iterator}}
:Gives an iterator over all items in the level.
----
{{moddef|desc|items_in_range|dot|Item iterator|Coord|position|integer|range}}
:Gives an iterator over all items within '''range''' units of [[distance]] from '''position''' in the level.

Modding:generator API

2013-04-25T19:24:43Z

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

Modding:generator API

2013-04-25T19:22:51Z

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

''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.

== API ==

Please note that the type "integer" indicates an numeric value without a decimal part. It does not indicate the range of acceptable values.

The argument type "CellID" may be the numeric or string ID of a cell.

The argument type "CellSet" may be the numeric ID, string ID, or a list of numeric and/or string IDs.

The argument type "Flags" expects a list of [[Modding:Constants|flag constants]] of the indicated type.

An argument name in [square brackets] is an optional one. The function description will indicate how the function operates if it is omitted.

=== Generator API Function List ===

{|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"|'''Generator Interface - Functions'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
||'''[[#Basic Cell Handling Functions|Basic Cell Handling Functions]]'''
|{{modarg|integer}}|{{moddef|list|get_cell|dot||Coord|loc}}
|{{modarg|string}}|{{moddef|list|get_cell_id|dot||Coord|loc}}
|{{modarg|integer}}|{{moddef|list|fast_get_cell|dot||integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|set_cell|dot||Coord|loc|CellID|what}}
|{{modarg|void}}|{{moddef|list|fast_set_cell|dot||integer|x|integer|y|integer|what}}
||'''[[#Map Checking Functions|Map Checking Functions]]'''
|{{modarg|integer}}|{{moddef|list|around|dot||Coord|where|CellSet|what}}
|{{modarg|integer}}|{{moddef|list|cross_around|dot||Coord|where|CellSet|what}}
|{{modarg|boolean}}|{{moddef|list|is_empty|dot||Coord|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|is_empty_area|dot||Area|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|scan|dot||Area|where|CellID|good}}
||'''[[#Map Searching Functions|Map Searching Functions]]'''
|{{modarg|Coord}}|{{moddef|list|drop_coord|dot||Coord|where|Flags|reqs}}
|{{modarg|Coord}}|{{moddef|list|find_coord|dot||CellSet|what|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|random_coord|dot||Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_random_coord|dot||CellSet|what|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_empty_coord|dot||CellSet|what|Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|random_empty_coord|dot||Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_random_empty_coord|dot||CellSet|what|Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|safe_empty_coord|dot||Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|standard_empty_coord|dot}}
||'''[[#Advanced Cell Handling Functions|Advanced Cell Handling Functions]]'''
|{{modarg|void}}|{{moddef|list|fill|dot||CellID|what|Area|[where]}}
|{{modarg|void}}|{{moddef|list|fill_pattern|dot||Area|where|boolean|horiz|Table|line1|Table|[line2]}}
|{{modarg|void}}|{{moddef|list|fill_edges|dot||CellID|what}}
|{{modarg|Table}}|{{moddef|list|each|dot||CellID|what|Area|[where]}}
|{{modarg|void}}|{{moddef|list|set_blood|dot||Area|[where]|boolean|[value]|CellID|[what]}}
|{{modarg|void}}|{{moddef|list|set_permanence|dot||Area|[where]|boolean|[value]|CellID|[what]}}
|{{modarg|Table}}|{{moddef|list|cell_set|dot||CellSet|cells}}
|{{modarg|void}}|{{moddef|list|restore_walls|dot||CellID|wallCell|boolean|keepFluids}}
|{{modarg|void}}|{{moddef|list|plot_line|dot||Coord|where|boolean|horiz|CellID|cell|CellSet|block}}
|{{modarg|void}}|{{moddef|list|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|CellID|cell|CellSet|block}}
|{{modarg|void}}|{{moddef|list|scatter|dot||Area|where|CellID|good|CellID|fill|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_blood|dot||Area|where|CellID|[good]|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_put|dot||Area|where|Table|translation|string|tile|CellID|good|integer|count}}
|{{modarg|void}}|{{moddef|list|transmute|dot||CellID|to|CellSet|from|Area|[where]}}
|{{modarg|void}}|{{moddef|list|transmute_marker|dot||Flag|marker|CellID|To|Area|[where]}}
||'''[[#Tile Handling Functions|Tile Handling Functions]]'''
|{{modarg|Table}}|{{moddef|list|create_translation|dot||Table|code}}
|{{modarg|Tile}}|{{moddef|list|tile_new|dot||string|map|Table|translation}}
|{{modarg|void}}|{{moddef|list|tile_place|dot||Coord|where|Tile|what}}
|{{modarg|void}}|{{moddef|list|place_tile|dot||Table|translation|string|tile|integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|place_dungen_tile|dot||Table|code|Tile|tile|Coord|where}}
|{{modarg|void}}|{{moddef|list|place_symmetry_quad|dot||string|tile|Table|translation}}
|{{modarg|void}}|{{moddef|list|place_proto_map|dot||Coord|where|string|proto_map|string|proto_key|Table|code}}
||'''[[#Room Handling Functions|Room Handling Functions]]'''
|{{modarg|void}}|{{moddef|list|add_room|dot||Area|room|string|[class]}}
|{{modarg|void}}|{{moddef|list|add_rooms|dot}}
|{{modarg|Room}}|{{moddef|list|get_room|dot||integer|min_size|integer|max_x|integer|max_y|integer|max_area|string|[class]}}
|{{modarg|integer, integer}}|{{moddef|list|get_endpoints|dot||Coord|where|boolean|horiz|CellSet|what}}
|{{modarg|void}}|{{moddef|list|handle_rooms|dot||integer|count|boolean|no_monsters}}
||'''[[#Generation Algorithm Functions|Generation Algorithm Functions]]'''
|{{modarg|void}}|{{moddef|list|run_drunkard_walk|dot||Area|where|Coord|start|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]}}
|{{modarg|void}}|{{moddef|list|drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|[where]}}
|{{modarg|void}}|{{moddef|list|contd_drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|edges1|CellSet|edges2|CellSet|[ignore]|boolean|[stop_at_edge]}}
|{{modarg|void}}|{{moddef|list|warehouse_fill|dot||CellSet|fill|Area|where|integer|size|integer|count|integer|special_chance|CellSet|special}}
|{{modarg|void}}|{{moddef|list|place_blob|dot||Coord|start|integer|size|CellID|cell}}
||'''[[#Generator Helper Functions|Generator Helper Functions]]'''
|{{modarg|<value>, <value>}}|{{moddef|list|roll_pair|dot||Table|list}}
|{{modarg|integer}}|{{moddef|list|being_weight|dot}}
|{{modarg|integer}}|{{moddef|list|item_amount|dot}}
|{{modarg|void}}|{{moddef|list|horiz_river|dot||CellID|cell|integer|width|boolean|[bridge]}}
|{{modarg|void}}|{{moddef|list|vert_river|dot||CellID|cell|integer|width|boolean|bridge|integer|position}}
{{moddef|list|vert_river|dot||CellID|cell|integer|width|boolean|bridge|Coord|position}}
|{{modarg|void}}|{{moddef|list|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
|{{modarg|void}}|{{moddef|list|generate_fluids|dot||Area|[where]}}
|{{modarg|void}}|{{moddef|list|generate_barrels|dot}}
|{{modarg|void}}|{{moddef|list|generate_stairs|dot}}
|{{modarg|void}}|{{moddef|list|generate_special_stairs|dot}}
|{{modarg|void}}|{{moddef|list|place_player|dot}}
|{{modarg|void}}|{{moddef|list|run|dot||Generator|gen}}
|{{modarg|void}}|{{moddef|list|reset|dot}}
||'''[[#Dungeon Generation Functions|Dungeon Generation Functions]]'''
|{{modarg|void}}|{{moddef|list|generate_tiled|dot}}
|{{modarg|void}}|{{moddef|list|maze_dungeon|dot||CellID|floor|CellID|wall|integer|granularity|integer|tries|integer|min_size|integer|max_size}}
|{{modarg|void}}|{{moddef|list|generate_caves_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_caves_2_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_lava_dungeon|dot}}
||'''[[#Event Handler Functions|Event Handler Functions]]'''
|{{modarg|void}}|{{moddef|list|roll_event|dot}}
|{{modarg|void}}|{{moddef|list|setup_flood_event|dot||integer|direction|integer|step|CellID|cell}}
|{{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]}}
|{{modarg|void}}|{{moddef|list|setup_targeted_event|dot||integer|step}}
|}}
|}

=== Basic Cell Handling Functions ===
;{{moddef|desc|get_cell|dot|integer|Coord|loc}}
Gets the Numeric ID (NID) of the [[Modding:Cell|cell]] at a given map position.
:''loc'': The coordinates of the cell to get.
:'''Returns''': The NID of the cell.
----
;{{moddef|desc|get_cell_id|dot|string|Coord|loc}}
Gets the ID of the [[Modding:Cell|cell]] at a given map position.
:''loc'': The coordinates of the cell to get.
:'''Returns''': The string ID of the cell.
----
;{{moddef|desc|fast_get_cell|dot|integer|integer|x|integer|y}}
Gets the Numeric ID (NID) of the [[Modding:Cell|cell]] at a given map position.
:''x'': The X position of the cell to get.
:''y'': The Y position of the cell to get.
:'''Returns''': The NID of the cell.
----
;{{moddef|desc|set_cell|dot||Coord|loc|CellID|what}}
Assigns a [[Modding:Cell|cell]] to a map position.
:''loc'': The coordinates of the position to set.
:''what'': The ID of the cell to assign to the position.
----
;{{moddef|desc|fast_set_cell|dot||integer|x|integer|y|integer|what}}
Assigns a [[Modding:Cell|cell]] to a map position.
:''x'': The X position of the cell to set.
:''y'': The Y position of the cell to set.
:''what'': The NID (string IDs not allowed) of the cell to assign to the position.
----
=== Map Checking Functions ===
;{{moddef|desc|around|dot|integer|Coord|where|CellSet|what}}
Checks the positions adjacent to a location (including diagonally adjacent) and returns the number of cells that match one of the indicated cell IDs.
:''where'': The coordinate to check around. The coordinate sent in this way is not checked, only adjacent cells are.
:''what'': The cell(s) to check for.
:'''Returns''': The number of cells (from 0 to 8) that matched one of the ''what'' cell IDs.
----
;{{moddef|desc|cross_around|dot|integer|Coord|where|CellSet|what}}
Checks the positions adjacent to a location (but not diagonally adjacent) and returns the number of cells that match one of the indicated cell IDs.
:''where'': The coordinates to check around. The coordinate sent in this way is not checked, only adjacent cells are.
:''what'': The cell(s) to check for.
:'''Returns''': The number of cells (from 0 to 4) that matched one of the ''what'' cell IDs.
----
;{{moddef|desc|is_empty|dot|boolean|Coord|where|Flags|reqs}}
Checks to see if the indicated cell is "empty", defining "empty" based on a list of criteria.
:''where'': The position to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the position cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the map position does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if the cell satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|is_empty_area|dot|boolean|Area|where|Flags|reqs}}
Checks to see if the indicated area is "empty", defining "empty" based on a list of criteria.
:''where'': The area to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the area cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the area does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if every cell in the area satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|scan|dot|boolean|Area|where|CellID|good}}
Checks to see if the entire area is filled with a certain cell.
:''where'': The area to check.
:''good'': The cell to look for.
:'''Returns''': ''True'' if all cells in the area are ''good'', ''False'' otherwise.
----
=== Map Searching Functions ===
;{{moddef|desc|drop_coord|dot|Coord|Coord|where|Flags|reqs}}
Finds the nearest "empty" coordinate to a given coordinate, defining "empty" based on a list of criteria.
:''where'': The coordinate to try. If this coordinate is "empty", this coordinate will be returned.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': The nearest coordinate the satisfies the criteria. If the supplied coordinate meets the criteria, that coordinate will be returned. If not a nearby, random, coordinate will be checked.
----
;{{moddef|desc|find_coord|dot|Coord|CellSet|what|Area|[where]}}
Searches the map for the first coordinate containing one of the indicated cell IDs.
:''what'': The cell(s) to search for.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': The coordinates of the first position that contains one of the ''what'' cell IDs. The map is checked row by row starting from the top, going from left to right across each row.
----
;{{moddef|desc|random_coord|dot|Coord|Area|[where]}}
Searches for a random coordinate within the specified area.
:''where'': ''Optional.'' The area to restrict the coordinate to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate.
----
;{{moddef|desc|find_random_coord|dot|Coord|CellSet|what|Area|[where]}}
Searches for a random coordinate within the specified area that contains one of the specified cell IDs.
:''what'': The cell(s) to search for.
:''where'' : ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|find_empty_coord|dot|Coord|CellSet|what|Flags|reqs|Area|[where]}}
Searches the map for the first "empty" coordinate containing one of the indicated cell IDs, defining "empty" based on a list of criteria.
:''what'': The cell(s) to search for.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': The coordinates of the first position that meets the supplied criteria. The map is checked row by row starting from the top, going from left to right across each row.
----
;{{moddef|desc|random_empty_coord|dot|Coord|Flags|reqs|Area|[where]}}
Searches the map for a random coordinate that is "empty", defining "empty" based on a list of criteria.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the random coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|find_random_empty_coord|dot|Coord|CellSet|what|Flags|reqs|Area|[where]}}
Searches the map for a random "empty" coordinate containing one of the indicated cell IDs, defining "empty" based on a list of criteria.
:''what'': The cell(s) to search for.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the random coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|random_square|dot|Coord|CellSet|what}}
Searches for a random 3x3 area containing only specified cells.
:''what'': The cell(s) to search for.
:'''Returns''': The center coordinate of the random 3x3 area.
----
;{{moddef|desc|safe_empty_coord|dot|Coord|Area|[where]}}
Searches for a random coordinate that meets certain predetermined criteria.

The function will try to find a coordinate that does not contain a being, item, staircase, wall, harmful terrain, spawning restrictions (cells marked with LF_NOSPAWN), and is more than 5 spaces from the player (EF_NOBEINGS, EF_NOITEMS, EF_NOSTAIRS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN, and EF_NOSAFE). If a valid space isn't found, the function will ignore distance from the player (EF_NOSAFE). If a valid space still can't be found, the function will ignore stairs and harmful terrain (EF_NOSTAIRS and EF_NOHARM).
:''where'': ''Optional.'' The area to restrict the initial pass to. If a valid coordinate is not found within the area after ignoring stairs and harmful terrain, the search is restarted and expanded automatically to the entire map. If omitted, the entire map will be searched.
:'''Returns''': A random coordinate that meets the criteria.
----
;{{moddef|desc|standard_empty_coord|dot|Coord}}
Searches for a random coordinate that meets certain predetermined criteria.

The function will search for a coordinate that does not contain a being, item, staircase, wall, harmful terrain, or spawning restrictions (EF_NOBEINGS, EF_NOITEMS, EF_NOSTAIRS, EF_NOBLOCK, EF_NOHARM, and EF_NOSPAWN).
:'''Returns''': A random coordinate that meets the criteria.
----
=== Advanced Cell Handling Functions ===
;{{moddef|desc|fill|dot||CellID|what|Area|[where]}}
Fills an area of the map with a given cell.
:''what'': The cell to fill with.
:''where'': ''Optional.'' The area to fill with the cell. If omitted, the entire map will be filled.
----
;{{moddef|desc|fill_pattern|dot||Area|where|boolean|horiz|string|Table|line1|Table|[line2]}}
Fills an area of the map with a pattern of cells.
:''where'': The area to fill.
:''horiz'': If ''True'', the pattern will fill each row left to right, then move to the next row down in the area. If ''False'', the pattern will fill each column top to bottom, then move to the next column right in the area.
:''line1'': The pattern to fill with. If the pattern is shorter than the area size, the pattern will loop. The pattern does not restart at the end of a row or column.
:''line2'': ''Optional.'' If given, each time the end of row (if ''horiz'' is ''True'') or column (if ''horiz'' is ''False'') is reached, the function will switch to filling with the other pattern. That is, the first row will use ''line1'' then the second will use ''line2'', then the third will use ''line1'' again, etc.
----
;{{moddef|desc|fill_edges|dot||CellID|what}}
Fills the edges of the map with the given cell.
:''what'': The cell to fill with.
----
;{{moddef|desc|each|dot|Table|CellID|what|Area|[where]}}
Searches for a cell and returns a table containing every location it was found.
:''what'': The cell to search for.
:''where'': ''Optional.'' The area to restrict the search to.
:'''Returns''': A table containing a list of [[Modding:Coord|Coord]] objects.
----
;{{moddef|desc|set_blood|dot||Area|[where]|boolean|[value]|CellID|[what]}}
Adds blood to the map or removes blood from it.
:''where'': ''Optional.'' The area to affect. If omitted, the entire map will selected.
:''value'': ''Optional.'' ''True'' adds blood. ''False'' removes it. If omitted, the default is to add blood.
:''what'': ''Optional.'' If provided, only locations containing the given cell are affected. If omitted, all cells in the area are affected.
----
;{{moddef|desc|set_permanence|dot||Area|[where]|boolean|[value]|CellID|[what]}}
Makes cell permanent or removes their permanence.
:''where'': ''Optional.'' The area to affect. If omitted, the entire map will be selected.
:''value'': ''Optional.'' ''True'' adds permanence. ''False'' removes it. If omitted, the default is to add permanence.
:''what'': ''Optional.'' If provided, only locations containing the given cell are affected. If omitted, wall cells (which includes crate cells) are affected.
----
;{{moddef|desc|cell_set|dot|Table|CellSet|cells}}
Creates a cell group.
:''cells'': A list of cells to add to the group.
:'''Returns''': A cell group table.
----
;{{moddef|desc|restore_walls|dot||CellID|wallCell|boolean|keepFluids}}
Fixes the edge walls of the map.
:''wallCell'': The cell to fill the edge of the map with.
:''keepFluids'': ''True'' to maintain any fluid tiles on the edge of the map. ''False'' to overwrite them.
----
;{{moddef|desc|plot_line|dot||Coord|where|boolean|horiz|CellID|cell|CellSet|block}}
Splits an area into two at the indicated location.
:''where'': The starting point.
:''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.
----
;{{moddef|desc|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|CellID|cell|CellSet|block}}
Splits an area into two at the indicated location.
:''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.
:''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.
----
;{{moddef|desc|scatter|dot||Area|where|CellID|good|CellID|fill|integer|count}}
Randomly places a certain cell around the map.
:''where'': The area to scatter the cell in.
:''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.
----
;{{moddef|desc|scatter_blood|dot||Area|where|CellID|[good]|integer|count}}
Randomly adds blood in an area.
:''where'': The area to scatter blood in.
:''good'': ''Optional.'' If defined, only locations with this cell will have blood added. If omitted, any location my have blood added.
:''count'': The number of attempts. On each attempt, a random cell in the area will be chosen to have blood added. The number of cell that will end up bloody may be less than ''count'' (or even 0), but never more.
----
;{{moddef|desc|scatter_put|dot||Area|where|Table|translation|string|tile|CellID|good|integer|count}}
Randomly adds a specified tile (a defined arrangement of cells) around the map.
:''where'': The area to scatter the tile in. The tiles will only be placed in locations entirely within the area.
:''translation'': A table with to be used with the ''tile'' argument. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string, one row of the tile per line, that lays out the arrangment of the cells. Refer to this (will be linked soon) for more information
:''good'': Only locations with this cell will be valid for the tile placement. If any coordinates of the selected placement area are not ''good'', the tile will not be placed at that location.
:''count'': The number of tiles to try to place. The placement will continue until this many have been placed, or 10,000 attempts have been made, whichever comes first.
----
;{{moddef|desc|transmute|dot||CellID|to|CellSet|from|Area|[where]}}
Changes all of one cell on the map to another cell.
:''to'': The cell that will replace the existing cells.
:''from'': The cell(s) that will be replaced.
:''where'': ''Optional.'' If specified, only cells in the area are changed. If omitted, the function will change cells across the entire map.
----
;{{moddef|desc|transmute_marker|dot||Flag|marker|CellID|To|Area|[where]}}
Changes all positions on the map that have a specified LightFlag (a named constant starting with "LF", no underscore) to another cell.
:''marker'': The LightFlag to check for. Only cells with this flag will be changed.
:''to'': The cell that will replace the existing cells.
:''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}}
Parses a translation table. Refer to this (will be linked soon) for more information.
:''code'': The translation table.
:'''Returns''': A parsed translation table.
----
;{{moddef|desc|tile_new|dot|Tile|string|map|Table|translation}}
Creates a new tile object.
:''map'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells. Refer to this (will be linked soon) for more information.
:''translation'': A table with to be used with the ''map'' argument. Refer to this (will be linked soon) for more information.
:'''Returns''': The new tile object.
----
;{{moddef|desc|tile_place|dot||Coord|where|Tile|what}}
Places the cells of the tile on the map.
:''where'': The coordinate that the upper-left of the tile should reside at.
:''what'': The tile object that will be placed.
----
;{{moddef|desc|place_tile|dot||Table|translation|string|tile|integer|x|integer|y}}
Combines the tile_new and tile_place functions together, by placing a tile using a string and translation table.
:''translation'': A table with to be used with the ''tile'' argument. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells. Refer to this (will be linked soon) for more information.
:''x'': The X position that the tile will be placed at.
:''y'': The Y position that the tile will be placed at.
----
;{{moddef|desc|place_dungen_tile|dot||Table|code|Tile|tile|Coord|where}}
Places an entire tile, including beings and items in the translation, on the map.
:''code'': The translation table. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells and indicate the positions of the beings and items. Refer to this (will be linked soon) for more information.
:''where'': The coordinate the tile will be placed at.
----
;{{moddef|desc|place_symmetry_quad|dot||string|tile|Table|translation}}
Takes a tile object and places it in all four corners. The tile object should be setup for the upper left corner and will be mirrored to the other corners. The tiles are placed one space from the map edge.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells and indicate the positions of the beings and items. Refer to this (will be linked soon) for more information.
:''translation'': The translation table. Refer to this (will be linked soon) for more information.
----
;{{moddef|desc|place_proto_map|dot||Coord|where|string|proto_map|string|proto_key|Table|code}}
Creates a map using multiple tile sets.
:''where'': The upper-left position of the map where the tiles will be layout from.
:''proto_map'': A string indicating the arrangement of the different pieces of the map. e.g., "ABCD", will lay out 4 different tiles with A on the far left and D on the far right.
:''proto_key'': A table containing, for each character in ''proto_map'', a table of the possible tiles for that section.
:''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]}}
Marks an area that can become a special room.
:''room'': The area of the room. This includes the walls.
:''class'': ''Optional.'' A string used to denote which room generators can be used on this room. If omitted, the class used is "closed".
----
;{{moddef|desc|add_rooms|dot}}
Finds all the areas that can be rooms on a map and adds them to the appropriate meta-map tables.
----
;{{moddef|desc|get_room|dot|Room|integer|min_size|integer|max_x|integer|max_y|integer|max_area|string|class}}
Selects a room given certain criteria.
:''min_size'': The smallest X and Y dimensions the room can be.
:''max_x'': The maximum width of the room.
:''max_y'': The maximum height of the room.
:''max_area'': The largest area the room can be.
:''class'': ''Optional.'' The string denoting which room classes are valid for this room generator. If omitted, "any" is used, which does not restrict the selection of rooms.
----
;{{moddef|desc|get_endpoints|dot|integer, integer|Coord|where|boolean|horiz|CellSet|what}}
Finds the ends of a line of cells.
:''where'': The starting coordinate.
:''horiz'': ''True'' checks horizontally. ''False'' checks vertically.
:''what'': The cell(s) that make up the line to check. The functions stops at the first cell '''not''' in this list.
:'''Returns''': Two integers. If ''horiz'' is ''True'', these are the X positions the line stops at. If ''horiz'' is ''False'', these are the Y positions the line stops at.
----
;{{moddef|desc|handle_rooms|dot||integer|count|boolean|no_monsters}}
Runs the rooms selection and setup process for a map.
:''count'': The number of rooms to attempt to place.
:''no_monsters'': ''True'' will exclude room generators that place monsters. ''False'' will not.
----
=== Generation Algorithm Functions ===
;{{moddef|desc|run_drunkard_walk|dot||Area|where|Coord|start|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|where}}
Runs an algorithm that walks to random adjacent spaces.
:''where'': The area that the algorithm will run in. If the algorithm tries to leave the area, it will stop early or will be pushed back in the area (''stop_at_edge'' will determine which of these happen).
:''start'': The location the algorithm will begin at.
:''steps'': The number of steps the algorithm will take. The number of spaces covered by the algorithm will be at most this number.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
----
;{{moddef|desc|drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|[where]}}
Runs multiple "drunken walk" algorithms.
:''amount'': The number of times to perform the algorithm.
:''steps'': The number of steps each run of the algorithm will take. The number of spaces covered by the algorithm will be at most the ''amount'' times the number of ''steps''.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
:''where'': ''Optional.'' The area the algorithm will run in. If the algorithm tries to leave the area, it will stop early or will be pushed back in the area (''stop_at_edge'' will determine which of these happen). If omitted, the default is entire area minus the very edge.
----
;{{moddef|desc|contd_drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|edges1|CellSet|edges2|CellSet|[ignore]|boolean|[stop_at_edge]}}
Runs multiple "drunken walk" algorithms starting at a space that doesn't have certain cells around it.
:''amount'': The number of times to perform the algorithm.
:''steps'': The number of steps each run of the algorithm will take. The number of spaces covered by the algorithm will be at most the ''amount'' times the number of ''steps''.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''edges1'': The algorithm will not start on a space with a cell listed here next to it.
:''edges2'': The algorithm will not start on a space with a cell listed here next to it.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
----
;{{moddef|desc|warehouse_fill|dot||CellID|fill|Area|where|integer|[size]|integer|[count]|integer|[special_chance]|CellID|[special]}}
Fills an area with random squares of cells.
:''fill'': The cell(s) to use for each square. If a list is given, one is chosen at random for each square.
:''where'': The area to fill.
:''size'': ''Optional.'' The size of the squares to use. If omitted, the default is 2.
:''count'': ''Optional.'' The number of attempts. If omitted, the default is 50.
:''special_chance'': ''Optional.'' A number indicating the probability of using a special list of cells to fill the square with instead of the ''fill'' list. The roll used for the chance is based on the ''size'' parameter. A number from 1 to (100 * ''size'') is chosen for each square and if the roll is less than the special_chance number, the ''special'' cell set is used to fill the square instead. If omitted, all squares will be filled from the ''fill'' set.
:''special'': ''Optional.'' The list of cells to use if the special set is to be used, based on ''special_chance''. If omitted, all squares will be filled from the ''fill'' set.
----
;{{moddef|desc|place_blob|dot||Coord|start|integer|size|CellID|cell}}
Fills an area by expanding to random edge coordinates.
:''start'': The position to start the blob at.
:''size'': The number of spaces to expand the blob to.
:''cell'': The cell to fill the blob area with.
----
=== Generator Helper Functions ===
;{{moddef|desc|roll_pair|dot|<value>, <value>|Table|list}}
Takes a list of values of any type and returns two different values randomly from the list.
:''list'': The list to choose from.
:'''Returns''': Two different values. If the list only contains one choice, it will be returned, but only once.
----
;{{moddef|desc|being_weight|dot}}
Gets the total danger level for the current dungeon level.
'''Returns''': The danger level for the current dungeon level. This value is calcuated using the current difficulty and ''level.danger_level''.
----
;{{moddef|desc|item_amount|dot}}
Gets the number of items to drop for the current dungeon level.
'''Returns''': The number of items to drop for the current dungeon level.
----
;{{moddef|desc|horiz_river|dot||CellID|cell|integer|width|boolean|[bridge]}}
Places a horizontal river on the map.
:''cell'': The cell to use for the river. It does not have to be a fluid cell.
:''width'': The width of the river.
:''bridge'': ''Optional.'' If ''True'', a 2 space wide bridge will be placed at a random coordinate on the river. If ''False'', no bridge will be placed. If omitted, the default is to not place a bridge.
----
;{{moddef|desc|vert_river|dot||CellID|cell|integer|width|boolean|bridge|integer|[position]}}
;{{moddef|desc|vert_river|dot||CellID|cell|integer|width|boolean|bridge|Coord|[position]}}
Places a vertical river on the map.
:''cell'': The cell to use for the river. It does not have to be a fluid cell.
:''width'': The width of the river.
:''bridge'': ''Optional.'' If ''True'', a 2 space wide bridge will be placed at a random coordinate on the river. If ''False'', no bridge will be placed. If omitted, the default is to not place a bridge.
:: NOTE: Because of a bug, a bridge will always be placed on the river, even if this value is set to ''False'' or omitted.
:''position'': A coordinate or an integer. If an integer is supplied, this is the X position of the river's left edge. If a coordinate is supplied, the river will start at this coordinate. If omitted, the river's left edge will be selected from between X = 19 to 58.
----
;{{moddef|desc|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
Creates rivers based on normal DoomRL 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.
:''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.
----
;{{moddef|desc|generate_stairs|dot}}
Creates the normal staircase based on normal DoomRL 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.
----
;{{moddef|desc|place_player|dot}}
Places the player on a random empty space.
----
;{{moddef|desc|run|dot||Generator|gen}}
Runs a generator object. These are stored in the generators table.
:''gen'': The generator object to run.
----
;{{moddef|desc|reset|dot}}
Resets the map.
----
=== Dungeon Generation Functions ===
;{{moddef|desc|generate_tiled|dot}}
Creates a tiled dungeon, also known as a "normal" dungeon. This only creates the layout, it does not place beings, items, stairs, barrels, or the player.
----
;{{moddef|desc|maze_dungeon|dot||CellID|floor|CellID|wall|integer|granularity|integer|tries|integer|min_size|integer|max_size}}
Creates a maze dungeon. This only creates the layout, it does not place beings, items, stairs, barrels, or the player.
:''floor'': The cell to use for the floor of the maze.
:''wall'': The cell to use for the wall of the maze.
:''granularity'': This denotes the size of the maze's paths.
:''tries'': Number of attempts to place a new wall in the maze.
:''min_size'': The smallest possible size of a wall.
:''max_size'': The largest possible size of a wall.
----
;{{moddef|desc|generate_caves_dungeon|dot}}
Runs the generation script for the cave dungeon. This is an all inclusive function, it also places all beings and items.
----
;{{moddef|desc|generate_caves_2_dungeon|dot}}
Runs the generation script for the cave-city dungeon. This is an all inclusive function, it also places all beings and items.
----
;{{moddef|desc|generate_lava_dungeon|dot}}
Runs the generation script for the lava dungeon. This is an all inclusive function, it also places all beings and items.
----
=== Event Handler Functions ===
;{{moddef|desc|roll_event|dot}}
Picks an event from the events table and sets it up.
----
;{{moddef|desc|setup_flood_event|dot||integer|direction|integer|step|CellID|cell}}
Runs the setup script for the flood event.
:''direction'': Use 1 to flood from the left. Use -1 to flood from the right.
:''step'': Number of turns (0.1 second intervals) between each flood step.
:''cell'': The cell to flood with. This does not have to be a fluid cell.
----
;{{moddef|desc|setup_deadly_air_event|dot||integer|step}}
Runs the setup script for the deadly air event.
:''step'': Number of turns between each "chill" (loss of HP).
----
;{{moddef|desc|setup_explosion_event|dot||integer|step|integer|size|integer|dice|integer|[content]}}
;{{moddef|desc|setup_explosion_event|dot||integer|step|Table|size|integer|dice|integer|[content]}}
Runs the setup script for the explosion event.
:''step'': Number of turns between each explosion.
:''size'': Either a number or a table of two numbers. Indicates the size of each explosion. If a table is supplied, the size is randomly chosen between the range supplied each time an explosion is created.
:''dice'': Number of d6 dice to use for the damage roll.
:''content'': ''Optional.'' The content to place in any space where the damage to a space is more than 20 points. If omitted, nothing will placed.
----
;{{moddef|desc|setup_targeted_event|dot||integer|step}}
Runs the setup script for the targeting event.
:''step'': Number of turns between each monster teleport.
----

Modding:generator API

2013-04-25T19:21:44Z

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

''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.

== API ==

Please note that the type "integer" indicates an numeric value without a decimal part. It does not indicate the range of acceptable values.

The argument type "CellID" may be the numeric or string ID of a cell.

The argument type "CellSet" may be the numeric ID, string ID, or a list of numeric and/or string IDs.

The argument type "Flags" expects a list of [[Modding:Constants|flag constants]] of the indicated type.

An argument name in [square brackets] is an optional one. The function description will indicate how the function operates if it is omitted.

=== Generator API Function List ===

{|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"|'''Generator Interface - Functions'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
||'''[[#Basic Cell Handling Functions|Basic Cell Handling Functions]]'''
|{{modarg|integer}}|{{moddef|list|get_cell|dot||Coord|loc}}
|{{modarg|string}}|{{moddef|list|get_cell_id|dot||Coord|loc}}
|{{modarg|integer}}|{{moddef|list|fast_get_cell|dot||integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|set_cell|dot||Coord|loc|CellID|what}}
|{{modarg|void}}|{{moddef|list|fast_set_cell|dot||integer|x|integer|y|integer|what}}
||'''[[#Map Checking Functions|Map Checking Functions]]'''
|{{modarg|integer}}|{{moddef|list|around|dot||Coord|where|CellSet|what}}
|{{modarg|integer}}|{{moddef|list|cross_around|dot||Coord|where|CellSet|what}}
|{{modarg|boolean}}|{{moddef|list|is_empty|dot||Coord|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|is_empty_area|dot||Area|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|scan|dot||Area|where|CellID|good}}
||'''[[#Map Searching Functions|Map Searching Functions]]'''
|{{modarg|Coord}}|{{moddef|list|drop_coord|dot||Coord|where|Flags|reqs}}
|{{modarg|Coord}}|{{moddef|list|find_coord|dot||CellSet|what|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|random_coord|dot||Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_random_coord|dot||CellSet|what|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_empty_coord|dot||CellSet|what|Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|random_empty_coord|dot||Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_random_empty_coord|dot||CellSet|what|Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|safe_empty_coord|dot||Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|standard_empty_coord|dot}}
||'''[[#Advanced Cell Handling Functions|Advanced Cell Handling Functions]]'''
|{{modarg|void}}|{{moddef|list|fill|dot||CellID|what|Area|[where]}}
|{{modarg|void}}|{{moddef|list|fill_pattern|dot||Area|where|boolean|horiz|Table|line1|Table|[line2]}}
|{{modarg|void}}|{{moddef|list|fill_edges|dot||CellID|what}}
|{{modarg|Table}}|{{moddef|list|each|dot||CellID|what|Area|[where]}}
|{{modarg|void}}|{{moddef|list|set_blood|dot||Area|[where]|boolean|[value]|CellID|[what]}}
|{{modarg|void}}|{{moddef|list|set_permanence|dot||Area|[where]|boolean|[value]|CellID|[what]}}
|{{modarg|Table}}|{{moddef|list|cell_set|dot||CellSet|cells}}
|{{modarg|void}}|{{moddef|list|restore_walls|dot||CellID|wallCell|boolean|keepFluids}}
|{{modarg|void}}|{{moddef|list|plot_line|dot||Coord|where|boolean|horiz|CellID|cell|CellSet|block}}
|{{modarg|void}}|{{moddef|list|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|CellID|cell|CellSet|block}}
|{{modarg|void}}|{{moddef|list|scatter|dot||Area|where|CellID|good|CellID|fill|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_blood|dot||Area|where|CellID|[good]|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_put|dot||Area|where|Table|translation|string|tile|CellID|good|integer|count}}
|{{modarg|void}}|{{moddef|list|transmute|dot||CellID|to|CellSet|from|Area|[where]}}
|{{modarg|void}}|{{moddef|list|transmute_marker|dot||Flag|marker|CellID|To|Area|[where]}}
||'''[[#Tile Handling Functions|Tile Handling Functions]]'''
|{{modarg|Table}}|{{moddef|list|create_translation|dot||Table|code}}
|{{modarg|Tile}}|{{moddef|list|tile_new|dot||string|map|Table|translation}}
|{{modarg|void}}|{{moddef|list|tile_place|dot||Coord|where|Tile|what}}
|{{modarg|void}}|{{moddef|list|place_tile|dot||Table|translation|string|tile|integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|place_dungen_tile|dot||Table|code|Tile|tile|Coord|where}}
|{{modarg|void}}|{{moddef|list|place_symmetry_quad|dot||string|tile|Table|translation}}
|{{modarg|void}}|{{moddef|list|place_proto_map|dot||Coord|where|string|proto_map|string|proto_key|Table|code}}
||'''[[#Room Handling Functions|Room Handling Functions]]'''
|{{modarg|void}}|{{moddef|list|add_room|dot||Area|room|string|[class]}}
|{{modarg|void}}|{{moddef|list|add_rooms|dot}}
|{{modarg|Room}}|{{moddef|list|get_room|dot||integer|min_size|integer|max_x|integer|max_y|integer|max_area|string|[class]}}
|{{modarg|integer, integer}}|{{moddef|list|get_endpoints|dot||Coord|where|boolean|horiz|CellSet|what}}
|{{modarg|void}}|{{moddef|list|handle_rooms|dot||integer|count|boolean|no_monsters}}
||'''[[#Generation Algorithm Functions|Generation Algorithm Functions]]'''
|{{modarg|void}}|{{moddef|list|run_drunkard_walk|dot||Area|where|Coord|start|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]}}
|{{modarg|void}}|{{moddef|list|drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|[where]}}
|{{modarg|void}}|{{moddef|list|contd_drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|edges1|CellSet|edges2|CellSet|[ignore]|boolean|[stop_at_edge]}}
|{{modarg|void}}|{{moddef|list|warehouse_fill|dot||CellSet|fill|Area|where|integer|size|integer|count|integer|special_chance|CellSet|special}}
|{{modarg|void}}|{{moddef|list|place_blob|dot||Coord|start|integer|size|CellID|cell}}
||'''[[#Generator Helper Functions|Generator Helper Functions]]'''
|{{modarg|<value>, <value>}}|{{moddef|list|roll_pair|dot||Table|list}}
|{{modarg|integer}}|{{moddef|list|being_weight|dot}}
|{{modarg|integer}}|{{moddef|list|item_amount|dot}}
|{{modarg|void}}|{{moddef|list|horiz_river|dot||CellID|cell|integer|width|boolean|[bridge]}}
|{{modarg|void}}|{{moddef|list|vert_river|dot||CellID|cell|integer|width|boolean|bridge|integer|position}}
{{moddef|list|vert_river|dot||CellID|cell|integer|width|boolean|bridge|Coord|position}}
|{{modarg|void}}|{{moddef|list|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
|{{modarg|void}}|{{moddef|list|generate_fluids|dot||Area|[where]}}
|{{modarg|void}}|{{moddef|list|generate_barrels|dot}}
|{{modarg|void}}|{{moddef|list|generate_stairs|dot}}
|{{modarg|void}}|{{moddef|list|generate_special_stairs|dot}}
|{{modarg|void}}|{{moddef|list|place_player|dot}}
|{{modarg|void}}|{{moddef|list|run|dot||Generator|gen}}
|{{modarg|void}}|{{moddef|list|reset|dot}}
||'''[[#Dungeon Generation Functions|Dungeon Generation Functions]]'''
|{{modarg|void}}|{{moddef|list|generate_tiled|dot}}
|{{modarg|void}}|{{moddef|list|maze_dungeon|dot||CellID|floor|CellID|wall|integer|granularity|integer|tries|integer|min_size|integer|max_size}}
|{{modarg|void}}|{{moddef|list|generate_caves_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_caves_2_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_lava_dungeon|dot}}
||'''[[#Event Handler Functions|Event Handler Functions]]'''
|{{modarg|void}}|{{moddef|list|roll_event|dot}}
|{{modarg|void}}|{{moddef|list|setup_flood_event|dot||integer|direction|integer|step|CellID|cell}}
|{{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]}}
|{{modarg|void}}|{{moddef|list|setup_targeted_event|dot||integer|step}}
|}}
|}

=== Basic Cell Handling Functions ===
;{{moddef|desc|get_cell|dot|integer|Coord|loc}}
Gets the Numeric ID (NID) of the [[Modding:Cell|cell]] at a given map position.
:''loc'': The coordinates of the cell to get.
:'''Returns''': The NID of the cell.
----
;{{moddef|desc|get_cell_id|dot|string|Coord|loc}}
Gets the ID of the [[Modding:Cell|cell]] at a given map position.
:''loc'': The coordinates of the cell to get.
:'''Returns''': The string ID of the cell.
----
;{{moddef|desc|fast_get_cell|dot|integer|integer|x|integer|y}}
Gets the Numeric ID (NID) of the [[Modding:Cell|cell]] at a given map position.
:''x'': The X position of the cell to get.
:''y'': The Y position of the cell to get.
:'''Returns''': The NID of the cell.
----
;{{moddef|desc|set_cell|dot||Coord|loc|CellID|what}}
Assigns a [[Modding:Cell|cell]] to a map position.
:''loc'': The coordinates of the position to set.
:''what'': The ID of the cell to assign to the position.
----
;{{moddef|desc|fast_set_cell|dot||integer|x|integer|y|integer|what}}
Assigns a [[Modding:Cell|cell]] to a map position.
:''x'': The X position of the cell to set.
:''y'': The Y position of the cell to set.
:''what'': The NID (string IDs not allowed) of the cell to assign to the position.
----
=== Map Checking Functions ===
;{{moddef|desc|around|dot|integer|Coord|where|CellSet|what}}
Checks the positions adjacent to a location (including diagonally adjacent) and returns the number of cells that match one of the indicated cell IDs.
:''where'': The coordinate to check around. The coordinate sent in this way is not checked, only adjacent cells are.
:''what'': The cell(s) to check for.
:'''Returns''': The number of cells (from 0 to 8) that matched one of the ''what'' cell IDs.
----
;{{moddef|desc|cross_around|dot|integer|Coord|where|CellSet|what}}
Checks the positions adjacent to a location (but not diagonally adjacent) and returns the number of cells that match one of the indicated cell IDs.
:''where'': The coordinates to check around. The coordinate sent in this way is not checked, only adjacent cells are.
:''what'': The cell(s) to check for.
:'''Returns''': The number of cells (from 0 to 4) that matched one of the ''what'' cell IDs.
----
;{{moddef|desc|is_empty|dot|boolean|Coord|where|Flags|reqs}}
Checks to see if the indicated cell is "empty", defining "empty" based on a list of criteria.
:''where'': The position to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the position cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the map position does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if the cell satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|is_empty_area|dot|boolean|Area|where|Flags|reqs}}
Checks to see if the indicated area is "empty", defining "empty" based on a list of criteria.
:''where'': The area to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the area cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the area does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if every cell in the area satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|scan|dot|boolean|Area|where|CellID|good}}
Checks to see if the entire area is filled with a certain cell.
:''where'': The area to check.
:''good'': The cell to look for.
:'''Returns''': ''True'' if all cells in the area are ''good'', ''False'' otherwise.
----
=== Map Searching Functions ===
;{{moddef|desc|drop_coord|dot|Coord|Coord|where|Flags|reqs}}
Finds the nearest "empty" coordinate to a given coordinate, defining "empty" based on a list of criteria.
:''where'': The coordinate to try. If this coordinate is "empty", this coordinate will be returned.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': The nearest coordinate the satisfies the criteria. If the supplied coordinate meets the criteria, that coordinate will be returned. If not a nearby, random, coordinate will be checked.
----
;{{moddef|desc|find_coord|dot|Coord|CellSet|what|Area|[where]}}
Searches the map for the first coordinate containing one of the indicated cell IDs.
:''what'': The cell(s) to search for.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': The coordinates of the first position that contains one of the ''what'' cell IDs. The map is checked row by row starting from the top, going from left to right across each row.
----
;{{moddef|desc|random_coord|dot|Coord|Area|[where]}}
Searches for a random coordinate within the specified area.
:''where'': ''Optional.'' The area to restrict the coordinate to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate.
----
;{{moddef|desc|find_random_coord|dot|Coord|CellSet|what|Area|[where]}}
Searches for a random coordinate within the specified area that contains one of the specified cell IDs.
:''what'': The cell(s) to search for.
:''where'' : ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|find_empty_coord|dot|Coord|CellSet|what|Flags|reqs|Area|[where]}}
Searches the map for the first "empty" coordinate containing one of the indicated cell IDs, defining "empty" based on a list of criteria.
:''what'': The cell(s) to search for.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': The coordinates of the first position that meets the supplied criteria. The map is checked row by row starting from the top, going from left to right across each row.
----
;{{moddef|desc|random_empty_coord|dot|Coord|Flags|reqs|Area|[where]}}
Searches the map for a random coordinate that is "empty", defining "empty" based on a list of criteria.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the random coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|find_random_empty_coord|dot|Coord|CellSet|what|Flags|reqs|Area|[where]}}
Searches the map for a random "empty" coordinate containing one of the indicated cell IDs, defining "empty" based on a list of criteria.
:''what'': The cell(s) to search for.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the random coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|random_square|dot|Coord|CellSet|what}}
Searches for a random 3x3 area containing only specified cells.
:''what'': The cell(s) to search for.
:'''Returns''': The center coordinate of the random 3x3 area.
----
;{{moddef|desc|safe_empty_coord|dot|Coord|Area|[where]}}
Searches for a random coordinate that meets certain predetermined criteria.

The function will try to find a coordinate that does not contain a being, item, staircase, wall, harmful terrain, spawning restrictions (cells marked with LF_NOSPAWN), and is more than 5 spaces from the player (EF_NOBEINGS, EF_NOITEMS, EF_NOSTAIRS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN, and EF_NOSAFE). If a valid space isn't found, the function will ignore distance from the player (EF_NOSAFE). If a valid space still can't be found, the function will ignore stairs and harmful terrain (EF_NOSTAIRS and EF_NOHARM).
:''where'': ''Optional.'' The area to restrict the initial pass to. If a valid coordinate is not found within the area after ignoring stairs and harmful terrain, the search is restarted and expanded automatically to the entire map. If omitted, the entire map will be searched.
:'''Returns''': A random coordinate that meets the criteria.
----
;{{moddef|desc|standard_empty_coord|dot|Coord}}
Searches for a random coordinate that meets certain predetermined criteria.

The function will search for a coordinate that does not contain a being, item, staircase, wall, harmful terrain, or spawning restrictions (EF_NOBEINGS, EF_NOITEMS, EF_NOSTAIRS, EF_NOBLOCK, EF_NOHARM, and EF_NOSPAWN).
:'''Returns''': A random coordinate that meets the criteria.
----
=== Advanced Cell Handling Functions ===
;{{moddef|desc|fill|dot||CellID|what|Area|[where]}}
Fills an area of the map with a given cell.
:''what'': The cell to fill with.
:''where'': ''Optional.'' The area to fill with the cell. If omitted, the entire map will be filled.
----
;{{moddef|desc|fill_pattern|dot||Area|where|boolean|horiz|string|Table|line1|Table|[line2]}}
Fills an area of the map with a pattern of cells.
:''where'': The area to fill.
:''horiz'': If ''True'', the pattern will fill each row left to right, then move to the next row down in the area. If ''False'', the pattern will fill each column top to bottom, then move to the next column right in the area.
:''line1'': The pattern to fill with. If the pattern is shorter than the area size, the pattern will loop. The pattern does not restart at the end of a row or column.
:''line2'': ''Optional.'' If given, each time the end of row (if ''horiz'' is ''True'') or column (if ''horiz'' is ''False'') is reached, the function will switch to filling with the other pattern. That is, the first row will use ''line1'' then the second will use ''line2'', then the third will use ''line1'' again, etc.
----
;{{moddef|desc|fill_edges|dot||CellID|what}}
Fills the edges of the map with the given cell.
:''what'': The cell to fill with.
----
;{{moddef|desc|each|dot|Table|CellID|what|Area|[where]}}
Searches for a cell and returns a table containing every location it was found.
:''what'': The cell to search for.
:''where'': ''Optional.'' The area to restrict the search to.
:'''Returns''': A table containing a list of [[Modding:Coord|Coord]] objects.
----
;{{moddef|desc|set_blood|dot||Area|[where]|boolean|[value]|CellID|[what]}}
Adds blood to the map or removes blood from it.
:''where'': ''Optional.'' The area to affect. If omitted, the entire map will selected.
:''value'': ''Optional.'' ''True'' adds blood. ''False'' removes it. If omitted, the default is to add blood.
:''what'': ''Optional.'' If provided, only locations containing the given cell are affected. If omitted, all cells in the area are affected.
----
;{{moddef|desc|set_permanence|dot||Area|[where]|boolean|[value]|CellID|[what]}}
Makes cell permanent or removes their permanence.
:''where'': ''Optional.'' The area to affect. If omitted, the entire map will be selected.
:''value'': ''Optional.'' ''True'' adds permanence. ''False'' removes it. If omitted, the default is to add permanence.
:''what'': ''Optional.'' If provided, only locations containing the given cell are affected. If omitted, wall cells (which includes crate cells) are affected.
----
;{{moddef|desc|cell_set|dot|Table|CellSet|cells}}
Creates a cell group.
:''cells'': A list of cells to add to the group.
:'''Returns''': A cell group table.
----
;{{moddef|desc|restore_walls|dot||CellID|wallCell|boolean|keepFluids}}
Fixes the edge walls of the map.
:''wallCell'': The cell to fill the edge of the map with.
:''keepFluids'': ''True'' to maintain any fluid tiles on the edge of the map. ''False'' to overwrite them.
----
;{{moddef|desc|plot_line|dot||Coord|where|boolean|horiz|CellID|cell|CellSet|block}}
Splits an area into two at the indicated location.
:''where'': The starting point.
:''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.
----
;{{moddef|desc|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|CellID|cell|CellSet|block}}
Splits an area into two at the indicated location.
:''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.
:''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.
----
;{{moddef|desc|scatter|dot||Area|where|CellID|good|CellID|fill|integer|count}}
Randomly places a certain cell around the map.
:''where'': The area to scatter the cell in.
:''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.
----
;{{moddef|desc|scatter_blood|dot||Area|where|CellID|[good]|integer|count}}
Randomly adds blood in an area.
:''where'': The area to scatter blood in.
:''good'': ''Optional.'' If defined, only locations with this cell will have blood added. If omitted, any location my have blood added.
:''count'': The number of attempts. On each attempt, a random cell in the area will be chosen to have blood added. The number of cell that will end up bloody may be less than ''count'' (or even 0), but never more.
----
;{{moddef|desc|scatter_put|dot||Area|where|Table|translation|string|tile|CellID|good|integer|count}}
Randomly adds a specified tile (a defined arrangement of cells) around the map.
:''where'': The area to scatter the tile in. The tiles will only be placed in locations entirely within the area.
:''translation'': A table with to be used with the ''tile'' argument. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string, one row of the tile per line, that lays out the arrangment of the cells. Refer to this (will be linked soon) for more information
:''good'': Only locations with this cell will be valid for the tile placement. If any coordinates of the selected placement area are not ''good'', the tile will not be placed at that location.
:''count'': The number of tiles to try to place. The placement will continue until this many have been placed, or 10,000 attempts have been made, whichever comes first.
----
;{{moddef|desc|transmute|dot||CellID|to|CellSet|from|Area|[where]}}
Changes all of one cell on the map to another cell.
:''to'': The cell that will replace the existing cells.
:''from'': The cell(s) that will be replaced.
:''where'': ''Optional.'' If specified, only cells in the area are changed. If omitted, the function will change cells across the entire map.
----
;{{moddef|desc|transmute_marker|dot||Flag|marker|CellID|To|Area|[where]}}
Changes all positions on the map that have a specified LightFlag (a named constant starting with "LF", no underscore) to another cell.
:''marker'': The LightFlag to check for. Only cells with this flag will be changed.
:''to'': The cell that will replace the existing cells.
:''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}}
Parses a translation table. Refer to this (will be linked soon) for more information.
:''code'': The translation table.
:'''Returns''': A parsed translation table.
----
;{{moddef|desc|tile_new|dot|Tile|string|map|Table|translation}}
Creates a new tile object.
:''map'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells. Refer to this (will be linked soon) for more information.
:''translation'': A table with to be used with the ''map'' argument. Refer to this (will be linked soon) for more information.
:'''Returns''': The new tile object.
----
;{{moddef|desc|tile_place|dot||Coord|where|Tile|what}}
Places the cells of the tile on the map.
:''where'': The coordinate that the upper-left of the tile should reside at.
:''what'': The tile object that will be placed.
----
;{{moddef|desc|place_tile|dot||Table|translation|string|tile|integer|x|integer|y}}
Combines the tile_new and tile_place functions together, by placing a tile using a string and translation table.
:''translation'': A table with to be used with the ''tile'' argument. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells. Refer to this (will be linked soon) for more information.
:''x'': The X position that the tile will be placed at.
:''y'': The Y position that the tile will be placed at.
----
;{{moddef|desc|place_dungen_tile|dot||Table|code|Tile|tile|Coord|where}}
Places an entire tile, including beings and items in the translation, on the map.
:''code'': The translation table. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells and indicate the positions of the beings and items. Refer to this (will be linked soon) for more information.
:''where'': The coordinate the tile will be placed at.
----
;{{moddef|desc|place_symmetry_quad|dot||string|tile|Table|translation}}
Takes a tile object and places it in all four corners. The tile object should be setup for the upper left corner and will be mirrored to the other corners. The tiles are placed one space from the map edge.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells and indicate the positions of the beings and items. Refer to this (will be linked soon) for more information.
:''translation'': The translation table. Refer to this (will be linked soon) for more information.
----
;{{moddef|desc|place_proto_map|dot||Coord|where|string|proto_map|string|proto_key|Table|code}}
Creates a map using multiple tile sets.
:''where'': The upper-left position of the map where the tiles will be layout from.
:''proto_map'': A string indicating the arrangement of the different pieces of the map. e.g., "ABCD", will lay out 4 different tiles with A on the far left and D on the far right.
:''proto_key'': A table containing, for each character in ''proto_map'', a table of the possible tiles for that section.
:''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]}}
Marks an area that can become a special room.
:''room'': The area of the room. This includes the walls.
:''class'': ''Optional.'' A string used to denote which room generators can be used on this room. If omitted, the class used is "closed".
----
;{{moddef|desc|add_rooms|dot}}
Finds all the areas that can be rooms on a map and adds them to the appropriate meta-map tables.
----
;{{moddef|desc|get_room|dot|Room|integer|min_size|integer|max_x|integer|max_y|integer|max_area|string|class}}
Selects a room given certain criteria.
:''min_size'': The smallest X and Y dimensions the room can be.
:''max_x'': The maximum width of the room.
:''max_y'': The maximum height of the room.
:''max_area'': The largest area the room can be.
:''class'': ''Optional.'' The string denoting which room classes are valid for this room generator. If omitted, "any" is used, which does not restrict the selection of rooms.
----
;{{moddef|desc|get_endpoints|dot|integer, integer|Coord|where|boolean|horiz|CellSet|what}}
Finds the ends of a line of cells.
:''where'': The starting coordinate.
:''horiz'': ''True'' checks horizontally. ''False'' checks vertically.
:''what'': The cell(s) that make up the line to check. The functions stops at the first cell '''not''' in this list.
:'''Returns''': Two integers. If ''horiz'' is ''True'', these are the X positions the line stops at. If ''horiz'' is ''False'', these are the Y positions the line stops at.
----
;{{moddef|desc|handle_rooms|dot||integer|count|boolean|no_monsters}}
Runs the rooms selection and setup process for a map.
:''count'': The number of rooms to attempt to place.
:''no_monsters'': ''True'' will exclude room generators that place monsters. ''False'' will not.
----
=== Generation Algorithm Functions ===
;{{moddef|desc|run_drunkard_walk|dot||Area|where|Coord|start|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|where}}
Runs an algorithm that walks to random adjacent spaces.
:''where'': The area that the algorithm will run in. If the algorithm tries to leave the area, it will stop early or will be pushed back in the area (''stop_at_edge'' will determine which of these happen).
:''start'': The location the algorithm will begin at.
:''steps'': The number of steps the algorithm will take. The number of spaces covered by the algorithm will be at most this number.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
----
;{{moddef|desc|drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|[where]}}
Runs multiple "drunken walk" algorithms.
:''amount'': The number of times to perform the algorithm.
:''steps'': The number of steps each run of the algorithm will take. The number of spaces covered by the algorithm will be at most the ''amount'' times the number of ''steps''.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
:''where'': ''Optional.'' The area the algorithm will run in. If the algorithm tries to leave the area, it will stop early or will be pushed back in the area (''stop_at_edge'' will determine which of these happen). If omitted, the default is entire area minus the very edge.
----
;{{moddef|desc|contd_drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|edges1|CellSet|edges2|CellSet|[ignore]|boolean|[stop_at_edge]}}
Runs multiple "drunken walk" algorithms starting at a space that doesn't have certain cells around it.
:''amount'': The number of times to perform the algorithm.
:''steps'': The number of steps each run of the algorithm will take. The number of spaces covered by the algorithm will be at most the ''amount'' times the number of ''steps''.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''edges1'': The algorithm will not start on a space with a cell listed here next to it.
:''edges2'': The algorithm will not start on a space with a cell listed here next to it.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
----
;{{moddef|desc|warehouse_fill|dot||CellID|fill|Area|where|integer|[size]|integer|[count]|integer|[special_chance]|CellID|[special]}}
Fills an area with random squares of cells.
:''fill'': The cell(s) to use for each square. If a list is given, one is chosen at random for each square.
:''where'': The area to fill.
:''size'': ''Optional.'' The size of the squares to use. If omitted, the default is 2.
:''count'': ''Optional.'' The number of attempts. If omitted, the default is 50.
:''special_chance'': ''Optional.'' A number indicating the probability of using a special list of cells to fill the square with instead of the ''fill'' list. The roll used for the chance is based on the ''size'' parameter. A number from 1 to (100 * ''size'') is chosen for each square and if the roll is less than the special_chance number, the ''special'' cell set is used to fill the square instead. If omitted, all squares will be filled from the ''fill'' set.
:''special'': ''Optional.'' The list of cells to use if the special set is to be used, based on ''special_chance''. If omitted, all squares will be filled from the ''fill'' set.
----
;{{moddef|desc|place_blob|dot||Coord|start|integer|size|CellID|cell}}
Fills an area by expanding to random edge coordinates.
:''start'': The position to start the blob at.
:''size'': The number of spaces to expand the blob to.
:''cell'': The cell to fill the blob area with.
----
=== Generator Helper Functions ===
;{{moddef|desc|roll_pair|dot|<value>, <value>|Table|list}}
Takes a list of values of any type and returns two different values randomly from the list.
:''list'': The list to choose from.
:'''Returns''': Two different values. If the list only contains one choice, it will be returned, but only once.
----
;{{moddef|desc|being_weight|dot}}
Gets the total danger level for the current dungeon level.
'''Returns''': The danger level for the current dungeon level. This value is calcuated using the current difficulty and ''level.danger_level''.
----
;{{moddef|desc|item_amount|dot}}
Gets the number of items to drop for the current dungeon level.
'''Returns''': The number of items to drop for the current dungeon level.
----
;{{moddef|desc|horiz_river|dot||CellID|cell|integer|width|boolean|[bridge]}}
Places a horizontal river on the map.
:''cell'': The cell to use for the river. It does not have to be a fluid cell.
:''width'': The width of the river.
:''bridge'': ''Optional.'' If ''True'', a 2 space wide bridge will be placed at a random coordinate on the river. If ''False'', no bridge will be placed. If omitted, the default is to not place a bridge.
----
;{{moddef|desc|vert_river|dot||CellID|cell|integer|width|boolean|bridge|integer|[position]}}
;{{moddef|desc|vert_river|dot||CellID|cell|integer|width|boolean|bridge|Coord|[position]}}
Places a vertical river on the map.
:''cell'': The cell to use for the river. It does not have to be a fluid cell.
:''width'': The width of the river.
:''bridge'': ''Optional.'' If ''True'', a 2 space wide bridge will be placed at a random coordinate on the river. If ''False'', no bridge will be placed. If omitted, the default is to not place a bridge.
:: NOTE: Because of a bug, a bridge will always be placed on the river, even if this value is set to ''False'' or omitted.
:''position'': A coordinate or an integer. If an integer is supplied, this is the X position of the river's left edge. If a coordinate is supplied, the river will start at this coordinate. If omitted, the river's left edge will be selected from between X = 19 to 58.
----
;{{moddef|desc|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
Creates rivers based on normal DoomRL 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.
:''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.
----
;{{moddef|desc|generate_stairs|dot}}
Creates the normal staircase based on normal DoomRL 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.
----
;{{moddef|desc|place_player|dot}}
Places the player on a random empty space.
----
;{{moddef|desc|run|dot||Generator|gen}}
Runs a generator object. These are stored in the generators table.
:''gen'': The generator object to run.
----
;{{moddef|desc|reset|dot}}
Resets the map.
----
=== Dungeon Generation Functions ===
;{{moddef|desc|generate_tiled|dot}}
Creates a tiled dungeon, also known as a "normal" dungeon. This only creates the layout, it does not place beings, items, stairs, barrels, or the player.
----
;{{moddef|desc|maze_dungeon|dot||CellID|floor|CellID|wall|integer|granularity|integer|tries|integer|min_size|integer|max_size}}
Creates a maze dungeon. This only creates the layout, it does not place beings, items, stairs, barrels, or the player.
:''floor'': The cell to use for the floor of the maze.
:''wall'': The cell to use for the wall of the maze.
:''granularity'': This denotes the size of the maze's paths.
:''tries'': Number of attempts to place a new wall in the maze.
:''min_size'': The smallest possible size of a wall.
:''max_size'': The largest possible size of a wall.
----
;{{moddef|desc|generate_caves_dungeon|dot}}
Runs the generation script for the cave dungeon. This is an all inclusive function, it also places all beings and items.
----
;{{moddef|desc|generate_caves_2_dungeon|dot}}
Runs the generation script for the cave-city dungeon. This is an all inclusive function, it also places all beings and items.
----
;{{moddef|desc|generate_lava_dungeon|dot}}
Runs the generation script for the lava dungeon. This is an all inclusive function, it also places all beings and items.
----
=== Event Handler Functions ===
;{{moddef|desc|roll_event|dot}}
Picks an event from the events table and sets it up.
----
;{{moddef|desc|setup_flood_event|dot||integer|direction|integer|step|CellID|cell}}
Runs the setup script for the flood event.
:''direction'': Use 1 to flood from the left. Use -1 to flood from the right.
:''step'': Number of turns (0.1 second intervals) between each flood step.
:''cell'': The cell to flood with. This does not have to be a fluid cell.
----
;{{moddef|desc|setup_deadly_air_event|dot||integer|step}}
Runs the setup script for the deadly air event.
:''step'': Number of turns between each "chill" (loss of HP).
----
;{{moddef|desc|setup_explosion_event|dot||integer|step|integer|size|integer|dice|integer|[content]}}
;{{moddef|desc|setup_explosion_event|dot||integer|step|Table|size|integer|dice|integer|[content]}}
Runs the setup script for the explosion event.
:''step'': Number of turns between each explosion.
:''size'': Either a number or a table of two numbers. Indicates the size of each explosion. If a table is supplied, the size is randomly chosen between the range supplied each time an explosion is created.
:''dice'': Number of d6 dice to use for the damage roll.
:''content'': ''Optional.'' The content to place in any space where the damage to a space is more than 20 points. If omitted, nothing will placed.
----
;{{moddef|desc|setup_targeted_event|dot||integer|step}}
Runs the setup script for the targeting event.
:''step'': Number of turns between each monster teleport.
----

Modding:generator API

2013-04-25T19:10:45Z

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

''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.

== API ==

Please note that the type "integer" indicates an numeric value without a decimal part. It does not indicate the range of acceptable values.

The argument type "CellID" may be the numeric or string ID of a cell.

The argument type "CellSet" may be the numeric ID, string ID, or a list of numeric and/or string IDs.

The argument type "Flags" expects a list of [[Modding:Constants|flag constants]] of the indicated type.

An argument name in [square brackets] is an optional one. The function description will indicate how the function operates if it is omitted.

=== Generator API Function List ===

{|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"|'''Generator Interface - Functions'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
||'''[[#Basic Cell Handling Functions|Basic Cell Handling Functions]]'''
|{{modarg|integer}}|{{moddef|list|get_cell|dot||Coord|loc}}
|{{modarg|string}}|{{moddef|list|get_cell_id|dot||Coord|loc}}
|{{modarg|integer}}|{{moddef|list|fast_get_cell|dot||integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|set_cell|dot||Coord|loc|CellID|what}}
|{{modarg|void}}|{{moddef|list|fast_set_cell|dot||integer|x|integer|y|integer|what}}
||'''[[#Map Checking Functions|Map Checking Functions]]'''
|{{modarg|integer}}|{{moddef|list|around|dot||Coord|where|CellSet|what}}
|{{modarg|integer}}|{{moddef|list|cross_around|dot||Coord|where|CellSet|what}}
|{{modarg|boolean}}|{{moddef|list|is_empty|dot||Coord|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|is_empty_area|dot||Area|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|scan|dot||Area|where|CellID|good}}
||'''[[#Map Searching Functions|Map Searching Functions]]'''
|{{modarg|Coord}}|{{moddef|list|drop_coord|dot||Coord|where|Flags|reqs}}
|{{modarg|Coord}}|{{moddef|list|find_coord|dot||CellSet|what|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|random_coord|dot||Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_random_coord|dot||CellSet|what|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_empty_coord|dot||CellSet|what|Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|random_empty_coord|dot||Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_random_empty_coord|dot||CellSet|what|Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|safe_empty_coord|dot||Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|standard_empty_coord|dot}}
||'''[[#Advanced Cell Handling Functions|Advanced Cell Handling Functions]]'''
|{{modarg|void}}|{{moddef|list|fill|dot||CellID|what|Area|[where]}}
|{{modarg|void}}|{{moddef|list|fill_pattern|dot||Area|where|boolean|horiz|Table|line1|Table|[line2]}}
|{{modarg|void}}|{{moddef|list|fill_edges|dot||CellID|what}}
|{{modarg|Table}}|{{moddef|list|each|dot||CellID|what|Area|[where]}}
|{{modarg|void}}|{{moddef|list|set_blood|dot||Area|[where]|boolean|[value]|CellID|[what]}}
|{{modarg|void}}|{{moddef|list|set_permanence|dot||Area|[where]|boolean|[value]|CellID|[what]}}
|{{modarg|Table}}|{{moddef|list|cell_set|dot||CellSet|cells}}
|{{modarg|void}}|{{moddef|list|restore_walls|dot||CellID|wallCell|boolean|keepFluids}}
|{{modarg|void}}|{{moddef|list|plot_line|dot||Coord|where|boolean|horiz|CellID|cell|CellSet|block}}
|{{modarg|void}}|{{moddef|list|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|CellID|cell|CellSet|block}}
|{{modarg|void}}|{{moddef|list|scatter|dot||Area|where|CellID|good|CellID|fill|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_blood|dot||Area|where|CellID|[good]|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_put|dot||Area|where|Table|translation|string|tile|CellID|good|integer|count}}
|{{modarg|void}}|{{moddef|list|transmute|dot||CellID|to|CellSet|from|Area|[where]}}
|{{modarg|void}}|{{moddef|list|transmute_marker|dot||Flag|marker|CellID|To|Area|[where]}}
||'''[[#Tile Handling Functions|Tile Handling Functions]]'''
|{{modarg|Table}}|{{moddef|list|create_translation|dot||Table|code}}
|{{modarg|Tile}}|{{moddef|list|tile_new|dot||string|map|Table|translation}}
|{{modarg|void}}|{{moddef|list|tile_place|dot||Coord|where|Tile|what}}
|{{modarg|void}}|{{moddef|list|place_tile|dot||Table|translation|string|tile|integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|place_dungen_tile|dot||Table|code|Tile|tile|Coord|where}}
|{{modarg|void}}|{{moddef|list|place_symmetry_quad|dot||string|tile|Table|translation}}
|{{modarg|void}}|{{moddef|list|place_proto_map|dot||Coord|where|string|proto_map|string|proto_key|Table|code}}
||'''[[#Room Handling Functions|Room Handling Functions]]'''
|{{modarg|void}}|{{moddef|list|add_room|dot||Area|room|string|[class]}}
|{{modarg|void}}|{{moddef|list|add_rooms|dot}}
|{{modarg|Room}}|{{moddef|list|get_room|dot||integer|min_size|integer|max_x|integer|max_y|integer|max_area|string|[class]}}
|{{modarg|integer, integer}}|{{moddef|list|get_endpoints|dot||Coord|where|boolean|horiz|CellSet|what}}
|{{modarg|void}}|{{moddef|list|handle_rooms|dot||integer|count|boolean|no_monsters}}
||'''[[#Generation Algorithm Functions|Generation Algorithm Functions]]'''
|{{modarg|void}}|{{moddef|list|run_drunkard_walk|dot||Area|where|Coord|start|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]}}
|{{modarg|void}}|{{moddef|list|drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|[where]}}
|{{modarg|void}}|{{moddef|list|contd_drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|edges1|CellSet|edges2|CellSet|[ignore]|boolean|[stop_at_edge]}}
|{{modarg|void}}|{{moddef|list|warehouse_fill|dot||CellSet|fill|Area|where|integer|size|integer|count|integer|special_chance|CellSet|special}}
|{{modarg|void}}|{{moddef|list|place_blob|dot||Coord|start|integer|size|CellID|cell}}
||'''[[#Generator Helper Functions|Generator Helper Functions]]'''
|{{modarg|<value>, <value>}}|{{moddef|list|roll_pair|dot||Table|list}}
|{{modarg|integer}}|{{moddef|list|being_weight|dot}}
|{{modarg|integer}}|{{moddef|list|item_amount|dot}}
|{{modarg|void}}|{{moddef|list|horiz_river|dot||CellID|cell|integer|width|boolean|[bridge]}}
|{{modarg|void}}|{{moddef|list|vert_river|dot||CellID|cell|integer|width|boolean|bridge|integer|position}}
{{moddef|list|vert_river|dot||CellID|cell|integer|width|boolean|bridge|Coord|position}}
|{{modarg|void}}|{{moddef|list|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
|{{modarg|void}}|{{moddef|list|generate_fluids|dot||Area|[where]}}
|{{modarg|void}}|{{moddef|list|generate_barrels|dot}}
|{{modarg|void}}|{{moddef|list|generate_stairs|dot}}
|{{modarg|void}}|{{moddef|list|generate_special_stairs|dot}}
|{{modarg|void}}|{{moddef|list|place_player|dot}}
|{{modarg|void}}|{{moddef|list|run|dot||Generator|gen}}
|{{modarg|void}}|{{moddef|list|reset|dot}}
||'''[[#Dungeon Generation Functions|Dungeon Generation Functions]]'''
|{{modarg|void}}|{{moddef|list|generate_tiled|dot}}
|{{modarg|void}}|{{moddef|list|maze_dungeon|dot||CellID|floor|CellID|wall|integer|granularity|integer|tries|integer|min_size|integer|max_size}}
|{{modarg|void}}|{{moddef|list|generate_caves_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_caves_2_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_lava_dungeon|dot}}
||'''[[#Event Handler Functions|Event Handler Functions]]'''
|{{modarg|void}}|{{moddef|list|roll_event|dot}}
|{{modarg|void}}|{{moddef|list|setup_flood_event|dot||integer|direction|integer|step|CellID|cell}}
|{{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]}}
|{{modarg|void}}|{{moddef|list|setup_targeted_event|dot||integer|step}}
|}}
|}

=== Basic Cell Handling Functions ===
;{{moddef|desc|get_cell|dot|integer|Coord|loc}}
Gets the Numeric ID (NID) of the [[Modding:Cell|cell]] at a given map position.
:''loc'': The coordinates of the cell to get.
:'''Returns''': The NID of the cell.
----
;{{moddef|desc|get_cell_id|dot|string|Coord|loc}}
Gets the ID of the [[Modding:Cell|cell]] at a given map position.
:''loc'': The coordinates of the cell to get.
:'''Returns''': The string ID of the cell.
----
;{{moddef|desc|fast_get_cell|dot|integer|integer|x|integer|y}}
Gets the Numeric ID (NID) of the [[Modding:Cell|cell]] at a given map position.
:''x'': The X position of the cell to get.
:''y'': The Y position of the cell to get.
:'''Returns''': The NID of the cell.
----
;{{moddef|desc|set_cell|dot||Coord|loc|CellID|what}}
Assigns a [[Modding:Cell|cell]] to a map position.
:''loc'': The coordinates of the position to set.
:''what'': The ID of the cell to assign to the position.
----
;{{moddef|desc|fast_set_cell|dot||integer|x|integer|y|integer|what}}
Assigns a [[Modding:Cell|cell]] to a map position.
:''x'': The X position of the cell to set.
:''y'': The Y position of the cell to set.
:''what'': The NID (string IDs not allowed) of the cell to assign to the position.
----
=== Map Checking Functions ===
;{{moddef|desc|around|dot|integer|Coord|where|CellSet|what}}
Checks the positions adjacent to a location (including diagonally adjacent) and returns the number of cells that match one of the indicated cell IDs.
:''where'': The coordinate to check around. The coordinate sent in this way is not checked, only adjacent cells are.
:''what'': The cell(s) to check for.
:'''Returns''': The number of cells (from 0 to 8) that matched one of the ''what'' cell IDs.
----
;{{moddef|desc|cross_around|dot|integer|Coord|where|CellSet|what}}
Checks the positions adjacent to a location (but not diagonally adjacent) and returns the number of cells that match one of the indicated cell IDs.
:''where'': The coordinates to check around. The coordinate sent in this way is not checked, only adjacent cells are.
:''what'': The cell(s) to check for.
:'''Returns''': The number of cells (from 0 to 4) that matched one of the ''what'' cell IDs.
----
;{{moddef|desc|is_empty|dot|boolean|Coord|where|Flags|reqs}}
Checks to see if the indicated cell is "empty", defining "empty" based on a list of criteria.
:''where'': The position to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the position cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the map position does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if the cell satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|is_empty_area|dot|boolean|Area|where|Flags|reqs}}
Checks to see if the indicated area is "empty", defining "empty" based on a list of criteria.
:''where'': The area to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the area cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the area does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if every cell in the area satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|scan|dot|boolean|Area|where|CellID|good}}
Checks to see if the entire area is filled with a certain cell.
:''where'': The area to check.
:''good'': The cell to look for.
:'''Returns''': ''True'' if all cells in the area are ''good'', ''False'' otherwise.
----
=== Map Searching Functions ===
;{{moddef|desc|drop_coord|dot|Coord|Coord|where|Flags|reqs}}
Finds the nearest "empty" coordinate to a given coordinate, defining "empty" based on a list of criteria.
:''where'': The coordinate to try. If this coordinate is "empty", this coordinate will be returned.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': The nearest coordinate the satisfies the criteria. If the supplied coordinate meets the criteria, that coordinate will be returned. If not a nearby, random, coordinate will be checked.
----
;{{moddef|desc|find_coord|dot|Coord|CellSet|what|Area|[where]}}
Searches the map for the first coordinate containing one of the indicated cell IDs.
:''what'': The cell(s) to search for.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': The coordinates of the first position that contains one of the ''what'' cell IDs. The map is checked row by row starting from the top, going from left to right across each row.
----
;{{moddef|desc|random_coord|dot|Coord|Area|[where]}}
Searches for a random coordinate within the specified area.
:''where'': ''Optional.'' The area to restrict the coordinate to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate.
----
;{{moddef|desc|find_random_coord|dot|Coord|CellSet|what|Area|[where]}}
Searches for a random coordinate within the specified area that contains one of the specified cell IDs.
:''what'': The cell(s) to search for.
:''where'' : ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|find_empty_coord|dot|Coord|CellSet|what|Flags|reqs|Area|[where]}}
Searches the map for the first "empty" coordinate containing one of the indicated cell IDs, defining "empty" based on a list of criteria.
:''what'': The cell(s) to search for.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': The coordinates of the first position that meets the supplied criteria. The map is checked row by row starting from the top, going from left to right across each row.
----
;{{moddef|desc|random_empty_coord|dot|Coord|Flags|reqs|Area|[where]}}
Searches the map for a random coordinate that is "empty", defining "empty" based on a list of criteria.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the random coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|find_random_empty_coord|dot|Coord|CellSet|what|Flags|reqs|Area|[where]}}
Searches the map for a random "empty" coordinate containing one of the indicated cell IDs, defining "empty" based on a list of criteria.
:''what'': The cell(s) to search for.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the random coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|random_square|dot|Coord|CellSet|what}}
Searches for a random 3x3 area containing only specified cells.
:''what'': The cell(s) to search for.
:'''Returns''': The center coordinate of the random 3x3 area.
----
;{{moddef|desc|safe_empty_coord|dot|Coord|Area|[where]}}
Searches for a random coordinate that meets certain predetermined criteria.

The function will try to find a coordinate that does not contain a being, item, staircase, wall, harmful terrain, spawning restrictions (cells marked with LF_NOSPAWN), and is more than 5 spaces from the player (EF_NOBEINGS, EF_NOITEMS, EF_NOSTAIRS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN, and EF_NOSAFE). If a valid space isn't found, the function will ignore distance from the player (EF_NOSAFE). If a valid space still can't be found, the function will ignore stairs and harmful terrain (EF_NOSTAIRS and EF_NOHARM).
:''where'': ''Optional.'' The area to restrict the initial pass to. If a valid coordinate is not found within the area after ignoring stairs and harmful terrain, the search is restarted and expanded automatically to the entire map. If omitted, the entire map will be searched.
:'''Returns''': A random coordinate that meets the criteria.
----
;{{moddef|desc|standard_empty_coord|dot|Coord}}
Searches for a random coordinate that meets certain predetermined criteria.

The function will search for a coordinate that does not contain a being, item, staircase, wall, harmful terrain, or spawning restrictions (EF_NOBEINGS, EF_NOITEMS, EF_NOSTAIRS, EF_NOBLOCK, EF_NOHARM, and EF_NOSPAWN).
:'''Returns''': A random coordinate that meets the criteria.
----
=== Advanced Cell Handling Functions ===
;{{moddef|desc|fill|dot||CellID|what|Area|[where]}}
Fills an area of the map with a given cell.
:''what'': The cell to fill with.
:''where'': ''Optional.'' The area to fill with the cell. If omitted, the entire map will be filled.
----
;{{moddef|desc|fill_pattern|dot||Area|where|boolean|horiz|string|Table|line1|Table|[line2]}}
Fills an area of the map with a pattern of cells.
:''where'': The area to fill.
:''horiz'': If ''True'', the pattern will fill each row left to right, then move to the next row down in the area. If ''False'', the pattern will fill each column top to bottom, then move to the next column right in the area.
:''line1'': The pattern to fill with. If the pattern is shorter than the area size, the pattern will loop. The pattern does not restart at the end of a row or column.
:''line2'': ''Optional.'' If given, each time the end of row (if ''horiz'' is ''True'') or column (if ''horiz'' is ''False'') is reached, the function will switch to filling with the other pattern. That is, the first row will use ''line1'' then the second will use ''line2'', then the third will use ''line1'' again, etc.
----
;{{moddef|desc|fill_edges|dot||CellID|what}}
Fills the edges of the map with the given cell.
:''what'': The cell to fill with.
----
;{{moddef|desc|each|dot|Table|CellID|what|Area|[where]}}
Searches for a cell and returns a table containing every location it was found.
:''what'': The cell to search for.
:''where'': ''Optional.'' The area to restrict the search to.
:'''Returns''': A table containing a list of [[Modding:Coord|Coord]] objects.
----
;{{moddef|desc|set_blood|dot||Area|[where]|boolean|[value]|CellID|[what]}}
Adds blood to the map or removes blood from it.
:''where'': ''Optional.'' The area to affect. If omitted, the entire map will selected.
:''value'': ''Optional.'' ''True'' adds blood. ''False'' removes it. If omitted, the default is to add blood.
:''what'': ''Optional.'' If provided, only locations containing the given cell are affected. If omitted, all cells in the area are affected.
----
;{{moddef|desc|set_permanence|dot||Area|[where]|boolean|[value]|CellID|[what]}}
Makes cell permanent or removes their permanence.
:''where'': ''Optional.'' The area to affect. If omitted, the entire map will be selected.
:''value'': ''Optional.'' ''True'' adds permanence. ''False'' removes it. If omitted, the default is to add permanence.
:''what'': ''Optional.'' If provided, only locations containing the given cell are affected. If omitted, wall cells (which includes crate cells) are affected.
----
;{{moddef|desc|cell_set|dot|Table|CellSet|cells}}
Creates a cell group.
:''cells'': A list of cells to add to the group.
:'''Returns''': A cell group table.
----
;{{moddef|desc|restore_walls|dot||CellID|wallCell|boolean|keepFluids}}
Fixes the edge walls of the map.
:''wallCell'': The cell to fill the edge of the map with.
:''keepFluids'': ''True'' to maintain any fluid tiles on the edge of the map. ''False'' to overwrite them.
----
;{{moddef|desc|plot_line|dot||Coord|where|boolean|horiz|CellID|cell|CellSet|block}}
Splits an area into two at the indicated location.
:''where'': The starting point.
:''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.
----
;{{moddef|desc|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|CellID|cell|CellSet|block}}
Splits an area into two at the indicated location.
:''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.
:''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.
----
;{{moddef|desc|scatter|dot||Area|where|CellID|good|CellID|fill|integer|count}}
Randomly places a certain cell around the map.
:''where'': The area to scatter the cell in.
:''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.
----
;{{moddef|desc|scatter_blood|dot||Area|where|CellID|[good]|integer|count}}
Randomly adds blood in an area.
:''where'': The area to scatter blood in.
:''good'': ''Optional.'' If defined, only locations with this cell will have blood added. If omitted, any location my have blood added.
:''count'': The number of attempts. On each attempt, a random cell in the area will be chosen to have blood added. The number of cell that will end up bloody may be less than ''count'' (or even 0), but never more.
----
;{{moddef|desc|scatter_put|dot||Area|where|Table|translation|string|tile|CellID|good|integer|count}}
Randomly adds a specified tile (a defined arrangement of cells) around the map.
:''where'': The area to scatter the tile in. The tiles will only be placed in locations entirely within the area.
:''translation'': A table with to be used with the ''tile'' argument. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string, one row of the tile per line, that lays out the arrangment of the cells. Refer to this (will be linked soon) for more information
:''good'': Only locations with this cell will be valid for the tile placement. If any coordinates of the selected placement area are not ''good'', the tile will not be placed at that location.
:''count'': The number of tiles to try to place. The placement will continue until this many have been placed, or 10,000 attempts have been made, whichever comes first.
----
;{{moddef|desc|transmute|dot||CellID|to|CellSet|from|Area|[where]}}
Changes all of one cell on the map to another cell.
:''to'': The cell that will replace the existing cells.
:''from'': The cell(s) that will be replaced.
:''where'': ''Optional.'' If specified, only cells in the area are changed. If omitted, the function will change cells across the entire map.
----
;{{moddef|desc|transmute_marker|dot||Flag|marker|CellID|To|Area|[where]}}
Changes all positions on the map that have a specified LightFlag (a named constant starting with "LF", no underscore) to another cell.
:''marker'': The LightFlag to check for. Only cells with this flag will be changed.
:''to'': The cell that will replace the existing cells.
:''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}}
Parses a translation table. Refer to this (will be linked soon) for more information.
:''code'': The translation table.
:'''Returns''': A parsed translation table.
----
;{{moddef|desc|tile_new|dot|Tile|string|map|Table|translation}}
Creates a new tile object.
:''map'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells. Refer to this (will be linked soon) for more information.
:''translation'': A table with to be used with the ''map'' argument. Refer to this (will be linked soon) for more information.
:'''Returns''': The new tile object.
----
;{{moddef|desc|tile_place|dot||Coord|where|Tile|what}}
Places the cells of the tile on the map.
:''where'': The coordinate that the upper-left of the tile should reside at.
:''what'': The tile object that will be placed.
----
;{{moddef|desc|place_tile|dot||Table|translation|string|tile|integer|x|integer|y}}
Combines the tile_new and tile_place functions together, by placing a tile using a string and translation table.
:''translation'': A table with to be used with the ''tile'' argument. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells. Refer to this (will be linked soon) for more information.
:''x'': The X position that the tile will be placed at.
:''y'': The Y position that the tile will be placed at.
----
;{{moddef|desc|place_dungen_tile|dot||Table|code|Tile|tile|Coord|where}}
Places an entire tile, including beings and items in the translation, on the map.
:''code'': The translation table. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells and indicate the positions of the beings and items. Refer to this (will be linked soon) for more information.
:''where'': The coordinate the tile will be placed at.
----
;{{moddef|desc|place_symmetry_quad|dot||string|tile|Table|translation}}
Takes a tile object and places it in all four corners. The tile object should be setup for the upper left corner and will be mirrored to the other corners. The tiles are placed one space from the map edge.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells and indicate the positions of the beings and items. Refer to this (will be linked soon) for more information.
:''translation'': The translation table. Refer to this (will be linked soon) for more information.
----
;{{moddef|desc|place_proto_map|dot||Coord|where|string|proto_map|string|proto_key|Table|code}}
Creates a map using multiple tile sets.
:''where'': The upper-left position of the map where the tiles will be layout from.
:''proto_map'': A string indicating the arrangement of the different pieces of the map. e.g., "ABCD", will lay out 4 different tiles with A on the far left and D on the far right.
:''proto_key'': A table containing, for each character in ''proto_map'', a table of the possible tiles for that section.
:''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]}}
Marks an area that can become a special room.
:''room'': The area of the room. This includes the walls.
:''class'': ''Optional.'' A string used to denote which room generators can be used on this room. If omitted, the class used is "closed".
----
;{{moddef|desc|add_rooms|dot}}
Finds all the areas that can be rooms on a map and adds them to the appropriate meta-map tables.
----
;{{moddef|desc|get_room|dot|Room|integer|min_size|integer|max_x|integer|max_y|integer|max_area|string|class}}
Selects a room given certain criteria.
:''min_size'': The smallest X and Y dimensions the room can be.
:''max_x'': The maximum width of the room.
:''max_y'': The maximum height of the room.
:''max_area'': The largest area the room can be.
:''class'': ''Optional.'' The string denoting which room classes are valid for this room generator. If omitted, "any" is used, which does not restrict the selection of rooms.
----
;{{moddef|desc|get_endpoints|dot|integer, integer|Coord|where|boolean|horiz|CellSet|what}}
Finds the ends of a line of cells.
:''where'': The starting coordinate.
:''horiz'': ''True'' checks horizontally. ''False'' checks vertically.
:''what'': The cell(s) that make up the line to check. The functions stops at the first cell '''not''' in this list.
:'''Returns''': Two integers. If ''horiz'' is ''True'', these are the X positions the line stops at. If ''horiz'' is ''False'', these are the Y positions the line stops at.
----
;{{moddef|desc|handle_rooms|dot||integer|count|boolean|no_monsters}}
Runs the rooms selection and setup process for a map.
:''count'': The number of rooms to attempt to place.
:''no_monsters'': ''True'' will exclude room generators that place monsters. ''False'' will not.
----
=== Generation Algorithm Functions ===
;{{moddef|desc|run_drunkard_walk|dot||Area|where|Coord|start|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|where}}
Runs an algorithm that walks to random adjacent spaces.
:''where'': The area that the algorithm will run in. If the algorithm tries to leave the area, it will stop early or will be pushed back in the area (''stop_at_edge'' will determine which of these happen).
:''start'': The location the algorithm will begin at.
:''steps'': The number of steps the algorithm will take. The number of spaces covered by the algorithm will be at most this number.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
----
;{{moddef|desc|drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|[where]}}
Runs multiple "drunken walk" algorithms.
:''amount'': The number of times to perform the algorithm.
:''steps'': The number of steps each run of the algorithm will take. The number of spaces covered by the algorithm will be at most the ''amount'' times the number of ''steps''.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
:''where'': ''Optional.'' The area the algorithm will run in. If the algorithm tries to leave the area, it will stop early or will be pushed back in the area (''stop_at_edge'' will determine which of these happen). If omitted, the default is entire area minus the very edge.
----
;{{moddef|desc|contd_drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|edges1|CellSet|edges2|CellSet|[ignore]|boolean|[stop_at_edge]}}
Runs multiple "drunken walk" algorithms starting at a space that doesn't have certain cells around it.
:''amount'': The number of times to perform the algorithm.
:''steps'': The number of steps each run of the algorithm will take. The number of spaces covered by the algorithm will be at most the ''amount'' times the number of ''steps''.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''edges1'': The algorithm will not start on a space with a cell listed here next to it.
:''edges2'': The algorithm will not start on a space with a cell listed here next to it.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
----
;{{moddef|desc|warehouse_fill|dot||CellID|fill|Area|where|integer|[size]|integer|[count]|integer|[special_chance]|CellID|[special]}}
Fills an area with random squares of cells.
:''fill'': The cell(s) to use for each square. If a list is given, one is chosen at random for each square.
:''where'': The area to fill.
:''size'': ''Optional.'' The size of the squares to use. If omitted, the default is 2.
:''count'': ''Optional.'' The number of attempts. If omitted, the default is 50.
:''special_chance'': ''Optional.'' A number indicating the probability of using a special list of cells to fill the square with instead of the ''fill'' list. The roll used for the chance is based on the ''size'' parameter. A number from 1 to (100 * ''size'') is chosen for each square and if the roll is less than the special_chance number, the ''special'' cell set is used to fill the square instead. If omitted, all squares will be filled from the ''fill'' set.
:''special'': ''Optional.'' The list of cells to use if the special set is to be used, based on ''special_chance''. If omitted, all squares will be filled from the ''fill'' set.
----
;{{moddef|desc|place_blob|dot||Coord|start|integer|size|CellID|cell}}
Fills an area by expanding to random edge coordinates.
:''start'': The position to start the blob at.
:''size'': The number of spaces to expand the blob to.
:''cell'': The cell to fill the blob area with.
----
=== Generator Helper Functions ===
;{{moddef|desc|roll_pair|dot|<value>, <value>|Table|list}}
Takes a list of values of any type and returns two different values randomly from the list.
:''list'': The list to choose from.
:'''Returns''': Two different values. If the list only contains one choice, it will be returned, but only once.
----
;{{moddef|desc|being_weight|dot}}
Gets the total danger level for the current dungeon level.
'''Returns''': The danger level for the current dungeon level. This value is calcuated using the current difficulty and ''level.danger_level''.
----
;{{moddef|desc|item_amount|dot}}
Gets the number of items to drop for the current dungeon level.
'''Returns''': The number of items to drop for the current dungeon level.
----
;{{moddef|desc|horiz_river|dot||CellID|cell|integer|width|boolean|[bridge]}}
Places a horizontal river on the map.
:''cell'': The cell to use for the river. It does not have to be a fluid cell.
:''width'': The width of the river.
:''bridge'': ''Optional.'' If ''True'', a 2 space wide bridge will be placed at a random coordinate on the river. If ''False'', no bridge will be placed. If omitted, the default is to not place a bridge.
----
;{{moddef|desc|vert_river|dot||CellID|cell|integer|width|boolean|bridge|integer|[position]}}
;{{moddef|desc|vert_river|dot||CellID|cell|integer|width|boolean|bridge|Coord|[position]}}
Places a vertical river on the map.
:''cell'': The cell to use for the river. It does not have to be a fluid cell.
:''width'': The width of the river.
:''bridge'': ''Optional.'' If ''True'', a 2 space wide bridge will be placed at a random coordinate on the river. If ''False'', no bridge will be placed. If omitted, the default is to not place a bridge.
:: NOTE: Because of a bug, a bridge will always be placed on the river, even if this value is set to ''False'' or omitted.
:''position'': A coordinate or an integer. If an integer is supplied, this is the X position of the river's left edge. If a coordinate is supplied, the river will start at this coordinate. If omitted, the river's left edge will be selected from between X = 19 to 58.
----
;{{moddef|desc|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
Creates rivers based on normal DoomRL 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.
:''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.
----
;{{moddef|desc|generate_stairs|dot}}
Creates the normal staircase based on normal DoomRL 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.
----
;{{moddef|desc|place_player|dot}}
Places the player on a random empty space.
----
;{{moddef|desc|run|dot||Generator|gen}}
Runs a generator object. These are stored in the generators table.
:''gen'': The generator object to run.
----
;{{moddef|desc|reset|dot}}
Resets the map.
----
=== Dungeon Generation Functions ===
;{{moddef|desc|generate_tiled|dot}}
Creates a tiled dungeon, also known as a "normal" dungeon. This only creates the layout, it does not place beings, items, stairs, barrels, or the player.
----
;{{moddef|desc|maze_dungeon|dot||CellID|floor|CellID|wall|integer|granularity|integer|tries|integer|min_size|integer|max_size}}
Creates a maze dungeon. This only creates the layout, it does not place beings, items, stairs, barrels, or the player.
:''floor'': The cell to use for the floor of the maze.
:''wall'': The cell to use for the wall of the maze.
:''granularity'': This denotes the size of the maze's paths.
:''tries'': Number of attempts to place a new wall in the maze.
:''min_size'': The smallest possible size of a wall.
:''max_size'': The largest possible size of a wall.
----
;{{moddef|desc|generate_caves_dungeon|dot}}
Runs the generation script for the cave dungeon. This is an all inclusive function, it also places all beings and items.
----
;{{moddef|desc|generate_caves_2_dungeon|dot}}
Runs the generation script for the cave-city dungeon. This is an all inclusive function, it also places all beings and items.
----
;{{moddef|desc|generate_lava_dungeon|dot}}
Runs the generation script for the lava dungeon. This is an all inclusive function, it also places all beings and items.
----
=== Event Handler Functions ===
;{{moddef|desc|roll_event|dot}}
Picks an event from the events table and sets it up.
----
;{{moddef|desc|setup_flood_event|dot||integer|direction|integer|step|CellID|cell}}
Runs the setup script for the flood event.
:''direction'': Use 1 to flood from the left. Use -1 to flood from the right.
:''step'': Number of turns (0.1 second intervals) between each flood step.
:''cell'': The cell to flood with. This does not have to be a fluid cell.
----
;{{moddef|desc|setup_deadly_air_event|dot||integer|step}}
Runs the setup script for the deadly air event.
:''step'': Number of turns between each "chill" (loss of HP).
----
;{{moddef|desc|setup_explosion_event|dot||integer|step|integer|size|integer|dice|integer|[content]}}
;{{moddef|desc|setup_explosion_event|dot||integer|step|Table|size|integer|dice|integer|[content]}}
Runs the setup script for the explosion event.
:''step'': Number of turns between each explosion.
:''size'': Either a number or a table of two numbers. Indicates the size of each explosion. If a table is supplied, the size is randomly chosen between the range supplied each time an explosion is created.
:''dice'': Number of d6 dice to use for the damage roll.
:''content'': ''Optional.'' The content to place in any space where the damage to a space is more than 20 points. If omitted, nothing will placed.
----
;{{moddef|desc|setup_targeted_event|dot||integer|step}}
Runs the setup script for the targeting event.
:''step'': Number of turns between each monster teleport.
----

Modding:generator API

2013-04-25T19:08:29Z

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

''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.

== API ==

Please note that the type "integer" indicates an numeric value without a decimal part. It does not indicate the range of acceptable values.

The argument type "CellID" may be the numeric or string ID of a cell.

The argument type "CellSet" may be the numeric ID, string ID, or a list of numeric and/or string IDs.

The argument type "Flags" expects a list of [[Modding:Constants|flag constants]] of the indicated type.

An argument name in [square brackets] is an optional one. The function description will indicate how the function operates if it is omitted.

=== Generator API Function List ===

{|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"|'''Generator Interface - Functions'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
||'''[[#Basic Cell Handling Functions|Basic Cell Handling Functions]]'''
|{{modarg|integer}}|{{moddef|list|get_cell|dot||Coord|loc}}
|{{modarg|string}}|{{moddef|list|get_cell_id|dot||Coord|loc}}
|{{modarg|integer}}|{{moddef|list|fast_get_cell|dot||integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|set_cell|dot||Coord|loc|CellID|what}}
|{{modarg|void}}|{{moddef|list|fast_set_cell|dot||integer|x|integer|y|integer|what}}
||'''[[#Map Checking Functions|Map Checking Functions]]'''
|{{modarg|integer}}|{{moddef|list|around|dot||Coord|where|CellSet|what}}
|{{modarg|integer}}|{{moddef|list|cross_around|dot||Coord|where|CellSet|what}}
|{{modarg|boolean}}|{{moddef|list|is_empty|dot||Coord|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|is_empty_area|dot||Area|where|Flags|reqs}}
|{{modarg|boolean}}|{{moddef|list|scan|dot||Area|where|CellID|good}}
||'''[[#Map Searching Functions|Map Searching Functions]]'''
|{{modarg|Coord}}|{{moddef|list|drop_coord|dot||Coord|where|Flags|reqs}}
|{{modarg|Coord}}|{{moddef|list|find_coord|dot||CellSet|what|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|random_coord|dot||Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_random_coord|dot||CellSet|what|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_empty_coord|dot||CellSet|what|Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|random_empty_coord|dot||Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|find_random_empty_coord|dot||CellSet|what|Flags|reqs|Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|safe_empty_coord|dot||Area|[where]}}
|{{modarg|Coord}}|{{moddef|list|standard_empty_coord|dot}}
||'''[[#Advanced Cell Handling Functions|Advanced Cell Handling Functions]]'''
|{{modarg|void}}|{{moddef|list|fill|dot||CellID|what|Area|[where]}}
|{{modarg|void}}|{{moddef|list|fill_pattern|dot||Area|where|boolean|horiz|Table|line1|Table|[line2]}}
|{{modarg|void}}|{{moddef|list|fill_edges|dot||CellID|what}}
|{{modarg|Table}}|{{moddef|list|each|dot||CellID|what|Area|[where]}}
|{{modarg|void}}|{{moddef|list|set_blood|dot||Area|[where]|boolean|[value]|CellID|[what]}}
|{{modarg|void}}|{{moddef|list|set_permanence|dot||Area|[where]|boolean|[value]|CellID|[what]}}
|{{modarg|Table}}|{{moddef|list|cell_set|dot||CellSet|cells}}
|{{modarg|void}}|{{moddef|list|restore_walls|dot||CellID|wallCell|boolean|keepFluids}}
|{{modarg|void}}|{{moddef|list|plot_line|dot||Coord|where|boolean|horiz|CellID|cell|CellSet|block}}
|{{modarg|void}}|{{moddef|list|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|CellID|cell|CellSet|block}}
|{{modarg|void}}|{{moddef|list|scatter|dot||Area|where|CellID|good|CellID|fill|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_blood|dot||Area|where|CellID|[good]|integer|count}}
|{{modarg|void}}|{{moddef|list|scatter_put|dot||Area|where|Table|translation|string|tile|CellID|good|integer|count}}
|{{modarg|void}}|{{moddef|list|transmute|dot||CellID|to|CellSet|from|Area|[where]}}
|{{modarg|void}}|{{moddef|list|transmute_marker|dot||Flag|marker|CellID|To|Area|[where]}}
||'''[[#Tile Handling Functions|Tile Handling Functions]]'''
|{{modarg|Table}}|{{moddef|list|create_translation|dot||Table|code}}
|{{modarg|Tile}}|{{moddef|list|tile_new|dot||string|map|Table|translation}}
|{{modarg|void}}|{{moddef|list|tile_place|dot||Coord|where|Tile|what}}
|{{modarg|void}}|{{moddef|list|place_tile|dot||Table|translation|string|tile|integer|x|integer|y}}
|{{modarg|void}}|{{moddef|list|place_dungen_tile|dot||Table|code|Tile|tile|Coord|where}}
|{{modarg|void}}|{{moddef|list|place_symmetry_quad|dot||string|tile|Table|translation}}
|{{modarg|void}}|{{moddef|list|place_proto_map|dot||Coord|where|string|proto_map|string|proto_key|Table|code}}
||'''[[#Room Handling Functions|Room Handling Functions]]'''
|{{modarg|void}}|{{moddef|list|add_room|dot||Area|room|string|[class]}}
|{{modarg|void}}|{{moddef|list|add_rooms|dot}}
|{{modarg|Room}}|{{moddef|list|get_room|dot||integer|min_size|integer|max_x|integer|max_y|integer|max_area|string|[class]}}
|{{modarg|integer, integer}}|{{moddef|list|get_endpoints|dot||Coord|where|boolean|horiz|CellSet|what}}
|{{modarg|void}}|{{moddef|list|handle_rooms|dot||integer|count|boolean|no_monsters}}
||'''[[#Generation Algorithm Functions|Generation Algorithm Functions]]'''
|{{modarg|void}}|{{moddef|list|run_drunkard_walk|dot||Area|where|Coord|start|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]}}
|{{modarg|void}}|{{moddef|list|drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|[where]}}
|{{modarg|void}}|{{moddef|list|contd_drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|edges1|CellSet|edges2|CellSet|[ignore]|boolean|[stop_at_edge]}}
|{{modarg|void}}|{{moddef|list|warehouse_fill|dot||CellSet|fill|Area|where|integer|size|integer|count|integer|special_chance|CellSet|special}}
|{{modarg|void}}|{{moddef|list|place_blob|dot||Coord|start|integer|size|CellID|cell}}
||'''[[#Generator Helper Functions|Generator Helper Functions]]'''
|{{modarg|<value>, <value>}}|{{moddef|list|roll_pair|dot||Table|list}}
|{{modarg|integer}}|{{moddef|list|being_weight|dot}}
|{{modarg|integer}}|{{moddef|list|item_amount|dot}}
|{{modarg|void}}|{{moddef|list|horiz_river|dot||CellID|cell|integer|width|boolean|[bridge]}}
|{{modarg|void}}|{{moddef|list|vert_river|dot||CellID|cell|integer|width|boolean|bridge|integer|position}}
{{moddef|list|vert_river|dot||CellID|cell|integer|width|boolean|bridge|Coord|position}}
|{{modarg|void}}|{{moddef|list|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
|{{modarg|void}}|{{moddef|list|generate_fluids|dot||Area|[where]}}
|{{modarg|void}}|{{moddef|list|generate_barrels|dot}}
|{{modarg|void}}|{{moddef|list|generate_stairs|dot}}
|{{modarg|void}}|{{moddef|list|generate_special_stairs|dot}}
|{{modarg|void}}|{{moddef|list|place_player|dot}}
|{{modarg|void}}|{{moddef|list|run|dot||Generator|gen}}
|{{modarg|void}}|{{moddef|list|reset|dot}}
||'''[[#Dungeon Generation Functions|Dungeon Generation Functions]]'''
|{{modarg|void}}|{{moddef|list|generate_tiled|dot}}
|{{modarg|void}}|{{moddef|list|maze_dungeon|dot||CellID|floor|CellID|wall|integer|granularity|integer|tries|integer|min_size|integer|max_size}}
|{{modarg|void}}|{{moddef|list|generate_caves_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_caves_2_dungeon|dot}}
|{{modarg|void}}|{{moddef|list|generate_lava_dungeon|dot}}
||'''[[#Event Handler Functions|Event Handler Functions]]'''
|{{modarg|void}}|{{moddef|list|roll_event|dot}}
|{{modarg|void}}|{{moddef|list|setup_flood_event|dot||integer|direction|integer|step|CellID|cell}}
|{{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}}
|{{modarg|void}}|{{moddef|list|setup_targeted_event|dot||integer|step}}
|}}
|}

=== Basic Cell Handling Functions ===
;{{moddef|desc|get_cell|dot|integer|Coord|loc}}
Gets the Numeric ID (NID) of the [[Modding:Cell|cell]] at a given map position.
:''loc'': The coordinates of the cell to get.
:'''Returns''': The NID of the cell.
----
;{{moddef|desc|get_cell_id|dot|string|Coord|loc}}
Gets the ID of the [[Modding:Cell|cell]] at a given map position.
:''loc'': The coordinates of the cell to get.
:'''Returns''': The string ID of the cell.
----
;{{moddef|desc|fast_get_cell|dot|integer|integer|x|integer|y}}
Gets the Numeric ID (NID) of the [[Modding:Cell|cell]] at a given map position.
:''x'': The X position of the cell to get.
:''y'': The Y position of the cell to get.
:'''Returns''': The NID of the cell.
----
;{{moddef|desc|set_cell|dot||Coord|loc|CellID|what}}
Assigns a [[Modding:Cell|cell]] to a map position.
:''loc'': The coordinates of the position to set.
:''what'': The ID of the cell to assign to the position.
----
;{{moddef|desc|fast_set_cell|dot||integer|x|integer|y|integer|what}}
Assigns a [[Modding:Cell|cell]] to a map position.
:''x'': The X position of the cell to set.
:''y'': The Y position of the cell to set.
:''what'': The NID (string IDs not allowed) of the cell to assign to the position.
----
=== Map Checking Functions ===
;{{moddef|desc|around|dot|integer|Coord|where|CellSet|what}}
Checks the positions adjacent to a location (including diagonally adjacent) and returns the number of cells that match one of the indicated cell IDs.
:''where'': The coordinate to check around. The coordinate sent in this way is not checked, only adjacent cells are.
:''what'': The cell(s) to check for.
:'''Returns''': The number of cells (from 0 to 8) that matched one of the ''what'' cell IDs.
----
;{{moddef|desc|cross_around|dot|integer|Coord|where|CellSet|what}}
Checks the positions adjacent to a location (but not diagonally adjacent) and returns the number of cells that match one of the indicated cell IDs.
:''where'': The coordinates to check around. The coordinate sent in this way is not checked, only adjacent cells are.
:''what'': The cell(s) to check for.
:'''Returns''': The number of cells (from 0 to 4) that matched one of the ''what'' cell IDs.
----
;{{moddef|desc|is_empty|dot|boolean|Coord|where|Flags|reqs}}
Checks to see if the indicated cell is "empty", defining "empty" based on a list of criteria.
:''where'': The position to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the position cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the map position does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if the cell satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|is_empty_area|dot|boolean|Area|where|Flags|reqs}}
Checks to see if the indicated area is "empty", defining "empty" based on a list of criteria.
:''where'': The area to check.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the area cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns true if the area does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': ''True'' if every cell in the area satisfies all of the conditions indicated in ''reqs'', ''False'' otherwise.
----
;{{moddef|desc|scan|dot|boolean|Area|where|CellID|good}}
Checks to see if the entire area is filled with a certain cell.
:''where'': The area to check.
:''good'': The cell to look for.
:'''Returns''': ''True'' if all cells in the area are ''good'', ''False'' otherwise.
----
=== Map Searching Functions ===
;{{moddef|desc|drop_coord|dot|Coord|Coord|where|Flags|reqs}}
Finds the nearest "empty" coordinate to a given coordinate, defining "empty" based on a list of criteria.
:''where'': The coordinate to try. If this coordinate is "empty", this coordinate will be returned.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:'''Returns''': The nearest coordinate the satisfies the criteria. If the supplied coordinate meets the criteria, that coordinate will be returned. If not a nearby, random, coordinate will be checked.
----
;{{moddef|desc|find_coord|dot|Coord|CellSet|what|Area|[where]}}
Searches the map for the first coordinate containing one of the indicated cell IDs.
:''what'': The cell(s) to search for.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': The coordinates of the first position that contains one of the ''what'' cell IDs. The map is checked row by row starting from the top, going from left to right across each row.
----
;{{moddef|desc|random_coord|dot|Coord|Area|[where]}}
Searches for a random coordinate within the specified area.
:''where'': ''Optional.'' The area to restrict the coordinate to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate.
----
;{{moddef|desc|find_random_coord|dot|Coord|CellSet|what|Area|[where]}}
Searches for a random coordinate within the specified area that contains one of the specified cell IDs.
:''what'': The cell(s) to search for.
:''where'' : ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|find_empty_coord|dot|Coord|CellSet|what|Flags|reqs|Area|[where]}}
Searches the map for the first "empty" coordinate containing one of the indicated cell IDs, defining "empty" based on a list of criteria.
:''what'': The cell(s) to search for.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': The coordinates of the first position that meets the supplied criteria. The map is checked row by row starting from the top, going from left to right across each row.
----
;{{moddef|desc|random_empty_coord|dot|Coord|Flags|reqs|Area|[where]}}
Searches the map for a random coordinate that is "empty", defining "empty" based on a list of criteria.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the random coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|find_random_empty_coord|dot|Coord|CellSet|what|Flags|reqs|Area|[where]}}
Searches the map for a random "empty" coordinate containing one of the indicated cell IDs, defining "empty" based on a list of criteria.
:''what'': The cell(s) to search for.
:''reqs'': A list of EmptyFlags (named numeric constants that start with EF_) indicating which types of objects or properties the random coordinate cannot have. For example, if the flag EF_NOBEINGS is sent, the function only returns a coordinate that does not contain a [[Modding:Being|being]]. See [[Modding:Constants#Empty_Flags]] for more information.
:''where'': ''Optional.'' The area to restrict the search to. If omitted, the coordinate can be picked from anywhere on the map.
:'''Returns''': A random coordinate that meets the supplied criteria.
----
;{{moddef|desc|random_square|dot|Coord|CellSet|what}}
Searches for a random 3x3 area containing only specified cells.
:''what'': The cell(s) to search for.
:'''Returns''': The center coordinate of the random 3x3 area.
----
;{{moddef|desc|safe_empty_coord|dot|Coord|Area|[where]}}
Searches for a random coordinate that meets certain predetermined criteria.

The function will try to find a coordinate that does not contain a being, item, staircase, wall, harmful terrain, spawning restrictions (cells marked with LF_NOSPAWN), and is more than 5 spaces from the player (EF_NOBEINGS, EF_NOITEMS, EF_NOSTAIRS, EF_NOBLOCK, EF_NOHARM, EF_NOSPAWN, and EF_NOSAFE). If a valid space isn't found, the function will ignore distance from the player (EF_NOSAFE). If a valid space still can't be found, the function will ignore stairs and harmful terrain (EF_NOSTAIRS and EF_NOHARM).
:''where'': ''Optional.'' The area to restrict the initial pass to. If a valid coordinate is not found within the area after ignoring stairs and harmful terrain, the search is restarted and expanded automatically to the entire map. If omitted, the entire map will be searched.
:'''Returns''': A random coordinate that meets the criteria.
----
;{{moddef|desc|standard_empty_coord|dot|Coord}}
Searches for a random coordinate that meets certain predetermined criteria.

The function will search for a coordinate that does not contain a being, item, staircase, wall, harmful terrain, or spawning restrictions (EF_NOBEINGS, EF_NOITEMS, EF_NOSTAIRS, EF_NOBLOCK, EF_NOHARM, and EF_NOSPAWN).
:'''Returns''': A random coordinate that meets the criteria.
----
=== Advanced Cell Handling Functions ===
;{{moddef|desc|fill|dot||CellID|what|Area|[where]}}
Fills an area of the map with a given cell.
:''what'': The cell to fill with.
:''where'': ''Optional.'' The area to fill with the cell. If omitted, the entire map will be filled.
----
;{{moddef|desc|fill_pattern|dot||Area|where|boolean|horiz|string|Table|line1|Table|[line2]}}
Fills an area of the map with a pattern of cells.
:''where'': The area to fill.
:''horiz'': If ''True'', the pattern will fill each row left to right, then move to the next row down in the area. If ''False'', the pattern will fill each column top to bottom, then move to the next column right in the area.
:''line1'': The pattern to fill with. If the pattern is shorter than the area size, the pattern will loop. The pattern does not restart at the end of a row or column.
:''line2'': ''Optional.'' If given, each time the end of row (if ''horiz'' is ''True'') or column (if ''horiz'' is ''False'') is reached, the function will switch to filling with the other pattern. That is, the first row will use ''line1'' then the second will use ''line2'', then the third will use ''line1'' again, etc.
----
;{{moddef|desc|fill_edges|dot||CellID|what}}
Fills the edges of the map with the given cell.
:''what'': The cell to fill with.
----
;{{moddef|desc|each|dot|Table|CellID|what|Area|[where]}}
Searches for a cell and returns a table containing every location it was found.
:''what'': The cell to search for.
:''where'': ''Optional.'' The area to restrict the search to.
:'''Returns''': A table containing a list of [[Modding:Coord|Coord]] objects.
----
;{{moddef|desc|set_blood|dot||Area|[where]|boolean|[value]|CellID|[what]}}
Adds blood to the map or removes blood from it.
:''where'': ''Optional.'' The area to affect. If omitted, the entire map will selected.
:''value'': ''Optional.'' ''True'' adds blood. ''False'' removes it. If omitted, the default is to add blood.
:''what'': ''Optional.'' If provided, only locations containing the given cell are affected. If omitted, all cells in the area are affected.
----
;{{moddef|desc|set_permanence|dot||Area|[where]|boolean|[value]|CellID|[what]}}
Makes cell permanent or removes their permanence.
:''where'': ''Optional.'' The area to affect. If omitted, the entire map will be selected.
:''value'': ''Optional.'' ''True'' adds permanence. ''False'' removes it. If omitted, the default is to add permanence.
:''what'': ''Optional.'' If provided, only locations containing the given cell are affected. If omitted, wall cells (which includes crate cells) are affected.
----
;{{moddef|desc|cell_set|dot|Table|CellSet|cells}}
Creates a cell group.
:''cells'': A list of cells to add to the group.
:'''Returns''': A cell group table.
----
;{{moddef|desc|restore_walls|dot||CellID|wallCell|boolean|keepFluids}}
Fixes the edge walls of the map.
:''wallCell'': The cell to fill the edge of the map with.
:''keepFluids'': ''True'' to maintain any fluid tiles on the edge of the map. ''False'' to overwrite them.
----
;{{moddef|desc|plot_line|dot||Coord|where|boolean|horiz|CellID|cell|CellSet|block}}
Splits an area into two at the indicated location.
:''where'': The starting point.
:''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.
----
;{{moddef|desc|plot_lines|dot||Coord|where|Area|larea|boolean|horiz|CellID|cell|CellSet|block}}
Splits an area into two at the indicated location.
:''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.
:''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.
----
;{{moddef|desc|scatter|dot||Area|where|CellID|good|CellID|fill|integer|count}}
Randomly places a certain cell around the map.
:''where'': The area to scatter the cell in.
:''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.
----
;{{moddef|desc|scatter_blood|dot||Area|where|CellID|[good]|integer|count}}
Randomly adds blood in an area.
:''where'': The area to scatter blood in.
:''good'': ''Optional.'' If defined, only locations with this cell will have blood added. If omitted, any location my have blood added.
:''count'': The number of attempts. On each attempt, a random cell in the area will be chosen to have blood added. The number of cell that will end up bloody may be less than ''count'' (or even 0), but never more.
----
;{{moddef|desc|scatter_put|dot||Area|where|Table|translation|string|tile|CellID|good|integer|count}}
Randomly adds a specified tile (a defined arrangement of cells) around the map.
:''where'': The area to scatter the tile in. The tiles will only be placed in locations entirely within the area.
:''translation'': A table with to be used with the ''tile'' argument. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string, one row of the tile per line, that lays out the arrangment of the cells. Refer to this (will be linked soon) for more information
:''good'': Only locations with this cell will be valid for the tile placement. If any coordinates of the selected placement area are not ''good'', the tile will not be placed at that location.
:''count'': The number of tiles to try to place. The placement will continue until this many have been placed, or 10,000 attempts have been made, whichever comes first.
----
;{{moddef|desc|transmute|dot||CellID|to|CellSet|from|Area|[where]}}
Changes all of one cell on the map to another cell.
:''to'': The cell that will replace the existing cells.
:''from'': The cell(s) that will be replaced.
:''where'': ''Optional.'' If specified, only cells in the area are changed. If omitted, the function will change cells across the entire map.
----
;{{moddef|desc|transmute_marker|dot||Flag|marker|CellID|To|Area|[where]}}
Changes all positions on the map that have a specified LightFlag (a named constant starting with "LF", no underscore) to another cell.
:''marker'': The LightFlag to check for. Only cells with this flag will be changed.
:''to'': The cell that will replace the existing cells.
:''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}}
Parses a translation table. Refer to this (will be linked soon) for more information.
:''code'': The translation table.
:'''Returns''': A parsed translation table.
----
;{{moddef|desc|tile_new|dot|Tile|string|map|Table|translation}}
Creates a new tile object.
:''map'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells. Refer to this (will be linked soon) for more information.
:''translation'': A table with to be used with the ''map'' argument. Refer to this (will be linked soon) for more information.
:'''Returns''': The new tile object.
----
;{{moddef|desc|tile_place|dot||Coord|where|Tile|what}}
Places the cells of the tile on the map.
:''where'': The coordinate that the upper-left of the tile should reside at.
:''what'': The tile object that will be placed.
----
;{{moddef|desc|place_tile|dot||Table|translation|string|tile|integer|x|integer|y}}
Combines the tile_new and tile_place functions together, by placing a tile using a string and translation table.
:''translation'': A table with to be used with the ''tile'' argument. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells. Refer to this (will be linked soon) for more information.
:''x'': The X position that the tile will be placed at.
:''y'': The Y position that the tile will be placed at.
----
;{{moddef|desc|place_dungen_tile|dot||Table|code|Tile|tile|Coord|where}}
Places an entire tile, including beings and items in the translation, on the map.
:''code'': The translation table. Refer to this (will be linked soon) for more information.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells and indicate the positions of the beings and items. Refer to this (will be linked soon) for more information.
:''where'': The coordinate the tile will be placed at.
----
;{{moddef|desc|place_symmetry_quad|dot||string|tile|Table|translation}}
Takes a tile object and places it in all four corners. The tile object should be setup for the upper left corner and will be mirrored to the other corners. The tiles are placed one space from the map edge.
:''tile'': A multi-line string containing the arrangement of the tile using the ''translation'' to convert the characters to cells and indicate the positions of the beings and items. Refer to this (will be linked soon) for more information.
:''translation'': The translation table. Refer to this (will be linked soon) for more information.
----
;{{moddef|desc|place_proto_map|dot||Coord|where|string|proto_map|string|proto_key|Table|code}}
Creates a map using multiple tile sets.
:''where'': The upper-left position of the map where the tiles will be layout from.
:''proto_map'': A string indicating the arrangement of the different pieces of the map. e.g., "ABCD", will lay out 4 different tiles with A on the far left and D on the far right.
:''proto_key'': A table containing, for each character in ''proto_map'', a table of the possible tiles for that section.
:''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]}}
Marks an area that can become a special room.
:''room'': The area of the room. This includes the walls.
:''class'': ''Optional.'' A string used to denote which room generators can be used on this room. If omitted, the class used is "closed".
----
;{{moddef|desc|add_rooms|dot}}
Finds all the areas that can be rooms on a map and adds them to the appropriate meta-map tables.
----
;{{moddef|desc|get_room|dot|Room|integer|min_size|integer|max_x|integer|max_y|integer|max_area|string|class}}
Selects a room given certain criteria.
:''min_size'': The smallest X and Y dimensions the room can be.
:''max_x'': The maximum width of the room.
:''max_y'': The maximum height of the room.
:''max_area'': The largest area the room can be.
:''class'': ''Optional.'' The string denoting which room classes are valid for this room generator. If omitted, "any" is used, which does not restrict the selection of rooms.
----
;{{moddef|desc|get_endpoints|dot|integer, integer|Coord|where|boolean|horiz|CellSet|what}}
Finds the ends of a line of cells.
:''where'': The starting coordinate.
:''horiz'': ''True'' checks horizontally. ''False'' checks vertically.
:''what'': The cell(s) that make up the line to check. The functions stops at the first cell '''not''' in this list.
:'''Returns''': Two integers. If ''horiz'' is ''True'', these are the X positions the line stops at. If ''horiz'' is ''False'', these are the Y positions the line stops at.
----
;{{moddef|desc|handle_rooms|dot||integer|count|boolean|no_monsters}}
Runs the rooms selection and setup process for a map.
:''count'': The number of rooms to attempt to place.
:''no_monsters'': ''True'' will exclude room generators that place monsters. ''False'' will not.
----
=== Generation Algorithm Functions ===
;{{moddef|desc|run_drunkard_walk|dot||Area|where|Coord|start|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|where}}
Runs an algorithm that walks to random adjacent spaces.
:''where'': The area that the algorithm will run in. If the algorithm tries to leave the area, it will stop early or will be pushed back in the area (''stop_at_edge'' will determine which of these happen).
:''start'': The location the algorithm will begin at.
:''steps'': The number of steps the algorithm will take. The number of spaces covered by the algorithm will be at most this number.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
----
;{{moddef|desc|drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|[ignore]|boolean|[stop_at_edge]|Area|[where]}}
Runs multiple "drunken walk" algorithms.
:''amount'': The number of times to perform the algorithm.
:''steps'': The number of steps each run of the algorithm will take. The number of spaces covered by the algorithm will be at most the ''amount'' times the number of ''steps''.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
:''where'': ''Optional.'' The area the algorithm will run in. If the algorithm tries to leave the area, it will stop early or will be pushed back in the area (''stop_at_edge'' will determine which of these happen). If omitted, the default is entire area minus the very edge.
----
;{{moddef|desc|contd_drunkard_walks|dot||integer|amount|integer|steps|CellID|fill|CellSet|edges1|CellSet|edges2|CellSet|[ignore]|boolean|[stop_at_edge]}}
Runs multiple "drunken walk" algorithms starting at a space that doesn't have certain cells around it.
:''amount'': The number of times to perform the algorithm.
:''steps'': The number of steps each run of the algorithm will take. The number of spaces covered by the algorithm will be at most the ''amount'' times the number of ''steps''.
:''fill'': The cell that will be placed at each location the algorithm hits.
:''edges1'': The algorithm will not start on a space with a cell listed here next to it.
:''edges2'': The algorithm will not start on a space with a cell listed here next to it.
:''ignore'': ''Optional.'' If specified, the algorithm will not place the ''fill'' cell in any location that has one of the cell(s) specified. If omitted, no locations are ignored.
:''stop_at_edge'': ''Optional.'' If ''True'', the algorithm will end early if it moves past the end of the area. If ''False'', the algorithm will clamp to the area (any moves to outside the area get moved back in the area). If omitted, the default is to clamp.
----
;{{moddef|desc|warehouse_fill|dot||CellID|fill|Area|where|integer|[size]|integer|[count]|integer|[special_chance]|CellID|[special]}}
Fills an area with random squares of cells.
:''fill'': The cell(s) to use for each square. If a list is given, one is chosen at random for each square.
:''where'': The area to fill.
:''size'': ''Optional.'' The size of the squares to use. If omitted, the default is 2.
:''count'': ''Optional.'' The number of attempts. If omitted, the default is 50.
:''special_chance'': ''Optional.'' A number indicating the probability of using a special list of cells to fill the square with instead of the ''fill'' list. The roll used for the chance is based on the ''size'' parameter. A number from 1 to (100 * ''size'') is chosen for each square and if the roll is less than the special_chance number, the ''special'' cell set is used to fill the square instead. If omitted, all squares will be filled from the ''fill'' set.
:''special'': ''Optional.'' The list of cells to use if the special set is to be used, based on ''special_chance''. If omitted, all squares will be filled from the ''fill'' set.
----
;{{moddef|desc|place_blob|dot||Coord|start|integer|size|CellID|cell}}
Fills an area by expanding to random edge coordinates.
:''start'': The position to start the blob at.
:''size'': The number of spaces to expand the blob to.
:''cell'': The cell to fill the blob area with.
----
=== Generator Helper Functions ===
;{{moddef|desc|roll_pair|dot|<value>, <value>|Table|list}}
Takes a list of values of any type and returns two different values randomly from the list.
:''list'': The list to choose from.
:'''Returns''': Two different values. If the list only contains one choice, it will be returned, but only once.
----
;{{moddef|desc|being_weight|dot}}
Gets the total danger level for the current dungeon level.
'''Returns''': The danger level for the current dungeon level. This value is calcuated using the current difficulty and ''level.danger_level''.
----
;{{moddef|desc|item_amount|dot}}
Gets the number of items to drop for the current dungeon level.
'''Returns''': The number of items to drop for the current dungeon level.
----
;{{moddef|desc|horiz_river|dot||CellID|cell|integer|width|boolean|[bridge]}}
Places a horizontal river on the map.
:''cell'': The cell to use for the river. It does not have to be a fluid cell.
:''width'': The width of the river.
:''bridge'': ''Optional.'' If ''True'', a 2 space wide bridge will be placed at a random coordinate on the river. If ''False'', no bridge will be placed. If omitted, the default is to not place a bridge.
----
;{{moddef|desc|vert_river|dot||CellID|cell|integer|width|boolean|bridge|integer|[position]}}
;{{moddef|desc|vert_river|dot||CellID|cell|integer|width|boolean|bridge|Coord|[position]}}
Places a vertical river on the map.
:''cell'': The cell to use for the river. It does not have to be a fluid cell.
:''width'': The width of the river.
:''bridge'': ''Optional.'' If ''True'', a 2 space wide bridge will be placed at a random coordinate on the river. If ''False'', no bridge will be placed. If omitted, the default is to not place a bridge.
:: NOTE: Because of a bug, a bridge will always be placed on the river, even if this value is set to ''False'' or omitted.
:''position'': A coordinate or an integer. If an integer is supplied, this is the X position of the river's left edge. If a coordinate is supplied, the river will start at this coordinate. If omitted, the river's left edge will be selected from between X = 19 to 58.
----
;{{moddef|desc|generate_rivers|dot||boolean|allow_horiz|boolean|allow_more}}
Creates rivers based on normal DoomRL 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.
:''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.
----
;{{moddef|desc|generate_stairs|dot}}
Creates the normal staircase based on normal DoomRL 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.
----
;{{moddef|desc|place_player|dot}}
Places the player on a random empty space.
----
;{{moddef|desc|run|dot||Generator|gen}}
Runs a generator object. These are stored in the generators table.
:''gen'': The generator object to run.
----
;{{moddef|desc|reset|dot}}
Resets the map.
----
=== Dungeon Generation Functions ===
;{{moddef|desc|generate_tiled|dot}}
Creates a tiled dungeon, also known as a "normal" dungeon. This only creates the layout, it does not place beings, items, stairs, barrels, or the player.
----
;{{moddef|desc|maze_dungeon|dot||CellID|floor|CellID|wall|integer|granularity|integer|tries|integer|min_size|integer|max_size}}
Creates a maze dungeon. This only creates the layout, it does not place beings, items, stairs, barrels, or the player.
:''floor'': The cell to use for the floor of the maze.
:''wall'': The cell to use for the wall of the maze.
:''granularity'': This denotes the size of the maze's paths.
:''tries'': Number of attempts to place a new wall in the maze.
:''min_size'': The smallest possible size of a wall.
:''max_size'': The largest possible size of a wall.
----
;{{moddef|desc|generate_caves_dungeon|dot}}
Runs the generation script for the cave dungeon. This is an all inclusive function, it also places all beings and items.
----
;{{moddef|desc|generate_caves_2_dungeon|dot}}
Runs the generation script for the cave-city dungeon. This is an all inclusive function, it also places all beings and items.
----
;{{moddef|desc|generate_lava_dungeon|dot}}
Runs the generation script for the lava dungeon. This is an all inclusive function, it also places all beings and items.
----
=== Event Handler Functions ===
;{{moddef|desc|roll_event|dot}}
Picks an event from the events table and sets it up.
----
;{{moddef|desc|setup_flood_event|dot||integer|direction|integer|step|CellID|cell}}
Runs the setup script for the flood event.
:''direction'': Use 1 to flood from the left. Use -1 to flood from the right.
:''step'': Number of turns (0.1 second intervals) between each flood step.
:''cell'': The cell to flood with. This does not have to be a fluid cell.
----
;{{moddef|desc|setup_deadly_air_event|dot||integer|step}}
Runs the setup script for the deadly air event.
:''step'': Number of turns between each "chill" (loss of HP).
----
;{{moddef|desc|setup_explosion_event|dot||integer|step|integer|size|integer|dice|integer|[content]}}
;{{moddef|desc|setup_explosion_event|dot||integer|step|Table|size|integer|dice|integer|[content]}}
Runs the setup script for the explosion event.
:''step'': Number of turns between each explosion.
:''size'': Either a number or a table of two numbers. Indicates the size of each explosion. If a table is supplied, the size is randomly chosen between the range supplied each time an explosion is created.
:''dice'': Number of d6 dice to use for the damage roll.
:''content'': ''Optional.'' The content to place in any space where the damage to a space is more than 20 points. If omitted, nothing will placed.
----
;{{moddef|desc|setup_targeted_event|dot||integer|step}}
Runs the setup script for the targeting event.
:''step'': Number of turns between each monster teleport.
----

Template:Table2Col

2013-04-25T19:06:15Z

Shark20061: Extending the tempate.

|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{1|}}}
|style="{{{c2|}}}"|{{{2|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{3|}}}
|style="{{{c2|}}}"|{{{4|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{5|}}}
|style="{{{c2|}}}"|{{{6|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{7|}}}
|style="{{{c2|}}}"|{{{8|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{9|}}}
|style="{{{c2|}}}"|{{{10|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{11|}}}
|style="{{{c2|}}}"|{{{12|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{13|}}}
|style="{{{c2|}}}"|{{{14|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{15|}}}
|style="{{{c2|}}}"|{{{16|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{17|}}}
|style="{{{c2|}}}"|{{{18|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{19|}}}
|style="{{{c2|}}}"|{{{20|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{21|}}}
|style="{{{c2|}}}"|{{{22|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{23|}}}
|style="{{{c2|}}}"|{{{24|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{25|}}}
|style="{{{c2|}}}"|{{{26|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{27|}}}
|style="{{{c2|}}}"|{{{28|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{29|}}}
|style="{{{c2|}}}"|{{{30|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{31|}}}
|style="{{{c2|}}}"|{{{32|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{33|}}}
|style="{{{c2|}}}"|{{{34|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{35|}}}
|style="{{{c2|}}}"|{{{36|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{37|}}}
|style="{{{c2|}}}"|{{{38|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{39|}}}
|style="{{{c2|}}}"|{{{40|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{41|}}}
|style="{{{c2|}}}"|{{{42|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{43|}}}
|style="{{{c2|}}}"|{{{44|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{45|}}}
|style="{{{c2|}}}"|{{{46|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{47|}}}
|style="{{{c2|}}}"|{{{48|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{49|}}}
|style="{{{c2|}}}"|{{{50|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{51|}}}
|style="{{{c2|}}}"|{{{52|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{53|}}}
|style="{{{c2|}}}"|{{{54|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{55|}}}
|style="{{{c2|}}}"|{{{56|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{57|}}}
|style="{{{c2|}}}"|{{{58|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{59|}}}
|style="{{{c2|}}}"|{{{60|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{61|}}}
|style="{{{c2|}}}"|{{{62|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{63|}}}
|style="{{{c2|}}}"|{{{64|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{65|}}}
|style="{{{c2|}}}"|{{{66|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{67|}}}
|style="{{{c2|}}}"|{{{68|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{69|}}}
|style="{{{c2|}}}"|{{{70|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{71|}}}
|style="{{{c2|}}}"|{{{72|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{73|}}}
|style="{{{c2|}}}"|{{{74|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{75|}}}
|style="{{{c2|}}}"|{{{76|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{77|}}}
|style="{{{c2|}}}"|{{{78|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{79|}}}
|style="{{{c2|}}}"|{{{80|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{81|}}}
|style="{{{c2|}}}"|{{{82|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{83|}}}
|style="{{{c2|}}}"|{{{84|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{85|}}}
|style="{{{c2|}}}"|{{{86|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{87|}}}
|style="{{{c2|}}}"|{{{88|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{89|}}}
|style="{{{c2|}}}"|{{{90|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{91|}}}
|style="{{{c2|}}}"|{{{92|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{93|}}}
|style="{{{c2|}}}"|{{{94|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{95|}}}
|style="{{{c2|}}}"|{{{96|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{97|}}}
|style="{{{c2|}}}"|{{{98|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{99|}}}
|style="{{{c2|}}}"|{{{100|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{101|}}}
|style="{{{c2|}}}"|{{{102|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{103|}}}
|style="{{{c2|}}}"|{{{104|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{105|}}}
|style="{{{c2|}}}"|{{{106|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{107|}}}
|style="{{{c2|}}}"|{{{108|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{109|}}}
|style="{{{c2|}}}"|{{{110|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{111|}}}
|style="{{{c2|}}}"|{{{112|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{113|}}}
|style="{{{c2|}}}"|{{{114|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{115|}}}
|style="{{{c2|}}}"|{{{116|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{117|}}}
|style="{{{c2|}}}"|{{{118|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{119|}}}
|style="{{{c2|}}}"|{{{120|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{121|}}}
|style="{{{c2|}}}"|{{{122|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{123|}}}
|style="{{{c2|}}}"|{{{124|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{125|}}}
|style="{{{c2|}}}"|{{{126|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{127|}}}
|style="{{{c2|}}}"|{{{128|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{129|}}}
|style="{{{c2|}}}"|{{{130|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{131|}}}
|style="{{{c2|}}}"|{{{132|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{133|}}}
|style="{{{c2|}}}"|{{{134|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{135|}}}
|style="{{{c2|}}}"|{{{136|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{137|}}}
|style="{{{c2|}}}"|{{{138|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{139|}}}
|style="{{{c2|}}}"|{{{140|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{141|}}}
|style="{{{c2|}}}"|{{{142|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{143|}}}
|style="{{{c2|}}}"|{{{144|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{145|}}}
|style="{{{c2|}}}"|{{{146|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{147|}}}
|style="{{{c2|}}}"|{{{148|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{149|}}}
|style="{{{c2|}}}"|{{{150|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{151|}}}
|style="{{{c2|}}}"|{{{152|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{153|}}}
|style="{{{c2|}}}"|{{{154|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{155|}}}
|style="{{{c2|}}}"|{{{156|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{157|}}}
|style="{{{c2|}}}"|{{{158|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{159|}}}
|style="{{{c2|}}}"|{{{160|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{161|}}}
|style="{{{c2|}}}"|{{{162|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{163|}}}
|style="{{{c2|}}}"|{{{164|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{165|}}}
|style="{{{c2|}}}"|{{{166|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{167|}}}
|style="{{{c2|}}}"|{{{168|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{169|}}}
|style="{{{c2|}}}"|{{{170|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{171|}}}
|style="{{{c2|}}}"|{{{172|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{173|}}}
|style="{{{c2|}}}"|{{{174|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{175|}}}
|style="{{{c2|}}}"|{{{176|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{177|}}}
|style="{{{c2|}}}"|{{{178|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{179|}}}
|style="{{{c2|}}}"|{{{180|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{181|}}}
|style="{{{c2|}}}"|{{{182|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{183|}}}
|style="{{{c2|}}}"|{{{184|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{185|}}}
|style="{{{c2|}}}"|{{{186|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{187|}}}
|style="{{{c2|}}}"|{{{188|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{189|}}}
|style="{{{c2|}}}"|{{{190|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{191|}}}
|style="{{{c2|}}}"|{{{192|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{193|}}}
|style="{{{c2|}}}"|{{{194|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{195|}}}
|style="{{{c2|}}}"|{{{196|}}}
|-style="{{{os|}}}"
|style="{{{c1|}}}"|{{{197|}}}
|style="{{{c2|}}}"|{{{198|}}}
|-style="{{{es|}}}"
|style="{{{c1|}}}"|{{{199|}}}
|style="{{{c2|}}}"|{{{200|}}}

Modding:generator API

2013-04-22T07:23:17Z

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

Modding:generator API

2013-04-21T02:37:55Z

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

Modding:generator API

2013-04-20T23:44:05Z

Shark20061: Adding more functions. Still under construction.

Modding:generator API

2013-04-20T20:38:00Z

Shark20061: Created page with "''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 help..."

Elite former sergeant

2013-04-17T05:18:11Z

Shark20061: Fixing HP amount

{{infostrat switch}}
{{Monsters|
monster_name=Elite former sergeant|
monster_looks=h|
monster_hp=25|
monster_ac=2 (+1 from equipped [[green armor]], total 3)|
monster_acc=+0 melee, +0 ranged|
monster_melee=1d3+1 = 2-4 = 3 avg|
monster_projectile=Attacks with an {{exotic link|assault shotgun}}: 7d3 = 7-21 = 14 avg
OR

Attacks with a {{exotic link|plasma shotgun}}: 7d3 = 7-21 = 14 avg

OR

Attacks with a {{exotic link|super shotgun}}: (8d4)x2 = 16-64 = 40 avg|
monster_speed=100%|
monster_dlvl=60-90|
monster_xp=320|
monster_inventory=Assault Shotgun/Super Shotgun: [[shotgun shell]] (x60), [[green armor]] (equipped)

Plasma Shotgun: [[power cell]] (x60), [[green armor]] (equipped)|
monster_pickup=Yes|
monster_doors=Yes|
monster_atkchance=75|
monster_abilities=N/A|
monster_description=''These are the elite among the former sergeants. And they carry firepower to boot! Too bad their weapons are set to self-destruct on death.''|
monster_other=15% bullet and shrapnel resist from green armor.
Weapon is picked randomly for each elite former sergeant.

Elite formers never drop their weapon.}}

Assemblies

2013-04-13T06:39:25Z

Shark20061: /* Advanced */ "Energy pistol" is the name displayed in game

Assemblies are the finished product of combining standard [[Weapons]]/[[Armor]] or [[Specials|Special]] equipment with a particular set of [[Items#Modification Packs|mod packs]]. Some assemblies can only be made with a particular piece of equipment, while others can take a variety of different weapons, armors, or boots. There are three types of assemblies: [[#basic|Basic]], [[#advanced|Advanced]] and [[#master|Master]].

You may choose not to assemble when prompted. If you do so, you will instead have a normal modified piece of equipment that can be modified further (if your [[Traits#Whizkid|Whizkid]] level allows it). The latter is particularly useful to remember if you're trying to figure out basic assembly combinations or when trying to assemble a higher rank assembly the recipe for which partially matches a lower rank assembly recipe (for example, the power armor and the nanofiber skin armor).

Assemblies can also be modded in limited circumstances. If the player has the second level of Whizkid before the assembly is finished, they may then add a single mod to that assembled item.

The schematics are listed in the order in which they appear on the in-game assembly screen, listing their name, base equipment and the required mods.

Mod types in the tables below are:
{| class="wikitable" cellpadding="2"
|-
! scope="col" width="75" align="left"| Mod type
! scope="col" width="50" align="left"| Shorthand
|-
| scope="row" | [[power mod pack|Power]] || P
|-
| scope="row" | [[agility mod pack|Agility]] || A
|-
| scope="row" | [[bulk mod pack|Bulk]] || B
|-
| scope="row" | [[technical mod pack|Technical]] || T
|-
| scope="row" | [[firestorm weapon pack|Firestorm]] || F
|-
| scope="row" | [[sniper weapon pack|Sniper]] || S
|-
| scope="row" | [[Onyx Armor Pack|Onyx]] || O
|-
| scope="row" | [[Nano Pack|Nano]] || N
|}

== Basic ==
'''Basic''' assemblies require two mod packs and can be built at any point in the game. Current list of basic assemblies:
{| class="wikitable" cellpadding="2"
! scope="col" width="200" align="left"| Assembly
! scope="col" width="175" align="left"| Base
! scope="col" width="100" align="left"| Mods
|-
| '''{{assembly link|chainsword}}''' || [[combat knife]] || '''PB'''
|-
| '''{{assembly link|piercing blade}}''' || any melee weapon || '''AP'''
|-
| '''{{assembly link|speedloader pistol}}''' || [[pistol]] || '''AT'''
|-
| '''{{assembly link|elephant gun}}''' || [[shotgun]] || '''PP'''
|-
| '''{{assembly link|gatling gun}}''' || [[chaingun]] || '''BB'''
|-
| '''{{assembly link|micro launcher}}''' || [[rocket launcher]] || '''TT'''
|-
| '''{{assembly link|tactical armor}}''' || [[green armor]] || '''AA'''
|-
| '''{{assembly link|tactical boots}}''' || [[steel boots]] || '''AA'''
|-
| '''{{assembly link|nanofiber armor}}''' || any armor || '''BP'''
|-
| '''{{assembly link|high power weapon}}''' || any non-shotgun, clip > 5 || '''PB'''
|-
| '''{{assembly link|power armor}}''' || any common armor || '''PN'''
|-
| '''{{assembly link|tactical shotgun}}''' || [[combat shotgun]] || '''PT'''
|-
| '''{{assembly link|tower shield}}''' || [[red armor]] || '''PO'''
|-
| '''{{assembly link|fireproof armor}}''' || any armor || '''BT'''
|-
| '''{{assembly link|fireproof boots}}''' || any boots || '''BT'''
|-
| '''{{assembly link|ballistic armor}}''' || any armor || '''AT'''
|-
| '''{{assembly link|plasmatic shrapnel}}''' || any shotgun || '''PS'''
|-
| '''{{assembly link|grappling boots}}''' || any boots || '''TT'''
|-
| '''{{assembly link|lava boots}}''' || any boots || '''TO'''
|}

== Advanced ==
'''Advanced''' assemblies require three mod packs and require the first level of [[Traits#Whizkid|Whizkid]] to be built. Current list of advanced assemblies:
{| class="wikitable" cellpadding="2"
! scope="col" width="200" align="left"| Assembly
! scope="col" width="175" align="left"| Base
! scope="col" width="100" align="left"| Mods
|-
| '''{{assembly link|double chainsaw}}''' || [[chainsaw]] || '''PPB'''
|-
| '''{{assembly link|tactical rocket launcher}}''' || [[rocket launcher]] || '''BBB'''
|-
| '''{{assembly link|storm bolter pistol}}''' || any pistol || '''TBB'''
|-
| '''{{assembly link|assault rifle}}''' || any rapid fire weapon || '''AAA'''
|-
| '''{{assembly link|energy pistol}}''' || any pistol || '''PPT'''
|-
| '''{{assembly link|burst cannon}}''' || any rapid fire weapon || '''PBB'''
|-
| '''{{assembly link|VBFG9000}}''' || any [[BFG 9000]] || '''PPP'''
|-
| '''{{assembly link|enviromental boots}}''' || any boots || '''PBT'''
|-
| '''{{assembly link|fireshield}}''' || [[red armor]] || '''BTO'''
|-
| '''{{assembly link|nanofiber skin armor}}''' || any armor || '''PPN'''
|-
| '''{{assembly link|antigrav boots}}''' || any boots || '''AAN'''
|-
| '''{{assembly link|nano-shrapnel}}''' || any shotgun || '''PPN'''
|-
| '''{{assembly link|hyperblaster}}''' || [[plasma rifle]] || '''ATT'''
|-
| '''{{assembly link|focused double shotgun}}''' || [[double shotgun]] || '''PAT'''
|}

== Master ==
'''Master''' assemblies require four mod packs and require both levels of [[Traits#Whizkid|Whizkid]] to be built. Current list of master assemblies:
{| class="wikitable" cellpadding="2"
! scope="col" width="200" align="left"| Assembly
! scope="col" width="175" align="left"| Base
! scope="col" width="100" align="left"| Mods
|-
| '''{{assembly link|nanomanufacture ammo}}''' || any ranged non-shotgun, non-BFG || '''BBBN'''
|-
| '''{{assembly link|demolition ammo}}''' || any 10mm-based weapon || '''PTTF'''
|-
| '''{{assembly link|cybernano armor}}''' || any armor || '''PPON'''
|-
| '''{{assembly link|biggest fucking gun}}''' || any [[BFG 9000]] || '''BBFF'''
|-
| '''{{assembly link|ripper}}''' || [[chainsaw]] || '''TPPB'''
|-
| '''{{assembly link|cerberus boots}}''' || any boots || '''PPTA'''
|-
| '''{{assembly link|cerberus armor}}''' || any armor || '''PPTA'''
|}

Energy pistol

2013-04-12T17:38:33Z

Shark20061: Name of the assembly in game is "energy pistol" and should link to the assembly information. I feel pages for specific assembled weapons are unnecessary. Please discuss if you feel differently.

{{infostrat switch}}
{{ranged weapon|
weapon_name=Energy pistol|
weapon_dmg=Original + 1 Sides per die|
weapon_avgdmg=Varies|
weapon_dmgtype=[[Damage type#Plasma|Plasma]]|
weapon_accuracy=Original|
weapon_ftime=Original|
weapon_rtime=Original|
weapon_clip=Original|
weapon_ammo=[[Power cell]]|
weapon_afire=Original|
weapon_areload=Original|
weapon_get=[[Assemblies|Assembly]]: any pistol + PPT|
weapon_quote=N/A|
weapon_looks=}|
weapon_description=Assembly (same as original)|
weapon_other=N/A|
weapon_source=Classic SF weapon}}

Energy gun

2013-04-12T17:37:13Z

Shark20061: Making this page a redirect but keeping the original content in a comment.

#REDIRECT [[Energy_pistol]]

Assemblies

2013-04-12T17:29:53Z

Shark20061: /* Advanced */ "Storm bolter pistol" is the name in the game.

Assemblies are the finished product of combining standard [[Weapons]]/[[Armor]] or [[Specials|Special]] equipment with a particular set of [[Items#Modification Packs|mod packs]]. Some assemblies can only be made with a particular piece of equipment, while others can take a variety of different weapons, armors, or boots. There are three types of assemblies: [[#basic|Basic]], [[#advanced|Advanced]] and [[#master|Master]].

You may choose not to assemble when prompted. If you do so, you will instead have a normal modified piece of equipment that can be modified further (if your [[Traits#Whizkid|Whizkid]] level allows it). The latter is particularly useful to remember if you're trying to figure out basic assembly combinations or when trying to assemble a higher rank assembly the recipe for which partially matches a lower rank assembly recipe (for example, the power armor and the nanofiber skin armor).

Assemblies can also be modded in limited circumstances. If the player has the second level of Whizkid before the assembly is finished, they may then add a single mod to that assembled item.

The schematics are listed in the order in which they appear on the in-game assembly screen, listing their name, base equipment and the required mods.

Mod types in the tables below are:
{| class="wikitable" cellpadding="2"
|-
! scope="col" width="75" align="left"| Mod type
! scope="col" width="50" align="left"| Shorthand
|-
| scope="row" | [[power mod pack|Power]] || P
|-
| scope="row" | [[agility mod pack|Agility]] || A
|-
| scope="row" | [[bulk mod pack|Bulk]] || B
|-
| scope="row" | [[technical mod pack|Technical]] || T
|-
| scope="row" | [[firestorm weapon pack|Firestorm]] || F
|-
| scope="row" | [[sniper weapon pack|Sniper]] || S
|-
| scope="row" | [[Onyx Armor Pack|Onyx]] || O
|-
| scope="row" | [[Nano Pack|Nano]] || N
|}

== Basic ==
'''Basic''' assemblies require two mod packs and can be built at any point in the game. Current list of basic assemblies:
{| class="wikitable" cellpadding="2"
! scope="col" width="200" align="left"| Assembly
! scope="col" width="175" align="left"| Base
! scope="col" width="100" align="left"| Mods
|-
| '''{{assembly link|chainsword}}''' || [[combat knife]] || '''PB'''
|-
| '''{{assembly link|piercing blade}}''' || any melee weapon || '''AP'''
|-
| '''{{assembly link|speedloader pistol}}''' || [[pistol]] || '''AT'''
|-
| '''{{assembly link|elephant gun}}''' || [[shotgun]] || '''PP'''
|-
| '''{{assembly link|gatling gun}}''' || [[chaingun]] || '''BB'''
|-
| '''{{assembly link|micro launcher}}''' || [[rocket launcher]] || '''TT'''
|-
| '''{{assembly link|tactical armor}}''' || [[green armor]] || '''AA'''
|-
| '''{{assembly link|tactical boots}}''' || [[steel boots]] || '''AA'''
|-
| '''{{assembly link|nanofiber armor}}''' || any armor || '''BP'''
|-
| '''{{assembly link|high power weapon}}''' || any non-shotgun, clip > 5 || '''PB'''
|-
| '''{{assembly link|power armor}}''' || any common armor || '''PN'''
|-
| '''{{assembly link|tactical shotgun}}''' || [[combat shotgun]] || '''PT'''
|-
| '''{{assembly link|tower shield}}''' || [[red armor]] || '''PO'''
|-
| '''{{assembly link|fireproof armor}}''' || any armor || '''BT'''
|-
| '''{{assembly link|fireproof boots}}''' || any boots || '''BT'''
|-
| '''{{assembly link|ballistic armor}}''' || any armor || '''AT'''
|-
| '''{{assembly link|plasmatic shrapnel}}''' || any shotgun || '''PS'''
|-
| '''{{assembly link|grappling boots}}''' || any boots || '''TT'''
|-
| '''{{assembly link|lava boots}}''' || any boots || '''TO'''
|}

== Advanced ==
'''Advanced''' assemblies require three mod packs and require the first level of [[Traits#Whizkid|Whizkid]] to be built. Current list of advanced assemblies:
{| class="wikitable" cellpadding="2"
! scope="col" width="200" align="left"| Assembly
! scope="col" width="175" align="left"| Base
! scope="col" width="100" align="left"| Mods
|-
| '''{{assembly link|double chainsaw}}''' || [[chainsaw]] || '''PPB'''
|-
| '''{{assembly link|tactical rocket launcher}}''' || [[rocket launcher]] || '''BBB'''
|-
| '''{{assembly link|storm bolter pistol}}''' || any pistol || '''TBB'''
|-
| '''{{assembly link|assault rifle}}''' || any rapid fire weapon || '''AAA'''
|-
| '''{{assembly link|energy gun}}''' || any pistol || '''PPT'''
|-
| '''{{assembly link|burst cannon}}''' || any rapid fire weapon || '''PBB'''
|-
| '''{{assembly link|VBFG9000}}''' || any [[BFG 9000]] || '''PPP'''
|-
| '''{{assembly link|enviromental boots}}''' || any boots || '''PBT'''
|-
| '''{{assembly link|fireshield}}''' || [[red armor]] || '''BTO'''
|-
| '''{{assembly link|nanofiber skin armor}}''' || any armor || '''PPN'''
|-
| '''{{assembly link|antigrav boots}}''' || any boots || '''AAN'''
|-
| '''{{assembly link|nano-shrapnel}}''' || any shotgun || '''PPN'''
|-
| '''{{assembly link|hyperblaster}}''' || [[plasma rifle]] || '''ATT'''
|-
| '''{{assembly link|focused double shotgun}}''' || [[double shotgun]] || '''PAT'''
|}

== Master ==
'''Master''' assemblies require four mod packs and require both levels of [[Traits#Whizkid|Whizkid]] to be built. Current list of master assemblies:
{| class="wikitable" cellpadding="2"
! scope="col" width="200" align="left"| Assembly
! scope="col" width="175" align="left"| Base
! scope="col" width="100" align="left"| Mods
|-
| '''{{assembly link|nanomanufacture ammo}}''' || any ranged non-shotgun, non-BFG || '''BBBN'''
|-
| '''{{assembly link|demolition ammo}}''' || any 10mm-based weapon || '''PTTF'''
|-
| '''{{assembly link|cybernano armor}}''' || any armor || '''PPON'''
|-
| '''{{assembly link|biggest fucking gun}}''' || any [[BFG 9000]] || '''BBFF'''
|-
| '''{{assembly link|ripper}}''' || [[chainsaw]] || '''TPPB'''
|-
| '''{{assembly link|cerberus boots}}''' || any boots || '''PPTA'''
|-
| '''{{assembly link|cerberus armor}}''' || any armor || '''PPTA'''
|}

Storm bolter

2013-04-12T17:22:31Z

Shark20061: Making this page a redirect but keeping the original content in a comment.

#REDIRECT [[Storm_bolter_pistol]]

Storm bolter pistol

2013-04-12T17:17:40Z

Shark20061: Name of the assembly in game is "storm bolter pistol" and should link to the assembly information. I feel pages for specific assembled weapons are unnecessary. Please discuss if you feel differently.

{{infostrat switch}}
{{ranged weapon|
weapon_name=Storm bolter pistol|
weapon_dmg=1d(Original Sides * Original Dice)x2|
weapon_avgdmg=Varies|
weapon_dmgtype=Original|
weapon_accuracy=Original-2|
weapon_ftime=Original*0.85|
weapon_rtime=Original|
weapon_clip=Original*1.5|
weapon_ammo=Original|
weapon_afire=Original|
weapon_areload=Original|
weapon_get=[[Assemblies|Assembly]]: any pistol + TBB|
weapon_quote=N/A|
weapon_looks=}|
weapon_description=Assembly (same as original)|
weapon_other=Storm bolters cannot receive additional mods, even with WK2.|
weapon_source=[http://warhammer40k.wikia.com/wiki/Bolter#Storm_Bolter Warhammer 40,000]}}

Medals

2013-04-08T05:58:41Z

Shark20061: Updating prohibited challenges for medals in 0997 (they haven't been updated in a while!)

{{infostrat switch}}
Medals are extra trophies that players receive at the end of a game. Most require you to win, although some are granted for other special achievements. Gaining medals is necessary for the [[Badges|Heroic badge series]], though little else. However, some are extremely difficult and can be considered especially reputable all by themselves.

There are two types of medals:
*'''Standard medals''' are displayed on the medals screen (albeit grayed out until you get one) so that you know what they are and how to get them.
*'''Secret medals''' are completely invisible until you actually gain them at some point. They are not necessarily harder than the other medals, but some of them are very, very hard to find.

==Standard medals==

{|
! scope="col" width="175" align="left" | Rank
! scope="col" align="left" cell-padding="2ex"| Requirements
! scope="col" align="left" cell-padding="2ex"| Prohibited Challenges
|-style="background:#333"
|Cyberdemon's Head
|Killing the Cyberdemon w/o taking damage
|N/A
|-
|Mastermind's Brain
|Killing the Mastermind w/o taking damage
|N/A
|-style="background:#333"
|Medal of Prejudice
|Awarded for a perfect kill-rate
|N/A
|-
|UAC Star (bronze cluster)
|25 kills without taking damage
|N/A
|-style="background:#333"
|UAC Star (silver cluster)
|50 kills without taking damage
|N/A
|-
|UAC Star (gold cluster)
|100 kills without taking damage
|N/A
|-style="background:#333"
|Minor Icarus Cross
|Finished the game in less than 40,000 turns
|Angel of Confidence, Angel of Overconfidence
|-
|Major Icarus Cross
|Finished the game in less than 20,000 turns
|Angel of Haste
|-style="background:#333"
|Gambler's Shield
|Pulled more than 25 levers in one game
|Angel of 100, Archangel of 666
|-
|Aurora Medallion
|Finding more than 3 uniques in one game
|Angel of 100
|-style="background:#333"
|Explorer Badge
|Visited all generated levels
|Angel of Confidence, Angel of Overconfidence, Angel of 100, Archangel of 666
|-
|Conqueror Badge
|Completed all [[Levels#Special Levels|generated levels]]
|Angel of Haste, Angel of 100
|-style="background:#333"
|Compet-n Silver Cross
|Finished the game in under thirty minutes
|Angel of Confidence, Angel of Overconfidence
|-
|Compet-n Gold Cross
|Finished the game in under twenty minutes
|Angel of Haste
|-style="background:#333"
|Compet-n Platinum Cross
|Finished the game in under ten minutes
|Angel of Confidence, Angel of Overconfidence
|-
|Untouchable Badge
|Won taking less than 500 damage
|Angel of Haste
|-style="background:#333"
|Experience Medal
|Reach experience level 20
|Angel of Pacifism, Archangel of Pacifism
|-
|Experience Cross
|Reach experience level 25
|Angel of Pacifism, Archangel of Pacifism
|}

==Secret medals==

{|
! scope="col" width="175" align="left" | Rank
! scope="col" align="left" cell-padding="2ex"| Requirements
! scope="col" align="left" cell-padding="2ex"| Prohibited Challenges
|-style="background:#333"
|Gutts' Heart
|Awarded for killing Mastermind with the [[Dragonslayer]]
|N/A
|-
|Grammaton Cleric Cross
|Mastermind shot with the [[Grammaton Cleric Beretta|Cleric Beretta]]
|N/A
|-style="background:#333"
|Apostle Insignia
|Awarded for killing the Apostle(????)
|N/A
|-
|Malicious Knives Cross
|Won and killed everything with [[Combat knife|knives]] and fists
|Angel of Pacifism
|-style="background:#333"
|Sunrise Iron Fist
|Winning the game killing everything only with [[Fists|your bare hands]]
|Angel of Pacifism, Archangel of Pacifism
|-
|Thomas's Medal
|Win [[Game_Settings#Challenges|AoHumanity]] as a [[Medals#Conqueror Badge|Conqueror]]
|N/A
|-style="background:#333"
|Fallout Gold Cross
|[[Thermonuclear bomb|Nuked]] at least three levels in one game
|Angel of Red Alert, Angel of 100, Archangel of 666
|-
|Fallout Platinum Cross
|[[Thermonuclear bomb|Nuked]] at least six levels in one game
|Angel of Red Alert, Angel of 100, Archangel of 666
|-style="background:#333"
|Iron Skull
|Take 10,000 damage in a single game
|Angel of 100, Archangel of 666
|-
|Untouchable Medal
|Won taking less than 200 damage
|Angel of Haste
|-style="background:#333"
|Untouchable Cross
|Won taking less than 50 damage
|Angel of Confidence, Angel of Overconfidence
|-
|Gargulec Medal
|Win [[Game_Settings#Challenges|AoB]] with 100% kills
|N/A
|-style="background:#333"
|Gargulec Cross
|Win [[Game_Settings#Challenges|AoB]] with 100% kills on UV
|N/A
|-
|Dervis' Medallion
|Winning [[Game_Settings#Challenges|Ao100]] on Nightmare!
|N/A
|-style="background:#333"
|Every Soldier's Medal
|Clear [[The Wall|the Wall]] on [[Game_Settings#Challenges|AoHumanity]]
|N/A
|-
|Grim Reaper's Badge
|Awarded for clearing the [[The Mortuary|Mortuary]]/[[Limbo]]
|N/A
|-style="background:#333"
|Angelic Badge
|Clearing the Mortuary/Limbo w/o taking damage
|N/A
|-
|Chessmaster's Token
|Complete arena on AoMs or AoI on UV
|N/A
|-style="background:#333"
|Chessmaster's Cross
|Complete arena on AoMs or AoI on N!
|N/A
|-
|Hell Champion Medal
|Awarded for completing [[Hell's Arena|hell arena]]
|N/A
|-style="background:#333"
|Hell Arena Key
|Awarded for completing [[Hell's Arena|hell arena]] w/o damage
|N/A
|-
|Hell Arena Pwnage Medal
|Awarded for completing [[Hell's Arena|hell arena]] on N! w/o damage
|N/A
|-style="background:#333"
|Spider Killer's Cross
|Clear the [[Spider's Lair]] on [[Game_Settings#Challenges|AoHumanity]]
|N/A
|-
|Hell Armorer Badge
|Awarded for clearing [[Hell's Armory]]/[[Deimos Lab]]
|N/A
|-style="background:#333"
|Shambler's Head
|Awarded for clearing Hell's Armory/Deimos Lab w/o damage
|N/A
|}

Halls of Carnage

2013-04-02T00:36:21Z

Shark20061: Updating for 0997

{{infostrat switch}}
{{Special level|
level_name=Halls of Carnage|
level_dlvl=14|
level_intxt=''You feel the sudden need to run!''|
level_loottxt=''None''|
level_outtxt=''None''|
level_itytd=[[former human]] (x9), [[former sergeant]] (x10), [[lost soul]] (x8), [[demon]] (x12), [[cacodemon]] (x4)
Lava Flood Rate: ~1 column / 8 [[time|seconds]]|
level_hntr=[[former human]] (x10), [[former sergeant]] (x12), [[lost soul]] (x10), [[demon]] (x8), [[cacodemon]] (x4), [[hell knight]] (x4)
Lava Flood Rate: ~1 column / 6 [[time|seconds]]|
level_hmp=[[former human]] (x11), [[former sergeant]] (x13), [[lost soul]] (x12), [[demon]] (x8), [[hell knight]] (x4), [[baron of hell]] (x4)
Lava Flood Rate: ~1 column / 5 [[time|seconds]]|
level_uv=[[former human]] (x12), [[former sergeant]] (x16), [[lost soul]] (x14), [[hell knight]] (x8), [[baron of hell]] (x8)
Lava Flood Rate: ~1 column / 3 [[time|seconds]]|
level_n=[[former human]] (x13), [[former sergeant]], [[lost soul]] (x16), [[nightmare demon]] (x8), [[nightmare cacodemon]] (x4), [[baron of hell]] (x4)
Lava Flood Rate: ~1 column / 2 [[time|seconds]]|
level_loot=[[combat shotgun]], {{exotic link|BFG 9000}}, [[Large Health Globe]] (x2), [[10mm ammo]] (24x8), standard [[mods]] (x2)|
level_other=Lava will start flooding the level from the left. Its speed is generally faster than the [[level feeling]] version, and is much faster on higher difficulties. There are many locked doors between the starting room and the stairs - attack them with any weapon to knock them down.
Paired with [[Spider's Lair]].}}

{{map|
map={{:Halls of Carnage/Map}}|
map_description=(This map was created based on 0.9.9.6. This will be updated sometime.)

This map shows the Ultra-violence monsters.

On Hurt Me Plenty, cacodemons are replaced by lost souls.

On Hey, Not Too Rough, cacodemons are replaced by lost souls, hell knights are replaced by cacodemons and barons of hell are replaced by hell knights.

On I'm Too Young To Die, cacodemons are replaced by lost souls, hell knights are replaced by demons and barons of hell are replaced by cacodemons.}}

Hell knight

2013-04-01T18:39:24Z

Shark20061: Turns out Knights have 110% speed!

{{infostrat switch}}
{{Monsters|
monster_name=Hell knight|
monster_looks=B|
monster_hp=50|
monster_ac=1|
monster_acc=+6 melee, +6 ranged|
monster_melee=1d3+6 = 7-9 = 8 avg|
monster_projectile=2d6 = 2-12 = 7 avg: [[damage type#plasma|plasma damage]], [[explosions|radius]] 1|
monster_speed=110%|
monster_dlvl=9-15|
monster_xp=128|
monster_inventory=None|
monster_pickup=Yes|
monster_doors=Yes|
monster_atkchance=40|
monster_abilities=Has 50% acid [[resistance]].|
monster_description=''These are hell's warlords. They command hellish armies to battle. Not as tough as Barons but still a pain in the ass...''|
monster_other=N/A}}

Abyssal Plains

2013-04-01T17:02:23Z

Shark20061: Adding all the level data I could figure out.

{{infostrat switch}}
{{Special level|
level_name=Abyssal Plains|
level_dlvl=12|
level_intxt=''Well isn't this... just... dandy.''|
level_loottxt=|
level_outtxt=|
level_itytd=[[imp]] (x17), [[lost soul]] (x11), [[cacodemon]] (x5), [[pain elemental]], [[Agony elemental]]|
level_hntr=[[imp]] (x8), [[lost soul]] (x13), [[cacodemon]] (x8), [[hell knight]] (x6), [[pain elemental]], [[Agony elemental]]|
level_hmp=[[lost soul]] (x17), [[cacodemon]] (x3), [[hell knight]] (x14), [[arachnotron]] (x5), [[pain elemental]] (x4), [[Agony elemental]]|
level_uv= [[lost soul]] (x15), [[cacodemon]] (x3), [[hell knight]] (x14), [[arachnotron]] (x5), [[pain elemental]] (x6), [[Agony elemental]]|
level_n=[[nightmare imp]] (x8), [[lost soul]] (x7), [[cacodemon]] (x3), [[hell knight]] (x6), [[arachnotron]] (x5), [[pain elemental]] (x14), [[Agony elemental]]|
level_loot=[[Small Health Globe]] (x4), [[large med-pack]], [[shotgun shell]] (8x3), [[10mm ammo]] (24x3), [[ammochain]], [[shell box]], [[rocket box]], [[shotgun]], [[chaingun]], {{exotic link|missile launcher}}, [[Supercharge Globe]]
The agony elemental drops three random [[Items#Consumables|skulls]] upon death.|
level_other=Entering the center room will cause walls to pop up on either side of you, trapping you in with the [[agony elemental]]. The walls will vanish after 40 [[time|seconds]]. This level is paired with [[City of Skulls]].}}

Containment Area

2013-04-01T07:21:54Z

Shark20061: Adding all the level data I could figure out.

{{infostrat switch}}
{{Special level|
level_name=Containment Area|
level_dlvl=11|
level_intxt=|
level_loottxt=|
level_outtxt=|
level_itytd=[[imp]] (x11), [[demon]] (x4)
Trap: [[hell knight]] (x9)|
level_hntr=[[imp]] (x13), [[demon]] (x4)
Trap: [[hell knight]] (x6), [[baron of hell]] (x4)|
level_hmp=[[imp]] (x15), [[demon]] (x4)
Trap: [[hell knight]] (x3), [[baron of hell]] (x8)|
level_uv=[[imp]] (x17), [[demon]] (x4)
Trap: [[baron of hell]] (x12), [[arch-vile]]|
level_n=[[imp]] (x19), [[demon]] (x4)
Trap: [[baron of hell]] (x13), [[arch-vile]] (x2)|
level_loot=[[ammochain]], {{exotic link|missile launcher}}, [[Backpack]], [[rocket box]]
Ammo crates (x8), Armor crates (x8)|
level_other=Getting too close to the backpack will spawn in powerful enemies behind you. However, nothing happens if you grab the missile launcher, located in one of the small southern rooms.
Paired with [[The Wall]].}}

Deimos Lab

2013-04-01T06:43:05Z

Shark20061: Adding all the level data I could figure out.

{{infostrat switch}}
{{Special level|
level_name=Deimos Lab|
level_dlvl=9 (Does not appear on ITYTD)|
level_intxt=|
level_loottxt=|
level_outtxt=|
level_itytd=N/A|
level_hntr=[[former human]] (x8), [[former sergeant]] (x4), [[former captain]] (x2), [[lost soul]] (x14), [[arachnotron]] (x4), [[Shambler]] (x2)|
level_hmp=[[former sergeant]] (x12), [[former captain]] (x2), [[lost soul]] (x16), [[arachnotron]] (x4), [[Shambler]] (x2)|
level_uv=[[former captain]] (x10), [[former commando]] (x4), [[cacodemon]] (x10), [[revenant]] (x4), [[Shambler]] (x2)|
level_n=[[former captain]] (x10), [[former commando]] (x4), [[cacodemon]] (x11), [[revenant]] (x4), [[Shambler]] (x2)|
level_loot= [[green armor]], [[blue armor]], [[Supercharge Globe]] (x2), standard [[mods]] (x2), [[ammochain]], [[shell box]], random weapons (x3)
Ammo crates (x16), Armor crates (x16)

Lab cache rewards are similar to [[Hell's Armory]], except there are 3 mods rewarded in addition to the premium item instead of 2.|
level_other=Pulling the levers in the centre will unleash two [[Shambler]]s.
Paired with [[Hell's Armory]].}}

Military Base

2013-03-31T05:25:53Z

Shark20061: Adding all the level data I could figure out.

{{infostrat switch}}
{{Special level|
level_name=Military Base|
level_dlvl=7|
level_intxt=''Seeing this place again takes you back!''|
level_loottxt=None|
level_outtxt=|
level_itytd=[[former human]] (x24), [[former sergeant]] (x17), [[former captain]] (x11), [[former commando]] (x2)|
level_hntr=[[former human]] (x24), [[former sergeant]] (x17), [[former captain]] (x6), [[elite former human]] (x5), [[elite former sergeant]] (x2)|
level_hmp=[[former human]] (x24), [[former sergeant]] (x12), [[former captain]] (x6), [[elite former human]] (x5), [[elite former sergeant]] (x5), [[elite former captain]] (x2)|
level_uv=[[former human]] (x17), [[former sergeant]] (x12), [[former captain]] (x6), [[elite former human]] (x7), [[elite former sergeant]] (x5), [[elite former captain]] (x5), [[elite former commando]] (x2)|
level_n=[[former human]] (x17), [[former sergeant]] (x12), [[former captain]] (x6), [[elite former human]] (x7), [[elite former sergeant]] (x5), [[elite former commando]] (x7)|
level_loot=[[envirosuit pack]], [[combat shotgun]], [[Large Health Globe]] (x3), [[Tracking Map]], standard [[mods]] (x2).
Ammo crates (x28), Armor crates (x28)

The breakable crates may contain all sorts of cool stuff, up to and including [[blue armor]], [[ammochain]]s, [[shell box]]es and med-packs, both [[large med-pack|large]] and [[small med-pack|small]].|
level_other=The pink and yellow crates can be broken with any weapon, although a pistol may take a few shots.
Paired with [[Phobos Lab]].}}

Phobos Lab

2013-03-31T03:28:16Z

Shark20061: Adding all the level data I could figure out.

{{infostrat switch}}
{{Special level|
level_name=Phobos Lab|
level_dlvl=7|
level_intxt=''You arrive at the Phobos Lab. You are overcome by the feeling of nostalgia!''|
level_loottxt=''This lab won't do any more experiments... I wonder if there are others?''|
level_outtxt=''So much for the lab, next time I'll use neurotoxin...''|
level_itytd=[[former human]] (x10), [[former sergeant]] (x5), [[demon]] (x12)|
level_hntr=[[former human]] (x14), [[former sergeant]] (x5), [[demon]] (x12)|
level_hmp=[[former human]] (x14), [[former sergeant]] (x13), [[imp]] (x6), [[demon]] (x25)|
level_uv= [[former human]] (x14), [[former sergeant]] (x13), [[imp]] (x7), [[demon]] (x13), [[Nightmare demon]] (x12) |
level_n=[[former human]] (x14), [[former sergeant]] (x13), [[imp]] (x7), [[Nightmare demon]] (x25)|
level_loot=[[blue armor]], [[combat shotgun]], [[small med-pack]] (x4), [[large med-pack]] (x2), [[Large Health Globe]] (x3), [[envirosuit pack]] (x2), [[10mm ammo]] (24x9), [[shotgun shell]] (8x9), random standard [[mods]] (x2)|
level_other=This level is paired with the [[Military Base]]. There is a random chance that you will roll this floor instead of The Military Base on Level 7.}}

Game Settings

2013-03-26T02:26:43Z

Shark20061: /* Angel Game Challenges */ Updating difficulty ratings.

{{infostrat switch}}
==Difficulty==
Game difficulty roughly emulates that of the original game. There are five to select from:
* '''I'm Too Young to Die (ITYTD)''': The easiest difficulty, in many ways. Ammo is doubled, enemy spawns are at their lowest, healing and powerup durations are doubled. A good way to start playing the game, although you won't have access to every [[Levels#Special levels|special level]] available nor play any challenges.
* '''Hey, Not Too Rough (HNTR)''': The "standard" difficulty for many players. Given that all multipliers are set to one, challenges are allowed, and all special levels are now available, this is an appropriate moniker.
* '''Hurt Me Plenty (HMP)''': The first "difficult" difficulty. More numerous and accurate enemies appear at earlier floors, giving you less time to prepare for the late stages of the game.
* '''Ultra-violence (UV)''': The difficulty of DoomRL veterans. This is the point where even the first few floors of the game can kill you reliably if you don't know the inns and outs of the game. It is unlocked at the Lance Corporal [[Ranks#Skill Ranks|skill rank]].
* '''Nightmare! (N!)''': The exclamation point does not lie, this difficulty is for hardcore players only. In addition to Ultra-violence changes, enemies can respawn at any time, are faster (relative to you), and attack more often. You can't save, either! At least several of the ITYTD benefits are back to help. It is unlocked at the Sergeant skill rank.

The differences in game difficulty may seem subtle, but switching to a harder difficulty is easily the most frustrating part of playing DoomRL, [[Badges#Diamond badges|diamond badges]] aside. Difficulty information has been tabulated: the columns are identified as follows:

* '''Shorthand''': How the difficulty is expressed on the score page (and in mortem tags on the forums)
* '''Score Multiplier''': How much your score is increased by, just by playing on that difficulty level
* '''Ammo Multiplier''': For randomly generated ammo, how much extra is added to each stack
* '''Enemy Accuracy''': How much the enemies' accuracy is changed on this difficulty
* '''Enemy Spawns''': How many enemies spawn on randomly generated levels, and how much their depth level is modified
* '''Healing/Powerups''': The duration/strength of powerups, and the health gain of small healing items
* '''XP Multipler''': How much increased experience is gained for killing enemies
* '''Special''': Any extra features regarding the difficulty level

{| style="rules: cols; border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=11 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Difficulty Levels'''
|-
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 0" width=100|'''Difficulty'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Shorthand'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Score Multiplier'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Ammo Multiplier'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Enemy Accuracy'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Enemy Spawns'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Healing/ Powerups'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''XP Multiplier'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 0 1px 1px"|'''Special'''
|- style="background: #333;"
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 1px 1px 0 0"|I'm Too Young To Die
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|E
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|0.5
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|2
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|-1
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|Low/+0
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|Doubled
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|1.4
|style="text-align: center; border: solid darkred; border-width: 1px 0px 0 1px"|Acid/lava deals half damage, some special levels barred, no challenges
|-
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Hey, Not Too Rough
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|M
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+0
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal/+0
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.2
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|N/A
|- style="background: #333;"
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Hurt Me Plenty
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|H
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.5
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.25
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+1
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|High/-3
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|N/A
|-
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Ultra-violence
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|U
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.5
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Very High/-6
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|N/A
|- style="background: #333;"
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Nightmare!
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|N!
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|4
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|WTF/-6
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Doubled
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.2
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|Respawning, player speed decreased by 10%, +50% enemy attack chance, no saving
|}

==Challenges==
This section lists the different challenges and how they affect gameplay.

'''Note:''' The standard items (that is, what you get in a standard game) is as follows: [[pistol]] (equipped), [[10mm ammo]] (x24), [[small med-pack]] (x2).

===Angel Game Challenges===
{| class="wikitable" cellpadding="2"
|-
! scope="col" width="150" align="left" | Challenge
! scope="col" align="left" cell-padding="2ex"| Difficulty
! scope="col" align="left" cell-padding="2ex"| Unlocked at
! scope="col" align="left" cell-padding="2ex"| Description
! scope="col" align="left" cell-padding="2ex"| Starting Items
|-style="background: #333;"
|'''Angel of Berserk''' (AoB)
|Medium
|Private FC
|Only melee weapons can be used to attack. Large Healing Globes additionally grant 20 turns of [[effects#berserk|berserk]].
|[[Large med-pack]] (x2), [[blue armor]]
|-
|'''Angel of Marksmanship''' (AoMr)
|Medium
|Private FC
|Only [[pistol|pistols]] and [[fists]] can be used to attack.
|Standard + 1 [[Items#Modification Packs (Mods)|random standard mod]] (except power mod) + 1 technical mod
|-style="background: #333;"
|'''Angel of Shotgunnery''' (AoSh)
|Easy
|Lance Corporal
|Only shotguns (weapons with a spread projectile) and fists can be used to attack.
|[[Shotgun]], [[shotgun shell]] (x50)
|-
|'''Angel of Light Travel''' (AoLT)
|Hard
|Lance Corporal
|Your inventory is limited to 5 items (excluding equipment slots); player speed is increased by 20%.
|Standard + [[10mm ammo chain]] + [[shell box]]
|-style="background: #333;"
|'''Angel of Impatience''' (AoI)
|Hard
|Corporal
|All [[Items#Consumables|consumable]] items are immediately used upon pickup.
|Standard - [[small med-pack]] (x2)
|-
|'''Angel of Confidence''' (AoCn)
|Very Hard
|Sergeant
|You start on Deimos floor 1 instead of Phobos floor 1 (thus skipping the first 8 levels)
|Pistol (equipped), shotgun, [[chaingun]], [[combat knife]], 10mm ammo (x100), shotgun shell (x50), large med-pack (x2)
|-style="background: #333;"
|'''Angel of Purity''' (AoP)
|Blade
|Sergeant
|All [[Items#Powerups|powerup]] effects are disabled.
|Standard
|-
|'''Angel of Red Alert''' (AoRA)
|Medium
|Sergeant
|A five-minute [[thermonuclear bomb|nuke]] is armed at the start of every level, whether random or special.
|Standard
|-style="background: #333;"
|'''Angel of Darkness''' (AoD)
|Very Hard
|Sergeant
|Your vision radius is only 6 and anything outside of this radius is black, except for what maps reveal as well as [[Intuition]]. Scouts and maps do not know the location of stairs. Experience gain is doubled.
|Standard
|-
|'''Angel of Max Carnage''' (AoMC)
|Easy
|Sergeant Major
|All attacks from all source deal maximum damage, and accuracy of yourself and all enemies is increased by 12.
|Standard
|-style="background: #333;"
|'''Angel of Masochism''' (AoMs)
|Blade
|Sergeant Major
|All healing effects (including [[tactics]] restoration) are disabled, save [[Traits#Vampyre|Vampyre]] You are [[Supercharge Globe|supercharged]] at every level-up.
|Standard, no medpacks, 100 ammo instead of 40.
|-
|'''Angel of 100''' (A100)
|Hard
|Sergeant Major
|All special levels are removed: the player must instead descend 100 floors to win.
|Standard
|-style="background: #333;"
|'''Angel of Pacifism''' (AoPc)
|Easy
|Sergeant Major
|All weapon attacks are disabled. [[Phobos Base Entry]] is removed (for balance purposes). Every third staircase you descend makes you level-up.
|[[Thermonuclear bomb]], large med-pack (x4), blue armor (equipped)
|-
|'''Angel of Humanity''' (AoHu)
|Blade
|Warrant Officer
|Your max HP starts at 10. [[Traits#Ironman|Ironman]] increases your max HP by two per rank.
|Standard + large med-pack (x2), [[red armor]] (equipped), one of each standard mod
|-style="background: #333;"
|'''Angel of Overconfidence''' (AoOC)
|Very Hard
|Sergeant
|You start on Hell floor 1 instead of Phobos floor 1 (thus skipping the first 16 levels)
|[[Combat pistol]] (equipped), [[assault shotgun]], [[minigun]], combat knife, large med-pack (x2), 10mm ammo chain, shell box
|}

===Dual-Angel Game Challenges===

Lets you select a pair of challenges to run simultaneously.

{| class="wikitable" cellpadding="2"
|-
! scope="col" align="left" cell-padding="2ex" | Primary Challenge
! scope="col" align="left" cell-padding="2ex" | Eligible Secondary Challenges
|-
|'''Angel of Berserk'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-style="background:#333"
|'''Angel of Marksmanship'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-
|'''Angel of Shotgunnery'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-style="background:#333"
|'''Angel of Impatience'''
|AoCn, AoOC, A100, AoLT, AoRA, AoD
|-
|'''Angel of Purity'''
|AoCn, AoOC, A100, AoLT, AoRA, AoD
|-style="background:#333"
|'''Angel of Darkness'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoMs
|-
|'''Angel of Max Carnage'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-style="background:#333"
|'''Angel of Pacifism'''
|AoCn, AoOC, A100, AoI, AoP, AoD, AoMs
|-
|'''Angel of Humanity'''
|AoCn, AoOC, A100, AoI, AoP, AoRA, AoD, AoMs
|}

===Archangel Game Challenges===

Extremely difficult challenges, each one is a harder version of an Angel Game Challenge.

{| class="wikitable" cellpadding="2"
|-
! scope="col" width="150" align="left" | Challenge
! scope="col" align="left" cell-padding="2ex"| Difficulty
! scope="col" align="left" cell-padding="2ex"| Unlocked at
! scope="col" align="left" cell-padding="2ex"| Description
! scope="col" align="left" cell-padding="2ex"| Starting Items
|-
|'''Archangel of Travel'''
|Blade
|Sergeant
|Your inventory is limited to 2 items (excluding equipment slots); player speed is increased by 30%.
|[[Pistol]] (equipped) + [[10mm ammo chain]]
|-style="background: #333;"
|'''Archangel of Red Alert'''
|Blade
|Sergeant
|A two-and-a-half-minute [[thermonuclear bomb|nuke]] is armed at the start of every level, whether random or special.
|Standard
|-
|'''Archangel of Masochism'''
|Blade
|Sergeant Major
|All healing effects (including [[tactics]] restoration) are disabled, save [[Traits#Vampyre|Vampyre]].
|Standard, no medpacks, 100 ammo instead of 40.
|-style="background: #333;"
|'''Archangel of 666'''
|Blade
|Sergeant Major
|All special levels are removed: the player must instead descend 666 floors to win.
|Standard
|-
|'''Archangel of Pacifism'''
|Blade
|Sergeant Major
|All weapon attacks are disabled. [[Phobos Base Entry]] is removed (for balance purposes).
|[[Thermonuclear bomb]], large med-pack (x4), blue armor (equipped)
|-style="background: #333;"
|'''Archangel of Humanity'''
|TwoDev
|Warrant Officer
|Your maximum HP starts at 10. [[Traits#Ironman|Ironman]] increases your max HP by two per rank. You don't get any benefit from leveling up.
|Standard + large med-pack (x2), [[red armor]] (equipped), one of each standard mod
|}

Game Settings

2013-03-25T15:14:54Z

Shark20061: /* Angel Game Challenges */ Added Abbreviations

{{infostrat switch}}
==Difficulty==
Game difficulty roughly emulates that of the original game. There are five to select from:
* '''I'm Too Young to Die (ITYTD)''': The easiest difficulty, in many ways. Ammo is doubled, enemy spawns are at their lowest, healing and powerup durations are doubled. A good way to start playing the game, although you won't have access to every [[Levels#Special levels|special level]] available nor play any challenges.
* '''Hey, Not Too Rough (HNTR)''': The "standard" difficulty for many players. Given that all multipliers are set to one, challenges are allowed, and all special levels are now available, this is an appropriate moniker.
* '''Hurt Me Plenty (HMP)''': The first "difficult" difficulty. More numerous and accurate enemies appear at earlier floors, giving you less time to prepare for the late stages of the game.
* '''Ultra-violence (UV)''': The difficulty of DoomRL veterans. This is the point where even the first few floors of the game can kill you reliably if you don't know the inns and outs of the game. It is unlocked at the Lance Corporal [[Ranks#Skill Ranks|skill rank]].
* '''Nightmare! (N!)''': The exclamation point does not lie, this difficulty is for hardcore players only. In addition to Ultra-violence changes, enemies can respawn at any time, are faster (relative to you), and attack more often. You can't save, either! At least several of the ITYTD benefits are back to help. It is unlocked at the Sergeant skill rank.

The differences in game difficulty may seem subtle, but switching to a harder difficulty is easily the most frustrating part of playing DoomRL, [[Badges#Diamond badges|diamond badges]] aside. Difficulty information has been tabulated: the columns are identified as follows:

* '''Shorthand''': How the difficulty is expressed on the score page (and in mortem tags on the forums)
* '''Score Multiplier''': How much your score is increased by, just by playing on that difficulty level
* '''Ammo Multiplier''': For randomly generated ammo, how much extra is added to each stack
* '''Enemy Accuracy''': How much the enemies' accuracy is changed on this difficulty
* '''Enemy Spawns''': How many enemies spawn on randomly generated levels, and how much their depth level is modified
* '''Healing/Powerups''': The duration/strength of powerups, and the health gain of small healing items
* '''XP Multipler''': How much increased experience is gained for killing enemies
* '''Special''': Any extra features regarding the difficulty level

{| style="rules: cols; border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=11 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Difficulty Levels'''
|-
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 0" width=100|'''Difficulty'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Shorthand'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Score Multiplier'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Ammo Multiplier'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Enemy Accuracy'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Enemy Spawns'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Healing/ Powerups'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''XP Multiplier'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 0 1px 1px"|'''Special'''
|- style="background: #333;"
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 1px 1px 0 0"|I'm Too Young To Die
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|E
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|0.5
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|2
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|-1
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|Low/+0
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|Doubled
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|1.4
|style="text-align: center; border: solid darkred; border-width: 1px 0px 0 1px"|Acid/lava deals half damage, some special levels barred, no challenges
|-
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Hey, Not Too Rough
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|M
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+0
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal/+0
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.2
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|N/A
|- style="background: #333;"
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Hurt Me Plenty
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|H
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.5
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.25
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+1
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|High/-3
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|N/A
|-
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Ultra-violence
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|U
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.5
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Very High/-6
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|N/A
|- style="background: #333;"
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Nightmare!
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|N!
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|4
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|WTF/-6
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Doubled
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.2
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|Respawning, player speed decreased by 10%, +50% enemy attack chance, no saving
|}

==Challenges==
This section lists the different challenges and how they affect gameplay.

'''Note:''' The standard items (that is, what you get in a standard game) is as follows: [[pistol]] (equipped), [[10mm ammo]] (x24), [[small med-pack]] (x2).

===Angel Game Challenges===
{| class="wikitable" cellpadding="2"
|-
! scope="col" width="150" align="left" | Challenge
! scope="col" align="left" cell-padding="2ex"| Difficulty
! scope="col" align="left" cell-padding="2ex"| Unlocked at
! scope="col" align="left" cell-padding="2ex"| Description
! scope="col" align="left" cell-padding="2ex"| Starting Items
|-style="background: #333;"
|'''Angel of Berserk''' (AoB)
|Very Hard
|Private FC
|Only melee weapons can be used to attack. Large Healing Globes additionally grant 20 turns of [[effects#berserk|berserk]].
|[[Large med-pack]] (x2), [[blue armor]]
|-
|'''Angel of Marksmanship''' (AoMr)
|Easy
|Private FC
|Only [[pistol|pistols]] and [[fists]] can be used to attack.
|Standard + 1 [[Items#Modification Packs (Mods)|random standard mod]] (except power mod) + 1 technical mod
|-style="background: #333;"
|'''Angel of Shotgunnery''' (AoSh)
|Medium
|Lance Corporal
|Only shotguns (weapons with a spread projectile) and fists can be used to attack.
|[[Shotgun]], [[shotgun shell]] (x50)
|-
|'''Angel of Light Travel''' (AoLT)
|Easy
|Lance Corporal
|Your inventory is limited to 5 items (excluding equipment slots); player speed is increased by 20%.
|Standard + [[10mm ammo chain]] + [[shell box]]
|-style="background: #333;"
|'''Angel of Impatience''' (AoI)
|Hard
|Corporal
|All [[Items#Consumables|consumable]] items are immediately used upon pickup.
|Standard - [[small med-pack]] (x2)
|-
|'''Angel of Confidence''' (AoCn)
|Hard
|Sergeant
|You start on Deimos floor 1 instead of Phobos floor 1 (thus skipping the first 8 levels)
|Pistol (equipped), shotgun, [[chaingun]], [[combat knife]], 10mm ammo (x100), shotgun shell (x50), large med-pack (x2)
|-style="background: #333;"
|'''Angel of Purity''' (AoP)
|Hard
|Sergeant
|All [[Items#Powerups|powerup]] effects are disabled.
|Standard
|-
|'''Angel of Red Alert''' (AoRA)
|Hard
|Sergeant
|A five-minute [[thermonuclear bomb|nuke]] is armed at the start of every level, whether random or special.
|Standard
|-style="background: #333;"
|'''Angel of Darkness''' (AoD)
|Hard
|Sergeant
|Your vision radius is only 6 and anything outside of this radius is black, except for what maps reveal as well as [[Intuition]]. Scouts and maps do not know the location of stairs. Experience gain is doubled.
|Standard
|-
|'''Angel of Max Carnage''' (AoMC)
|Medium
|Sergeant Major
|All attacks from all source deal maximum damage, and accuracy of yourself and all enemies is increased by 12.
|Standard
|-style="background: #333;"
|'''Angel of Masochism''' (AoMs)
|Very Hard
|Sergeant Major
|All healing effects (including [[tactics]] restoration) are disabled, save [[Traits#Vampyre|Vampyre]] You are [[Supercharge Globe|supercharged]] at every level-up.
|Standard, no medpacks, 100 ammo instead of 40.
|-
|'''Angel of 100''' (A100)
|Blade
|Sergeant Major
|All special levels are removed: the player must instead descend 100 floors to win.
|Standard
|-style="background: #333;"
|'''Angel of Pacifism''' (AoPc)
|Blade
|Sergeant Major
|All weapon attacks are disabled. [[Phobos Base Entry]] is removed (for balance purposes). Every third staircase you descend makes you level-up.
|[[Thermonuclear bomb]], large med-pack (x4), blue armor (equipped)
|-
|'''Angel of Humanity''' (AoHu)
|Blade
|Warrant Officer
|Your max HP starts at 10. [[Traits#Ironman|Ironman]] increases your max HP by two per rank.
|Standard + large med-pack (x2), [[red armor]] (equipped), one of each standard mod
|-style="background: #333;"
|'''Angel of Overconfidence''' (AoOC)
|Hard
|Sergeant
|You start on Hell floor 1 instead of Phobos floor 1 (thus skipping the first 16 levels)
|[[Combat pistol]] (equipped), [[assault shotgun]], [[minigun]], combat knife, large med-pack (x2), 10mm ammo chain, shell box
|}

===Dual-Angel Game Challenges===

Lets you select a pair of challenges to run simultaneously.

{| class="wikitable" cellpadding="2"
|-
! scope="col" align="left" cell-padding="2ex" | Primary Challenge
! scope="col" align="left" cell-padding="2ex" | Eligible Secondary Challenges
|-
|'''Angel of Berserk'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-style="background:#333"
|'''Angel of Marksmanship'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-
|'''Angel of Shotgunnery'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-style="background:#333"
|'''Angel of Impatience'''
|AoCn, AoOC, A100, AoLT, AoRA, AoD
|-
|'''Angel of Purity'''
|AoCn, AoOC, A100, AoLT, AoRA, AoD
|-style="background:#333"
|'''Angel of Darkness'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoMs
|-
|'''Angel of Max Carnage'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-style="background:#333"
|'''Angel of Pacifism'''
|AoCn, AoOC, A100, AoI, AoP, AoD, AoMs
|-
|'''Angel of Humanity'''
|AoCn, AoOC, A100, AoI, AoP, AoRA, AoD, AoMs
|}

===Archangel Game Challenges===

Extremely difficult challenges, each one is a harder version of an Angel Game Challenge.

{| class="wikitable" cellpadding="2"
|-
! scope="col" width="150" align="left" | Challenge
! scope="col" align="left" cell-padding="2ex"| Difficulty
! scope="col" align="left" cell-padding="2ex"| Unlocked at
! scope="col" align="left" cell-padding="2ex"| Description
! scope="col" align="left" cell-padding="2ex"| Starting Items
|-
|'''Archangel of Travel'''
|Blade
|Sergeant
|Your inventory is limited to 2 items (excluding equipment slots); player speed is increased by 30%.
|[[Pistol]] (equipped) + [[10mm ammo chain]]
|-style="background: #333;"
|'''Archangel of Red Alert'''
|Blade
|Sergeant
|A two-and-a-half-minute [[thermonuclear bomb|nuke]] is armed at the start of every level, whether random or special.
|Standard
|-
|'''Archangel of Masochism'''
|Blade
|Sergeant Major
|All healing effects (including [[tactics]] restoration) are disabled, save [[Traits#Vampyre|Vampyre]].
|Standard, no medpacks, 100 ammo instead of 40.
|-style="background: #333;"
|'''Archangel of 666'''
|Blade
|Sergeant Major
|All special levels are removed: the player must instead descend 666 floors to win.
|Standard
|-
|'''Archangel of Pacifism'''
|Blade
|Sergeant Major
|All weapon attacks are disabled. [[Phobos Base Entry]] is removed (for balance purposes).
|[[Thermonuclear bomb]], large med-pack (x4), blue armor (equipped)
|-style="background: #333;"
|'''Archangel of Humanity'''
|TwoDev
|Warrant Officer
|Your maximum HP starts at 10. [[Traits#Ironman|Ironman]] increases your max HP by two per rank. You don't get any benefit from leveling up.
|Standard + large med-pack (x2), [[red armor]] (equipped), one of each standard mod
|}

Game Settings

2013-03-25T15:08:00Z

Shark20061: Added Dual-Angel Combinations

{{infostrat switch}}
==Difficulty==
Game difficulty roughly emulates that of the original game. There are five to select from:
* '''I'm Too Young to Die (ITYTD)''': The easiest difficulty, in many ways. Ammo is doubled, enemy spawns are at their lowest, healing and powerup durations are doubled. A good way to start playing the game, although you won't have access to every [[Levels#Special levels|special level]] available nor play any challenges.
* '''Hey, Not Too Rough (HNTR)''': The "standard" difficulty for many players. Given that all multipliers are set to one, challenges are allowed, and all special levels are now available, this is an appropriate moniker.
* '''Hurt Me Plenty (HMP)''': The first "difficult" difficulty. More numerous and accurate enemies appear at earlier floors, giving you less time to prepare for the late stages of the game.
* '''Ultra-violence (UV)''': The difficulty of DoomRL veterans. This is the point where even the first few floors of the game can kill you reliably if you don't know the inns and outs of the game. It is unlocked at the Lance Corporal [[Ranks#Skill Ranks|skill rank]].
* '''Nightmare! (N!)''': The exclamation point does not lie, this difficulty is for hardcore players only. In addition to Ultra-violence changes, enemies can respawn at any time, are faster (relative to you), and attack more often. You can't save, either! At least several of the ITYTD benefits are back to help. It is unlocked at the Sergeant skill rank.

The differences in game difficulty may seem subtle, but switching to a harder difficulty is easily the most frustrating part of playing DoomRL, [[Badges#Diamond badges|diamond badges]] aside. Difficulty information has been tabulated: the columns are identified as follows:

* '''Shorthand''': How the difficulty is expressed on the score page (and in mortem tags on the forums)
* '''Score Multiplier''': How much your score is increased by, just by playing on that difficulty level
* '''Ammo Multiplier''': For randomly generated ammo, how much extra is added to each stack
* '''Enemy Accuracy''': How much the enemies' accuracy is changed on this difficulty
* '''Enemy Spawns''': How many enemies spawn on randomly generated levels, and how much their depth level is modified
* '''Healing/Powerups''': The duration/strength of powerups, and the health gain of small healing items
* '''XP Multipler''': How much increased experience is gained for killing enemies
* '''Special''': Any extra features regarding the difficulty level

{| style="rules: cols; border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=11 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Difficulty Levels'''
|-
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 0" width=100|'''Difficulty'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Shorthand'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Score Multiplier'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Ammo Multiplier'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Enemy Accuracy'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Enemy Spawns'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''Healing/ Powerups'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 1px 1px 1px" width=50|'''XP Multiplier'''
|style="text-align: center; padding: 1ex; border: solid darkred; border-width: 0 0 1px 1px"|'''Special'''
|- style="background: #333;"
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 1px 1px 0 0"|I'm Too Young To Die
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|E
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|0.5
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|2
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|-1
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|Low/+0
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|Doubled
|style="text-align: center; border: solid darkred; border-width: 1px 1px 0 1px"|1.4
|style="text-align: center; border: solid darkred; border-width: 1px 0px 0 1px"|Acid/lava deals half damage, some special levels barred, no challenges
|-
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Hey, Not Too Rough
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|M
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+0
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal/+0
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.2
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|N/A
|- style="background: #333;"
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Hurt Me Plenty
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|H
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.5
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.25
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+1
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|High/-3
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|N/A
|-
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Ultra-violence
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|U
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.5
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Very High/-6
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Normal
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|N/A
|- style="background: #333;"
|style="text-align: left; padding-right: 1ex; border: solid darkred; border-width: 0 1px 0 0"|Nightmare!
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|N!
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|4
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|+2
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|WTF/-6
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|Doubled
|style="text-align: center; border: solid darkred; border-width: 0 1px 0 1px"|1.2
|style="text-align: center; border: solid darkred; border-width: 0 0px 0 1px"|Respawning, player speed decreased by 10%, +50% enemy attack chance, no saving
|}

==Challenges==
This section lists the different challenges and how they affect gameplay.

'''Note:''' The standard items (that is, what you get in a standard game) is as follows: [[pistol]] (equipped), [[10mm ammo]] (x24), [[small med-pack]] (x2).

===Angel Game Challenges===
{| class="wikitable" cellpadding="2"
|-
! scope="col" width="150" align="left" | Challenge
! scope="col" align="left" cell-padding="2ex"| Difficulty
! scope="col" align="left" cell-padding="2ex"| Unlocked at
! scope="col" align="left" cell-padding="2ex"| Description
! scope="col" align="left" cell-padding="2ex"| Starting Items
|-style="background: #333;"
|'''Angel of Berserk'''
|Very Hard
|Private FC
|Only melee weapons can be used to attack. Large Healing Globes additionally grant 20 turns of [[effects#berserk|berserk]].
|[[Large med-pack]] (x2), [[blue armor]]
|-
|'''Angel of Marksmanship'''
|Easy
|Private FC
|Only [[pistol|pistols]] and [[fists]] can be used to attack.
|Standard + 1 [[Items#Modification Packs (Mods)|random standard mod]] (except power mod) + 1 technical mod
|-style="background: #333;"
|'''Angel of Shotgunnery'''
|Medium
|Lance Corporal
|Only shotguns (weapons with a spread projectile) and fists can be used to attack.
|[[Shotgun]], [[shotgun shell]] (x50)
|-
|'''Angel of Light Travel'''
|Easy
|Lance Corporal
|Your inventory is limited to 5 items (excluding equipment slots); player speed is increased by 20%.
|Standard + [[10mm ammo chain]] + [[shell box]]
|-style="background: #333;"
|'''Angel of Impatience'''
|Hard
|Corporal
|All [[Items#Consumables|consumable]] items are immediately used upon pickup.
|Standard - [[small med-pack]] (x2)
|-
|'''Angel of Confidence'''
|Hard
|Sergeant
|You start on Deimos floor 1 instead of Phobos floor 1 (thus skipping the first 8 levels)
|Pistol (equipped), shotgun, [[chaingun]], [[combat knife]], 10mm ammo (x100), shotgun shell (x50), large med-pack (x2)
|-style="background: #333;"
|'''Angel of Purity'''
|Hard
|Sergeant
|All [[Items#Powerups|powerup]] effects are disabled.
|Standard
|-
|'''Angel of Red Alert'''
|Hard
|Sergeant
|A five-minute [[thermonuclear bomb|nuke]] is armed at the start of every level, whether random or special.
|Standard
|-style="background: #333;"
|'''Angel of Darkness'''
|Hard
|Sergeant
|Your vision radius is only 6 and anything outside of this radius is black, except for what maps reveal as well as [[Intuition]]. Scouts and maps do not know the location of stairs. Experience gain is doubled.
|Standard
|-
|'''Angel of Max Carnage'''
|Medium
|Sergeant Major
|All attacks from all source deal maximum damage, and accuracy of yourself and all enemies is increased by 12.
|Standard
|-style="background: #333;"
|'''Angel of Masochism'''
|Very Hard
|Sergeant Major
|All healing effects (including [[tactics]] restoration) are disabled, save [[Traits#Vampyre|Vampyre]] You are [[Supercharge Globe|supercharged]] at every level-up.
|Standard, no medpacks, 100 ammo instead of 40.
|-
|'''Angel of 100'''
|Blade
|Sergeant Major
|All special levels are removed: the player must instead descend 100 floors to win.
|Standard
|-style="background: #333;"
|'''Angel of Pacifism'''
|Blade
|Sergeant Major
|All weapon attacks are disabled. [[Phobos Base Entry]] is removed (for balance purposes). Every third staircase you descend makes you level-up.
|[[Thermonuclear bomb]], large med-pack (x4), blue armor (equipped)
|-
|'''Angel of Humanity'''
|Blade
|Warrant Officer
|Your max HP starts at 10. [[Traits#Ironman|Ironman]] increases your max HP by two per rank.
|Standard + large med-pack (x2), [[red armor]] (equipped), one of each standard mod
|-style="background: #333;"
|'''Angel of Overconfidence'''
|Hard
|Sergeant
|You start on Hell floor 1 instead of Phobos floor 1 (thus skipping the first 16 levels)
|[[Combat pistol]] (equipped), [[assault shotgun]], [[minigun]], combat knife, large med-pack (x2), 10mm ammo chain, shell box
|}

===Dual-Angel Game Challenges===

Lets you select a pair of challenges to run simultaneously.

{| class="wikitable" cellpadding="2"
|-
! scope="col" align="left" cell-padding="2ex" | Primary Challenge
! scope="col" align="left" cell-padding="2ex" | Eligible Secondary Challenges
|-
|'''Angel of Berserk'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-style="background:#333"
|'''Angel of Marksmanship'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-
|'''Angel of Shotgunnery'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-style="background:#333"
|'''Angel of Impatience'''
|AoCn, AoOC, A100, AoLT, AoRA, AoD
|-
|'''Angel of Purity'''
|AoCn, AoOC, A100, AoLT, AoRA, AoD
|-style="background:#333"
|'''Angel of Darkness'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoMs
|-
|'''Angel of Max Carnage'''
|AoCn, AoOC, A100, AoLT, AoI, AoP, AoRA, AoD, AoMs
|-style="background:#333"
|'''Angel of Pacifism'''
|AoCn, AoOC, A100, AoI, AoP, AoD, AoMs
|-
|'''Angel of Humanity'''
|AoCn, AoOC, A100, AoI, AoP, AoRA, AoD, AoMs
|}

===Archangel Game Challenges===

Extremely difficult challenges, each one is a harder version of an Angel Game Challenge.

{| class="wikitable" cellpadding="2"
|-
! scope="col" width="150" align="left" | Challenge
! scope="col" align="left" cell-padding="2ex"| Difficulty
! scope="col" align="left" cell-padding="2ex"| Unlocked at
! scope="col" align="left" cell-padding="2ex"| Description
! scope="col" align="left" cell-padding="2ex"| Starting Items
|-
|'''Archangel of Travel'''
|Blade
|Sergeant
|Your inventory is limited to 2 items (excluding equipment slots); player speed is increased by 30%.
|[[Pistol]] (equipped) + [[10mm ammo chain]]
|-style="background: #333;"
|'''Archangel of Red Alert'''
|Blade
|Sergeant
|A two-and-a-half-minute [[thermonuclear bomb|nuke]] is armed at the start of every level, whether random or special.
|Standard
|-
|'''Archangel of Masochism'''
|Blade
|Sergeant Major
|All healing effects (including [[tactics]] restoration) are disabled, save [[Traits#Vampyre|Vampyre]].
|Standard, no medpacks, 100 ammo instead of 40.
|-style="background: #333;"
|'''Archangel of 666'''
|Blade
|Sergeant Major
|All special levels are removed: the player must instead descend 666 floors to win.
|Standard
|-
|'''Archangel of Pacifism'''
|Blade
|Sergeant Major
|All weapon attacks are disabled. [[Phobos Base Entry]] is removed (for balance purposes).
|[[Thermonuclear bomb]], large med-pack (x4), blue armor (equipped)
|-style="background: #333;"
|'''Archangel of Humanity'''
|TwoDev
|Warrant Officer
|Your maximum HP starts at 10. [[Traits#Ironman|Ironman]] increases your max HP by two per rank. You don't get any benefit from leveling up.
|Standard + large med-pack (x2), [[red armor]] (equipped), one of each standard mod
|}