View source for Modding:Constants

Constants and Enumerations are common in any game and DoomRL is no exception.  Internally, as most programmers are aware, these are integers.  But to modders they are all important magic values, looked up here.

== Engine Enums ==

==== ItemType ====

Every item has a type that determines how the engine treats it.

{| 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"|'''TItemType'''
|-
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_NONE
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_RANGED
|-
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_NRANGED
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_ARMOR
|-
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_MELEE
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_AMMO
|-
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_PACK
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_POWER
|-
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_BOOTS
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_TELE
|-
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_LEVER
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|ITEMTYPE_AMMOPACK
|}

==== BodyTarget ====

Sources of damage must specify a body target to determine which sources of armor are used. Inherent armor bonuses always apply.

{| 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"|'''TBodyTarget'''
|-
|style="vertical-align:top; padding-right: 2ex;"|TARGET_INTERNAL
|Protection from boots and armor will be ignored.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|TARGET_TORSO
|Protection from armor counts but protection from boots does not.
|-
|style="vertical-align:top; padding-right: 2ex;"|TARGET_FEET
|Protection from boots counts but protection from armor does not.
|}

==== EqSlot ====

It is preferred to use the (equivalent) [[#Equip Slots|slot]] constants.

{| 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"|'''TEqSlot'''
|-
|style="vertical-align:top; padding-right: 2ex;"|EFTORSO
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|EFWEAPON
|-
|style="vertical-align:top; padding-right: 2ex;"|EFBOOTS
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|EFWEAPON2
|}

==== StatusEffect ====

[[Modding:Affects|Affects]] specify one of these status effects that will apply a color scheme to all the tiles on the HUD.

{| 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"|'''TStatusEffect'''
|-
|style="vertical-align:top; padding-right: 2ex;"|STATUSNORMAL
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|STATUSINVERT
|-
|style="vertical-align:top; padding-right: 2ex;"|STATUSRED
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|STATUSGREEN
|}

==== DamageType ====

Sources of damage usually specify a damage type that determines how the damage regards protection, resistances, gibbing, and other things. For details on the differences between the damage types, look [[Damage type|here]].

{| 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"|'''TDamageType'''
|-
|style="vertical-align:top; padding-right: 2ex;"|DAMAGE_BULLET
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|DAMAGE_MELEE
|-
|style="vertical-align:top; padding-right: 2ex;"|DAMAGE_SHARPNEL [sic]
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|DAMAGE_ACID
|-
|style="vertical-align:top; padding-right: 2ex;"|DAMAGE_FIRE
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|DAMAGE_PLASMA
|-
|style="vertical-align:top; padding-right: 2ex;"|DAMAGE_IGNOREARMOR
|}

==== AltFire ====
{| 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"|'''TAltFire'''
|-
|style="vertical-align:top; padding-right: 2ex;"|ALT_NONE
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|ALT_CHAIN
|-
|style="vertical-align:top; padding-right: 2ex;"|ALT_THROW
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|ALT_SCRIPT
|-
|style="vertical-align:top; padding-right: 2ex;"|ALT_AIMED
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|ALT_SINGLE
|-
|style="vertical-align:top; padding-right: 2ex;"|ALT_WHIRLWIND
|}

==== AltReload ====
{| 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"|'''TAltReload'''
|-
|style="vertical-align:top; padding-right: 2ex;"|RELOAD_NONE
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|RELOAD_SCRIPT
|-
|style="vertical-align:top; padding-right: 2ex;"|RELOAD_FULL
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|RELOAD_DUAL
|-
|style="vertical-align:top; padding-right: 2ex;"|RELOAD_SINGLE
|}

==== ExplosionFlag ====
{| style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=3 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''TExplosionFlag'''
|-
|style="vertical-align:top; padding-right: 2ex;"|EFSELFHALF
|Deals half damage to the active being.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|EFSELFKNOCKBACK
|Gives extra knockback to the active being.
|-
|style="vertical-align:top; padding-right: 2ex;"|EFSELFSAFE
|Deals no damage to the active being.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|EFAFTERBLINK
|Blinks the screen after the explosion finishes.
|-
|style="vertical-align:top; padding-right: 2ex;"|EFCHAIN
|Causes secondary explosions (as the [[BFG 9000]]).
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|EFHALFKNOCK
|Causes half the usual knockback.
|-
|style="vertical-align:top; padding-right: 2ex;"|EFNOKNOCK
|Doesn't cause knockback.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|EFRANDOMCONTENT
|Transmutes some cells in the explosion to the explosion's content cell; the rules is to transmute when damage is greater than 20.
|}

====LightFlag====
{| 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"|'''TLightFlag'''
|-
|style="vertical-align:top; padding-right: 2ex;"|LFEXPLORED
|This flag is set for explored cells. It can be modified to create computer map-like effects or Angel of Darkness-like effects.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|LFVISIBLE
|This flag is set for cells in the player's current LOS. This flag is automatically recalculated on every player action. It may be useful to manually modify this flag if LOS needs to be updated more often.
|-
|style="vertical-align:top; padding-right: 2ex;"|LFLIGHTED
|This flag is always set on the same cells as LFVISIBLE; both flags must be set for a cell to be visible.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|LFDAMAGE
|This is a book-keeping flag for shotgun area-of-effect. Cells are set with this flag if they are calculated as in the shotgun blast but haven't yet been processed.
|-
|style="vertical-align:top; padding-right: 2ex;"|LFFRESH
|This is a book-keeping flag for explosions. New corpses are set with this flag to keep them from being immediately destroyed. This flag can be set to make any cell indestructible, but it may be cleared by the engine.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|LFNOSPAWN
|Cells with this flag are counted as non-empty by the EF_NOSPAWN empty flag.
|}

== Constants ==

==== Maximums ====
{| 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"|'''Maximums'''
|-
|style="vertical-align:top; padding-right: 2ex;"|MAXX || 78
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|MAXY || 20
|-
|style="vertical-align:top; padding-right: 2ex;"|BOSS_LEVEL || 25
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|MAXDEPTH || 26
|-
|style="vertical-align:top; padding-right: 2ex;"|MAXAFFECT || 5
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|MAX_INV_SIZE || 22
|-
|style="vertical-align:top; padding-right: 2ex;"|MAX_EQ_SIZE || 4
|}

==== Cellsets ====
{| 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"|'''Cellsets'''
|-
|style="vertical-align:top; padding-right: 2ex;"|CELLSET_WALLS
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|CELLSET_FLOORS
|-
|style="vertical-align:top; padding-right: 2ex;"|CELLSET_CORPSES
|}

==== Challenges ====
{| 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"|'''Challenges'''
|-
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_BERSERK
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_MARKSMANSHIP
|-
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_SHOTGUNNERY
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_LIGHTTRAVEL
|-
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_IMPATIENCE
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_HASTE
|-
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_PURITY
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_REDALERT
|-
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_CARNAGE
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_MASOCHISM
|-
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_100
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_PACIFISM
|-
|style="vertical-align:top; padding-right: 2ex;"|CHALLENGE_HUMANITY
|}

==== Difficulty ====
{| 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"|'''Difficulty'''
|-
|style="vertical-align:top; padding-right: 2ex;"|DIFF_EASY
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|DIFF_MEDIUM
|-
|style="vertical-align:top; padding-right: 2ex;"|DIFF_HARD
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|DIFF_VERYHARD
|-
|style="vertical-align:top; padding-right: 2ex;"|DIFF_NIGHTMARE
|}

==== PlayerRank ====
{| 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"|'''PlayerRank'''
|-
|style="vertical-align:top; padding-right: 2ex;"|RANKEXP
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|RANKSKILL
|}

==== Player Statistics ====
{| 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 Statistics'''
|-
|style="vertical-align:top; padding-right: 2ex;"|RANK_KILLTOTAL
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|RANK_KILLMELEE
|-
|style="vertical-align:top; padding-right: 2ex;"|RANK_KILLPISTOL
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|RANK_LEVEL
|-
|style="vertical-align:top; padding-right: 2ex;"|RANK_BADGE
|}

==== Equip Slots ====
{| 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"|'''Equip Slots'''
|-
|style="vertical-align:top; padding-right: 2ex;"|SLOT_ARMOR
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|SLOT_WEAPON
|-
|style="vertical-align:top; padding-right: 2ex;"|SLOT_BOOTS
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|SLOT_PREPARED
|}

==== Colors ====
Usually, it is possible to specify a foreground color and a background color. Since DoomRL uses 4 bit color, the lowest 4 bits determine the foreground color, and the next 4 bits determine the background color (zero is black). Occasionally, one of these may conflict with one of the special color constants.

Also, note that the exact color the end-user sees may depend on his system settings.

For the basic 16 colors, the valkyrie string coloring escape is noted.

{| style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=4 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Colors'''
|-
|style="vertical-align:top; padding-right: 2ex;"|BLACK
|width="100" style="background: black;"|
|@D
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|BLUE
|width="100" style="background: navy;"|
|@b
|-
|style="vertical-align:top; padding-right: 2ex;"|GREEN
|width="100" style="background: green;"|
|@g
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|CYAN
|width="100" style="background: teal;"|
|@c
|-
|style="vertical-align:top; padding-right: 2ex;"|RED
|width="100" style="background: maroon;"|
|@r
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|MAGENTA
|width="100" style="background: purple;"|
|@v
|-
|style="vertical-align:top; padding-right: 2ex;"|BROWN
|width="100" style="background: olive;"|
|@n or @N
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|LIGHTGRAY
|width="100" style="background: silver;"|
|@l
|-
|style="vertical-align:top; padding-right: 2ex;"|DARKGRAY
|width="100" style="background: gray;"|
|@d
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|LIGHTBLUE
|width="100" style="background: blue;"|
|@B
|-
|style="vertical-align:top; padding-right: 2ex;"|LIGHTGREEN
|width="100" style="background: lime;"|
|@G
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|LIGHTCYAN
|width="100" style="background: aqua;"|
|@C
|-
|style="vertical-align:top; padding-right: 2ex;"|LIGHTRED
|width="100" style="background: red;"|
|@R
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|LIGHTMAGENTA
|width="100" style="background: fuchsia;"|
|@V
|-
|style="vertical-align:top; padding-right: 2ex;"|YELLOW
|width="100" style="background: yellow;"|
|@y or @Y
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|WHITE
|width="100" style="background: white;"|
|@L
|-
|style="vertical-align:top; padding-right: 2ex;"|MULTIBLUE
|
|Randomly chosen from BLUE, LIGHTBLUE, and WHITE. Only works for missiles.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|MULTIYELLOW
|
|Randomly chosen from YELLOW, LIGHTGREEN, and WHITE. Only works for missiles.
|-
|style="vertical-align:top; padding-right: 2ex;"|MULTIPORTAL
|
|Cycles between LIGHTMAGENTA, MAGENTA, and WHITE. Only works for things displayed in the map.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|COLOR_WATER
|
|Alternates between BLUE and LIGHTBLUE. Only works for things displayed in the map.
|-
|style="vertical-align:top; padding-right: 2ex;"|COLOR_ACID
|
|Alternates between GREEN and LIGHTGREEN. Only works for things displayed in the map.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|COLOR_LAVA
|
|Alternates between RED and YELLOW. Only works for things displayed in the map.
|}

== Flags ==

==== Generic Flags ====
{| style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=3 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Generic Flags'''
|-
|style="vertical-align:top; padding-right: 2ex;"|F_OVERLAY
|This flag is related to the graphical version.
|}

==== Empty Flags ====
Empty flags are used with various functions to control the selection of random coords.

{| 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"|'''Empty Flags'''
|-
|style="vertical-align:top; padding-right: 2ex;"|EF_NOITEMS
|Excludes cells that contain an item.
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|EF_NOBEINGS
|Excludes cells that contain a being.
|-
|style="vertical-align:top; padding-right: 2ex;"|EF_NOBLOCK
|Excludes cells that block movement (CF_BLOCKMOVE).
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|EF_NOVISION
|Excludes cells that block vision (CF_BLOCKLOS).
|-
|style="vertical-align:top; padding-right: 2ex;"|EF_NOSTAIRS
|Excludes stairs (cells with an OnExit hook).
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|EF_NOTELE
|Excludes cells with a teleporter (an item with ITEMTYPE_TELE).
|-
|style="vertical-align:top; padding-right: 2ex;"|EF_NOHARM
|Excludes hazardous cells (CF_HAZARD).
|- style="background: #333;"
|style="vertical-align:top; padding-right: 2ex;"|EF_NOSAFE
|Excludes cells that are too near to the player (currently the threshold is less than or equal to distance of 5).
|-
|style="vertical-align:top; padding-right: 2ex;"|EF_NOSPAWN
|Excludes cells with LF_NOSPAWN.
|}