EMAPINFO

From Eternity Wiki
(Redirected from MapInfo)
Jump to: navigation, search

The EMAPINFO lump customizes properties of a map. It is the main Eternity lump for this purpose.

Back to Eternity Engine
  • This section incorporates text from the HTML Eternity documentation.

Usage[edit]

Level info data is stored in the global EMAPINFO lump, which is a plain-text lump containing information for all maps together. Variables for each level must be placed under a section header that has the same name as the map's header lump.

Do note that older Eternity and SMMU compatible releases had level info stored inside each map's header lump. This is deprecated however, kept only for backward compatibility.

Syntax[edit]

  • Each map definition begins with a block header. This consists of the map's lump name in brackets, such as [MAP01], [E1M1], or [MYLEVEL].
  • Variables are specified in the lines following the block header.
  • All values are treated as text strings, and quotation marks are not required.
  • Comments may start with '#', ';', or '//'. All three comments are single line only, and extend to the end of the line.
  • An optional equal sign can be placed between a variable and the value it is given. It is not an error to omit it.

EMAPINFO Variables[edit]

Level identification[edit]

Variable Description Example
creator The level author's name, which can be viewed in the console using the "creator" console command. If this value is not provided, the default value is "unknown".
creator = Edwin Chadwick 'chadders'
edf-intername Boolean value which, if true, enables the use of EDF-defined intermission map name strings which will be drawn using the FONTB graphics (provided in eternity.wad for DOOM/DOOM II, and natively supported by Heretic). This feature is meant to obsolete the levelpic variable and to remove the need for authors to create title graphics for their maps in DOOM/DOOM II. It also allows intermission map name replacement to work correctly for the next level and for Heretic without any hacks.

The EDF string which will be used as the intermission name for the current map should have the mnemonic _IN_NAME_<mapname>, where <mapname> is the exact name of the map's header lump (Example: _IN_NAME_MAP01). In order for the name of the next map to display correctly, the current level must either define its nextlevel/nextsecret values explicitly, or it must be an ExMy or MAPxy level.

edf-intername = true
enterpic Name of a 320x200 graphic lump to be displayed as the background of the statistics intermission during the entering of this map's stage. If omitted and previous map's interpic property is set, it will continue displaying that.
enterpic = INTOCAVE
inter-levelname Name of the map to display in the intermission score screen. This is separate from levelname which is for the automap display, and can be used as an alternative to levelpic which is a graphic lump for the intermission name. If both inter-levelname and levelpic are present, levelpic takes precedence. Unlike levelpic, this one also works in Heretic.
inter-levelname = Circle of death
interpic Name of a 320x200 graphic lump to be displayed as the background of the statistics intermission.
interpic = BOSSBACK
killstats Boolean value that allows the statistics intermission between two maps to be disabled. If the map has a finale sequence to be displayed, it will start immediately, otherwise the next map will be loaded.
killstats = true
levelname This is the name of the level which will be displayed in the automap. This value overrides any string provided via DeHackEd. If you want to change the level name displayed in the intermission, change levelpic or inter-levelname.
levelname = chadders' lair
levelnum Integer value used to identify it for the Teleport_NewMap special. When the map's lump name does not follow the format MAPxx or ExMy, a numeric value is required.
[D2DM1]
levelnum = 1
levelpic This is the name of a graphic lump which will be shown as the level name during the statistics intermission when this map is the previous map which was just beaten. This value is only used for DOOM and DOOM II maps. You can also use inter-levelname to set the intermission display level name, which will use the necessary font, already included in Eternity.
levelpic = E1M1PIC
levelpicnext The level pic to show for the next level, only when taking the normal exit. If omitted, it will try that level's levelpic or write the name of it using the font.
levelpicsecret Same as levelpicnext, but for taking the secret exit instead.
nextlevel The exact header name of the next level to go to when a normal exit occurs on this map. This can specify *any* lump name, but the lump should be a valid level header or an error will occur.
nextlevel = CHAD2
nextsecret The exact header name of the next level to go to when a secret exit occurs on this map. This can specify *any* lump name, but the lump should be a valid level header or an error will occur. Note that except for maps which normally have secret exits, the default behavior is to repeat the same level. This MapInfo value allows you to avoid that and use a secret exit on any map.
nextsecret = MAP34
allowexittags If true, allows the exit linedef classic linedef specials to use their tags to specify the number of the level to go to. This doesn't apply to the parameterized specials
allowexittags = true
allowsecrettags Same as allowexittags, but applies to the secret exit classic linedef specials.
allowsecrettags = true
partime Partime for the map in seconds. This value overrides any value provided via DeHackEd. Note that partimes are only supported in episodes 1-3 of DOOM and any map of DOOM II. Ultimate DOOM episode 4, Heretic, and non-standard maps currently never display par times.
partime = 200

Scripting[edit]

Variable Description Example
acsopendelay Boolean value that determines whether or not scripts' execution within the first 35 tics after entering the map is delayed until 35 tics have passed.
acsopendelay = true
acsscript Name of the lump containing the compiled ACS script for this map. Not needed for UDMF, which uses the BEHAVIOR lump between TEXTMAP and ENDMAP, as added by the level editor.
acsscript = SCRIPT01
extradata Name of the ExtraData script lump for this map. See the ExtraData Reference for full information on ExtraData. There are no naming restrictions on ExtraData script lumps. Not needed for UDMF, only for the classic format.
extradata = EXTRDT01
levelscript Name of a compiled (deprecated) Small script lump which will serve as the Levelscript for this map. NOTE: use acsscript for compiled ACS scripts.

Physics[edit]

Variable Description Example
aircontrol How much control the player has when attempting to move while in mid-air. By default Doom and Heretic have it 0 (no control whatsoever) and Hexen and Strife have a tiny value, just enough to allow jumping on objects.

Default value is 0. Keep in mind you can set the comp_aircontrol property in the OPTIONS lump to "yes" or "no", which if enabled, will produce the Hexen effect. Maximum air control is 65536, so anything between 0 and 65536 is equivalent to air control between 0 and 100%.

airfriction This is an optional field, useful if aircontrol is significant, in order to limit player's speed when moving in mid-air. Non-player objects, such as projectiles, are not affected by this. Default value is 0 (no friction, like in the original games), and the maximum is 65536 (no acceleration whatsoever). In order to feel realistic, if it's needed, make sure to keep airfriction very low, or lower than the ground friction anyway, as it only applies while you're above ground.
disable-jump If set to true, it will disable player jumping in current level. Default is false. See also playerclass in EDF, and comp_aircontrol in OPTIONS.
disable-jump = true
gravity Global gravity factor for the current level. The default gravity value is 65536.
# Enable 50% gravity
gravity = 32768

Ambience[edit]

Variable Description Example
altskyname Name of a texture to display instead of the normal sky texture during a lightning strike. This value is only used if lightning is enabled for this level. If this value is not provided, no sky animation will occur during lightning strikes.
altskyname = LBOLTSKY
colormap Name of a colormap lump to use as the global colormap for this level. This colormap is applied to any sectors which do not have their own colormaps specified either via use of 242 height transfer linedefs or scripting. This lump must be between C_START and C_END tags or the "colormaps" directory in the PKE.
colormap = FOGMAP
outdoorfog Name of a colormap lump to use as the outdoors colormap for this level. This lump must be between C_START and C_END tags or the "colormaps" directory in the PKE.
outdoorfog = FOGMAP
defaultenvironment Sets the default sound environment (reverb) effect to happen in the map. Use two identifiers, as defined in EDF.
defaultenvironment = 1 2
doublesky Boolean value that determines whether or not this map uses double skies. When double skies are enabled, any F_SKY1 or F_SKY2 sectors *not* affected by MBF sky transfer lines will use both the primary and secondary sky textures together. The secondary texture will be drawn first, normally, then the primary texture will be drawn over it, omitting any pixels which use palette index zero (this is usually pure black). Any MapInfo sky delta values provided will be applied to their respective textures.
doublesky = true
fullbright Boolean value that determines whether fullbright can be used on this level. When fullbright is disabled, player gun flashes will not occur, and fullbright sprites and particles will be drawn normally. This should be used with most custom colormaps, since flashes and fullbright sprites usually look incorrect with them.
fullbright = false
lightning Boolean value that toggles the global lightning effect. When set to true, all sky sectors on the map will flash at randomly determined intervals along with a thunder sound and optional animation of the normal sky texture. Warning: sectors must currently have a sky ceiling at the beginning of the level in order to be affected by lightning. The only current method to make non-sky sectors flash during lightning strikes is via use of BOOM lighting transfer linedefs. This may be improved in the near future.
lightning = true
music Provides the name of a MUS or MIDI lump to use as music. In DOOM gamemodes, the string provided should be the lump name minus the "D_" prefix. In Heretic, the string provided should be the lump name minus the "MUS_" prefix. You are *not* limited to using only the built-in music lump names; Eternity automatically adds any new lump which matches the naming convention for the current gamemode to the internal music list.
music = cheese
noautosequences Determines the default assignment of sound sequences. If set to true, no sound sequences will be automatically assigned to sectors. The sequence of all sectors by default will be sequence number 0. If set to false, the default sound sequences defined in sounds.edf will be used. These sequences implement the normal, default behaviors for DOOM and Heretic, and can be easily overridden by the user if desired.
noautosequences = true
sector-colormaps This optional property can be used to enforce classic Boom or SMMU-style behaviour for sector colormap applications using either the Transfer_Heights linedef special or ExtraData or UDMF sector properties. Possible values are:
  • normal: this is the default value. It makes the Transfer_Heights special apply the Boom behaviour, where the sector the player is in causes the entire view to change colour, while ExtraData and UDMF use the SMMU-introduced behaviour, where the sector colour is local to the sector, as if having local coloured light or fog effect. It's default because of required compatibility with past Boom and MBF wad releases, whereas the new SMMU introduced behaviour can be more useful for new maps with ExtraData or UDMF.
  • Boom: the Boom sector colormap behaviour will apply to all kinds of colormap settings, like in Boom or MBF.
  • SMMU: the SMMU sector colormap behaviour will apply to all kinds of colormap settings, like in previous Eternity versions.
sector-colormaps = normal
skydelta Pixels per gametic that the primary sky texture should scroll. This effect will only be applied to double skies and to F_SKY1 sectors which are NOT affected by any MBF sky transfer linedefs.
skydelta = 5
sky2delta Pixels per gametic that the secondary sky texture should scroll. This effect will only be applied to double skies and to F_SKY2 sectors (which cannot be affected by MBF sky transfer linedefs).
sky2delta = 7
skyname Name of a texture to use as the primary sky for this map. This sky will appear in all sectors which use the F_SKY1 flat, and it will also appear as the top layer of Hexen-style double skies. The name provided for this lump must be a valid texture or an error will occur.
skyname = SKY2
sky2name Name of a texture to use as the secondary sky for this map. This sky will appear in all sectors which use the F_SKY2 flat, and it will also appear as the bottom layer of Hexen- style double skies. The name provided for this lump must be a valid texture or an error will occur. If no name is provided for the secondary sky, the primary sky name will be copied to it, so it is not an error to use F_SKY2 or double skies in a level where the sky2 texture is not explicitly defined.
sky2name = SKY4
skyrowoffset Set the vertical offset of the sky. This is useful to give you control from which height to draw the sky. Above this offset, the sky will appear as fading to a single colour. Usual values are:
  • 100: draw like in vanilla Doom, where it assumed that the player can't look up and down.
  • 200: draw like in Heretic, where the view pitch is ±32 degrees.
  • 260: draw for the view pitch of ±45 degrees, as set by default in Eternity Doom.

You can customize the player view pitch in EDF game properties.

If unspecified, Eternity will autodetect based on sky height. If at least 200 units, tall, it will set to 200. If less, it will set to 100. Note that even 200 is insufficient for the default ±45 degree view pitch; you may want to set 260 for that. NOTE: for PrBoom wad compatibility, and only for DOOM wads, the same autodetection rule doesn't apply if the tall sky is purely specified via a texture replacement: those will always be drawn as vanilla, as long as no skyname replacement is set in EMAPINFO.

Also, beware that Static_Init (sky transfer) specials use their own sidedef Y offset to adjust the sky location, bypassing this setting.

sky2rowoffset Same as skyrowoffset, but for sky2name. If you use doublesky as in Hexen, you may want to set both these row offset fields.
unevenlight Boolean value that determines whether walls parallel to the x and y axes of the game world are given lighting values 1 level higher or lower than other walls. This can dramatically affect the perceived light level of an area, so only use it for maps that are designed specifically for it. Maps which use custom global colormaps should usually set this value to false, since it only generally looks appropriate with the normal colormap.
unevenlight = false
sound-* There are several sound-* commands which can be used to replace the default sounds in a map with sounds, using their mnemonics defined in EDF.

Sounds available for replacement:

swtchx
swtchn
stnmov
pstop
pstart
bdcls
bdopn
dorcls
doropn
fcmove
sound-swtchx = newswtch
sound-doropn = dorcreak

Finale control[edit]

Variable Description Example
boss-specials A flags field that specifies what formerly level-specific boss "magic codepointer" actions are enabled for this level. This field takes a value in the same format as that used by EDF, DeHackEd/BEX, and ExtraData flag fields, but the format will be reviewed here for completeness.

A BEX flag list is a string of flag names separated by whitespace, pipe characters, commas, or plus characters. Flags are combined using bitwise-OR logic, so a flag name can be specified more than once. Specifying a flag name causes that flag to be turned on. The default state of all flags is off.

These are the flag values which are available for this field:

         Flag name  Decimal  Hex     Meaning
         -----------------------------------------------------------------
         MAP07_1    1        0x0001  MAP07 Special 1 (BossDeath only)
         MAP07_2    2        0x0002  MAP07 Special 2 (BossDeath only)
         E1M8       4        0x0004  E1M8 Special
         E2M8       8        0x0008  E2M8 Special
         E3M8       16       0x0010  E3M8 Special
         E4M6       32       0x0020  E4M6 Special (BossDeath only)
         E4M8       64       0x0040  E4M8 Special
         E5M8       128      0x0080  E5M8 Special (HticBossDeath Only)
         -----------------------------------------------------------------

Notes: Actions differ depending on whether monsters use the BossDeath or HticBossDeath codepointers. See the documentation for those specific codepointers to see what actions they perform. The monsters which must be dead for a given special to activate are controlled by various EDF/BEX thingtype flags. Together, these features allow complete customization.

All of these are equivalent:

boss-specials = MAP07_1|MAP07_2
boss-specials = MAP07_1 | MAP07_2
         
boss-specials = MAP07_1+MAP07_2
boss-specials = MAP07_2 + MAP07_2
         
boss-specials = MAP07_1,MAP07_2
boss-specials = MAP07_1, MAP07_2
         
boss-specials = MAP07_1 MAP07_2
endofgame Boolean value which, if true, causes a DOOM II cast call to occur when this map is exited. This value is currently only usable in DOOM II. A level must also have intermission text defined for a cast call to take place.
endofgame = true
endpic String value. If finaletype has been set to endpic, this value specifies the picture lump to display for the finale.
finaletype = endpic
endpic = FINALPIC    // show a custom patch lump named FINALPIC
finale-early Boolean value which, if true, indicates that a text intermission should occur after this map without displaying the usual score screen. If no intermission text is defined for this map, this variable has no effect.
finale-early = true
finale-normal Boolean value which, if true, indicates that a text intermission should only occur after this map if a normal exit was taken. If no intermission text is defined for this map, this variable has no effect.
finale-normal = true
finale-secret Boolean value which, if true, indicates that a text intermission should only occur after this map if a secret exit was taken. If no intermission text is defined for this map, this variable has no effect.
finale-secret = true
finaletype Specifies which finale image sequence to use. Possible values are:
  • text: Only the intertext will be displayed. Play will then continue to the next level normally.
  • doom_credits: The DOOM CREDITS screen will be displayed after the intertext. Play ends after this map.
  • doom_deimos: The DOOM picture of Deimos above Hell will be displayed after the intertext. Play ends after this map.
  • doom_bunny: The scrolling picture of Daisy's head on a pike will be displayed, accompanied by the words "THE END" which are shot up with several bullets. Play ends after this map.
  • doom_marine: The E4 ending picture of the Marine holding Daisy's head is displayed after the intertext. Play ends after this map.
  • htic_credits: The Heretic CREDITS screen will be displayed after the intertext. Play ends after this map.
  • htic_water: The Heretic underwater screen with special palette is displayed after the intertext. Play ends after this map.
  • htic_demon: The Heretic demon scroller is displayed after the intertext. Play ends after this map.
  • psx_udoom: PSX Ultimate DOOM finale
  • psx_doom2: PSX DOOM II finale
  • endpic: End the game with a custom static picture set by the endpic property (see its relevant row in this table). This is a generalization of the DOOM I and Heretic intermediary episode endings.
finalesecrettype Like above, but for the secret exit.
inter-backdrop Name of a 64x64 flat OR a 320x200 graphic lump to be displayed as the background of a text intermission which occurs after this map. The flat namespace will be searched first, so if both a flat and a 320x200 picture of the same name exist, the flat will be chosen.
inter-backdrop = FLATHUH1
intermusic Name of a MUS or MIDI lump to use as music during a text intermission which occurs after this map. If no intertext is defined for the map, this value will not be used. In DOOM gamemodes, the string provided should be the lump name minus the "D_" prefix. In Heretic, the string provided should be the lump name minus the "MUS_" prefix. You are *not* limited to using only the built-in music lump names; Eternity automatically adds any new lump which matches the naming convention for the current gamemode to the internal music list.
intermusic = ROMERO
intertext Lump name of a text lump to be loaded as intermission text for this level. If the level has an intermission by default, this will replace the default intermission text, even if it has been edited via DeHackEd. If there is not normally a text intermission after this map, the presence of this variable serves to enable it. If no intertext is defined, a text intermission will not occur after a map. The formatting of the text inside the indicated lump will be preserved exactly, with the exception of tabs, which are converted to spaces. There is no length limitation, but only one screen of text (40 columns, 17 rows) can be displayed. Any extra text will be drawn off the bottom of the screen.
intertext = MAP04TXT
intertext-secret Like intertext, but for the secret exit.
killfinale Boolean value that allows built-in text intermission points to be disabled. For example, if you do not want text to appear after DOOM II MAP11, set this variable to true.
killfinale = true
levelaction Specifies what happens when certain species of monsters all die in the map. The syntax is such: thingtype special [arg1 [arg2 [arg3 [arg4 [arg5]]]]]. You can even have more than one per level.

NOTE: this does not depend on the presence of the BossDeath or HticBossDeath codepointer in a monster's death sequence. Instead, it triggers immediately when the last monster is killed. In fact, if used in a map without such monsters, it will activate from the start. Also, it can only be used for actual monsters (COUNTKILL or KILLABLE in cflags), not for picking up items. Use levelaction-bossdeath if you want triggering when said codepointers are run.

levelaction = BaronOfHell Floor_LowerToLowest 671 8
levelaction = Arachnotron Floor_RaiseByValue  667 8 24
levelaction-bossdeath Like levelaction, but activated only during BossDeath or HticBossDeath from a dead monster of the intended species. Same syntax as levelaction. Warning: this one is susceptible to unexpected effects if the monsters can respawn or resurrect, then die again, retriggering the action. Use with care.

Examples of EMAPINFO Definitions[edit]

A basic EMAPINFO lump may be similar to this:

   [MAP01]
   levelname = Evil Hell Lab
   creator = DooMGuy667

   [E1M1]
   levelname = Not Hangar
   creator = Not Romero
   skyname = SKY3
   skydelta = 1

The first example would change the automap and intermission screen names for MAP01 to "Evil Hell Lab" and when the creator command is used in the console, output "DooMGuy667". The name in the brackets is the map the EMAPINFO applies to, so by changing [MAP01] to [MAP02], the changes would apply to MAP02 instead.

The second example also sets a name and creator for the map (for the E1M1 mapslot, in this case), and also specifies that it will use SKY3 and scroll the sky slowly, using the skydelta variable.

See also[edit]