Difference between revisions of "Modding:Constants"

Revision as of 19:29, 23 December 2012 (view source) Yaflhdztioxo (Talk | contribs) (→‎LightFlag) ← Older edit		Revision as of 19:31, 23 December 2012 (view source) Yaflhdztioxo (Talk | contribs) (→‎LightFlag) Newer edit →
Line 169:		Line 169:
	|}		|}
−	====LightFlag====	+	====Level Flag====
		+	{{Template:Level_Flags}}
		+
		+	====Light Flag====
	{{Template:Light_Flags}}		{{Template:Light_Flags}}

---

Revision as of 19:31, 23 December 2012

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.

Contents 1 Engine Enums 1.1 ItemType 1.2 BodyTarget 1.3 EqSlot 1.4 StatusEffect 1.5 DamageType 1.6 AltFire 1.7 AltReload 1.8 ExplosionFlag 1.9 Level Flag 1.10 Light Flag 2 Constants 2.1 Maximums 2.2 Cellsets 2.3 Challenges 2.4 Difficulty 2.5 PlayerRank 2.6 Player Statistics 2.7 Equip Slots 2.8 Colors 3 Flags 3.1 Generic Flags 3.2 Empty Flags

Engine Enums

ItemType

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

TItemType

ITEMTYPE_NONE

ITEMTYPE_RANGED

ITEMTYPE_NRANGED

ITEMTYPE_ARMOR

ITEMTYPE_MELEE

ITEMTYPE_AMMO

ITEMTYPE_PACK

ITEMTYPE_POWER

ITEMTYPE_BOOTS

ITEMTYPE_TELE

ITEMTYPE_LEVER

ITEMTYPE_AMMOPACK

BodyTarget

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

TBodyTarget
TARGET_INTERNAL	Protection from boots and armor will be ignored.
TARGET_TORSO	Protection from armor counts but protection from boots does not.
TARGET_FEET	Protection from boots counts but protection from armor does not.

EqSlot

It is preferred to use the (equivalent) slot constants.

TEqSlot

EFTORSO

EFWEAPON

EFBOOTS

EFWEAPON2

StatusEffect

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

TStatusEffect

STATUSNORMAL

STATUSINVERT

STATUSRED

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

TDamageType

DAMAGE_BULLET

DAMAGE_MELEE

DAMAGE_SHARPNEL [sic]

DAMAGE_ACID

DAMAGE_FIRE

DAMAGE_PLASMA

DAMAGE_IGNOREARMOR

AltFire

TAltFire

ALT_NONE

ALT_CHAIN

ALT_THROW

ALT_SCRIPT

ALT_AIMED

ALT_SINGLE

ALT_WHIRLWIND

AltReload

TAltReload

RELOAD_NONE

RELOAD_SCRIPT

RELOAD_FULL

RELOAD_DUAL

RELOAD_SINGLE

ExplosionFlag

TExplosionFlag
EFSELFHALF	Deals half damage to the active being.
EFSELFKNOCKBACK	Gives extra knockback to the active being.
EFSELFSAFE	Deals no damage to the active being.
EFAFTERBLINK	Blinks the screen after the explosion finishes.
EFCHAIN	Causes secondary explosions (as the BFG 9000).
EFHALFKNOCK	Causes half the usual knockback.
EFNOKNOCK	Doesn't cause knockback.
EFRANDOMCONTENT	Transmutes some cells in the explosion to the explosion's content cell; the rules is to transmute when damage is greater than 20.

Level Flag

Level Flags
LF_NOHOMING	Causes homing phase devices to act like normal phase devices.
LF_UNIQUEITEM	Used by the level generation code to keep track of whether a unique item has dropped on the current level (in order to prevent multiple uniques from dropping on one level). This flag also causes a level feeling to occur indicating that a unique item is present.
LF_BONUS	This flag is automatically set for so-called special levels like Halls of Carnage. (It is not set for those special levels like Hellgate that replace normal levels, only by those reached from red stairs.)
LF_SCRIPT	This flag is automatically set for scripted levels, ie levels defined with the level blueprint.
LF_NORESPAWN	Prevents the Nightmare! respawn feature.
LF_NUKED	This flag is automatically set when the level is nuked.
LF_NONUKE	Causes the thermonuclear bomb to have no effect when it is used. It is not respected by other nuke effects.
LF_ITEMSVISIBLE	Allows the player to see all items on the level (as with a Computer Map).
LF_BEINGSVISIBLE	Allows the player to see all beings on the level (as with a Tracking Map).
LF_RESPAWN	Causes monsters to randomly respawn as when playing the game on Nightmare!
LF_SHARPFLUID	???

Light Flag

Light Flags
LFEXPLORED	This flag is set for explored cells. It can be modified to create computer map-like effects or Angel of Darkness-like effects.
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.
LFLIGHTED	This flag is always set on the same cells as LFVISIBLE; both flags must be set for a cell to be visible.
LFDAMAGE	This is a bookkeeping 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.
LFFRESH	This is a bookkeeping flag for explosions. New corpses are set with this flag to keep them from being immediately destroyed. This flag can also be set to make any cell indestructible, but it may be cleared by the engine.
LFPERMANENT	This flag marks a cell as being indestructible.
LFCORNER	This flag only exists in debug builds of DoomRL. It identifies a cell that is visible but that enemies will not return fire from, ie, corner shooting.
LFBLOOD	This flag marks a cell as being bloody. Bloody cells can only have cosmetic differences.
LFNOSPAWN
LFMARKER1
LFMARKER2

Constants

Maximums

Maximums
MAXX	78
MAXY	20
BOSS_LEVEL	25
MAXDEPTH	26
MAXAFFECT	5
MAX_INV_SIZE	22
MAX_EQ_SIZE	4

Cellsets

Cellsets

CELLSET_WALLS

CELLSET_FLOORS

CELLSET_CORPSES

Challenges

Challenges

CHALLENGE_BERSERK

CHALLENGE_MARKSMANSHIP

CHALLENGE_SHOTGUNNERY

CHALLENGE_LIGHTTRAVEL

CHALLENGE_IMPATIENCE

CHALLENGE_HASTE

CHALLENGE_PURITY

CHALLENGE_REDALERT

CHALLENGE_CARNAGE

CHALLENGE_MASOCHISM

CHALLENGE_100

CHALLENGE_PACIFISM

CHALLENGE_HUMANITY

Difficulty

Difficulty

DIFF_EASY

DIFF_MEDIUM

DIFF_HARD

DIFF_VERYHARD

DIFF_NIGHTMARE

PlayerRank

PlayerRank

RANKEXP

RANKSKILL

Player Statistics

Player Statistics

RANK_KILLTOTAL

RANK_KILLMELEE

RANK_KILLPISTOL

RANK_LEVEL

RANK_BADGE

Equip Slots

Equip Slots

SLOT_ARMOR

SLOT_WEAPON

SLOT_BOOTS

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. See Modding:Color for details.

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.

Colors
Color	ID	Valkyrie ID	Looks Like
BLACK	0	@D
BLUE	1	@b
GREEN	2	@g
CYAN	3	@c
RED	4	@r
MAGENTA	5	@v
BROWN	6	@n or @N
LIGHTGRAY	7	@l
DARKGRAY	8	@d
LIGHTBLUE	9	@B
LIGHTGREEN	10	@G
LIGHTCYAN	11	@C
LIGHTRED	12	@R
LIGHTMAGENTA	13	@V
YELLOW	14	@y or @Y
WHITE	15	@L

Colors
Color	ID	Looks Like						Comments
MULTIBLUE	17							Missile only
MULTIYELLOW	18							Missile only
MULTIPORTAL	20							Map object only
COLOR_WATER	21							Map object only
COLOR_ACID	22							Map object only
COLOR_LAVA	23							Map object only

Flags

Generic Flags

Generic Flags
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.

Empty Flags
EF_NOITEMS	Excludes cells that contain an item.
EF_NOBEINGS	Excludes cells that contain a being.
EF_NOBLOCK	Excludes cells that block movement (CF_BLOCKMOVE).
EF_NOVISION	Excludes cells that block vision (CF_BLOCKLOS).
EF_NOSTAIRS	Excludes stairs (cells with an OnExit hook).
EF_NOTELE	Excludes cells with a teleporter (an item with ITEMTYPE_TELE).
EF_NOHARM	Excludes hazardous cells (CF_HAZARD).
EF_NOSAFE	Excludes cells that are too near to the player (currently the threshold is less than or equal to distance of 5).
EF_NOSPAWN	Excludes cells with LF_NOSPAWN.