Eternity Wiki - User contributions [en]

Translucency map

2018-05-20T21:51:45Z

Anotak:

Translucency maps (tranmaps) are a Boom feature where colours combined with other colours result in other values. They can be set on linedefs or things and are stored in wads as 256*256 ( = 65536) byte long lumps.

See also: [[doom_wiki:Translucency|The doomwiki article on translucency.]]

UDMF

2018-05-20T21:48:37Z

Anotak:

UDMF is the extensible format that replaces the classic Doom format and [[ExtraData]]. Each level, instead of being defined by the classic lumps (THINGS, LINEDEFS, SIDEDEFS etc.) is defined by a human-readable lump named TEXTMAP, and can have associated lumps (e.g. ZNODES, BLOCKMAP, REJECT if needed) and other lumps, until a marker lump named ENDMAP.

TEXTMAP has a well-defined language. Check the UDMF article at doomwiki.org. Each game and port has its own namespace(s), for example we have these namespaces: "doom", "heretic", "hexen", "strife", "zdoom" and others. Eternity has the "eternity" namespace.

At its core, UDMF is made of many blocks, each titled "vertex", "sector", "sidedef", "linedef", "thing" and containing several properties, some mandatory, others optional. Each game or port namespace can define its own set, which is typically hard-coded, though it's also possible for the user to add their own fields (which have to be preceded by a safe prefix, to avoid conflicts with the standard).

Maps designed in UDMF no longer need ExtraData.

==Basics==

Eternity supports the "doom" and "eternity" namespaces. In the rest of this article, we'll detail the "eternity" namespace. See the [https://www.doomworld.com/eternity/engine/stuff/udmf11.txt base UDMF specifications] for the options not detailed in this document.

A TEXTMAP for Eternity must start with this:
namespace = "eternity";

===Eternity compatibility===
You can also add the following field in UDMF TEXTMAP:
ee_compat = true;
which, no matter the namespace used (e.g. "zdoom"), assumes the map is going to work in Eternity. In other words, it is equivalent to setting namespace as "eternity". Any fields not supported by Eternity, however, may make the mod fail.

===Node format===

Nodes for UDMF use the uncompressed GL-nodes format under the ZNODES name. Tools such as ZDBSP should build such a lump upon detecting a TEXTMAP lump.

==Linedefs==
linedef
{
polycross = <boolean>;

midtex3d = <boolean>;
firstsideonly = <boolean>;
blockeverything = <boolean>;
zoneboundary = <boolean>;
clipmidtex = <boolean>;
midtex3dimpassible = <boolean>;
lowerportal = <boolean>;
upperportal = <boolean>;

portal = <integer>;

alpha = <floating-point>;
renderstyle = <string>;
tranmap = <string>;
}
===Explanation of fields===
*'''polycross'''
:If true, linedef is activated when a polyobject's center point crosses it.
*'''midtex3d'''
:If true, this linedef's middle texture uses [[3DMidTex_tutorial|3dmidtex]] physics.
*'''firstsideonly'''
:Linedef can only be activated from front side.
*'''blockeverything'''
:Linedef blocks all objects, acting like an external solid wall
*'''zoneboundary'''
:Linedef acts like a boundary for [[EDF_sound_reference#Sound_environments|reverb]] effects.
*'''clipmidtex'''
:Middle texture is clipped against the floor or ceiling as if a light change took place.
*'''midtex3dimpassible'''
:Treat the 3dmidtex line as a classic impassable middle texture, with regards to projectiles (i.e. they will pass through, just like hitscans).
*'''lowerportal''', '''upperportal'''
:Apply [[edge portals|edge portal]] on the lower or upper part of this linedef, copying back sector's floor or ceiling portal into it.
*'''portal'''
:The ID of the portal to apply on this linedef, as defined from [[Portal_Define]]
*'''alpha''' (default: 1.0)
:Opacity of this line.
*'''renderstyle'''
:Either "translucent" or "add". Default is "".
*'''tranmap'''
:Boom [[translucency map]]. Mutually exclusive with alpha and renderstyle.

==Sidedefs==
No new fields are in Eternity, but '''offsetx''' and '''offsety''' now work as floating-point, instead of integer.

==Vertices==
No change yet from the base "doom" namespace.
==Sectors==
sector
{
heightfloor = <floating-point>;
heightceiling = <floating-point>;

xpanningfloor = <floating-point>;
ypanningfloor = <floating-point>;
xpanningceiling = <floating-point>;
ypanningceiling = <floating-point>;

xscalefloor = <floating-point>;
yscalefloor = <floating-point>;
xscaleceiling = <floating-point>;
yscaleceiling = <floating-point>;
rotationfloor = <floating-point>;
rotationceiling = <floating-point>;

secret = <boolean>;
friction = <integer>;

leakiness = <integer>;
damageamount = <integer>;
damageinterval = <integer>;
damage_endgodmode = <boolean>;
damage_exitlevel = <boolean>;
damageterraineffect = <boolean>;
damagetype = <string>;

floorterrain = <string>;
ceilingterrain = <string>;

lightfloor = <integer>;
lightceiling = <integer>;
lightfloorabsolute = <boolean>;
lightceilingabsolute = <boolean>;

colormaptop = <string>;
colormapmid = <string>;
colormapbottom = <string>;

scroll_ceil_x = <floating-point>;
scroll_ceil_y = <floating-point>;
scroll_ceil_type = <string>;
scroll_floor_x = <floating-point>;
scroll_floor_y = <floating-point>;
scroll_floot_type = <string>;

floorid = <integer>;
ceilingid = <integer>;
attachfloor = <integer>;
attachceiling = <integer>;

soundsequence = <string>;

portalfloor = <integer>;
portalceiling = <integer>;

portal_floor_disabled = <boolean>;
portal_floor_norender = <boolean>;
portal_floor_nopass = <boolean>;
portal_floor_blocksound = <boolean>;
portal_floor_useglobaltex = <boolean>;
portal_floor_overlaytype = <string>;
alphafloor = <floating-point>;
portal_floor_attached = <boolean>;

portal_ceil_disabled = <boolean>;
portal_ceil_norender = <boolean>;
portal_ceil_nopass = <boolean>;
portal_ceil_blocksound = <boolean>;
portal_ceil_useglobaltex = <boolean>;
portal_ceil_overlaytype = <string>;
alphaceiling = <floating-point>;
portal_ceil_attached = <boolean>;
}

=== Explanation of fields ===
*'''heightfloor''', '''heightceiling''' (mandatory)
:Unlike the base field from the core specs, these ones allow floating-point values.
*'''xpanningfloor''', '''ypanningfloor''', '''xpanningceiling''', '''ypanningceiling'''
:These properties control the panning of the floor or ceiling flat.
*'''xscalefloor''', '''yscalefloor''', '''xscaleceiling''', '''yscaleceiling''' (default: 1.0)
:These properties control the scaling of the floor or ceiling flat. Greater values result in smaller textures.
*'''rotationfloor''', '''rotationceiling'''
:These properties control the rotation of the floor or ceiling flat, in degrees.
*'''secret'''
:If true, the sector counts as a secret when visited by player.
*'''friction''' (default: -1)
:This one controls the friction of movement on the floor. The value of this field is equivalent to the length of a horizontal linedef with the classic Boom friction special. Default value: -1 (use usual Doom friction).
*'''leakiness'''
:This one controls the probability that, if this sector is also damaging, it will leak damage through the radiation suit. As reference, the classic Doom 20% sector has 5 leakiness. For damage which always goes through the suit, use 256.
*'''damageamount'''
:Damage per hit for players on the floor.
*'''damageinterval'''
:Time between hits. The classic Doom damaging floors use a 32 period.
*'''damage_endgodmode'''
:If true, it will cause the damaging floor to disable the godmode cheat.
*'''damage_exitlevel'''
:If true, it will cause the damaging floor to exit the level in victory if the player has too little health.
*'''damageterraineffect'''
:If true, then each damage hit will produce a splash, like the Heretic lava.
*'''damagetype''' (default: "Unknown")
:The [[damagetype|damage type]] of the floor.
*'''floorterrain''' (default: "@flat")
:The [[terrain]] effect of the floor.
*'''ceilingterrain''' (default: "@flat")
:The [[terrain]] effect of the ceiling. Currently used for particle recolouring.
*'''lightfloor''', '''lightceiling'''
:The light amount to add to the floor or ceiling, relative to the designated light level.
*'''lightfloorabsolute''', '''lightceilingabsolute'''
:If true, then '''lightfloor''' or '''lightceiling''' just overrides the light.
*'''colormaptop''', '''colormapmid''', '''colormapbottom''' (default: "@default")
:The colormap to set for the top, normal or bottom part of a Boom sector with fake flats. Or for any normal part, if it's '''colormapmid'''. Use a lump from between '''C_START''' and '''C_END'''. "WATERMAP" and "LAVAMAP" are provided by Eternity.
*'''scroll_ceil_x''', '''scroll_ceil_y''', '''scroll_floor_x''', '''scroll_floor_y'''
:These fields make the sector ceiling or floor scroll at startup. The values you input there are the equivalents of a Boom trigger linedef length divided by 10. So to emulate a linedef pointing east of length 64 having a scroll trigger, set value 6.4 on '''scroll_ceil_x''' or '''scroll_floor_x'''.
*'''scroll_ceil_type''', '''scroll_floor_type''' (default: "none")
:These fields control the kind of scrolling for each surface and can be: "none" (no scrolling enabled), "visual" (only scroll the texture), "physical" (only carry the things), "both" (both scroll and carry). For now, '''scroll_ceil_type''' only supports "none" or "visual".
*'''floorid''', '''ceilingid'''
:ID of the floor or ceiling of this sector to use for [[attached surfaces]]. Use this id in '''attachfloor''' and '''attachceiling'''.
*'''attachfloor''', '''attachceiling'''
:Makes the floor or ceiling of this sector move whenever sectors with '''floorid''' or '''ceilingid''' with the same number move their respective surfaces. If you want this sector's floor or ceiling to move in opposite direction, use the negative value.
*'''soundsequence'''
:Name of the [[soundsequence]] to use for the movement of this sector.
*'''portalfloor''', '''portalceiling'''
:Portal ID to use on the floor or ceiling of this sector, using the same value as the one set in [[Portal_Define]]. For two-way portals, use the negative number for the opposite portal (i.e. one way uses portal ''n'', and the other way uses -''n'').
*'''portal_floor_disabled''', '''portal_ceil_disabled'''
:If true, the portal is disabled (has no effect).
*'''portal_floor_norender''', '''portal_ceil_norended'''
:If true, the portal is not rendered but may have effects.
*'''portal_floor_nopass''', '''portal_ceil_nopass'''
:If true, it disables any linked portals interaction.
*'''portal_floor_blocksound''', '''portal_ceil_blocksound'''
:If true, it blocks sounds from monsters listening for alerts.
*'''portal_floor_useglobaltex''', '''portal_ceil_useglobaltex'''
:Reserved.
*'''portal_floor_overlaytype''', '''portal_ceil_overlaytype''' (default: "none")
:Can be "none", "translucent" or "additive". Controls the rendering of portal overlays.
*'''alphafloor''', '''alphaceiling''' (default: 1.0)
:Alpha of the portal overlay. 1.0 makes it fully visible, 0.0 is invisible.
*'''portal_floor_attached''', '''portal_ceil_attached'''
:If true, and the sector has a linked portal on the floor or ceiling, the portal will move along with the floor or ceiling surface, instead of remaining at the same height as default. This is useful for easily moving platforms vertically.

==Things==
thing
{
health = <floating-point>;
}
===Explanation of fields===
*'''health'''
:Health modifier. Works like in ZDoom: 0 means no change from [[EDF]], positive values multiply the initial spawn health, and negative values change the absolute spawn health.

EMAPINFO

2018-01-09T04:06:47Z

Anotak:

'''MapInfo''' serves as a method of customizing some aesthetic properties of a map which would otherwise be unchangeable, as well as adding the ability to use some [[Eternity]]-specific features. Eternity's MapInfo is stored in the EMAPINFO text lump.
{{Backto|Eternity Engine}}
{{editref}}

==Usage==
MapInfo 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.

==Syntax==
*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.

==MapInfo Variables==
'''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. '''(since 16th Feb 2016)'''
acsopendelay = true

'''acsscript'''
:Name of the lump containing the compiled ACS script for this map.
acsscript = SCRIPT01

'''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. For example:
altskyname = LBOLTSKY

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

Example flags fields -- 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

'''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. For example:
colormap = FOGMAP

'''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". For example:
creator = Edwin Chadwick 'chadders'

'''defaultenvironment'''
:Sets the default sound environment (reverb) effect to happen in the map. Use two identifiers, as defined in [[EDF]].
defaultenvironment = 1 2

'''disable-jump'''
:If set to '''true''', it will disable player jumping in current level. Default is '''false'''.
disable-jump = true

'''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. For example:
doublesky = true

'''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. For example:
edf-intername = true

'''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. For example:
endofgame = true

'''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. For example:
extradata = EXTRDT01

'''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. For example:
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. For example:
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. For example:
finale-secret = true

'''finaletype'''
:Specifies which finale image sequence to use. Possible values are:
:*''text''
:*''doom_credits''
:*''doom_deimos''
:*''doom_bunny''
:*''doom_marine''
:*''htic_credits''
:*''htic_water''
:*''htic_demon''

'''finalesecrettype'''
:Like above, but for the secret exit.

'''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. For example:
fullbright = false

'''gravity'''
:Global gravity factor for the current level. The default gravity value is 65536. For example:
# Enable 50% gravity
gravity = 32768

'''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. For example:
inter-backdrop = FLATHUH1

'''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. For example:
inter-levelname = Circle of death

'''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. For example:
intermusic = ROMERO

'''interpic'''
:Name of a 320x200 graphic lump to be displayed as the background of the statistics intermission. For example:
interpic = BOSSBACK

'''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. For example:
intertext = MAP04TXT

'''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. For example:
killfinale = true

'''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. For example:
killstats = 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.
levelaction = BaronOfHell Floor_LowerToLowest 671 8
levelaction = Arachnotron Floor_RaiseByValue 667 8 24

'''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''' example:
levelname = chadders' lair

'''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''' example:
levelpic = E1M1PIC

'''levelpicnext'''
:Same as levelpic, but only if the normal exit was taken.

'''levelpicsecret
:Same as levelpic, but only if the secret exit was taken.

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

'''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. For example:
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. For example:
music = cheese

'''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. For example:
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. For example:
nextsecret = MAP34

'''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. For example:
partime = 200

'''sector-colormaps'''
:'''(since 2nd April 2017)''' 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. For example:
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). For example:
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. For example:
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. For example:
sky2name = SKY4

'''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. For example:
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]].
[[EDF]] mnemonic of a sound to replace the default "swtchn" sound for this map.

Sounds available for replacement:
swtchx
swtchn
stnmov
pstop
pstart
bdcls
bdopn
dorcls
doropn
fcmove

Examples of use:
sound-swtchx = newswtch
sound-doropn = dorcreak

==Examples of MapInfo Definitions==
A basic MapInfo 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 <tt>creator</tt> command is used in the console, output "DooMGuy667". The name in the braces is the map the MapInfo applies to, so by changing <tt>[MAP01]</tt> to <tt>[MAP02]</tt>, 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.

[[Category:Editing]]

EMAPINFO

2018-01-09T04:02:24Z

Anotak:

'''MapInfo''' serves as a method of customizing some aesthetic properties of a map which would otherwise be unchangeable, as well as adding the ability to use some [[Eternity]]-specific features. Eternity's MapInfo is stored in the EMAPINFO text lump.
{{Backto|Eternity Engine}}
{{editref}}

==Usage==
MapInfo 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.

==Syntax==
*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.

==MapInfo Variables==
'''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. '''(since 16th Feb 2016)'''
acsopendelay = true

'''acsscript'''
:Name of the lump containing the compiled ACS script for this map.
acsscript = SCRIPT01

'''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. For example:
altskyname = LBOLTSKY

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

Example flags fields -- 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

'''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. For example:
colormap = FOGMAP

'''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". For example:
creator = Edwin Chadwick 'chadders'

'''defaultenvironment'''
:Sets the default sound environment (reverb) effect to happen in the map. Use two identifiers, as defined in [[EDF]].
defaultenvironment = 1 2

'''disable-jump'''
:If set to '''true''', it will disable player jumping in current level. Default is '''false'''.
disable-jump = true

'''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. For example:
doublesky = true

'''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. For example:
edf-intername = true

'''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. For example:
endofgame = true

'''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. For example:
extradata = EXTRDT01

'''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. For example:
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. For example:
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. For example:
finale-secret = true

'''finaletype'''
:Specifies which finale image sequence to use. Possible values are:
:*''text''
:*''doom_credits''
:*''doom_deimos''
:*''doom_bunny''
:*''doom_marine''
:*''htic_credits''
:*''htic_water''
:*''htic_demon''

'''finalesecrettype'''
:Like above, but for the secret exit.

'''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. For example:
fullbright = false

'''gravity'''
:Global gravity factor for the current level. The default gravity value is 65536. For example:
# Enable 50% gravity
gravity = 32768

'''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. For example:
inter-backdrop = FLATHUH1

'''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. For example:
inter-levelname = Circle of death

'''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. For example:
intermusic = ROMERO

'''interpic'''
:Name of a 320x200 graphic lump to be displayed as the background of the statistics intermission. For example:
interpic = BOSSBACK

'''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 (17 rows) can be displayed. Any extra text will be drawn off the bottom of the screen. For example:
intertext = MAP04TXT

'''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. For example:
killfinale = true

'''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. For example:
killstats = 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.
levelaction = BaronOfHell Floor_LowerToLowest 671 8
levelaction = Arachnotron Floor_RaiseByValue 667 8 24

'''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''' example:
levelname = chadders' lair

'''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''' example:
levelpic = E1M1PIC

'''levelpicnext'''
:Same as levelpic, but only if the normal exit was taken.

'''levelpicsecret
:Same as levelpic, but only if the secret exit was taken.

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

'''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. For example:
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. For example:
music = cheese

'''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. For example:
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. For example:
nextsecret = MAP34

'''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. For example:
partime = 200

'''sector-colormaps'''
:'''(since 2nd April 2017)''' 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. For example:
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). For example:
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. For example:
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. For example:
sky2name = SKY4

'''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. For example:
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]].
[[EDF]] mnemonic of a sound to replace the default "swtchn" sound for this map.

Sounds available for replacement:
swtchx
swtchn
stnmov
pstop
pstart
bdcls
bdopn
dorcls
doropn
fcmove

Examples of use:
sound-swtchx = newswtch
sound-doropn = dorcreak

==Examples of MapInfo Definitions==
A basic MapInfo 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 <tt>creator</tt> command is used in the console, output "DooMGuy667". The name in the braces is the map the MapInfo applies to, so by changing <tt>[MAP01]</tt> to <tt>[MAP02]</tt>, 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.

[[Category:Editing]]