Eternity Wiki - User contributions [en]

List of cheat codes

2024-08-25T23:43:46Z

Bloodshedder: Undo revision 6178 by 188.242.190.172 (talk)

The Eternity Engine supports several cheat codes besides what vanilla Doom has. The list follows.
{{Backto|Eternity Engine}}
{{editref}}
==Classic Doom cheats==
These cheats are available in Doom and Doom 2, and function mostly if not identically the same.
===IDMUS===
IDMUS allows the music to be changed to any other internally defined music. Type IDMUS and then the level number to hear the song that plays on that map (in DOOM and Heretic, use the episode and then map; in DOOM II, use the 2-digit map number). Typing numbers beyond the number of levels in the game will allow you to hear other songs such as intermission, title, and ending music. This cheat won't crash on bad numbers like DOOM originally could.
===IDCHOPPERS===
IDCHOPPERS gives you the chainsaw. It is named after a game entered in a state programming contest, and the message it gives is related to it.
===IDDQD===
IDDQD sets the player's health to 100 and toggles god mode. DQD stands for Delta-Q-Delta, a supposed fraternity for programmers where the requirement for entry was at least one Q (a mark given in college for a class withdrawal) on your transcript.
===IDK, IDKFA, IDFA===
These cheats give the following:
*IDK: All six DOOM keys
*IDKFA: All six keys, full ammo and weapons, and armor
*IDFA: Full ammo, weapons, and armor, but no keys
IDK is new as of the BOOM engine. According to the Linux DOOM source, KFA either stands for killer fraggin' arsenal (although a less kosher word is used for fraggin'), or Keys and Full Ammo. You can take your pick.
===IDCLIP, IDSPISPOPD===
These two cheats have identical functionality, which is turning off the game's clipping code for the player. This allows you to walk through walls and solid things, and even completely out of the map. SPISPOPD stands for "Smashing Pumpkins Into Small Piles Of Putrid Debris," and has its origins in the pre-DOOM-release Usenet mayhem.
===IDBEHOLD===
Typing IDBEHOLD will bring up a small menu where you can choose to enable one of various powerup effects. To choose a powerup, use the following keys:
*R: Toggles radiation suit
*I: Toggles partial invisibility
*V: Toggles invulnerability (with inverse colormap)
*A: Toggles all-map cheat (reveals the automap)
*L: Toggles lite-amp goggles
*S: Toggles berserk strength
In DOOM, some of these effects would wear off after the normal amount of time. By default, Eternity allows them to stay on forever until you explicitly turn them off by typing the cheat again.
===IDCLEV===
This cheat allows you to change levels. In DOOM or Heretic, type the episode number and then the map number after the cheat. In DOOM II, type the two-digit level number. You can only warp to levels which are normally in the game, even if other map numbers are available in the wad (to warp to oddly-named or higher-numbered levels, use Eternity's map console command).
===IDMYPOS===
This cheat prints detailed information about your current location. The format of its output has been improved over that which was used in DOOM; however, this cheat's function is mostly obsoleted by the automap coordinates widget.
===IDDT===
To activate this cheat, go to the automap and type IDDT. Doing this once will allow you to see all lines in the map. Doing it again will allow you to also see all things in the map. Type it a third time to return the automap to normal. You can see some areas of the map with IDDT that you cannot see with the all-map powerup.
==BOOM and MBF Cheats==
These cheats were added in BOOM and MBF. Some of them have been changed slightly (in BOOM, many of them had a TNT prefix, which was removed in MBF).
===COMP===
This cheat toggles all of the compatibility vector variables at once, turning them on or off.
===KILLEM===
This cheat kills all monsters on the map, keeping count (it counts monsters which do not normally count for kills, such as Lost Souls, so the number may be higher than the kill count for the map). If there are no enemy monsters on the map and you type this, it will kill all friends on the map (not including the player, of course).

Same as the "nuke" console command.
===HOM===
This cheat toggles the BOOM HOM detection feature. Depending on your settings, HOM will appear either as solid red or as a red flashing area when this cheat is enabled.

Same as the "r_showhom /" console command.
===KEY===
Type KEY to bring up a menu, then type R, Y, or B to choose a key color (red, yellow, or blue). Then, type C or S to select card or skull. Once you make the final selection, the key will either be given to you if you don't have it, or it will be taken away. This lets you select the key you need (especially useful in maps with missing keys).
===WEAP===
Type WEAP, then type a number (1-9 in DOOM II, 1-8 in DOOM). The selected weapon which is associated with that slot will either be added or removed, depending on whether you have it or not (note the Super Shotgun is weapon #9 in DOOM II). You can remove the fist, chainsaw, and pistol with this code, but cannot get them back unless you type it again.
===AMMO===
Type AMMO, then either type a number from 1 to 4, or B for Backpack. The selected ammo will be added or taken away (yes, you can remove the backpack if you already have it). Ammo types are bullets, shells, rockets, and cells.
===TRAN===
This code toggles translucency rendering effects (both BOOM-style and DosDOOM-style). Sometimes turning this off can help the framerate a bit, especially on really old machines.
===ICE===
Type this cheat to toggle BOOM friction effects.
===PUSH===
Type this cheat to toggle BOOM pusher effects.

Same as the "pushers /" console command.
===NUKE===
Type this cheat to toggle the effects of damaging sectors.
==Eternity Cheats==
These cheat codes are new to Eternity.
===HIDEME ===

This cheat toggles the new total invisibility powerup effect. When totally invisible, enemies will not awaken by seeing you. Deaf enemies cannot awaken at all, since they can neither see nor hear you. However, if a normal enemy hears you, this cheat will only become as good as partial invisibility, as the demons have a sense for where you are even when you are invisible.

===GHOST===

This cheat toggles the Heretic shadowsphere effect. You will become translucent, and if you move slowly and keep at a distance, enemies may fail to see you. They also cannot aim at you well even when they do see you, just as with partial and total invisibility.

Same as the "r_trans /" console command.

===INFSHOTS ===

This cheat toggles infinite ammo. When turned on, none of your weapons will use any ammo whatsoever.

===SILENCE ===

This cheat toggles the new silencer powerup effect. When active, your weapons' sounds will not cause enemies to awaken. When combined with HIDEME, enemies will never wake up unless you hurt them.

===IAMTHEONE ===

This is a master cheat which will make you all-powerful. It will turn on god mode, infinite ammo, total invisibility, and silencer effects if they are not on (it will not deactivate them if you type it again). It also gives full ammo, weapons, and armor.

Eternity Engine

2024-08-25T23:43:40Z

Bloodshedder: Undo revision 6179 by 69.130.117.220 (talk)

The Eternity Engine is [[Doom Wiki:Team Eternity|Team Eternity]]'s advanced [[Doom Wiki:Doom|Doom]] [[Doom Wiki:Source port|source port]] and the primary subject of this Wiki. It is meant as a versatile feature port which keeps gameplay compatibility with its roots (DOOM, [[BOOM]], [[MBF]] and so on) while advancing with powerful features such as new ways to design levels ([[linked portals]], [[3DMidTex]], [[polyobjects]] etc.) and modding capabilities (using the [[EDF]] definition language). Every new feature we add is tested not to affect anything that exists so far.

==History==
The Eternity Engine began in 1998 as a simple modification of [[Doom Wiki:Boom|Boom]] meant to power [[Doom Wiki:Eternity TC|Eternity TC]], which was at that time a new and active project. When [[Doom Wiki:Lee Killough|Lee Killough]] began the [[MBF]] project, [[Doom Wiki:James_Haley_(Quasar)|James "Quasar" Haley]] became a beta tester after emailing Lee with questions about the early Doom alpha versions. The Eternity project moved to an MBF code base after that port's first release.

In late 1999, [[Doom Wiki:Simon "Fraggle" Howard|Fraggle]] released v3.10 of his MBF-based source port [[SMMU]], which contained support for the new [[Doom Wiki:FraggleScript|FraggleScript]] scripting language. Although activity in the Eternity TC project by editors had steadily dropped to almost nothing, Quasar was still interested in developing the code associated with it. Needing features such as scripting and the [[console]], he then moved the Eternity project's code into SMMU.

Despite this long history of jumping between Boom-based ports, no public release of Eternity based on any port other than SMMU was ever made. The first private alpha, released to a select few beta testers, was derived from SMMU 3.21 with selected modifications from 3.30. Because of this, Eternity began at version 3.29.

After the release of the [[Doom Wiki:Caverns_of_Darkness|Caverns of Darkness]] project, which used a customized version of Eternity Engine v3.29 Development Beta 5, the project began to attract more attention. A second programmer, [[Doom Wiki:Stephen_McGranahan_(SoM)|Steven "SoM" McGranahan]], joined the project and immediately set to work porting the code to use [[Wikipedia:Simple_DirectMedia_Layer|SDL]], making it capable of running on many operating systems, including [[Wikipedia:Microsoft Windows|Windows]].

Now it has [[Universal Doom Map Format|UDMF]] support and a dynamic weapon and inventory system. It supports linked portals for full room-over-room gameplay. Current major goals for the engine include completing support for [[Doom Wiki:Heretic|Heretic]].

==Getting started==
You can download Eternity either from [https://www.doomworld.com/forum/25-eternity/ Doomworld] (as official releases) or from [https://devbuilds.drdteam.org/eternity/ DRDTeam] (as "beta quality" development builds, which in practice are generally stable, and may be needed for some modding features listed on this wiki).

Eternity's goal that makes it different from feature ports such as [[Doom Wiki:GZDoom|GZDoom]] is demo compatibility similar to that of [[Doom Wiki:PrBoom+|PrBoom+]], kept specifically to ensure that every new feature we add fits seamlessly with what exists so far, and that we don't stray from the bases made so far in the DOOM gameplay.

Support for [[Doom Wiki:Heretic|Heretic]] is growing, though still under way. While we don't support vanilla Heretic demos for playback yet, a possibility exists in the horizon.

===Playing Eternity===
When run directly, Eternity tries to find the DOOM, DOOM 2 or Final DOOM megawads in some standard locations. If it can't find them, it will let you know. If it finds several of them, it will start with a picker screen, letting you choose.

On [[Wikipedia:Windows|Windows]] you can use the drag-and-drop feature of Explorer by moving WADs and PKEs into Eternity's executable. Or you can use Powershell or Command Prompt in a manner similar to starting [[Doom Wiki:Vanilla Doom|vanilla DOOM]]. See [[list of command line parameters]]. For more advanced cases, you can use [[GFS]] files to quickly load multiple files and settings together.

The [[Wikipedia:macOS|macOS]] version of Eternity also comes with a visual dialog-box launcher, hiding the complexity behind starting a terminal.

For advanced technical stuff, cheating and testing maps, Eternity has a [[console]] similar to [[Wikipedia:Quake|Quake's]].

====Loading main game WADs====
Eternity looks for the main game WADs (IWADs), e.g. doom2.wad, at these locations:
* IWAD file paths in user/system.cfg;
* the -iwad command-line parameter;
* the [[Doom Wiki:Environment variables|'''DOOMWADDIR''' or '''DOOMWADPATH''' environment variables]];
* the IWAD in the working directory;
* the IWAD file under the appropriate game folder of the base directory, which can be found using the -game parameter.

====Loading Master Levels for DOOM II====
Eternity offers a menu for conveniently loading each WAD from the Master Levels. To start the Master Levels:
# Start Eternity with DOOM II;
# Go to the Options menu, under the Game Files section, select WAD Options;
# Under the Master Levels section, you may need to specify Master Levels Dir to the path with the WADs;
# Once the path is configured, enter Play Master Levels.
Once the Master Levels Dir is configured, entering New Game from the menu will give you the choice to start the Master Levels.

===Making mods for Eternity===
The editors [[Doom Wiki:Doom Builder X|Doom Builder X]], [[Doom Wiki:GZDoom Builder|GZDoom Builder]], [[Doom Wiki:Eureka|Eureka]] and [[Doom Wiki:SLADE|SLADE]] have Eternity level editing support of varying degrees. For [[UDMF]] (modern advanced format) you can use Doom Builder X, GZDoom Builder or SLADE. However, if you lack access to a UDMF-capable editor or don't want the complexity it brings, you can also use the classic DOOM format, combined with [[ExtraData]]

For general modding, Eternity relies on [[EDF]], its own content definition language. For level definitions in particular it uses [[EMAPINFO]]. Eternity also has growing support for some lumps from [[Doom Wiki:GZDoom|GZDoom]] and [[Doom Wiki:Hexen|Hexen]] such as [[ANIMDEFS]], thus increasing the support for cross-port mods.

Eternity can load [[PKE]] archives, not just [[Doom Wiki:WAD|WADs]]. It can also load unarchived folders structured the same as PKE archives (you can use the -file command-line parameter on folders), facilitating project work. You can use powerful editors such as [[Wikipedia:Visual Studio Code|Visual Studio Code]] on such folders to edit your EDF modifications.

See [[Editing reference|all editing reference]] to get started on modding.

==Major Features==

===Cardboard engine===
[[Cardboard]] is a floating-point rendering engine created by [[Doom Wiki:Stephen_McGranahan_(SoM)|SoM]] that fixes several problems inherent with the classic fixed-point [[Doom Wiki:Doom rendering engine|Doom rendering engine]].

===EDF===
[[EDF]], which stands for Eternity Definition Files, is a textual input language that allows specification of almost all the static game data which was once contained inside the executable. This includes [[thingtype|thing types]], [[frame|frames]], sprites, terrain definitions, and more. EDF has a relaxed [[Wikipedia:C programming language|C]]-like syntax and can be used from both files and [[WAD]] lumps.

===ExtraData===
[[ExtraData]] is another EDF-like data specification language that allows the Doom map format to be extended with any kind of data. Use of special thing, line, and sector types within a map allows the editor to attach ExtraData records to those objects. Special data for the objects is then given inside the script.

===Linked portals===
[[Linked portals]] are surfaces that, like regular [[portals]], connect different areas of the map, but in addition can be walked through, thus allowing multistory maps to be designed in Doom.

===[[MapInfo]]===
Eternity expands SMMU's level info system significantly, allowing dozens of new properties to be specified, and allowing cascading global EMAPINFO lumps as an alternative to inserting MapInfo data into level headers. Among other things, MapInfo is used to tie ExtraData and ACS scripts to the maps that use them.

==Releases==
A complete list of Eternity's release history follows. You can find most of these releases on the [https://www.doomworld.com/forum/25-eternity/ Doomworld Eternity forum], on the [https://github.com/team-eternity/eternity/releases GitHub Eternity repository] and the older releases on the [http://eternity.mancubus.net/ee-old/ Eternity Mancubus website]. Most of the releases are Windows only, but the most recent ones are also available on macOS.

For finer grained non-official releases, see also the [[Eternity Engine#Development builds|development builds]] below.

===Version 3.29===
* 3.29 Private Alpha - September 14, 2000
* 3.29 Public Beta 1 - January 8, 2001
* 3.29 Public Beta 2 - January 9, 2001
* 3.29 Public Beta 3 - May 10, 2001
* 3.29 Public Beta 4 - June 30, 2001
* 3.29 Development Beta 5 - October 2, 2001
* 3.29 "Gamma" - July 4, 2002

===Version 3.31===
* 3.31 Public Beta 1 - September 11, 2002
* 3.31 Public Beta 2 - March 5, 2003
* 3.31 Public Beta 3 - August 8, 2003
* 3.31 Public Beta 4 - November 29, 2003
* 3.31 Public Beta 5 - December 17, 2003
* 3.31 Public Beta 6 - February 29, 2004
* 3.31 Public Beta 7 - April 11, 2004
* 3.31 "Delta" Pre-Release Alpha 1 - August 23, 2004
* 3.31 "Delta" Pre-Release Alpha 2 - November 11, 2004
* 3.31.10 "Delta" - January 19, 2005

===Version 3.33===
* 3.33.00 "Genesis" - May 26, 2005
* 3.33.01 "Outcast" - June 24, 2005
* 3.33.02 "Warrior" - October 1, 2005
* 3.33.33 "Paladin" - May 17, 2006
* 3.33.50 "Phoenix" - October 23, 2006

===Version 3.35===
* [http://www.doomworld.com/vb/eternity/45146-eternity-engine-v3-35-90-simorgh/ 3.35.90] "Simorgh" - January 11, 2009
* [http://www.doomworld.com/vb/eternity/45757-eternity-engine-3-35-92-nekhbet/ 3.35.92] "Nekhbet" - March 22, 2009

===Version 3.37===
* [http://www.doomworld.com/vb/eternity/49268-eternity-engine-3-37-00-sekhmet/ 3.37.00] "Sekhmet" - January 1, 2010

===Version 3.39===
* [http://www.doomworld.com/vb/eternity/52873-eternity-engine-v3-39-20-resheph/ 3.39.20] "Resheph" - October 10, 2010

===Version 3.40===
* [http://www.doomworld.com/vb/eternity/53944-eternity-engine-v3-40-00-rebirth/ 3.40.00] "Rebirth" - January 8, 2011
* [http://www.doomworld.com/vb/eternity/55219-announcing-the-blue-box-ee-3-40-11-and-vaporware-demo/ 3.40.11] "Aasgard" - May 2, 2011
* [http://www.doomworld.com/vb/eternity/55874-eternity-engine-3-40-15-wodanaz/ 3.40.15] "Wodanaz" - June 22, 2011
* [http://www.doomworld.com/vb/eternity/58281-eternity-engine-v3-40-20-mjolnir/ 3.40.20] "Mjolnir" - December 26, 2011
* [http://www.doomworld.com/vb/eternity/61245-eternity-engine-3-40-25-midgard/ 3.40.25] "Midgard" - August 27, 2012
* [http://www.doomworld.com/vb/eternity/62087-eternity-engine-3-40-30-alfheim/ 3.40.30] "Alfheim" - November 4, 2012
* [http://www.doomworld.com/vb/eternity/64382-eternity-engine-3-40-37-gungnir/ 3.40.37] "Gungnir" - May 27, 2013
* [http://www.doomworld.com/vb/eternity/67069-eternity-engine-3-40-46-bifrost/ 3.40.46] "Bifröst" - January 19, 2014 - ''first one with a macOS release''

===Version 3.42===
* [https://www.doomworld.com/forum/topic/94046-eternity-engine-34202-heimdal-files-documentation-buglist/ 3.42.02] "Heimdal" - May 7, 2017
* [https://www.doomworld.com/forum/topic/95351-eternity-engine-34203a-heimdal-release-2-hotfix/ 3.42.03a] "Heimdal" release 2 - August 2, 2017

===Version 4.00===
* [https://www.doomworld.com/forum/topic/99957-eternity-engine-40000-v%C3%B6lusp%C3%A1/ 4.00.00] "Völuspá" - March 17, 2018

===Version 4.01===
* [https://www.doomworld.com/forum/topic/117429-eternity-engine-40100-tyrfing/ 4.01.00] "Tyrfing" - October 13, 2020

===Version 4.02===
* [https://www.doomworld.com/forum/topic/119425-eternity-engine-40200-forseti/ 4.02.00] "Forseti" - January 27, 2021

==Cross-platform development==
Eternity is built by using the [[Wikipedia:CMake|CMake]] utility. You can download the Eternity [[Wikipedia:source code|source code]] from [[Wikipedia:GitHub|GitHub]] and execute CMake. Eternity's source code repository, as well as the latest releases, are located [https://github.com/team-eternity/eternity/ here].

==Development builds==
Development builds ("beta" releases) for Eternity are available for Windows and macOS at [http://devbuilds.drdteam.org/eternity/ DRDTeam's website]. They are recommended if you encounter serious bugs with any of the official releases, or if you want to test brand new features that didn't exist in the latest official releases. Due to their beta status, they may be untested and have other problems. However, due to the sometimes sporadic release cycles, it's often recommended to just try the development builds. The only problem is that by upgrading Eternity often, savegames tend to become unusable, so exercise caution before upgrading Eternity if you rely on games with saves.

==System features==
*[[Cardboard engine]]
*[[List of command line parameters]]
*[[Console]]
*[[List of cheat codes]]
*[[GFS|GFS files]]
*[[ZIP|ZIP mods]]

==Gameplay and modding features==
*[[DeHackEd / BEX Reference]]
*[[List of codepointers]]
*[[EDF|EDF files]]
*[[Editing reference]]
*[[OPTIONS|OPTIONS lump]]
*[[MapInfo]]
*[[SMMU|Features inherited from SMMU]]
*[[ExtraData]]
*[[Hexen format SNDINFO]]

[[Category:Source ports]]

Main Page

2023-03-04T14:36:19Z

Bloodshedder: update links

__NOTOC__
==Welcome to the Eternity Engine Wiki==

The [[Eternity Engine]] [[Wikipedia:Wiki|Wiki]] is a community-maintained documentation resource for the Eternity Engine [[Doom Wiki:Source port|source port]] and everything related to it. It is powered by [[Wikipedia:MediaWiki|MediaWiki]]. Feel free to edit and create articles to help make this a valuable source of knowledge. If you're not familiar with wiki markup, [[Wikipedia:Help:Wikitext|look here]] for some examples.

==About Eternity==
See general info about the port in the [[Eternity Engine]] page.

==Level editing==
See [[Editing reference]] for the full documentation. Below are some of the more popular features:
*[[EMAPINFO|Map info (EMAPINFO lump)]]
:*[[UMAPINFO]]
*[[ACS scripting]]
:*[[ACS built-in functions]]
*[[UDMF]]
*[[ExtraData]]
*[[Linedef types|Classic linedef specials]]
*[[Detailed parameterized linedef specification|Parameterized linedef specials]]
*[[Linedef flags|New linedef flags in Eternity]]
*[[Thing types|New Eternity thing types]]

==Wad storage==
*[[ZIP|PKE files or directory structure]]

==Tutorials==
*[[Polyobject]]
*[[3DMidTex tutorial]]
*[[3DMidTex advanced topics]]
*[[Portals]]
*[[Linked portals]]

==Gameplay editing==
===Eternity definition files===
*[[EDF|Full EDF reference]]
*[[Thingtype]]
*[[Thing type flags]]
*[[Frame]]
*[[List of codepointers]]
*[[Sound]]
*[[OPTIONS]]
===Cross-port definition lumps===
*[[ANIMDEFS]]
*[[Dehacked]]
*[[S_SKIN]]
===Base game data===
*Frames.edf: [https://github.com/team-eternity/eternity/blob/master/base/doom/frames.edf list of Doom thing frames (states)]
*Things.edf: [https://github.com/team-eternity/eternity/blob/master/base/doom/things.edf list of Doom thing types (classes)]

==Console and command line==
*[[List of command line parameters]]
:*[[Environment variables]]
*[[Console]]
:*[[List of console commands and variables|Console commands and variables]]

==Inherited stuff==
*[[SMMU]]
*[[MBF]]
*[[Boom]]

==Eternity maps and mods==
*[[List of maps and mods made for Eternity]]

==Latest version==
The latest version of the Eternity Engine is currently {{Latest}}.
*[[Eternity_Engine#Releases|List of Eternity releases]]
*[https://devbuilds.drdteam.org/eternity/ Daily unofficial development builds.]

[[Category:Eternity Wiki]]

EMAPINFO

2023-03-04T14:19:51Z

Bloodshedder: test edit after mediawiki upgrade

The '''EMAPINFO''' lump customizes the properties of maps. It is the main Eternity lump for this purpose.
{{Backto|Eternity Engine}}
{{editref}}

==Usage==
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==
*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==
===Level identification===
{|class="wikitable sortable"
! 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 [[Parameterized_linedef_specials#Exits|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===
{|class="wikitable sortable"
! 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===
{|class="wikitable sortable"
! 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===
{|class="wikitable sortable"
! 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===
{|class="wikitable sortable"
! 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==
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 <tt>creator</tt> command is used in the console, output "DooMGuy667". The name in the brackets is the map the EMAPINFO 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.
==See also==
*[[UMAPINFO]]
[[Category:Editing]]

Console

2023-03-03T00:07:50Z

Bloodshedder: test edit after wikimedia upgrade

This reference contains information on useful console commands and variables that work with the Eternity console, as well as pointers on console command syntax.
{{backto|Eternity Engine}}
{{editref}}
==Notes on special command syntax==
Commands which take parameters may accept numbers, strings, or members of a predefined set of values.
ex:
$ delay 50
$ spawn 249 1
$ name Quasar
$ hu_overlay distributed
If string arguments contain whitespace, they must be in quotations. Quotations around strings are otherwise optional.
ex:
$ echo "This has to be in quotes"
$ i_error "R_FindVisplane: no more visplanes!"
Multiple commands can be run from one prompt by separating them with a semicolon.
ex:
$ delay; kill
Variables of type integer, named-value, on / off, and yes / no can be affected by the following operators:
*+
:Affixed to the end of the variable, it will increment it to the next valid value, but no higher than the maximum allowed.
ex:
$ screensize +

*-
:Affixed to the end of the variable, it will decrement it to the next lower valid value, but no lower than the minimum allowed.
ex:
$ screensize -

*/
:Toggles through the variable values from minimum to maximum, wrapping around to the minimum value again when it is maxed out. This is most useful with two-state yes/no and on/off variables.
ex:
$ hu_overlay /

==List of console commands and variables==
:''See [[List of console commands and variables]]''
[[Category:Console]]

List of console commands and variables

2019-07-03T10:05:53Z

Bloodshedder: Reverted edits by 118.148.240.226 (talk) to last revision by Printz

Console commands carry out a particular action when sent to the console.
:''Back to [[Console]]''

==Core commands==
*'''alias''' ''newcmdname'' ''command''
:'''alias''' alone will list all currently defined aliases. Providing ''newcmdname'' alone will remove that alias if it exists. Providing ''newcmdname'' and a valid console ''command'' will create "newcmdname" as an alias to that command, allowing shortcuts.
:In order to make an alias take parameters, use the special variable "%opt", as such:
alias "mycommand" "hu_overlay %opt"

*'''c_popup'''
:Instantly removes the console from view.

*'''cmdlist''' ''filter''
:Displays all user-visible console commands, one per line. As of Eternity Engine v3.31 Delta, this command accepts an optional ''filter'' parameter that, if provided, should consist of a single character between A and Z. The character will be used to filter the command list down to only commands beginning with that letter.

*'''cvarhelp''' ''variablename''
:Outputs a list of possible values for the given variable.

*'''delay''' ''amt''
:Delays the running of the next console command by either 1, or if provided, by ''amt'' game tics.

*'''dir'''
:Lists the contents of the current working directory to the console.

*'''echo''' ''msg''
:Echoes a string message to the console. As with all console strings, the string should be in quotes if it contains whitespace.

*'''flood'''
:Writes 300 garbage characters to the console. Usefulness is of debate.

*'''quote'''
:Currently does nothing.

===Logging the console===
*'''dumplog''' ''filename''
:Dumps the current state of the console message buffer to the specified file as ASCII text. The text will be appended to the file if it already exists, allowing multiple use of a single log file.

*'''openlog''' ''filename''
:Opens the specified file in append mode and begins writing any text printed to the console into the file. All console messages will be logged until either the '''closelog''' command is used, or the program closes. Note this log file is totally separate from any used with the "dumplog" command, which is simply for saving the current buffer. If a log file is already open, this command does nothing.

*'''closelog'''
:Closes a console log opened by the '''openlog''' command. If no logging is currently occuring, this command does nothing. This command doesn't apply to files used by '''dumplog''', as they are closed immediately, so it doesn't need to be used with the '''dumplog''' command.

==Menus==
====mn_clearmenus====

Deactivates any active menu and returns to the game

====mn_newgame====

Displays the New Game menu or takes the player to the start map, depending on their configuration.

====mn_quit====

Displays a prompt asking the user if they want to quit.

====mn_episode====

Displays the episode selection screen for Ultimate DOOM.

Flags: not in network games

====mn_prevmenu====

Returns user to the last menu they viewed, or to the game if the present menu is the highest-most in that chain.

====newgame====

Clears any active menus and starts a new game.

Flags: not in network games

====mn_weaponkeys====

Displays the weapon keybinding menu.

====mn_keybindings====

Displays primary keybindings menu.

====mn_demos====

Displays the Demos menu

Flags: not in a network game

====mn_weapons====

Displays the weapons preferences menu

====mn_loadwad====

Displays the wad/file options menu.

====mn_status====

Displays the status bar options menu.

====mn_hud====

Displays the heads-up display options menu.

====mn_mouse====

Displays the mouse options menu.

====mn_sound====

Displays the sound options menu.

====mn_vidmode====

Displays the video mode options menu.

====mn_particle====

Displays the particle effects options menu.

====mn_video====

Displays the video options menu.

====mn_endgame====

Prompts the user to end the current game and return to the title screen.

====mn_options====

Displays the main options menu.

====mn_savegame====

Displays the save game menu. Will not display if not in a level.

====mn_load slotnum====

Loads the save game from save slot slotnum.

====mn_loadgame====

Displays the load game menu.

====mn_player====

Displays the player setup menu.

====mn_envkeys====

Displays the environment keybindings menu.

====credits====

Displays game engine / game credits.

====help====

Displays built-in and user-provided help screens. See the BOOM editing reference on how to provide up to 99 custom help screens.

====mn_enemies====

Displays enemy AI options menu.

====mn_compat====

Displays the DOOM compatibility options menu.

====mn_automap====

Displays the automap options menu.

====quickload====

Quickloads a game from a previously chosen quicksave slot. NOTE: does nothing in network games or demos

====quicksave====

Quicksaves a game. First time command is used, a slot must be chosen normally. Subsequent uses will overwrite the save in that slot.

NOTE: does nothing in network games or demos

====mn_joymenu====

Brings up the SDL joystick configuration menu. NOTE: This command does not exist in the DOS version of Eternity.

====mn_hnewgame====

Brings up the Heretic new game menu.

====mn_hepis====

Brings up the Heretic episode selection menu.

====skinviewer====

Brings up the skin viewer menu widget.

====mn_dmflags====

Brings up the deathmatch flags configuration menu.

====mn_dynamenu menuname====

Brings up the EDF dynamic menu with the given mnemonic. If no such menu exists, an error message will appear in the console.

====mn_selectwad====

Brings up the wad selection dialog box. The selected wad cannot be loaded if the current gamemode is a shareware game. Flags: not in a netgame

====mn_search====

Begins or continues a menu search operation. This command uses the value of the "mn_searchstr" console variable to carry out its search.

====mn_menus====

Brings up the menu options menu.

==Keybindings==
*'''listactions'''

Displays a list of all bindable actions, aside from console commands.

*'''bind''' ''keyname'' ''actionname''

Binds the specified action to the specified key. actionname is a string and should be enclosed in quotes if it contains whitespace. actionname may specify any valid action or console command. If "actionname" is not provided, the current binding status of the specified key will be displayed.

*'''unbindall'''

Releases *all* dynamic keybindings. Use with caution!

*'''unbind''' ''keyname'' ''bindingclass''

Unbinds the specified key from any action, or from only the action in the specified class if the bindingclass parameter is specified. As of Eternity Engine v3.31 Delta, keys may have one binding from each separate binding class. Binding class numbers are displayed next to action names when using the "bind keyname" command.

*'''listkeys'''

Displays a list of all bindable key names. Not all bindable key codes correspond to pressable keys, however. Most pressable keys have obvious names which correspond to those on the keyboard.

*'''bindings'''

Dumps a list of all active keybindings to the console.

==Multiplayer==

*'''disconnect'''
:Disconnects from any ongoing network game and sets full-screen console mode.
:Flags: only in network games

*'''playerinfo'''
:Displays name information for all connected players.

*'''frags'''
:Displays the current frag count for all players.

*'''kick ''playernum''
:('''Currently disabled''') Kicks the player with the specified player number from the game. Player numbers can be retrieved with '''playerinfo'''.
:Flags: server-only

*'''say''' ''...''
:Sends all arguments as a single message to all players in a network game.
:Flags: net command

==Cheats==
====god====

Toggles god mode (IDDQD) on or off.

Flags: not in network games, only in levels

====noclip====

Toggles no clipping (IDCLIP) on or off.

Flags: not in network games, only in levels

====nuke====

Kills all enemies on the level, and if there are no enemies, kills all friends on the level (equivalent to KILLEM).

Flags: server-only, only in level, net command

====infammo====

Toggles infinite ammo (INFSHOTS) on or off.

Flags: not in network games, only in levels

====mdk====

Fires a tracer from the player that instantly kills any monster the player is targetting.

Flags: only in level, not in netgames, hidden

====mdkbomb====

As above, but fires 60 such tracers in a circle around the player.

Flags: only in level, not in network games, hidden

====spacejump====

Allows the player to jump any number of times in midair; useful for testing linked portals.

Flags: only in level, not in network games, hidden

====viles ====

A special command for DOOM II only. Try it and see what happens :)

Flags: only in level, not in network games, hidden

====vilehit====

If the player is autoaiming at an enemy, the player will perform an Arch-vile attack on that enemy.

Flags: only in level, not in network games

====banish====

If the player is autoaiming at an enemy, the enemy will be removed from the play simulation and its memory will be freed once no other objects reference it.

Flags: only in level, not in network games

==Video Options==
====v_modelist====

Prints a list of available video modes to the console.

====animshot numframes====

Takes the given number of consecutive screenshots for the purpose of making a crude animation. Would be useful for animated GIFs or AVI movies. This command will make the game run very slow, however, and will eat up disk space quickly, so use it with care.

====screenshot====

Takes a single screenshot. Bind this command to a key in order to take a shot without the console in the way.

==Sound Options==
====s_playmusic name====

Plays the given lump as music, if that lump can be found in the music hash table. Only lumps listed in the internal music table, or new lumps with names beginning with "D_" in DOOM or "MUS_" in Heretic are available.

==Player Options==
====listskins====

Lists names of all available player skins.

====listwads====

Lists all currently loaded WAD files.

==Demos==
These commands are related to playing / recording demos. For all of these commands, the demo specified by demoname must have been added in either a WAD or on the command-line with the -file option. Demos cannot be played directly from a file name.

====timedemo demoname showmenu====

Starts the given demo as a time demo, in which the framerate of the game can be measured. If showmenu is set to 1, a meter comparing the framerate against that of a "fast" machine will be displayed after the demo is complete. Otherwise, the framerate will be printed to the console as a number.

Flags: not in a network game

====playdemo demoname====

Plays the given demo normally.

Flags: not in a network game

====stopdemo====

Stops any currently playing demo and drops to console.

Flags: not in a network game

==Gameplay==
====pause====

Pauses or unpauses the game.

Flags: server-only

====i_error ...====

Simulates an internal game engine error. Prints any arguments provided as a single string when the game exits.

====spawn objecttype <friend>====

Spawns a map object of the given internal type (DeHackEd number minus 1) in front of the player. If friend is provided and is a non-zero number, the object will be friendly. This command is for developers.

Flags: not in a network game, only in levels, hidden

====endgame====

Drops to console mode.

Flags: not in a network game

====starttitle====

Returns the game to the title screen / demo / credits loop.

Flags: not in a network game

====quit====

Plays a random monster sound and exits the game normally, with no prompt.

====map mapname====

Transfers game play to the given map. mapname may be the name of a WAD file to load, as well as the name of a map header itself.
Examples:
map E1M1
map w00t.wad

Flags: server-only, net command, buffered command

====kill====

Causes the player to commit suiceide.

Flags: only in level, net command

====addfile wadfilename====

Adds the specified wad file at run-time. Some features will not function completely as expected when WADs are loaded at run-time, so for maximum compatibility always use the command line to load files.

Flags: not in network games, buffered command

====exitlevel====

Exits the current level. Starting with EE v3.31 beta 1, this command will not allow an exit if the player is dead unless the comp_zombie variable is set to allow zombie exits.

Flags: only in level, server-only, net command, buffered command

====defdmflags <mode>====

Sets the deathmatch flags variable to its default settings. If no argument is provided, dmflags is set to the default for the current game type. Otherwise, the "mode" parameter indicates what game mode's defaults to set, with the following values:

0 = Single-player mode
1 = Cooperative mode
2 = Deathmatch mode
3 = Altdeath mode (deathmatch 2.0, items respawn)
4 = Trideath mode (DM 3, barrels respawn, players drop backpacks)

Flags: server-only, net command

====summon thingtypename <flagslist> <mode>====

Allows spawning of things via their EDF thing type name. An EDF/BEX flag list can optionally be provided, with the flags separated by commas only. By default, this will cause the listed flags to be added to the thing along with its normal flags. By specifying the third parameter as "set" or "remove", it is possible to set the thing's flags value to only the listed flags, or to remove the listed flags if the thingtype has them set by default.

Example to spawn a friendly thing:
$ summon doomimp friend

Flags: not in a network game, only in levels, hidden

====give thingtypename <num>====

Spawns 1, or "num" if provided, of the object with this EDF thing type name on the player and causes the player to collect it/them. If the requested thing type is not collectable, it will not be spawned. In addition, if a collectable item is not picked up by the player, it will be removed immediately.

Flags: not in a network game, only in levels, hidden

====whistle thingtypename====

If there is a live, friendly thing of the given EDF type, the first such thing found on the map will be teleported in front of the player. If the thing doesn't fit where the player is trying to teleport it, it will not be teleported. It will also not be teleported across blocking lines.

Flags: not in a network game, only in levels

====p_linespec name <arg> <arg> <arg> <arg> <arg>====

Executes the named Eternity Engine parameterized line special with the given parameters. The line special is restricted to behaving as though it has been invoked without any linedef to reference, and thus certain effects such as sector special transfers will not occur even if specified by the special type or arguments.

Flags: not in a network game, only in levels.

==Mod information==
*'''e_dumpitemeffect''' ''mnemonic''
:Displays the properties of an item effect metatable.

*'''e_dumpitems'''
:Lists all EDF thing type mnemonics and DeHackEd/DoomEd numbers for thing types which are collectable items. Useful in conjunction with the give command.

*'''e_dumpmeta''' ''mnemonic''
:Displays the properties stored in the metatable for the given thingtype.

*'''e_dumpstate''' ''mnemonic''
:Displays information on one EDF state definition.

*'''e_dumpthings'''
:Lists all EDF thing type mnemonics along with the DeHackEd numbers and doomednums of the corresponding types.

*'''e_linedef''' ''recordnum''
:Lists verbose information on an ExtraData linedef record with the given numeric record number. If no such linedef is defined or no ExtraData exists for the current map, an appropriate error message will be given.

*'''e_listkeyitems'''
:Lists all key-type artifact definitions.

*'''e_listlinedefs'''
:Lists all linedef definitions from the current map's ExtraData. If no linedefs are defined or no ExtraData exists for the current map, an appropriate error message will be given.

*'''e_listmapthings'''
:Lists all mapthing definitions from the current map's [[ExtraData]]. If no mapthings are defined or no [[ExtraData]] exists for the current map, an appropriate error message will be given.

*'''e_mapthing''' ''recordnum''
:Lists verbose information on an ExtraData mapthing record with the given numeric record number. If no such mapthing is defined or no ExtraData exists for the current map, an appropriate error message will be given.

*'''e_playsound''' ''name''
:Plays an EDF sound.

*'''e_thingtype''' ''thingtypename''
:Lists verbose information on an EDF thingtype with the given mnemonic. If no such thingtype is defined, an error message will be given.
===Others===
*'''ev_mapsectorspecs'''
:List out all the sector specials in use on the current map.

*'''ev_mapspecials'''
:Lists all linedef specials in current map.

[[category:console]]

Main Page

2018-10-27T14:11:14Z

Bloodshedder: switch to php 7.2 test edit

Eternity Engine

2017-09-01T02:26:03Z

Bloodshedder: Reverted edits by 178.137.83.166 (talk) to last revision by Printz

The Eternity Engine is [[Team Eternity]]'s advanced [[Doom Wiki:Doom|Doom]] [[Doom Wiki:Source port|source port]] and the primary subject of this Wiki.

==History==
The Eternity Engine began in 1998 as a simple modification of [[Doom Wiki:Boom|Boom]] meant to power Eternity TC, which was at that time a new and active project. When [[Doom Wiki:Lee Killough|Lee Killough]] began the [[MBF]] project, [[James "Quasar" Haley]] became a beta tester after emailing Lee with questions about the early Doom alpha versions. The Eternity project moved to an MBF code base after that port's first release.

In late 1999, [[Doom Wiki:Simon "Fraggle" Howard|Fraggle]] released v3.10 of his MBF-based source port [[SMMU]], which contained support for the new [[FraggleScript]] scripting language. Although activity in the Eternity TC project by editors had steadily dropped to almost nothing, Quasar was still interested in developing the code associated with it. Needing features such as scripting and the [[console]], he then moved the Eternity project's code into SMMU.

Despite this long history of jumping between Boom-based ports, no public release of Eternity based on any port other than SMMU was ever made. The first private alpha, released to a select few beta testers, was derived from SMMU 3.21 with selected modifications from 3.30. Because of this, Eternity began at version 3.29.

After the release of the [[Caverns of Darkness]] project, which used a customized version of Eternity Engine v3.29 Development Beta 5, the project began to attract more attention. A second programmer, [[Steven "SoM" McGranahan]], joined the project and immediately set to work porting the code to use [[Wikipedia:Simple_DirectMedia_Layer|SDL]], making it capable of running on many operating systems, including [[Wikipedia:Microsoft Windows|Windows]].

Now it has [[Universal Doom Map Format|UDMF]] support. Current major goals for the engine include completing support for [[Doom Wiki:Heretic|Heretic]], a dynamic weapon and inventory system.

==Major Features==

===Cardboard engine===
[[Cardboard]] is a floating-point rendering engine created by [[SoM]] that fixes several problems inherent with the classic fixed-point Doom rendering engine.

===EDF===
[[EDF]], which stands for Eternity Definition Files, is a textual input language that allows specification of almost all the static game data which was once contained inside the executable. This includes thing types, frames, sprites, terrain definitions, and more. EDF has a relaxed [[Wikipedia:C programming language|C]]-like syntax and can be used from both files and [[WAD]] lumps.

===ExtraData===
[[ExtraData]] is another EDF-like data specification language that allows the Doom map format to be extended with any kind of data. Use of special thing, line, and sector types within a map allows the editor to attach ExtraData records to those objects. Special data for the objects is then given inside the script.

===Linked portals===
[[Linked portals]] are surfaces that, like regular [[portals]], connect different areas of the map, but in addition can be walked through, thus allowing multistory maps to be designed in Doom.

===[[MapInfo]]===
Eternity expands SMMU's level info system significantly, allowing dozens of new properties to be specified, and allowing cascading global EMAPINFO lumps as an alternative to inserting MapInfo data into level headers. Among other things, MapInfo is used to tie ExtraData and ACS scripts to the maps that use them.

==Releases==
A complete listing of Eternity's release history follows.

===Version 3.29===
* 3.29 Private Alpha - September 14, 2000
* 3.29 Public Beta 1 - January 8, 2001
* 3.29 Public Beta 2 - January 9, 2001
* 3.29 Public Beta 3 - May 10, 2001
* 3.29 Public Beta 4 - June 30, 2001
* 3.29 Development Beta 5 - October 2, 2001
* 3.29 "Gamma" - July 4, 2002

===Version 3.31===
* 3.31 Public Beta 1 - September 11, 2002
* 3.31 Public Beta 2 - March 5, 2003
* 3.31 Public Beta 3 - August 8, 2003
* 3.31 Public Beta 4 - November 29, 2003
* 3.31 Public Beta 5 - December 17, 2003
* 3.31 Public Beta 6 - February 29, 2004
* 3.31 Public Beta 7 - April 11, 2004
* 3.31 "Delta" Pre-Release Alpha 1 - August 23, 2004
* 3.31 "Delta" Pre-Release Alpha 2 - November 11, 2004
* 3.31.10 "Delta" - January 19, 2005

===Version 3.33===
* 3.33.00 "Genesis" - May 26, 2005
* 3.33.01 "Outcast" - June 24, 2005
* 3.33.02 "Warrior" - October 1, 2005
* 3.33.33 "Paladin" - May 17, 2006
* 3.33.50 "Phoenix" - October 23, 2006

===Version 3.35===
* [http://www.doomworld.com/vb/eternity/45146-eternity-engine-v3-35-90-simorgh/ 3.35.90] "Simorgh" - January 11, 2009
* [http://www.doomworld.com/vb/eternity/45757-eternity-engine-3-35-92-nekhbet/ 3.35.92] "Nekhbet" - March 22, 2009

===Version 3.37===
* [http://www.doomworld.com/vb/eternity/49268-eternity-engine-3-37-00-sekhmet/ 3.37.00] "Sekhmet" - January 1, 2010

===Version 3.39===
* [http://www.doomworld.com/vb/eternity/52873-eternity-engine-v3-39-20-resheph/ 3.39.20] "Resheph" - October 10, 2010

===Version 3.40===
* [http://www.doomworld.com/vb/eternity/53944-eternity-engine-v3-40-00-rebirth/ 3.40.00] "Rebirth" - January 8, 2011
* [http://www.doomworld.com/vb/eternity/55219-announcing-the-blue-box-ee-3-40-11-and-vaporware-demo/ 3.40.11] "Aasgard" - May 2, 2011
* [http://www.doomworld.com/vb/eternity/55874-eternity-engine-3-40-15-wodanaz/ 3.40.15] "Wodanaz" - June 22, 2011
* [http://www.doomworld.com/vb/eternity/58281-eternity-engine-v3-40-20-mjolnir/ 3.40.20] "Mjolnir" - December 26, 2011
* [http://www.doomworld.com/vb/eternity/61245-eternity-engine-3-40-25-midgard/ 3.40.25] "Midgard" - August 27, 2012
* [http://www.doomworld.com/vb/eternity/62087-eternity-engine-3-40-30-alfheim/ 3.40.30] "Alfheim" - November 4, 2012
* [http://www.doomworld.com/vb/eternity/64382-eternity-engine-3-40-37-gungnir/ 3.40.37] "Gungnir" - May 27, 2013
* [http://www.doomworld.com/vb/eternity/67069-eternity-engine-3-40-46-bifrost/ 3.40.46] "Bifröst" - January 19, 2014
===Version 3.42===
* [https://www.doomworld.com/forum/topic/94046-eternity-engine-34202-heimdal-files-documentation-buglist/ 3.42.02] "Heimdal" - May 7, 2017
* {{Latest}} "Heimdal" release 2 - August 2, 2017

==Cross-platform==
Eternity can be compiled on other operating systems than Windows by using the CMake utility. You can download the source code and execute CMake on its top-level folder.

==Development builds==
SVN builds ("beta" releases) for Eternity are available for Windows and OS X at [http://devbuilds.drdteam.org/eternity/ DRDTeam's website]. They are recommended if you encounter serious bugs with any of the official releases, or if you want to test brand new features that didn't exist in the latest official releases. Due to their beta status, they may be untested and have other problems.

==System features==
*[[Cardboard engine]]
*[[List of command line parameters]]
*[[Console]]
*[[List of cheat codes]]
*[[GFS|GFS files]]
*[[ZIP|ZIP mods]]

==Gameplay and modding features==
*[[DeHackEd / BEX Reference]]
*[[List of codepointers]]
*[[EDF|EDF files]]
*[[Editing reference]]
*[[OPTIONS|OPTIONS lump]]
*[[MapInfo]]
*[[SMMU|Features inherited from SMMU]]
*[[ExtraData]]
*[[Hexen format SNDINFO]]

[[Category:Source ports]]

Talk:List of codepointers

2016-05-25T04:10:02Z

Bloodshedder: Reverted edits by 46.39.231.76 (talk) to last revision by Bloodshedder

I noticed some codepointers, mainly the ones with parameters, have been documented here with type specifiers in them (int, float, string...). While I know they're there for information purposes, do they actually have this form in the source? Normally all misc1, misc2 and args[] are of type int in the source, so this type naming I think it's pseudocode at most.--[[User:Printz|Printz]] 05:57, 29 May 2009 (EDT)

Cardboard engine

2016-05-25T04:09:44Z

Bloodshedder: Reverted edits by 46.39.231.76 (talk) to last revision by Bloodshedder

'''Cardboard''' is the floating-point renderer which debuted in version 3.35.90 of the [[Eternity Engine]]. Cardboard was created by programmer '''Stephen "[[SoM]]" McGranahan''' to address deep-seated problems inherent in the Doom engine's method of projecting and rendering lines and flats.

Advantages of the Cardboard renderer include greatly improved behavior of anisotropic two-sided lines, giving a clean-scaled appearance to textures even when the camera is looking down a line that it is practically on, and even when mlook is engaged to the minimum or maximum of its vertical range. Long wall error is reduced, allowing maps to contain much longer linedefs without numeric instability causing the walls to appear to "wobble". Behavior of the engine with respect to extreme height differences is also improved, retaining earlier repairs of crashes and eliminating most remaining rendering glitches associated with tall areas. Rendering of flats is now pixel-perfect in most circumstances.

Cardboard also includes optimizations. Flat drawing has been sped up significantly, and two-sided lines have also been improved via tweaks to the main seg-drawing loop and the ability to treat closed lines as one-sided for rendering purposes.

Unlike previous attempts by the Boom team and other source ports, Cardboard manages to allow the game engine to retain full compatibility by creating an optimum interface between fixed-point level geometry and the floating-point renderer. For example, floating-point vertex coordinates and sector heights are cached on a per-frame basis, minimizing integer-to-float conversions. As a result, frame rates under Cardboard are in most cases superior to the original renderer.

Cardboard includes some qualities which will improve the ability to later add true color support. It was originally developed outside of the Eternity Engine as a stand-alone program which could draw Doom textures and flats in 32-bit color with dynamically calculated light fading.
{{backto|Eternity Engine}}

==Enhancements provided==
* 2S lines remain firmly in place even when the player is directly above them and between the two vertices. No more "wobbly" lines.
* Long wall error is drastically reduced.
* 2S line texturing remains stable even with the player's view point inside the texture.
* Artificial limitations on area height are completely removed.
* Flat rendering accuracy is greatly improved; visplanes no longer dance when light levels change, and flats line up perfectly with wall textures.
* No more "sparklies" at the bottom of line textures.
* Speed improvements.

Talk:List of codepointers

2016-04-25T04:05:55Z

Bloodshedder: Reverted edits by 46.39.231.84 (talk) to last revision by Bloodshedder

Cardboard engine

2016-04-25T04:04:05Z

Bloodshedder: Reverted edits by 46.39.231.84 (talk) to last revision by Printz

Talk:List of codepointers

2016-04-11T07:43:44Z

Bloodshedder: Reverted edits by 46.39.231.54 (talk) to last revision by Bloodshedder

EDF thing reference

2015-12-23T17:38:17Z

Bloodshedder:

Thing types define monsters, lamps, control points, items, etc -- anything that moves, occupies space, can display a sprite, or is useful for singling out locations. Things have unique names, or mnemonics, for easy identification. They're referenced in several places by their name, such as the console command ''Summon'', or [[List of codepointers|action functions]] dealing with spawning things (such as [[Spawn]] or [[MissileAttack]]).

If a thing type's mnemonic is not unique, the latest definition of a thing type with that mnemonic replaces any earlier ones. Like most other identifiers in EDF (but not lump names or subnames), thing type mnemonics are completely case-insensitive.

New objects, created via EDF files or wad lumps, can be later tweaked with Dehacked (BEX) patches, if they're given a unique '''dehackednum''' entry. For forward compatibility, the '''dehackednum''' has to be greater than or equal to 10000.

For placing the thing on the map, an integer field called '''doomednum''' must be specified. For forward compatibility it has to be greater than or equal to 20000 or in the 3000-3999 range. Due to how binary WAD files format their THINGS lumps, '''doomednum''' values have to be less than 32767, though textmode representations such as [[ExtraData]] or UDMF solve this limit.

{{See|Thing type flags}}
{{Backto|EDF}}

==Eternity Alfheim syntax==
For versions of Eternity from Alfheim up, EDF thingtypes support the following syntax. Make sure to add:
setdialect("ALFHEIM")
before using this syntax:
thingtype <unique name> : <inherited thingtype>, <doomednum>, <dehackednum>
{
<other attributes>
}
===Header properties===
* ''<inherited thingtype>'' must be a value, even if the thingtype doesn't inherit from anything else. In that case, it must be '''Mobj''', which is a placeholder value belonging to no real thingtype.
* ''<doomednum>'' and ''<dehackednum>'' can be -1 if not used. If both are -1, they can be omitted, leaving just this:
thingtype <unique name> : <inherited thingtype> {<attributes>}
* If header properties are used, the pre-Alfheim '''inherits''', '''doomednum''' and '''dehackednum''' attributes are not used.

==Syntax==
thingtype <unique name> [: <parent type> [, <doomednum> [, <dehackednum>]]]
{
doomednum <number>
dehackednum <unique number>
inherits <thingtype>
basictype <basic type qualifier>

spawnstate <frame>
seestate <frame>
painstate <frame>
dmg_painstates {<damage type>, <frame>, ...}
dmg_painstates.add {<damage type>, <frame>, ...}
dmg_painstates.remove {<damage type>, ...}
meleestate <frame>
missilestate <frame>
deathstate <frame>
dmg_deathstates {<damage type>, <frame>, ...}
dmg_deathstates.add {<damage type>, <frame>, ...}
dmg_deathstates.remove {<damage type>, ...}
xdeathstate <frame>
raisestate <frame>
crashstate <frame>
activestate <frame>
inactivestate <frame>

seesound <sound>
attacksound <sound>
painsound <sound>
deathsound <sound>
activesound <sound>
activatesound <sound>
deactivatesound <sound>

spawnhealth <number>
gibhealth <number>
reactiontime <number>
painchance <number>
speed <number OR floating-point number>
fastspeed <number OR floating-point number>
radius <floating-point number>
height <floating-point number>
correct_height <floating-point number>
mass <number>
respawntime <number>
respawnchance <number>

damage <number>
dmgspecial <dmgspecial name>
aimshift <number>

damagefactor <damage type>, <floating point number>
damagefactor <damage type>, <floating point number>
...

topdamage <number>
topdamagemask <number>
mod <MOD name OR number>
obituary_normal <string>
obituary_melee <string>

bloodcolor <number>
nukespecial <BEX codepointer mnemonic>
droptype <thing type mnemonic>

cleardropitems
dropitem <type>, [, <chance> [, <amount> [, <toss>]]]
dropitem.remove <type>
collectionspawn <thingtype> [, <spchance> [, <coopchance> [, <dmchance>]]]
itemrespawnat <thingtype>

cflags <flag list>
addflags <flag list>
remflags <flag list>
flags <flag list>
flags2 <flag list>
flags3 <flag list>
flags4 <flag list>
particlefx <particle effect flag list>

translucency <number OR percentage>
translation <number OR translation table lump name>
skinsprite <sprite>
defaultsprite <sprite>
alphavelocity <floating-point number>
xscale <floating-point number>
yscale <floating-point number>

acs_spawndata {num <number> modes <mnemonic>}

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''doomednum'''
:Default = -1
:The identification number, which makes this actor type placeable in maps. Zombieman monsters for example have '''doomednum''' 3004. Objects which don't need to be placed on the map can have '''doomednum''' -1. For EDF, recommended numbers are in the ranges 3000-3999 and 20000 up. Other numbers may be used by future versions of Eternity, so they're not safe to use.
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the thing type from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.
*'''basictype'''
:Default = (nothing)
:'''Basictype''' is a list of common flags used in Doom and derived games. Using '''basictype''' instead of setting individual flags is encouraged, in order to keep up with Eternity engine updates. Other flags may be subsequently added or removed with '''addflags''' or '''remflags'''. See the [[Thing type flags]] page for a full list. The '''basictype''' mnemonics follow:
:*''Monster''
::An ordinary walking monster with no fancy features.
::'''cflags''' "SOLID+SHOOTABLE+COUNTKILL+FOOTCLIP+SPACMONSTER+PASSMOBJ"

:*''FlyingMonster''
::An ordinary flying monster.
::'''cflags''' "SOLID+SHOOTABLE+COUNTKILL+NOGRAVITY+FLOAT+SPACMONSTER+PASSMOBJ"

:*''FriendlyHelper''
::A player helper with maximum friendliness options.
::'''cflags''' "SOLID+SHOOTABLE+COUNTKILL+FRIEND+JUMPDOWN+FOOTCLIP+WINDTHRUST+SUPERFRIEND+SPACMONSTER+PASSMOBJ"

:*''Projectile''
::A standard projectile.
::'''cflags''' "NOBLOCKMAP+NOGRAVITY+DROPOFF+MISSILE+NOCROSS"

:*''PlayerProjectile''
::A projectile for use by players.
::'''cflags''' "NOBLOCKMAP+NOGRAVITY+DROPOFF+MISSILE+NOCROSS+SPACMISSILE"

:*''Seeker''
::A missile prepared to be fired by homing missile codepointers.
::'''cflags''' "NOBLOCKMAP+NOGRAVITY+DROPOFF+MISSILE+NOCROSS+SEEKERMISSILE"

:*''SolidDecor''
::A solid decorative item.
::'''cflags''' SOLID

:*''HangingDecor''
::A hanging decorative item that is passable even without 3D object clipping.
::'''cflags''' "SPAWNCEILING+NOGRAVITY"

:*''SolidHangingDecor''
::A solid hanging decorative item.
::'''cflags''' "SOLID+SPAWNCEILING+NOGRAVITY"

:*''ShootableDecor''
::A shootable decorative item.
::'''cflags''' "SOLID+SHOOTABLE+NOBLOOD"

:*''Fog''
::A fog item such as telefog or item fog.
::'''cflags''' "NOBLOCKMAP+NOGRAVITY+TRANSLUCENT+NOSPLASH"

:*''Item''
::A collectable item. Doesn't count towards the item score.
::'''cflags''' SPECIAL

:*''ItemCount''
::A collectable item. Counts for item score.
::'''cflags''' "SPECIAL+COUNTITEM"

:*''TerrainBase''
::A TerrainTypes base item.
::'''cflags''' "NOBLOCKMAP+NOGRAVITY+NOSPLASH"

:*''TerrainChunk''
::A TerrainTypes chunk item.
::'''cflags''' "NOBLOCKMAP+DROPOFF+MISSILE+LOGRAV+NOSPLASH+NOCROSS+CANNOTPUSH"

:*''ControlPoint''
::An inert control point.
::'''cflags''' "NOBLOCKMAP+NOSECTOR+NOGRAVITY"
::'''spawnstate''' S_TNT1

:*''ControlPointGrav''
::An control point that is subject to gravity. Because of this, it's not considered inert.
::'''cflags''' "DONTDRAW+NOSPLASH"
::'''spawnstate''' S_TNT1

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this thing accessible from other thing types. Default games' (Doom, Heretic) thing types use externalized frames for all thing types, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other thingtypes, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an imp-like monster (the '=' sign is optional):
states =
@"
Spawn:
TROO AB 10 A_Look
loop
See:
TROO AABBCCDD 3 A_Chase
loop
Pain:
TROO H 2
TROO H 2 A_Pain
goto See
Melee:
Missile:
TROO EF 8 A_FaceTarget
TROO G 6 A_TroopAttack
goto See
Death:
TROO I 8
TROO J 8 A_Scream
TROO K 6
TROO L 6 A_Fall
TROO M -1
stop
XDeath:
TROO N 5
TROO O 5 A_XScream
TROO P 5
TROO Q 5 A_Fall
TROO RST 5
TROO U -1
stop
Raise:
TROO ML 8
TROO KJI 6
goto See
"@
*'''spawnstate'''
:Default = S_NULL
:Sets the frame which a thing starts in when it is spawned. Monsters generally use this frame to stand still and look for targets. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''spawnstate''' at S_NULL.
*'''seestate'''
:Default = S_NULL
:Sets the frame which a monster will jump to when it sees or hears a target during a [[Look]] (monster standing unawakened) check. If an object is alive and has a seestate, it is considered ''sentient'' by certain game mechanics.
*'''painstate'''
:Default = S_NULL
:Sets the frame a thing may randomly enter when it has been injured. If set to S_NULL, the creature will be removed instantly from the game if the random check succeeds.
*'''dmg_painstates'''
:Default = (nothing)
:This is a list of one or more damagetype/frame pairs, enclosed in braces. For example:
dmg_painstates
{
Fire, S_HPLAY_FPAIN1,
Lava, S_HPLAY_LPAIN1
}
makes the actor go to frame S_HPLAY_FPAIN1 when damaged by fire, or to S_HPLAY_LPAIN1 when harmed by lava. It defaults to its '''painstate''' if the damage is of another nature. The damage type of an actor is set up through the '''mod''' field.
*'''dmg_painstates.add'''
*'''dmg_painstates.remove'''
:Can be used for derived actor types, who can have more or fewer specialized pain states than their ancestors. ''Dmg_painstates.add'' has the same format as ''dmg_painstates'', but ''dmg_painstates.remove'' only lists the damagetypes. For example:
dmg_painstates.remove
{
Fire, lava
}
makes them get hurt normally from fire or lava, without going to special pain states.
*'''meleestate'''
:Default = S_NULL
:If this frame is not S_NULL, monsters will have a slightly lower range attack probability and when they are within about 64 units of their target, they will enter this frame to perform a melee attack.
*'''missilestate'''
:Default = S_NULL
:If this frame is not S_NULL, monsters chasing a target will randomly enter it to perform a missile attack.
*'''deathstate'''
:Default = S_NULL
:When a thing dies normally, it will enter this state. If the state is S_NULL, the thing will disappear forever.
*'''dmg_deathstates'''
*'''dmg_deathstates.add'''
*'''dmg_deathstates.remove'''
:Defaults = (nothing)
:These three properties work similar to ''dmg_painstates*'', in that they allow the object to enter special frames depending on the damage type suffered, but if they die. The formats are the same.
*'''xdeathstate'''
:Default = S_NULL
:If a thing dies by taking enough damage that its health is equal to its negated spawnhealth value (or negated 0.5 spawnhealth value in Heretic), it will enter this frame instead of its deathstate. If this frame is S_NULL, the thing will always die normally.
*'''raisestate'''
:Default = S_NULL
:If this frame is not S_NULL, a creature running [[VileChase]] codepointers can perform a resurrection on this actor. When this occurs, the actor will enter this frame along with being restored.
*'''crashstate'''
:Default = S_NULL
:When a thing with this state dies and then subsequently hits the ground, it will enter this state. If this state S_NULL, it is not used.
*'''activestate'''
:Default = S_NULL
:State to enter when triggered by the '''Thing_Activate''' parameterized special.
*'''inactivestate'''
:Default = S_NULL
:State to enter when triggered by the '''Thing_Deactivate''' parameterized special.

====Sounds====
*'''seesound'''
:Default = none
:Sets the sound that a monster will play when it awakens. This sound is also played by missiles when they are shot. (Note: "none" is a special mnemonic for no sound)
*'''attacksound'''
:Default = none
:Sets a sound used by some monster attacks, including the Lost Soul's charge, or melee attacks.
*'''painsound'''
:Default = none
:Sets the sound played by the Pain codepointer when this thing uses it.
*'''deathsound'''
:Default = none
:Sound played by the Scream codepointer. Used to play monster death sounds.
*'''activesound'''
:Default = none
:Sets the sound used by a thing when it is wandering around. A thing is given a 3 out of 256 chance (1.17%) of making this sound every time it calls the Chase codepointer. There are some new flags3 flags which can alter the behavior of this sound.
*'''activatesound'''
:Default = none
:Sound to play when triggered by the '''Thing_Activate''' parameterized special.
*'''deactivatesound'''
:Default = none
:Sound to play when triggered by the '''Thing_Deactivate''' parameterized special.
====Basic Stats====
*'''spawnhealth'''
:Default = 1000
:Sets a thing's maximum amount of life.
*'''gibhealth''' ''number''
:gibhealth overrides the gamemode default behavior for determining the negative amount of health at which a thing uses its "extreme" death state rather than its normal one. This is ordinarily defined in terms of the spawnhealth (Doom and Strife thingtypes gib at -spawnhealth; Heretic and Hexen thingtypes gib at -(spawnhealth/2).
:If an inheriting thingtype changes its spawnhealth, it will "lose" the inherited definition of gibhealth from its parent. If changing spawnhealth when inheriting from a thingtype that customizes gibhealth, be sure to re-customize the gibhealth in the inheriting thingtype.
*'''reactiontime'''
:Default = 8
:Sets an amount of time that a thing must wait under certain circumstances. Monsters use this value as a means to control their rate of attack. This value is also used as an internal field for varying purposes, but those uses are not editable.
*'''painchance'''
:Default = 0
:Sets the chance out of 255 that this thing will enter its painstate when it is injured. A thing with 0 painchance will never feel pain, whereas a thing with 255 painchance will always feel pain. If a thing has a painchance greater than zero, it should have a valid painstate, otherwise it will disappear forever.
*'''speed'''
:Default = 0
:Value used by monsters as a movement delta per walking frame. The monster will move by an amount relative to this value each time it uses the Chase codepointer. For missiles, this value is a fixed-point number (multiplied by 65536), and represents a constant speed by which the missile advances every game tic. Missile speed is not affected by the missile frame durations, whereas monster walking speed is.
:This field also supports floating-point values. When a floating-point value is provided, it will be translated into the corresponding fixed-point value. This means that a value of 10.0 is equivalent to the integer value 655360 (10*65536). It is NOT equivalent to 10. This distinction is very important. Small integer speed values are appropriate for monsters, whereas floating-point values will be suitable only for missiles.
*'''fastspeed'''
:Default = 0
:When the game is switched into Nightmare difficulty or -fast mode is active, all thing types with a non-zero fastspeed will have their speed fields changed to their fastspeed value. This enables editing of the -fast speed of projectiles and monsters. For detailed information on speed, see the speed field itself above. Note: as of EDF 1.2, this field also supports floating-point numbers, with the same meaning as that for the speed field.
*'''radius'''
:Default = 20.0
:Floating-point value that represents the radius of this thing type. A thing can fit into corridors which are at least as wide as this value times two, plus one unit (ie a thing with radius 32 can fit into a 65-wide hallway). The maximum value this field *should* have is 64.0 units. However, the game breaks its own rule here, giving several monsters radii up to 128 units. These monsters, which include the Mancubus, Arachnotron, and Spider Demon, exhibit clipping errors which enable other things to walk into them, and which can cause some moving sectors to malfunction. Avoid giving things radii larger than 64.0 to remain absolutely safe.
*'''height'''
:Default = 16.0
:Floating-point value that represents the height of this thing type. A thing can fit into areas which are of this exact height or taller. Note that in DOOM, this value is only used to see where a monster can fit relative to walls and floor/ceiling heights. For purposes of clipping against other things, monsters were considered to be infinitely tall. However, Eternity's extended 3D object clipping enables this field to also be used to allow or disallow things to pass over, under, or stand on this thing.
*'''correct_height'''
:Default = 0.0
:Floating-point value that represents a height for this thing type which is corrected for 3D object clipping. When 3D object clipping is enabled and the comp_theights variable is set to off, objects which have a non-zero correct_height field will begin to use this value for their height instead of the normal height field. If an object has the 3DDECORATION flags3 bit set, it will still clip missiles at its original height instead of at this value, so that playability of old maps is not altered. This field will generally only be necessary for old DOOM objects, which have now been assigned correct_height values in the default things.edf module. Use for new objects is discouraged; instead, set the height field above to the proper value.
*'''mass'''
:Default = 100
:Normal integer value that serves as a mass factor for this object. Mass affects the amount of thrust an object is given when it is damaged, the amount of effect an archvile's attack can have on it, and for bouncing objects, the rate at which they fall. Objects with a mass less than 10 will cause small terrain hits when landing on terrain that supports small splashes.
*'''respawntime'''
:Default = 420
:Sets the number of gametics before the monster may respawn. A tic is 1/35 of a second.
*'''respawnchance'''
:Default = 4
:Sets the chance out of 255 that the monster may respawn after respawntime has passed. The check is done for each tic that the monster isn't blocked.
====Damage Properties====
*'''damage'''
:Default = 0
:This number is used as a damage multiplier when a [[Thing type flags|MISSILE]] or SKULLFLY actor hits a SHOOTABLE. The damage formula used for impact damage is:
((rnd % 8) + 1) * damage
:This field is also used as a parameter by some parameterized codepointers, including [[Scratch]], [[BetaSkullAttack]] and [[Detonate]].
*'''dmgspecial'''
:Default = "none"
:The dmgspecial field allows specification of a special action that will be taken when this object is involved in damaging another object as the inflictor (an inflictor is the object actually doing the damage, and not necessarily the object that is blamed for the damage). Supported values and their meanings are as follows:
:*''none''
::This is the default value. No special action is taken; the object is normal when damaging other things.

:*''MinotaurCharge''
::If the thing is flying like a skull (has flags bit SKULLFLY set), it will inflict a large amount of thrust on the target along the vector of the impact, will hit it directly for ((rnd % 8) + 1) * 6 damage, and if the target is a player, the player's controls will be frozen for 14 + (rnd % 8) gametics. When the thing is not in SKULLFLY mode, normal damage is done by all attacks.

:*''Whirlwind''
::The target will have its angle and x/y momenta modified by random amounts. If the current level time has the 5th bit (value 16) set and the target is not a boss (possesses the BOSS flag), the target will be given randomized z momentum up to but no greater than 12 units per tic. When the level time is divisible by 8, the target will be hit directly for 3 damage.

*'''aimshift''' ''number''
:If in the range of 0 to 24, this value overrides the "shift" amount that enemies of this object experience while trying to aim at it due to effects like SHADOW, GHOST, and TOTALINVISIBLE. A larger number in this field makes enemies more inaccurate when aiming at this creature. The default value of -1 means that no aiming inaccuracy is experienced *except* what may be incurred from what flags this monster has. A value larger than 24 will, on the other hand, override the creature's flags and cause enemies to experience no inaccuracy due to to those flags (so for example a creature inheriting from Spectre and setting its aimshift to 25 will behave as though it does not have the SHADOW flag other than for rendering purposes). Values of 20 and 21 are used by the various built-in flag effects.

*'''damagefactor'''
:This sets up the monster's resistance to various [[EDF damagetype reference|damage types]] ("means of death"). 0 means invincible, 1 full damage. This property has a distinct syntax: there may be as many ''DamageFactor'' lines as damage resistances. Note that setting the factor to 0 won't prevent monster retaliation. Example of usage:
damagefactor fire, 0.3
damagefactor lava, 0.2
:As seen above, no braces are used, and the arguments are separated by commas.

*'''topdamage'''
:Default = 0
:This number is a constant amount of damage inflicted on any shootable object that stands on top of this object when 3D object clipping is active. This is useful for objects such as torches and flaming barrels. The frequency of damage is determined by the topdamagemask field.
*'''topdamagemask'''
:Default = 0
:This number determines how often a thing with a non-zero topdamage field burns objects that are standing on top of it. This number should be a power of two minus 1 to work properly, such as 1, 3, 7, 15, or 31 (31 would be approximately once per second and is used by DOOM's nukage sector types). New to EDF 1.7.
*'''mod'''
:Default = UNKNOWN (0)
:Originally standing for "Means of Death", this field allows you to associate a '''[[damagetype]]''' to an inflictor (such as projectile) thing type. Then, you'll be able to make other thing types resistant to the given damage type by using the '''damagefactor''' field. You can give them specific pain or death states as well. Damage types also have the role in multiplayer to specify what obituaries are shown depending on which weapon the player uses.
:The mnemonics were initially hard-coded, but are now available inside ''base\things.edf'' as '''damagetype''' blocks. Notice that the default damage types (means of death) have been differentiated for each player attack, as well as for the various slime types and whatnot, so as to have the obituaries differentiated. Monsters don't need new damage types to have new obituaries, because these are defined within the '''thingtype''' block. See the two fields below.
*'''obituary_normal'''
:Default = empty
:Defines the obituary seen by players when killed by a projectile or other miscellaneous attack by a monster. If the obituary is not defined for this type, it will simply read that the player died. Note that you are only allowed to specify an obituary starting immediately after the player's name. If you want an obituary to say "Player was flamed", then simply make the obituary read "was flamed".
*'''obituary_melee'''
:Default = empty
:Defines the obituary seen by players when killed by a monster's melee attack. If the obituary is not defined for this type, it will simply read that the player died. Note that you are only allowed to specify an obituary starting immediately after the player's name. If you want an obituary to say "Player was stabbed mercilessly", then simply make the obituary read "was stabbed mercilessly".

====Pain/Death Properties====
*'''bloodcolor'''
:Default = 0
:Allows this thing type to have differently colored blood when particle blood effects are enabled (this does not currently have any effect on blood sprites). Currently available blood color values are as follows:
Blood color Number
--------------------------
Red (normal) 0
Grey 1
Green 2
Blue 3
Yellow 4
Black 5
Purple 6
White 7
Orange 8
--------------------------

*'''nukespecial'''
:Default = NULL
:This field is the name of a special codepointer to call when the player uses the KILLEM cheat to kill all monsters. Currently only two special pointers are provided for this purpose, PainNukeSpec and SorcNukeSpec. These enable monsters with spawn-on-death actions to either spawn enemies early, or not at all. See the Eternity Engine Definitive Codepointer Reference for detailed information.
*'''droptype'''
:Default = NONE
:This field allows the type of thing that is dropped by this thing when it dies to be edited. This field should either be a valid thing type mnemonic, or the special value NONE.
*'''cleardropitems'''
:The '''cleardropitems''' flag, if present, removes ALL dropitems from a thingtype. This is applied *before* any dropitem or droptype fields defined within this thingtype itself. This allows removing all inherited dropitems at once. This field is a flag and does not accept any value. Its presence in a thingtype is not inheritable (things which inherit from this type must again specify cleardropitems if they want to in turn remove any items this type added).
*'''dropitem ''type'', [, ''chance'' [, ''amount'' [, ''toss'']]]'''
:dropitem defines a Doom- or Heretic-style drop item; any number of dropitems can be defined. All are dropped when an enemy dies, subject to possible randomization.
:*''type'': name of EDF thing type to spawn
:*''chance'': If specified, chance between 0 and 255 to spawn this drop, 0 being no chance and 255 being 100%.
:*''amount'': If specified, overrides the '''dropamount''' field of an '''ammoeffect''' definition. Does not affect any other item effect type. If zero, this field is ignored.
:*''toss'': Flag value. If specified as +toss, the item is a Heretic-style item drop which will be thrown out during the A_Fall action function with randomized velocity. If this flag is not specified, or is specified as -toss, the item is a Doom-style drop item which will be spawned on the floor as soon as the dying thing has reached 0 health.
:Note: The older '''droptype''' field is still supported, and defines a Doom-style dropitem (100% chance, no dropamount override, and never tossed).
*'''dropitem.remove'''
:removes from this thingtype's dropitem list the named EDF thingtype. Useful when inheriting.
*'''collectionspawn''' ''thingtype'' [, ''spchance'' [, ''coopchance'' [, ''dmchance'']]]
:collectionspawn defines a thingtype at which THIS thingtype will select one instance out of all instances on the map at which to spawn itself at level start.
:Explanation of collectionspawn multivalue properties:
:*''thingtype'': Name of the EDF thingtype at which to spawn at random. If this is invalid, this collectionspawn definition will be disregarded.
:*''spchance'': if specified, chance this item will spawn at all in single player, from 0 to 255. Default is 255.
:*''coopchance'': if specified, chance this item will spawn at all in coop mode, from 0 to 255. Default is 255.
:*''dmchance'': if specified, chance this item will spawn at all in deathmatch mode, from 0 to 255. Default is 255.
*'''itemrespawnat''' ''thingtype''
:itemrespawnat defines an EDF thingtype at which this thingtype will respawn if it becomes subject to Heretic-style item respawning.
====Flags====
*'''cflags'''
:Default = ""
:This field allows specification of all the thing's flag values in one single flag list. When this field is defined, flags, flags2, flags3 and flags4 are ignored. The only caveat to this field is that the '''flags''' bit "SLIDE", which has no effect, cannot be specified in this field. If SLIDE is used, it will activate the '''flags3''' bit with the same name, which has the expected effect. All other flags will be assigned to their appropriate internal fields as normal. See the [[Thing type flags]] for their descriptions.

*'''addflags'''
:Default = ""
:This field specifies a combined list of flags to be added to the thing's existing flags values (this works the same as the cflags field above). Flags in this list are "turned on" in the thing. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within thingdelta sections and in concert with thing type inheritance.
*'''remflags'''
:Default = ""
:This field specifies a combined list of flags to be subtracted from the thing's existing flags values (this works the same as the cflags field above). Flags in this list are "turned off" in the thing, as if they had never been listed. If flags are listed here which are not already "on," there is no effect on those flags. This field is most useful within thingdelta sections and in concert with thing type inheritance. This field will be applied '''AFTER''' the addflags field is applied, so it could potentially turn off flags turned on by that field.

*'''flags'''
:Default = ""
:This field controls a number of thing type properties using bit flags, where each bit in the field stands for some effect, and has the value of being either on or off. See the [[Thing type flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''flags2'''
:Default = ""
:Similar to flags but takes a different set of values with different meanings. See the [[Thing type flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''flags3'''
:Default = ""
:Similar to flags, but takes a different set of values with different meanings. See the [[Thing type flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''flags4'''
:Default = ""
:Similar to flags, but takes a different set of values with different meanings. See the [[Thing type flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''particlefx'''
:Default = 0
:This field is a flag field with syntax identical to the flags, flags2, and flags3 fields, but which accepts the following values which control what persistent particle effects are associated with objects of this type:
Flag name Hex Value Effect
--------------------------------------------------------
ROCKET 0x00000001 Rocket trail
GRENADE 0x00000002 Grenade trail
FLIES 0x00000004 Swarm of flies w/ sound
BFG 0x00000008 BFG particle swarm
FLIESONDEATH 0x00000010 Flies when object dies
DRIP 0x00000020 Parameterized drip effect
REDFOUNTAIN 0x00010000 Red fountain
GREENFOUNTAIN 0x00020000 Green fountain
BLUEFOUNTAIN 0x00030000 Blue fountain
YELLOWFOUNTAIN 0x00040000 Yellow fountain
PURPLEFOUNTAIN 0x00050000 Purple fountain
BLACKFOUNTAIN 0x00060000 Black fountain
WHITEFOUNTAIN 0x00070000 White fountain
--------------------------------------------------------
:Note that the fountain flag values cannot be combined with each other. Doing so will simply result in another one of the existing fountain colors.
:The DRIP effect requires parameters to be specified in a thing's [[ExtraData]] mapthing block. The parameters to this effect are as follows:
:*args 0: color (palette index from 0 to 255)
:*args 1: particle width/height in pixels
:*args 2: frequency in gametics
:*args 3: if 1, particles cause terrain hits
:*args 4: if 1, particles are fullbright
:Examples:
# a single effect
particlefx = ROCKET

# multiple effects
particlefx = BFG+GREENFOUNTAIN

# if there are spaces or disallowed characters, you must use quotations
particlefx = "BFG + GREENFOUNTAIN"

====Graphic Properties====
*'''translucency'''
:Default = 65536 (100%)
:This field allows fine, customizable control over a thing's translucency. This field accepts two types of values. First, it may be given an integer value in the range of 0 to 65536, with 0 being completely invisible, and 65536 being normal. Alternatively, beginning with EDF 1.3, you can provide a percentage value to this field indicating the amount of the foreground sprite that is blended with the background. A percentage value must be a base 10 integer between 0 and 100, with the final digit followed immediately by a '%' character (percent sign).

:Note this effect is mutually exclusive of BOOM-style translucency. If this value is not 65536 (or 100%), and the BOOM translucency flag is turned on for the same thing type, the flag will be turned off at run-time, and this field will take precedence.

*'''translation'''
:Default = 0
:Sets a translation for the thing's sprite. Translation tables are 256-byte lumps which can be used to remap any range of colors in a sprite. When this field defaults, no translation will be used. Otherwise, you may either provide a number to access one of the internal player translation tables, or you may provide the name of a translation lump, which must be found between T_START and T_END markers amongst one of the currently loaded wad files. Numeric values for player translations are as follows. All of the player translations remap the pure green range.
Number Color
------------------
1 Indigo
2 Brown
3 Red
4 Tomato
5 Dirt
6 Blue
7 Gold
8 Felt
9 Black
10 Purple
11 "Vomit"
12 Pink
13 Cream
14 Yellow
------------------

*'''skinsprite'''
:Default = "noskin"
:The skinsprite field defines a sprite that will be used to override the sprite value in any frame a thing of this type enters. This allows the creation of thingtypes which behave identically but look different without the creation of any new frames. Note that when things are crushed into gibs, the skinsprite is cleared at that time. If an Archvile resurrects such a thing, the proper skinsprite is then restored.
*'''defaultsprite'''
:Default = the object's first spawn state's sprite
:Controls the remapping behavior of skins for objects that use more than one sprite. Any frame not using the defaultsprite is ignored for remapping by the skin. If not set, the defaultsprite is adapted from the object's first spawn state.
*'''alphavelocity'''
:Default = 0.0
:If nonzero, the thing's opacity (alpha value) will raise up to full solidity, or lower to full invisibility, depending on '''alphavelocity''''s sign and quantity per tic. If the '''CYCLEALPHA''' [[Thing type flags|flag]] is set, the thing will cycle between visibility and invisibility with this speed.
*'''xscale'''
:Default = 1.0
:Sets how much the horizontal component of the sprite is to be scaled.
*'''yscale'''
:Default = 1.0
:Sets how much the vertical component of the sprite is to be scaled.

====ACS Spawn Data Sub-Block====
*'''acs_spawndata'''
:Default = (nothing)
:This specifies the identification number for various parameterized specials, such as Thing_Spawn or Thing_SpawnNoFog. It also limits the number to a game namespace. For example, by default the Zombieman has
acs_spawndata { num 4; modes doom }
:Heretic objects will use "modes heretic" instead of "modes doom".
[[category:EDF]]
==References==
This document has content from:
*New Bifrost features, on Eternity website: http://eternity.mancubus.net/text/bifrost_docs.txt
*Old documentation

ImpMisssileAtk

2015-08-24T07:11:35Z

Bloodshedder: Bloodshedder moved page ImpMisssileAtk to ImpMissileAtk

#REDIRECT [[ImpMissileAtk]]

ImpMissileAtk

2015-08-24T07:11:35Z

Bloodshedder: Bloodshedder moved page ImpMisssileAtk to ImpMissileAtk

Will play its attack sound. If within melee range, it will cause 5-12 damage to the target. Otherwise, it will shoot a HereticImpShot projectile.

===See also===
[[List of codepointers]]

[[Category:Codepointers]]

DeHackEd / BEX Reference/Weapon Block

2015-03-26T06:56:37Z

Bloodshedder: Changed protection level for "DeHackEd / BEX Reference/Weapon Block" ([Edit=Allow only autoconfirmed users] (expires 06:56, 26 June 2015 (UTC)) [Move=Allow only autoconfirmed users] (expires 06:56, 26 June 2015 (UTC)))

This block allows editing of player weapon characteristics.
{{backto|DeHackEd / BEX Reference}}
==Syntax==
A brief explanation of the syntax description:

Items in angle brackets (< >) are required.

Items in square brackets ([ ]) are optional.

All fields in the block are optional. Fields not provided will not be changed.

Weapon <weapon number>
Ammo type = <ammo number>
Deselect frame = <frame number>
Select frame = <frame number>
Bobbing frame = <frame number>
Shooting frame = <frame number>
Firing frame = <frame number>
# The fields below are Eternity extensions
Ammo per shot = <number>

Explanation of special information:

'''weapon number''' is a weapon type number, which must be one of the following:
Number Weapon type
------------------------
0 Fist
1 Pistol
2 Shotgun
3 Chaingun
4 Rocket Launcher
5 Plasma Rifle
6 BFG 9000
7 Chainsaw
8 Super Shotgun
'''ammo number''' is an ammo type number, which must be one of the following:
Number Ammo type
-----------------
0 Bullets
1 Shells
2 Cells
3 Rockets
5 None

==Fields==
====Ammo type = <number>====
The type number, as given above, of the ammo type used by this weapon. Note that 4 is not a valid ammo type; do not use it. Also, in Eternity, any weapon can be safely given ammo type 5, none. In DOOM, giving any weapon other than the fist or chainsaw this type would cause the shotgun's max ammo to decrease on every use.

====Deselect frame = <frame number>====
A weapon enters this frame when the player changes to another weapon or dies.

====Select frame = <frame number>====
A weapon enters this frame when the player changes to it.

====Bobbing frame = <frame number>====
A weapon stays in this frame when the player is walking around without firing.

====Shooting frame = <frame number>====
A weapon enters this frame when the player hits the fire key.

====Firing frame = <frame number>====
This frame is used to display muzzle flashes when a weapon is fired.

====Ammo per shot = <number>====
This field is an Eternity extension which allows editing of the amount of ammo a weapon must have to be fired and uses on each shot (there is no point to these values being separate). Unless enabled through explicit use of this field in DeHackEd, this value is not used by the game engine, for compatibility reasons.
[[category:dehacked]]

DeHackEd / BEX Reference/Weapon Block

2015-03-26T06:56:17Z

Bloodshedder: Protected "DeHackEd / BEX Reference/Weapon Block" ([Edit=Allow only autoconfirmed users] (indefinite) [Move=Allow only autoconfirmed users] (indefinite))

DeHackEd / BEX Reference/Weapon Block

2015-03-26T06:55:48Z

Bloodshedder: Reverted edits by 116.68.144.30 (talk) to last revision by Bloodshedder

DeHackEd / BEX Reference/Weapon Block

2015-03-24T17:21:04Z

Bloodshedder: Reverted edits by 5.39.42.18 (talk) to last revision by Bloodshedder

DeHackEd / BEX Reference/Weapon Block

2015-03-23T16:34:53Z

Bloodshedder: Reverted edits by 130.211.152.29 (talk) to last revision by Bloodshedder

DeHackEd / BEX Reference/Weapon Block

2015-03-22T07:54:24Z

Bloodshedder: Reverted edits by 188.226.170.26 (talk) to last revision by Bloodshedder

DeHackEd / BEX Reference/Weapon Block

2015-03-20T19:44:26Z

Bloodshedder: rv

DeHackEd / BEX Reference/Weapon Block

2015-02-01T18:47:38Z

Bloodshedder: Reverted edits by 91.106.38.34 (talk) to last revision by Printz

Talk:List of codepointers

2015-01-31T01:14:10Z

Bloodshedder: Reverted edits by 134.249.141.83 (talk) to last revision by Printz

Main Page

2013-04-12T21:20:55Z

Bloodshedder: test edit/new mysql version

List of codepointers

2011-11-20T05:59:29Z

Bloodshedder: rv

This '''list of codepointers''' is a list of all the action routines which can be used in [[EDF]] [[frame]]s. The Heretic actions ''can'' be used in Doom based modifications.

=Player guns=
==Attacks==
*[[CustomPlayerMelee]]
*[[FireBFG]]
*[[FireCGun]]
*[[FireCustomBullets]]
*[[FireMissile]]: rocket launcher attack
*[[FireOldBFG]]: alpha Doom BFG attack
*[[FirePistol]]
*[[FirePlasma]]
*[[FirePlayerMissile]]: custom missile attack
*[[FireShotgun]]
*[[FireShotgun2]]: super shotgun attack
*[[PlayerThunk]] {{deprecated}}
*[[Punch]]: fist attack
*[[Saw]]: chainsaw attack

==Control==
*[[CheckReload]]: super shotgun reload check
*[[CheckReloadEx]]: extended version that allows counter comparison
*[[JumpIfNoAmmo]]: as it says
*[[Lower]]: "lower" effect & frame
*[[Raise]]: "raise" effect & frame
*[[ReFire]]: skip frame if shooting is maintained (plasma gun cooldown effect)
*[[WeaponReady]]: "bob" effect, ready frame

==Other==
*[[EjectCasing]]: throw casing

==Muzzle flash effects==
*[[GunFlash]]: produces gunflash sprite without firing anything
*[[Light0]]: resets the muzzle light level
*[[Light1]]: muzzle light level 1
*[[Light2]]

==Sound effects==
*[[BFGSound]]
*[[CloseShotgun2]]: this one also includes ReFire
*[[LoadShotgun2]]: ...these two don't
*[[OpenShotgun2]]

==Frame scripting==
*[[PlayerStartScript]]: start map script
*[[WeaponCopyCtr]]
*[[WeaponCtrOp]]
*[[WeaponCtrJump]]
*[[WeaponCtrSwitch]]
*[[WeaponSetCtr]]

=Map objects=
==Flashes and booms==
*[[BFG11KHit]]: [[SMMU]] BFG variant
*[[BFGBurst]]: produce a burst of smaller plasma objects
*[[BFGSpray]]: BFG explosion afterglow
*[[BouncingBFG]]: SMMU bouncing BFG
*[[BrainExplode]]: brain perpetual explosion controller
*[[BrainScream]]: giant demon wall explosion sequence
*[[Detonate]]: thing damage controlled explosion
*[[Explode]]: rocket/barrel splash damage
*[[Fire]]: stick on the face of attacker's target, like the vile fire
*[[GenTracer]]: generic tracer
*[[Mushroom]]: mushroom explosion
*[[Nailbomb]]: explosion with shrapnels
*[[SpawnFly]]: spawn cube controller
*[[Tracer]]: one of the required components for homing missiles
===Heretic===
*[[BeastPuff]]: weredragon fire belch smoke
*[[BlueSpark]]: create a blue d'sparil attack spark
*[[GenWizard]]: create a disciple
*[[HticExplode]]: heretic-compatible explosion
*[[HticTracer]]: like those golem skulls
*[[LichFireGrow]]: how the fire column expands
*[[LichIceImpact]]: how an ice globe explodes into shards
*[[MntrFloorFire]]: used by the straight flame snake
*[[PhoenixPuff]]: missile trail
*[[PodPain]]: pod goo splash on being hit
*[[VolcBallImpact]]: how a volcano ball fragments on impact
*[[WhirlwindSeek]]: used by the tornados

==AI==
*[[AlertMonsters]]: shout so other monsters chase the player
*[[Chase]]: pursue a target and check for attack
*[[CPosRefire]]: go to seestate if target is out of sight
*[[Face]]: face a specified angle
*[[FaceTarget]]: turn to target, look around it if it's partly invisible
*[[GenRefire]]: customizable refire control
*[[KeepChasing]]: pursue target without attacking
*[[Look]]: stand in guard, looking for targets
*[[RandomWalk]]: random wandering for inactive enemies
*[[Sor1Chase]]: d'sparil mount specific chase
*[[Sor1Pain]]: d'sparil mount specific twitch. Calls Pain.
*[[SpidRefire]]: like CPosRefire, slightly modified
*[[Turn]]: turn around a specified angle
*[[VileChase]]: same as Chase, but resurrecting encountered cadavers

==AI attacks==
*[[BetaSkullAttack]]: remote melee attack
*[[BrainSpit]]: cube spawn
*[[BruisAttack]]: baron/knight of hell
*[[BspiAttack]]: arachnotron
*[[BulletAttack]]: custom bullet shooting
*[[CPosAttack]]: pistol attack w/ shotgn noise
*[[CyberAttack]]: rocket launching
*[[FatAttack1]]: mancubus left attack
*[[FatAttack2]]: mancubus right attack
*[[FatAttack3]]: mancubus front attack
*[[HeadAttack]]: cacodemon
*[[MissileAttack]]: custom missile shooting
*[[MissileSpread]]: MissileAttack variation, supports shooting spread shots
*[[PainAttack]]: elemental
*[[PainDie]]: elemental death (3 souls)
*[[PosAttack]]: former human
*[[SargAttack]]: demon bite
*[[Scratch]]: custom melee attack
*[[SkelFist]]: revenant punch
*[[SkelMissile]]: revenant missile
*[[SkullAttack]]: flying skull
*[[SPosAttack]]: sergeant
*[[ThingSummon]]: customized summoning
*[[TroopAttack]]: imp
*[[VileAttack]]: arch vile toss
*[[VileTarget]]: spawn a vile fire effect on target
===Heretic===
*[[BeastAttack]]: weredragon
*[[ClinkAttack]]: sabre
*[[ImpChargeAtk]]: gargoyle charge
*[[ImpMeleeAtk]]: gargoyle scratch
*[[ImpMisssileAtk]]: gargoyle fire
*[[KnightAttack]]: undead warrior
*[[LichAttack]]: iron lich random attack **only one which includes ice globes**
*[[LichFire]]: iron lich fire column
*[[LichWhirlwind]]: iron lich tornado
*[[MinotaurAtk1]]: maulotaur melee damage
*[[MinotaurAtk2]]: spreadshot
*[[MinotaurAtk3]]: straight flame snake
*[[MinotaurCharge]]: maulotaur charge
*[[MinotaurDecide]]: maulotaur ranged attack choosing
*[[MummyAttack]]: golem melee
*[[MummyAttack2]]: nitrogolem range
*[[SnakeAttack]]: ophidian blue spark
*[[SnakeAttack2]]: ophidian yellow shot
*[[Srcr1Attack]]: d'sparil mount attack
*[[Srcr2Attack]]: d'sparil sorcerer attack
*[[Srcr2Decide]]: d'sparil decide whether to teleport
*[[VolcanoBlast]]: volcano burst
*[[WizardAtk3]]: disciple tri-ball

==Alterations==
*[[BossDeath]]: special monster death functions (such as Baron death in E1M8)
*[[BrainDie]]: exits the level
*[[CasingThrust]]: movement for ejected casing
*[[Die]]: causes suicide
*[[FadeIn]]: increments alpha
*[[FadeOut]]: decrements alpha, DOESN'T destroy the thing
*[[Fall]]: remove SOLID flag (used on dying monsters)
*[[KeenDie]]: open 666-tagged doors on death of all like-named monsters
*[[KillChildren]]: destroy all summoned things
*[[LineEffect]]: activate a tag using a special
*[[PainNukeSpec]]
*[[SetFlags]]: alter flags
*[[SetTranslucent]]: modify alpha amount; setup additiveness or fuzziness
*[[ShowMessage]]: display text message
*[[Spawn]]: create another object on top of this one
*[[SteamSpawn]]: create steam effects
*[[Stop]]: set velocity to 0
*[[UnSetFlags]]: alter flags
===Heretic===
*[[AccelGlitter]]: accelerate upwards
*[[DripBlood]]: spawn heretic blood
*[[HticBossDeath]]: special monster death functions for Heretic
*[[ImpDeath]]: special death for gargoyle
*[[ImpExplode]]: crash for gargoyle
*[[ImpXDeath1]]: special extreme death for gargoyle, stage 1
*[[ImpXDeath2]]: special extreme death for gargoyle, stage 2
*[[MakePod]]: generate a pod
*[[MummySoul]]: create raising soul
*[[PlayerSkull]]: player death effect, when the skull tosses in air
*[[RemovePod]]: notifies the generator that this pod was destroyed
*[[Sor2DthInit]]: d'sparil death maintenance
*[[Sor2DthLoop]]: d'sparil death maintenance
*[[SorcererRise]]: d'sparil waking up after mount crash
*[[SorcNukeSpec]]
*[[SpawnAbove]]: spawns above the summoner
*[[SpawnGlitter]]: create teleportation sparkle
*[[WizardAtk1]]: face target and clear GHOST flag
*[[WizardAtk2]]: face target and set GHOST flag

==Sound effects==
*[[AmbientThinker]]: ambient sound maintenance
*[[BabyMetal]]: bspwlk sound effect -- also includes Chase!
*[[BrainAwake]]: loud bossit sound effect
*[[BrainPain]]: loud bospn sound effect
*[[FatRaise]]: mancubus warning -- also includes FaceTarget
*[[FireCrackle]]: flame sound effect -- also includes "Fire" action!
*[[Hoof]]: cyberdemon hoof sound -- also includes Chase!
*[[Metal]]: metal sound effect -- also includes Chase!
*[[Pain]]: play pain sound
*[[PlayerScream]]: player-specific, health-dependent (death) sound
*[[PlaySound]]: custom sound
*[[PlaySoundEx]]: extended custom sound
*[[Scream]]: play death sound
*[[SkelWhoosh]]: revenant swing noise -- also includes FaceTarget
*[[SpawnSound]]: boscub sound effect -- also includes SpawnFly
*[[StartFire]]: flamst sound effect -- also includes "Fire" action!
*[[VileStart]]: archvile heat-up noise
*[[XScream]]: extreme death gut noise

==Frame scripting==
*[[AproxDistance]]: assign distance from target to a variable
*[[CheckPlayerDone]]: jump to a frame if not under player control
*[[CopyCounter]]: copy a variable to another variable
*[[CounterJump]]: counter-based next frame
*[[CounterOp]]: set a variable to an operation of another 2 variables
*[[CounterSwitch]]: counter-based set of frames
*[[HealthJump]]: health-based next frame
*[[JumpIfTargetInLOS]]: jump to frame if target is in the field of view
*[[RandomJump]]: random next frame
*[[SetCounter]]: set a variable
*[[SetTics]]: set frame duration
*[[StartScript]]: run map script
*[[TargetJump]]: go to designated frame if having a target

[[Category:Codepointers|*]]

ExtraData

2011-11-20T05:58:25Z

Bloodshedder: Reverted edits by 95.227.195.85 (talk) to last revision by Bloodshedder

ExtraData is a new data specification language for the [[Eternity Engine]] that allows arbitrary extension of mapthings, lines, and sectors with any number of new fields, with data provided in more or less any format. The use of a textual input language forever removes any future problems caused by binary format limitations. The ExtraData parser is based on the libConfuse configuration file parser library by Martin Hedenfalk, which is also used by GFS and EDF.

Each section in this document deals with one of the ExtraData constructs, as well as how to embed ExtraData in a WAD and how to associate it with a given map.

ExtraData will continue to be supported in future versions of Eternity, even though it will soon be superceded by support for the [[Universal Doom Map Format]].

=General Syntax=
''See [[EDF#Syntax|EDF Syntax]], as it is the same.''

=Embedding and Associating ExtraData =

ExtraData is embedded directly as a text script into a lump of any name. This can be done with any number of wad file management tools, such as SLumpEd, SLADE 3, or XWE.

An ExtraData script is associated with a map via use of the [[MapInfo]] variable '''extradata'''. A map can only have one ExtraData script, but it is possible for multiple maps to share the same script.

Example of ExtraData specification via EMAPINFO:
[MAP01]
extradata = EDLUMP01

=Mapthings =

Mapthings define monsters, lamps, control points, items, etc -- anything that is spawned on the map at level start.

Each field in the mapthing definition, with the exception of the '''recordnum''' field, is optional. If a field is not provided, it takes on the default value indicated below the syntax information. Fields may also be provided in any order.

Note that the order of mapthing definitions in ExtraData is not important. The '''recordnum''' field serves to identify mapthing records.

==Creating ExtraData Control Objects ==

Mapthing records in ExtraData are only associated with a special control object that must be placed on the map in the usual manner.

The ExtraData control object has a '''doomednum''' of 5004. Each control object specifies its corresponding ExtraData mapthing record number as an integer value in its mapthing '''options''' field. If your editor does not allow entering arbitrary values into the options field of mapthings, you will need to use the BOOM command-line editor, CLED. As of the initial writing time of this document, both DETH and Doom Builder support entering arbitrary integer values for the options field. Check your editor's documentation or user interface to verify if it supports this.

The x, y, and angle fields of the ExtraData control object are passed on to the thing which will be spawned at the control point's location, so those fields of the control object should be set normally. The true type and options fields of the thing to be spawned, along with any extended fields, are specified in the ExtraData record.

Any number of ExtraData control objects can reference the same ExtraData record. In the event that a control object references a non-existent ExtraData record, the ExtraData script for a level is missing, or the thing type referenced by an ExtraData record isn't valid, an [[Unknown]] thing will be spawned at the control point's location. Note that you cannot spawn ExtraData control objects using ExtraData. Attempting this will also result in an Unknown thing.

==Mapthing Syntax and Fields ==

The syntax of the ExtraData mapthing record is as follows. Remember that all fields except the '''recordnum''' field are optional and can be specified in any order.
mapthing
{
recordnum <unique number>

// These fields are normal mapthing fields
type <doomednum> OR <EDF thingtype mnemonic>
options <options flag list>

// These fields are ExtraData extensions
tid <number>
args { <special field>, ... }
height <number>
}
===Explanation of fields:===
====recordnum====
The recordnum serves to identify this record, and is the number which ExtraData control objects must use to associate themselves with a mapthing record. Every ExtraData mapthing record must have a unique record number. If a duplicate record number is detected, the engine will currently exit with an error message. The record number is limited to values between 0 and 65535 inclusive. Some editors may only allow input of numbers up to 32767 in the mapthing options field, or may treat values above 32767 as negative numbers. Beware of this.

====type====
Default: No meaningful default value; an Unknown thing will be spawned if not valid.

This field specifies the type of object to spawn at the location and angle of ExtraData control objects using this record. This field can accept one of two types of values. The first is a normal thingtype doomednum as specified via [[EDF]] and used by all editors. For example, the DOOM Imp's doomednum is 3001.

This field can also accept EDF thingtype mnemonics. EDF thingtype mnemonics must be prefixed with ''thing:'' -- this allows the parser to know it is dealing with a string instead of a number. EDF thingtypes must have a unique doomednum to be specified in an ExtraData mapthing record. If the specified EDF thingtype doesn't exist or has a doomednum of -1, an Unknown object will be spawned instead.

Example:
mapthing { type 3001 } // This record specifies an Imp via its doomednum

mapthing { type DoomImp } // This record specifies an Imp by its EDF mnemonic

====options====
Default: No flags are set by default.

This field specifies the options (also known as mapthing flags). This field uses the same syntax as BEX/EDF flag strings, but the syntax 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. In ExtraData, if a flag list contains whitespace, commas, or plus signs, it must be enclosed in double or single quotations. 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 Meaning
------------------------------------------------------------------------------
EASY Thing appears in easy difficulties
NORMAL Thing appears in "Hurt Me Plenty"
HARD Thing appears in Ultra-Violence and Nightmare
AMBUSH Thing is "deaf", will not wake up via sound
NOTSINGLE Thing doesn't appear in single-player mode
NOTDM Thing doesn't appear in deathmatch
NOTCOOP Thing doesn't appear in cooperative multiplayer
FRIEND Thing uses MBF friendly logic
DORMANT Thing is dormant at map startup (script feature)
------------------------------------------------------------------------------

The mapthing options value 256 (0x0100) is reserved. If this bit is set, all BOOM, MBF, and Eternity extended mapthing bits will be cleared. This is to guard against editors like Hellmaker which set all bits they do not understand, instead of leaving them zero.

Example options fields -- All of these are equivalent:
// This is the only syntax that does not require quotations.

mapthing { options EASY|NORMAL|HARD }

// All of these syntaxes must be quoted, because unquoted strings in
// ExtraData cannot contain spaces, commas, or plus signs.

mapthing { options "EASY NORMAL HARD" }
mapthing { options "EASY | NORMAL | HARD" }
mapthing { options "EASY+NORMAL+HARD" }
mapthing { options "EASY + NORMAL + HARD" }
mapthing { options "EASY,NORMAL,HARD" }
mapthing { options "EASY, NORMAL, HARD" }

====tid====
Default: 0

The TID, or "Thing ID", is a tag for mapthings which is used for identification in [[Small]] scripts. TID values must be positive numbers between 1 and 65535. The TID value zero means no TID. Negative TID values are reserved and are used to indicate special things within the engine. TIDs are not required to be unique, and most Small functions that accept TIDs will perform an action on all mapthings which bear the same TID. Things spawned within Small scripts can also be given TIDs.

====args====
Default: All args values default to zero.

The args field is a list of up to five special values which can have a broad range of meanings. Any values not provided in the args list will default, and if more than five values are provided, only the first five will be used. Currently, all args values are interpreted as integers (a non-number string evaluates to zero). This may change in the future.

Example args list:
mapthing { args { 0, 1, 2, 3, 4 } }

====height====
Default: 0

For normal objects, this field indicates a distance above the floor that the thing will spawn at level start. For objects with the SPAWNCEILING flag, this field indicates a distance below the ceiling instead. This field will have no effect on objects which spawn at a randomized height.

=Linedefs =

Linedefs define walls, two-sided textures, and provide action triggers within maps.

Each field in the linedef definition, with the exception of the '''recordnum''' field, is optional. If a field is not provided, it takes on the default value indicated below the syntax information. Fields may also be provided in any order.

Note that the order of linedef definitions in ExtraData is not important. The '''recordnum''' field serves to identify linedef records.

==Creating ExtraData Linedefs ==

Linedef records in ExtraData are associated either with lines which bear the ExtraData Control Line Special (270), or with any linedef in a DOOM-format map which uses a parameterized line special. You can place the 270 special, as well as parameterized special numbers, into the normal "special" field of a line using virtually any map editor. Editors with Eternity-specific configurations should support these specials natively.

Each control linedef (or directly-used parameterized special) specifies its corresponding ExtraData linedef record number as an integer value in its linedef tag field. If your editor does not allow entering arbitrary values up to 32767 into the tag field of linedefs, you will need to use the BOOM command-line editor, CLED. As of the initial writing time of this document, both DETH and Doom Builder support entering arbitrary integer values for the tag field. Check your editor's documentation or user interface to verify if it supports this.

The flags, sidedefs, textures, and location of the ExtraData control linedef are used normally by the line and cannot be altered from within ExtraData. The true special (if 270 is used) and tag fields of the linedef, along with any extended fields, are specified in the ExtraData record which the control linedef references.

Any number of linedefs can reference the same ExtraData record. In the event that a control linedef references a non-existent ExtraData record or the ExtraData script for a level is missing, the special and tag of the ExtraData control linedef will both be set to zero.

==Linedef Syntax and Fields ==

The syntax of the ExtraData linedef record is as follows. Remember that all fields except the '''recordnum''' field are optional and can be specified in any order.
linedef
{
recordnum <unique number>

// These fields are normal linedef fields
special <number> OR <special name>
tag <number>

// These fields are ExtraData extensions
extflags <extended line flags list>
args { <special field>, ... }
alpha <number>
}
===Explanation of fields: ===
====recordnum====
The recordnum serves to identify this record, and is the number which ExtraData control linedefs must use to associate themselves with a linedef record. Every ExtraData linedef record must have a unique record number. If a duplicate record number is detected, the engine will currently exit with an error message. The record number is limited to values between 0 and 32767 inclusive. Some editors may only allow input of numbers up to 255 in the linedef tag field. Beware of this.

====special====
:''Default: 0 ''

The special field determines what [[Linedef_types|type of action]] may be taken when a line is crossed, used, shot, etc. There are three types of linedef specials in Eternity: normal, generalized, and parameterized. Parameterized specials use the '''args''' field documented below to provide complete customization of line actions.

This field can accept numbers for any special type, including generalized and parameterized, but it can also accept special names for parameterized line types. See the [[Detailed parameterized linedef specification]] for a complete list of the available names.

====tag====
:''Default: 0 ''

The tag of the linedef, used by DOOM-style line specials and sector effects.

====extflags====
:''Default: No flags are set by default. ''

This field specifies extended linedef flag values which impact the functionality of parameterized linedef specials. This field uses the same syntax as BEX/EDF flag strings, but the syntax 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. In ExtraData, if a flag list contains whitespace, commas, or plus signs, it must be enclosed in double or single quotations. 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 Meaning
---------------------------------------------------------------------------------------
CROSS Linedef can be activated by being crossed.
USE Linedef can be activated by being used.
IMPACT Linedef can be activated by being shot.
PUSH Linedef can be activated by being pushed.
PLAYER Linedef can be activated by players.
MONSTER Linedef can be activated by objects with SPACMONSTER flag.
MISSILE Linedef can be activated by objects with SPACMISSILE flag.
REPEAT Linedef action is repeatable.
1SONLY Linedef can only be activated from first side.
ADDITIVE Linedef's midtexture is drawn with additive blending.
BLOCKALL Linedef will block everything that can be clipped.
---------------------------------------------------------------------------------------

Notes: IMPACT is currently only implemented for bullet weapons. The ability to use IMPACT with MISSILE will be added in the near future. The PUSH style of activation is not implemented at all yet, so this flag currently does nothing.

Example flags fields -- All of these are equivalent:
// This is the only syntax that does not require quotations.

linedef { extflags CROSS|PLAYER|MISSILE|REPEAT }

// All of these syntaxes must be quoted, because unquoted strings in
// ExtraData cannot contain spaces, commas, or plus signs.

linedef { extflags "CROSS PLAYER MISSILE REPEAT" }
linedef { extflags "CROSS | PLAYER | MISSILE | REPEAT" }
linedef { extflags "CROSS+PLAYER+MISSILE+REPEAT" }
linedef { extflags "CROSS + PLAYER + MISSILE + REPEAT" }
linedef { extflags "CROSS,PLAYER,MISSILE,REPEAT" }
linedef { extflags "CROSS, PLAYER, MISSILE, REPEAT" }

====args====
:''Default: All args values default to zero. ''

The args field is a list of up to five special values which can have a broad range of meanings. Any values not provided in the args list will default, and if more than five values are provided, only the first five will be used. Currently, all args values are interpreted as integers (a non-number string evaluates to zero). This may change in the future. The args list is used by parameterized linedef specials.

Example args list:
linedef { args { 0, 1, 2, 3, 4 } }

====alpha====
:"Default: Alpha defaults to 1.0."

The alpha field takes a value from 0.0 to 1.0 to set the opacity at which this linedef's midtexture is drawn. When combined with the ADDITIVE extflag, this can be used for additive-blended translucency as well.

=Sectors=

Sectors define distinct areas of the map that are bordered by linedefs, with floor and ceiling properties, lighting data, and specials.

Each field in the sector definition, with the exception of the '''recordnum''' field, is optional. If a field is not provided, it takes on the default value indicated below the syntax information. Fields may also be provided in any order.

Note that the order of sector definitions in ExtraData is not important. The '''recordnum''' field serves to identify sector records.

==Creating ExtraData Sectors==

Sector records in ExtraData are associated with lines which bear the ExtraData Sector Control Special (401). The linedef's front side sector is the map sector that will receive properties from the ExtraData record which is specified by number in the linedef's tag.

Since ExtraData is attached to sectors via linedefs and not through overriding any of the sectors' native fields, you specify all of the normal data for a sector in the map itself, and overriding that data through ExtraData sector records is not supported.

Any number of linedefs can reference the same ExtraData sector record. In the event that a control linedef references a non-existent ExtraData record or the ExtraData script for a level is missing, the tag of the ExtraData sector control linedef will be set to zero and will otherwise be ignored.

==Sector Syntax and Fields ==

The syntax of the ExtraData sector record is as follows. Remember that all fields except the '''recordnum''' field are optional and can be specified in any order.
sector
{
recordnum <unique number>

// These fields are ExtraData extensions to sector data
flags <sector flag list>
flags.add <sector flag list>
flags.remove <sector flag list>
damage <integer>
damagemask <integer>
damagemod <method of damage type>
damageflags <sector damage flags list>
damageflags.add <sector damage flags list>
damageflags.remove <sector damage flags list>
floorterrain <terrain name>
floorangle <float>
flooroffsetx <float>
flooroffsety <float>
ceilingterrain <terrain name>
ceilingangle <float>
ceilingoffsetx <float>
ceilingoffsety <float>
colormaptop <lump name>
colormapmid <lump name>
colormapbottom <lump name>
portalflags.floor <portal flags list>
portalflags.ceiling <portal flags list>
overlayalpha.floor <percentage or value from 0 to 255>
overlayalpha.ceiling <percentage or value from 0 to 255>
}
===Explanation of fields: ===
====recordnum====
The recordnum serves to identify this record, and is the number which ExtraData sector control linedefs must use to associate themselves with a sector record. Every ExtraData sector record must have a unique record number. If a duplicate record number is detected, the engine will currently exit with an error message. The record number is limited to values between 0 and 32767 inclusive. Some editors may only allow input of numbers up to 255 in the linedef tag field. Beware of this.

====flags====
:''Default: No flags are set by default. ''

This field specifies sector flag values which specify various properties of sectors. This field uses the same syntax as BEX/EDF flag strings.

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

Flag name Meaning
---------------------------------------------------------------------------------------
SECRET Sector is secret
FRICTION Sector has friction enabled, if targeted by a BOOM friction transfer line
PUSH Sector has BOOM push effects enabled
KILLSOUND Objects in sector cannot make sounds.
KILLMOVESOUND Sector makes no movement sounds, even if it has a special sound sequence
---------------------------------------------------------------------------------------

Example flags fields -- All of these are equivalent:
// This is the only syntax that does not require quotations.

sector { flags SECRET|FRICTION|KILLMOVESOUND }

// All of these syntaxes must be quoted, because unquoted strings in
// ExtraData cannot contain spaces, commas, or plus signs.

sector { flags "SECRET FRICTION KILLMOVESOUND" }
sector { flags "SECRET | FRICTION | KILLMOVESOUND" }
sector { flags "SECRET+FRICTION+KILLMOVESOUND" }
sector { flags "SECRET + FRICTION + KILLMOVESOUND" }
sector { flags "SECRET,FRICTION,KILLMOVESOUND" }
sector { flags "SECRET, FRICTION, KILLMOVESOUND" }

====flags.add====
:''Default: No flags are set by default. ''

This is a list of sector flags to add to the sector. This is supported because some sector specials (such as sector special 9, "Secret") imply that certain sector flags will be set on the sector before ExtraData is applied. If you wish to only add flags and not override any that may have been set by sector specials, use this field to specify only the flags that you wish to be added to the sector.

====flags.remove====
:''Default: No flags are set by default. ''

This is a list of sector flags to remove from the sector. If you wish to only remove flags and not override any that may have been set by sector specials, use this field to specify only the flags that you wish to be removed from the sector.

====damage====
:''Default: 0''

Specifies the amount of damage this sector does to players if the players are standing inside the sector and do not meet any special exemption criteria, such as wearing a Radiation Suit. This amount is done at each damage opportunity, which is determined by the '''damagemask''' field.

====damagemask====
:''Default: 0''

Specifies the interval in gametics between damage opportunities for a player standing in this sector. The default value of 0 will cause the sector to do constant and instantaneous damage every gametic. Setting this value to an integer greater than 0 will cause damage to be done every Nth gametic, with N being the value of this field. The default DOOM nukage types all use a damagemask of 32, which is roughly once per in-game second (there are 35 gametics per second).

====damagemod====
:''Default: "Unknown"''

Specifies the type of damage done by this sector. If "Unknown" is specified, the damage done is generic. The value specified should be a valid EDF damagetype mnemonic. If it is not, "Unknown" will be used. This can be used to have a sector type trigger special pain and death states when it deals damage. For example, you can use '''slime''' or '''lava''' damagemod.

====damageflags====
:''Default: No flags are set by default.''

This field specifies sector damage flag values which affect the manner in which a sector does damage. This field uses the same syntax as BEX/EDF flag strings.

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

Flag name Meaning
---------------------------------------------------------------------------------------
LEAKYSUIT The player may take damage at random even if he has the radsuit powerup
IGNORESUIT Radiation suit powerups are ignored entirely
ENDGODMODE God mode will be disabled when the player enters this sector
EXITLEVEL The player will exit if has < 11 health and this sector tries to do damage
TERRAINHIT A TerrainTypes hit will occur when this sector does damage
---------------------------------------------------------------------------------------

====damageflags.add====
:''Default: No flags are set by default.''

Because some sector types imply the activation of various sector damageflags (for example, DOOM sector type 11 sets sector damageflags ENDGODMODE and EXITLEVEL), this field is supported to add additional damageflags to any that may have been set by the map itself. Simply specify whatever flags you wish to have added to those that are already set.

====damageflags.remove====
:''Default: No flags are set by default.''

As with damageflags.add, it may be desirable to turn off some flags that were set by sector specials or other portions of the map data. Use this field to specify any sector damage flags you want to remove from sectors.

====floorterrain====
:''Default: "@flat"''

Specifies an EDF TerrainTypes mnemonic for the type of terrain this sector should exhibit on its floor. If left to default or specified with an invalid name, the terrain of the sector will be determined by its floorpic as usual.

====floorangle====
:''Default: 0 (East, or upper edge to the north)''

Specifies the angle of the floor flat in floating-point degrees from 0 to 359. Note that for compatibility with ZDoom, the angle specified advances in a '''clockwise''' fashion, contrary to most other angles in the DOOM engine.

====flooroffsetx/flooroffsety====
:''Default: 0''

Specifies the x and y offsets of the floor flat, relative to the normal floor grid, in floating point units.

====ceilingterrain====
:''Default: "@flat"''

Specifies an EDF TerrainTypes mnemonic for the type of terrain this sector should exhibit on its ceiling. If left to default or specified with an invalid name, the terrain of the sector will be determined by its floorpic as usual. This currently only affects the behavior of bullet puffs when particles are enabled.

====ceilingangle====
:''Default: 0 (East, or upper edge to the north)''

Specifies the angle of the ceiling flat in floating-point degrees from 0 to 359. Note that for compatibility with ZDoom, the angle specified advances in a '''clockwise''' fashion, contrary to most other angles in the DOOM engine.

====flooroffsetx/flooroffsety====
:''Default: 0''

Specifies the x and y offsets of the ceiling flat, relative to the normal ceiling grid, in floating point units.

====colormaptop====
:''Default: "@default"''

Specifies the colormap lump to use when a player's viewpoint is above the fake ceiling of a BOOM 242 "deep water" effect applying to this sector. If left to default, the global colormap from MapInfo will be used as normal, unless one is specified by the 242 effect.

====colormapmid====
:''Default: "@default"''

Specifies the colormap lump to use when a player's viewpoint is between the normal floor and ceiling for an ordinary sector, or between the fake floor and ceiling for a BOOM 242 "deep water" sector. If left to default, the global colormap from MapInfo will be used as normal, unless one is specified by a 242 effect.

====colormapbottom====
:''Default: "@default"''

Specifies the colormap lump to use when a player's viewpoint is below the fake floor of a BOOM 242 "deep water" effect applying to this sector. If left to default, the global colormap from MapInfo will be used as normal, unless one is specified by the 242 effect.

====portalflags====
:''Default: No flags are set by default.''

These two fields (portalflags.floor and portalflags.ceiling) specify portal property flag values which affect the rendering and behavior of portals attached to this sector's surfaces. These fields use the same syntax as BEX/EDF flag strings.

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

Flag name Meaning
---------------------------------------------------------------------------------------
DISABLED Portal is completely disabled
NORENDER Portal will not be rendered, but may still be interactive
NOPASS Objects cannot pass through the portal even if it is a linked portal
BLOCKSOUND Sound will not traverse through a linked portal
OVERLAY The portal will render the sector's flat as a blended overlay
ADDITIVE If OVERLAY is also specified, the overlay will use additive blending
USEGLOBALTEX Reserved for future per-portal texture specification
---------------------------------------------------------------------------------------

====overlayalpha====
:''Default'': 100%

These two fields (overlayalpha.floor and overlayalpha.ceiling) specify the opacity of the corresponding portal overlay, if any exists. You can specify either a percentage value from 0% to 100%, or a plain integer number from 0 to 255. 100%/255 are completely solid, while 0% is invisible.

Portal

2011-11-20T05:58:23Z

Bloodshedder: Reverted edits by 103.22.164.200 (talk) to last revision by Printz

Portals are a powerful mapping feature which allow a variety of rendering effects; they allow an architectural surface to be used as a "window" which can display something besides the texture that would normally cover the surface. Anything from simple fixed plane, to another area of the map can be rendered within these surfaces via the same architecture.

== Terminology ==

=== Portal Window ===

'Portal window' refers to the area of the screen that a portal occupies. For example:

[[Image:Pterminology01.png]]

This is a simple map with no portal surfaces, and no portal window.

[[Image:Pterminology02.png]]

This is the same simple map with a fixed plane portal applied to the ceiling of the sector. The portal window is outlined in white.

[[Image:Pterminology03.png]]

This is the map, but the same plane portal is applied to the ceiling and the far wall. The two surfaces display the same portal, and as such, they share a common portal window (also outlined in white).

All surfaces in a scene that have a common portal will share the same portal window.

=== Dummy Sector ===
A sector off of the main map area which is used by line or sector specials as a model, or as housing for lines which need to be a specific size.

== Fixed Plane Portals ==

Fixed plane portals (as the name implies) render a single, fixed plane into the portal window. The plane is always rendered a the same height and texture offset even when the camera changes its position.

Line specials:

:283 Apply fixed plane portal to the ceilings of tagged sectors
:284 Apply fixed plane portal to the floors of tagged sectors
:285 Apply fixed plane portal to the floors and ceilings of tagged sectors

The front side sector of the special line is used to generate the plane. The ceiling texture, sector light, and ceiling texture scrolling are all used as attributes for the rendered fixed plane. The absolute height of the ceiling is used as the height of the plane. That is, if the special line front sector has a ceiling height of 64, the plane will always render at 64 units above the camera height. If the ceiling height is 128, the plane will always render at 128 units above the camera height, and so on.

For example:

[[Image:Pfixedplane01.png]] [[Image:Pfixedplane02.png]]

The left image shows a simple map with a small sector off to the side of the rest of the map. One of the lines in this sector has been given a 283 special which will apply a fixed play portal to all tagged sector ceilings. The height of the dummy sector is set to 128, the blue water texture FWATER1 is the ceiling texture, there is no scrolling applied to the ceiling, and the ceiling height is 128.

The right image shows what the map looks like in [[Eternity]]. Notice the rendered height of the plane is the same as a ceiling 128 units above eye level.

The line special 289 can be used to apply fixed plane portals to walls as well. The special will find a portal with the same line tag and will display that portal on the surface of the line.

Here is the map from above:

[[Image:Pfixedplane03.png]] [[Image:Pfixedplane04.png]]

The highlighted wall has been given a special of 289 and tagged to the portal line. In-game, the tagged wall now displays the portal. Note: The 289 line special works for all portal types.

== Horizon Plane Portals ==

Horizon portals display two planes which appear to go on forever until they meet in the middle (horizon). The plane coordinates are not fixed, and will appear to move with the camera. This can be used to achieve the illusion that water or grass goes off far into the distance without having to make overly large sectors.

Line specials:

:286 Apply horizon portal to the ceilings of tagged sectors
:287 Apply horizon portal to the floors of tagged sectors
:288 Apply horizon portal to the floors and ceilings of tagged sectors

Like the fixed plane portals, the front sector of the special line is used. The top plane uses the front sector ceiling (height, texture, scrolling, light) as its model, and the bottom plane uses the front sector floor (height, texture, scrolling, light) as its model. Example:

[[Image:Phorizon01.png]]

This map has a horizon portal applied to the ceiling and wall of the sector where the player starts. Both sectors have a floor height of 0, and a ceiling height of 72, but the floor texture in the dummy sector is set to a grass texture, and the ceiling texture is set to FSKY_1. This produces a field of grass which goes on into the horizon. If the camera moves up or down, the floor plane will appear to move along with it. If the ceiling plane had a regular texture on it, it would also move with the camera and appear to go off into the distance.

Note: If the camera ever travels below the floor height of a horizon portal, the bottom plane will appear to move in the opposite direction of the camera movement until the camera is once again above the floor height.

== Skybox Portals ==

Skybox portals draw another part of the map into the portal window. The scene in the portal window will use the angle from the player camera, but will render the scene from the location of the skybox camera. This helps create the illusion that the contents of the skybox actually surround the map and are much larger in size than they really are.

Line specials:

:290 Apply skybox portals to the ceilings of tagged sectors
:291 Apply skybox portals to the floors of tagged sectors
:292 Apply skybox portals to the floors and ceilings of tagged sectors

The front sector of the special line becomes the "skybox sector". This is not the only sector that gets rendered, but this sector is where [[Eternity]] will look for the skybox camera object which will be the point the skybox is rendered from.

For example:

[[Image:Pskybox01.png]]

This map has a skybox portal applied to the ceiling and wall of the sector with the player start. The "Skybox sector" is the small rectangular one which contains the EESkyboxCam object. The camera object always spawns on the floor, so the skybox sector has been made a glass floor 48 units above the surrounding area so the camera will be above the floor of the box.

[[Image:Pskybox02.png]] [[Image:Pskybox03.png]]

The first image is the view in-game when the player no-clips into the sky box. The second image is the view from inside the main map area with the skybox portal applied. No matter where the player moves inside the map area, the skybox portal will always render from the location of the camera inside the skybox, however, the skybox is rendered from the angle the player is looking. [[ExtraData]] also provides a means of assigning a z-height to objects in maps. This could also be used to raise the skybox camera off the floor. If the skybox camera is left on the floor, the floor plane will not render and result in [[Doom Wiki:HOM|HOM]].

The skybox is not restricted to simple boxes. Any map architecture the skybox camera can see can be part of a skybox. Below is an example of a basic mountainous landscape created with map architecture.

[[Image:Pskybox04.png]]

== Anchored Portals ==

Anchored portals are the most powerful and complex of all the basic portal types. Anchored portals will render another area of the map into the portal window, but the portal camera moves as the player moves, creating the illusion that the other area of the map is actually connected to the main area. This can be used to create the appearance of 3D architecture. Before use, however, an understanding of how these portals work is important.

In order to piece the parts of a map together, an anchored portal needs to know how far apart they are. The distance is determined with the use of specific line specials. Each anchored portal needs a "portal line" (the line with the anchored portal special) which usually area the portal should render, and an "anchor line" which is usually located in the main map area. The distance between these lines becomes the offset, that is, how far [[Eternity]] needs to move the camera from where the player stands to get the portal area.

Line specials:

:295 Apply anchored portal to the ceilings of all tagged sectors
:296 Apply anchored portal to the floors of all tagged sectors
:297 Apply anchored portal to the floors and ceilings of all tagged sectors
:298 Anchor line (for specials 295 and 297)
:299 Anchor line (for special 296)

There are two different anchor line types so a different anchored portal can be placed on the ceiling and floor of the same sector. The two portals will share the sector tag.

For example:

[[Image:Panchored01.png]]

The above map has a single anchored portal applied to the inner sector of the area the player start is in. The "portal area" is to the right, and the "main area" is to the left. The view height is not changed, so the portal area needs to be set above the main area, or there will be [[Doom Wiki:HOM|HOM]] in the portal window. Note that no camera objects are needed for this effect. The portal will create a temporary camera automatically.

Here's how it works:

When the map is loaded, the the centers of both lines (the portal and the anchor line) are calculated, and the distance between those centers is determined:

[[Image:Panchored03.png]]

In the example, the distance is 512 units to the east and 0 units north. This set of numbers becomes the "portal offset" (distance between where the player stands and where the portal camera should go) and when the portal is rendered, the portal camera is place 512 map units east of the player camera, and the map is rendered from the portal camera.

If the portal camera becomes obstructed, unwanted results can occur:

[[Image:Panchored04.png]]

In the example above, the camera actually "wanders" out of the portal area and into the main part of the map resulting in an unwanted wall rendering in the portal window. To prevent occurrences such as this, it is usually a good idea to place the portal area a good distance away from any other map architecture to prevent the camera from "wandering into" anything else. If the camera moves out of the portal area, it won't cause problems as long as it is not obstructed by other map architecture.

== Linked Portals ==

:''See: [[Linked portals]]''

[[Category:Editing]]

List of codepointers

2011-11-17T06:39:17Z

Bloodshedder: rv

List of codepointers

2011-11-17T06:38:32Z

Bloodshedder: Reverted edits by 182.20.206.193 (Talk) to last revision by 83.250.112.5

Wodenrful explanation of facts available here.

Slope linedef types

2011-11-17T05:56:13Z

Bloodshedder: Reverted edits by 220.255.1.73 (Talk) to last revision by Printz

Eternity allows you to add slopes to levels, like in [http://zdoom.org/wiki/Slopes ZDoom]. They're set up through [[linedef types|linedefs]], which are activated at level startup. Note that contrarily to ZDoom slopes, the physics code in Eternity Engine ignores slopes for the moment: as far as collisions and movements go, a sloped sector is still flat.

The slope linedefs work by aligning a sector (front or back) to reach the height of another (back or front) along the linedef.

The floor, the ceiling, or both can be sloped. The various linedefs listed below correspond to the possible combinations.

The slope specials are:
* 386: Slope_FrontsectorFloor - The floor of the front sector is sloped to reach the height of the back sector floor.
* 387: Slope_FrontsectorCeiling - The ceiling of the front sector is sloped to reach the height of the back sector ceiling.
* 388: Slope_FrontsectorFloorAndCeiling - The floor and the ceiling of the front sector are sloped to reach the height of the back sector floor and ceiling respectively.
* 389: Slope_BacksectorFloor - The floor of the back sector is sloped to reach the height of the front sector floor.
* 390: Slope_BacksectorCeiling - The ceiling of the front sector is sloped to reach the height of the front sector ceiling.
* 391: Slope_BacksectorFloorAndCeiling - The floor and the ceiling of the back sector are sloped to reach the height of the front sector floor and ceiling respectively.
* 392: Slope_BackFloorAndFrontCeiling - The floor of the back sector slopes to the height of the front sector floor; the ceiling of the front sector slopes to the height of the back sector ceiling.
* 393: Slope_BackCeilingAndFrontFloor - The ceiling of the back sector slopes to the height of the front sector ceiling; the floor of the front sector slopes to the height of the back sector floor.
* 394: Slope_FrontFloorToTaggedSlope - Copies the floor slope of a like-tagged sector to the frontsector of the line with the special.
* 395: Slope_FrontCeilingToTaggedSlope - Copies the ceiling slope of a like-tagged sector to the frontsector of the line with the special.
* 396: Slope_FrontFloorAndCeilingToTaggedSlope - Copies both the floor and ceiling slope of a like-tagged sector to the frontsector of the line with the special.

----
''Back to [[Linedef types]]''

File:Pterminology01.png

2011-11-17T05:56:06Z

Bloodshedder: Reverted edits by 46.43.76.93 (Talk) to last revision by SoM

A simple map with no portal surfaces, and no portal window.

ExtraData

2011-11-17T05:55:56Z

Bloodshedder: Reverted edits by 183.181.99.143 (Talk) to last revision by Bloodshedder

Light0

2011-11-16T18:25:39Z

Bloodshedder: Reverted edits by 192.138.151.51 (Talk) to last revision by Printz

'''Light0''' (void)

==Usage==
Light0 is a player weapon codepointer. This codepointer is used to reset player weapon light flashes to normal. Most DOOM weapons call this pointer by transfering to frame S_LIGHTDONE (DeHackEd number 1) after their last firing frame.
==See also==
*[[Light1]]
*[[Light2]]
*[[List of codepointers]]

[[Category:Codepointers]]

Eternity Engine

2011-11-16T18:24:46Z

Bloodshedder: Reverted edits by 109.230.216.60 (Talk) to last revision by Printz

ExtraData

2011-11-16T18:24:43Z

Bloodshedder: Reverted edits by 109.230.216.60 (Talk) to last revision by Printz

Category:Editing

2011-11-16T18:24:39Z

Bloodshedder: Reverted edits by 200.246.158.1 (Talk) to last revision by Bloodshedder

Editing category, should end up with a lot of subcategories.

[[Category:Categories]]

Portals

2011-11-16T18:24:26Z

Bloodshedder: Reverted edits by 64.64.11.143 (Talk) to last revision by Quasar

#REDIRECT [[Portal]]

Portal

2011-11-16T18:24:15Z

Bloodshedder: rv

List of codepointers

2011-11-16T18:23:54Z

Bloodshedder: rv

List of codepointers

2011-07-13T16:45:29Z

Bloodshedder: Reverted edits by 59.152.215.253 (Talk) to last revision by Printz

This '''list of codepointers''' is a list of all the action routines which can be used in [[EDF]] [[frame]]s. The Heretic actions ''can'' be used in Doom based modifications.

=Player guns=
==Attacks==
*[[CustomPlayerMelee]]
*[[FireBFG]]
*[[FireCGun]]
*[[FireCustomBullets]]
*[[FireMissile]]: rocket launcher attack
*[[FireOldBFG]]: alpha Doom BFG attack
*[[FirePistol]]
*[[FirePlasma]]
*[[FirePlayerMissile]]: custom missile attack
*[[FireShotgun]]
*[[FireShotgun2]]: super shotgun attack
*[[PlayerThunk]] {{deprecated}}
*[[Punch]]: fist attack
*[[Saw]]: chainsaw attack

==Control==
*[[CheckReload]]: super shotgun reload check
*[[CheckReloadEx]]: extended version that allows counter comparison
*[[JumpIfNoAmmo]]: as it says
*[[Lower]]: "lower" effect & frame
*[[Raise]]: "raise" effect & frame
*[[ReFire]]: skip frame if shooting is maintained (plasma gun cooldown effect)
*[[WeaponReady]]: "bob" effect, ready frame

==Other==
*[[EjectCasing]]: throw casing
*[[PlayerStartScript]]: start map script

==Muzzle flash effects==
*[[GunFlash]]: produces gunflash sprite without firing anything
*[[Light0]]: resets the muzzle light level
*[[Light1]]: muzzle light level 1
*[[Light2]]

==Sound effects==
*[[BFGSound]]
*[[CloseShotgun2]]: this one also includes ReFire
*[[LoadShotgun2]]: ...these two don't
*[[OpenShotgun2]]

==Frame scripting==
*[[WeaponCopyCtr]]
*[[WeaponCtrOp]]
*[[WeaponCtrJump]]
*[[WeaponCtrSwitch]]
*[[WeaponSetCtr]]

=Map objects=
==Flashes and booms==
*[[BFG11KHit]]: [[SMMU]] BFG variant
*[[BFGBurst]]: produce a burst of smaller plasma objects
*[[BFGSpray]]: BFG explosion afterglow
*[[BouncingBFG]]: SMMU bouncing BFG
*[[BrainExplode]]: brain perpetual explosion controller
*[[BrainScream]]: giant demon wall explosion sequence
*[[Detonate]]: thing damage controlled explosion
*[[Explode]]: rocket/barrel splash damage
*[[Fire]]: stick on the face of attacker's target, like the vile fire
*[[GenTracer]]: generic tracer
*[[Mushroom]]: mushroom explosion
*[[Nailbomb]]: explosion with shrapnels
*[[SpawnFly]]: spawn cube controller
*[[Tracer]]: one of the required components for homing missiles
===Heretic===
*[[BeastPuff]]: weredragon fire belch smoke
*[[BlueSpark]]: create a blue d'sparil attack spark
*[[GenWizard]]: create a disciple
*[[HticExplode]]: heretic-compatible explosion
*[[HticTracer]]: like those golem skulls
*[[LichFireGrow]]: how the fire column expands
*[[LichIceImpact]]: how an ice globe explodes into shards
*[[MntrFloorFire]]: used by the straight flame snake
*[[PhoenixPuff]]: missile trail
*[[PodPain]]: pod goo splash on being hit
*[[VolcBallImpact]]: how a volcano ball fragments on impact
*[[WhirlwindSeek]]: used by the tornados

==AI==
*[[AlertMonsters]]: shout so other monsters chase the player
*[[Chase]]: pursue a target and check for attack
*[[CPosRefire]]: go to seestate if target is out of sight
*[[Face]]: face a specified angle
*[[FaceTarget]]: turn to target, look around it if it's partly invisible
*[[GenRefire]]: customizable refire control
*[[KeepChasing]]: pursue target without attacking
*[[Look]]: stand in guard, looking for targets
*[[RandomWalk]]: random wandering for inactive enemies
*[[Sor1Chase]]: d'sparil mount specific chase
*[[Sor1Pain]]: d'sparil mount specific twitch. Calls Pain.
*[[SpidRefire]]: like CPosRefire, slightly modified
*[[Turn]]: turn around a specified angle
*[[VileChase]]: same as Chase, but resurrecting encountered cadavers

==AI attacks==
*[[BetaSkullAttack]]: remote melee attack
*[[BrainSpit]]: cube spawn
*[[BruisAttack]]: baron/knight of hell
*[[BspiAttack]]: arachnotron
*[[BulletAttack]]: custom bullet shooting
*[[CPosAttack]]: pistol attack w/ shotgn noise
*[[CyberAttack]]: rocket launching
*[[FatAttack1]]: mancubus left attack
*[[FatAttack2]]: mancubus right attack
*[[FatAttack3]]: mancubus front attack
*[[HeadAttack]]: cacodemon
*[[MissileAttack]]: custom missile shooting
*[[MissileSpread]]: MissileAttack variation, supports shooting spread shots
*[[PainAttack]]: elemental
*[[PainDie]]: elemental death (3 souls)
*[[PosAttack]]: former human
*[[SargAttack]]: demon bite
*[[Scratch]]: custom melee attack
*[[SkelFist]]: revenant punch
*[[SkelMissile]]: revenant missile
*[[SkullAttack]]: flying skull
*[[SPosAttack]]: sergeant
*[[ThingSummon]]: customized summoning
*[[TroopAttack]]: imp
*[[VileAttack]]: arch vile toss
*[[VileTarget]]: spawn a vile fire effect on target
===Heretic===
*[[BeastAttack]]: weredragon
*[[ClinkAttack]]: sabre
*[[ImpChargeAtk]]: gargoyle charge
*[[ImpMeleeAtk]]: gargoyle scratch
*[[ImpMisssileAtk]]: gargoyle fire
*[[KnightAttack]]: undead warrior
*[[LichAttack]]: iron lich random attack **only one which includes ice globes**
*[[LichFire]]: iron lich fire column
*[[LichWhirlwind]]: iron lich tornado
*[[MinotaurAtk1]]: maulotaur melee damage
*[[MinotaurAtk2]]: spreadshot
*[[MinotaurAtk3]]: straight flame snake
*[[MinotaurCharge]]: maulotaur charge
*[[MinotaurDecide]]: maulotaur ranged attack choosing
*[[MummyAttack]]: golem melee
*[[MummyAttack2]]: nitrogolem range
*[[SnakeAttack]]: ophidian blue spark
*[[SnakeAttack2]]: ophidian yellow shot
*[[Srcr1Attack]]: d'sparil mount attack
*[[Srcr2Attack]]: d'sparil sorcerer attack
*[[Srcr2Decide]]: d'sparil decide whether to teleport
*[[VolcanoBlast]]: volcano burst
*[[WizardAtk3]]: disciple tri-ball

==Alterations==
*[[BossDeath]]: special monster death functions (such as Baron death in E1M8)
*[[BrainDie]]: exits the level
*[[CasingThrust]]: movement for ejected casing
*[[Die]]: causes suicide
*[[FadeIn]]: increments alpha
*[[FadeOut]]: decrements alpha, DOESN'T destroy the thing
*[[Fall]]: remove SOLID flag (used on dying monsters)
*[[KeenDie]]: open 666-tagged doors on death of all like-named monsters
*[[KillChildren]]: destroy all summoned things
*[[LineEffect]]: activate a tag using a special
*[[PainNukeSpec]]
*[[SetFlags]]: alter flags
*[[SetTranslucent]]: modify alpha amount; setup additiveness or fuzziness
*[[ShowMessage]]: display text message
*[[Spawn]]: create another object on top of this one
*[[StartScript]]: run map script
*[[SteamSpawn]]: create steam effects
*[[Stop]]: set velocity to 0
*[[UnSetFlags]]: alter flags
===Heretic===
*[[AccelGlitter]]: accelerate upwards
*[[DripBlood]]: spawn heretic blood
*[[HticBossDeath]]: special monster death functions for Heretic
*[[ImpDeath]]: special death for gargoyle
*[[ImpExplode]]: crash for gargoyle
*[[ImpXDeath1]]: special extreme death for gargoyle, stage 1
*[[ImpXDeath2]]: special extreme death for gargoyle, stage 2
*[[MakePod]]: generate a pod
*[[MummySoul]]: create raising soul
*[[PlayerSkull]]: player death effect, when the skull tosses in air
*[[RemovePod]]: notifies the generator that this pod was destroyed
*[[Sor2DthInit]]: d'sparil death maintenance
*[[Sor2DthLoop]]: d'sparil death maintenance
*[[SorcererRise]]: d'sparil waking up after mount crash
*[[SorcNukeSpec]]
*[[SpawnAbove]]: spawns above the summoner
*[[SpawnGlitter]]: create teleportation sparkle
*[[WizardAtk1]]: face target and clear GHOST flag
*[[WizardAtk2]]: face target and set GHOST flag

==Sound effects==
*[[AmbientThinker]]: ambient sound maintenance
*[[BabyMetal]]: bspwlk sound effect -- also includes Chase!
*[[BrainAwake]]: loud bossit sound effect
*[[BrainPain]]: loud bospn sound effect
*[[FatRaise]]: mancubus warning -- also includes FaceTarget
*[[FireCrackle]]: flame sound effect -- also includes "Fire" action!
*[[Hoof]]: cyberdemon hoof sound -- also includes Chase!
*[[Metal]]: metal sound effect -- also includes Chase!
*[[Pain]]: play pain sound
*[[PlayerScream]]: player-specific, health-dependent (death) sound
*[[PlaySound]]: custom sound
*[[PlaySoundEx]]: extended custom sound
*[[Scream]]: play death sound
*[[SkelWhoosh]]: revenant swing noise -- also includes FaceTarget
*[[SpawnSound]]: boscub sound effect -- also includes SpawnFly
*[[StartFire]]: flamst sound effect -- also includes "Fire" action!
*[[VileStart]]: archvile heat-up noise
*[[XScream]]: extreme death gut noise

==Frame scripting==
*[[AproxDistance]]: assign distance from target to a variable
*[[CheckPlayerDone]]: jump to a frame if not under player control
*[[CopyCounter]]: copy a variable to another variable
*[[CounterJump]]: counter-based next frame
*[[CounterOp]]: set a variable to an operation of another 2 variables
*[[CounterSwitch]]: counter-based set of frames
*[[HealthJump]]: health-based next frame
*[[JumpIfTargetInLOS]]: jump to frame if target is in the field of view
*[[RandomJump]]: random next frame
*[[SetCounter]]: set a variable
*[[SetTics]]: set frame duration
*[[TargetJump]]: go to designated frame if having a target

[[Category:Codepointers|*]]

Category:Tutorials

2011-07-13T16:44:42Z

Bloodshedder: Reverted edits by 93.186.192.216 (Talk) to last revision by Bloodshedder

For editing tutorials and such.

[[Category:Editing]]

Linked portal

2011-07-13T16:44:31Z

Bloodshedder: rv

(If you have not read [[Portals]], please do so now before reading this article.)

'''WARNING:''' Linked portals are currently an in development feature and object movement through them is not yet fully implemented. Usage of linked portals for gameplay purposes is NOT recommended at this time of writing.

----

'''Linked portals''' are a powerful feature which make it possible to connect two separate areas of a map via the floor/ceiling or one-sided linedefs, allowing the player to see, shoot, and even move seamlessly from one area into another. They are used similarly to two-way portals, apart from the fact that you can pass through them. They can be used to create 3D architecture and room-over-room effects, with very few limitations.

==Line triggers==
# Class Trig Description

358 Ext -- Apply linked portal to like-tagged ceilings

359 Ext -- Apply linked portal to like-tagged floors

360 Ext -- Linked portal anchor line for special 358

361 Ext -- Linked portal anchor line for special 359

376 Ext -- Apply linked portals to like-tagged lines

377 Ext -- Anchor line for special 376

==Terminology==
Linked portals have their own specific sub-set of terminology used to describe certain aspects and behaviors.

===Portal Plane===
Unlike the basic portal types, which were rendered and could cover height variances (much like the doom sky), linked portals form an actual map structure. The '''Portal Plane''' refers to an X/Y plane that bisects the sector(s) that contain the portal. The z-position of the portal is fixed, and should be the same height on both sides of the linked portal.

===Beyond the Plane===
Map architecture is said to be beyond the portal plane when its vertical height is equal to or beyond the portal height--that is, at or above a ceiling portal plane or at or below a floor portal plane. When map architecture is beyond a portal plane, the portal will display at the height of the plane.

===Inside the plane===
Map architecture is said to be inside the portal plane when its vertical height is not beyond the portal plane--that is, below a ceiling portal or above a floor portal. Any architecture that is inside the portal plane will render normally and will obscure rendering of the portal.

==Usage==
Linked portals use trigger and anchor lines (much like anchored portals) to determine an X and Y offset from one part of the map to another, but there are specific requirements unique to linked portals:

*Linked portals must be two-way, meaning the upper area must reference the lower area and visa versa.
*Linked portals have specific behavior relating to z-coordinates of the portal plane.

===Setup (Doom line specials)===

(this section is still under construction)

==Tutorial==
Refer to Zarkyb's [[linked portals tutorial]] for in-depth information on usage.

[[Category:Editing]]

Category:Scripting

2011-07-13T16:41:49Z

Bloodshedder: Reverted edits by 86.28.210.250 (Talk) to last revision by Bloodshedder

For scripting-related articles.

[[Category:Editing]]

List of command line parameters

2011-07-13T16:40:56Z

Bloodshedder: rv

This is a list of all '''command line parameters''' that are supported by the Eternity Engine, along with detail about their functions. Most of the options available through the command line are also settable with the [[Eternity Frontend]].

:''See also: [[Doom_Wiki:Command line arguments|Command line arguments]] on the [[Doom Wiki]]''

==Console==
* -exec <filename> : Executes the indicated file as a console script at game startup.
* -nocscload : Disables autoloaded console scripts for this play session only.

==Debugging==
* -devparm : Enables FPS ticker and screenshots with F1 key (id development mode)

==DeHackEd/BEX==
* -bex <filename> ... : Alias for -deh.
* -bexout <filename> : Alias for -dehout.
* -deh <filename> ... : Loads one or more DeHackEd/BEX patch files.
* -dehout <filename> : Enables verbose DeHackEd parser logging.

==EDF==
* -edf <filename> : Specifies the root EDF file.
* -edfenables : Causes all gamemode's definitions to be enabled. For compatibility with older projects.
* -edfout : Enables verbose EDF logging to edfout##.txt

==Gameplay==
* -dog : Enables a single MBF helper dog.
* -dogs <n> : Enables from one to three MBF helper dogs, depending on the number specified.
* -episode <n> : Start a new game on episode n. For DOOM and Heretic only.
* -fast : Enables Nightmare-mode monster speed in any difficulty.
* -nomonsters : Removes all monsters except Lost Souls from all levels.
* -respawn : Enables Nightmare-mode monster respawning in any difficulty.
* -skill <n> : Sets skill to level 1 through 5.
* -solo-net : Starts the game as single-player cooperative '''(SVN revision 1071+)'''
* -spechit <n> : Sets spechit emulation magic number to n. Spechit emulation must be enabled separately.
* -turbo <n> : Sets player turbo factor to n.
* -warp <x> <y> : Warps to level x in DOOM 2, or ExMy for DOOM or Heretic.
* -wart : Alias for -warp.

==Miscellaneous==
* -affinity <num> : Enables processor affinity mask to stop SDL_mixer crashes on multicore processors. Expert setting only.
* -blockmap : Enables MBF blockmap builder for all levels.
* -cdrom : Game is running from a cd-rom. Data is written to C:\DOOMDATA. Does not work in Linux.
* -grabmouse : Enables mouse input grabbing.
* -nograbmouse : Disables mouse input grabbing.
* -numparticles <n> : Sets the static particle limit to n.
* -speed <n> : Sets game speed to n% of normal speed. Range is 10 to 1000.
* -statcopy : Does nothing. Enabled external statistics driver in Vanilla Doom.

==Multiplayer==
* -altdeath : Enables Deathmatch 2.0 (items respawn, weapons stay).
* -avg : Austin Virtual Gaming. Deathmatch levels end after 20 minutes.
* -deathmatch : Enables original Deathmatch mode.
* -dmflags <n> : Sets the dmflags variable to value n.
* -dup
* -extratic
* -frags <n> : Sets fraglimit for Deathmatch. Levels end when the fraglimit is reached.
* -net
* -timer <n> : Sets timelimit for Deathmatch to n minutes.
* -trideath : Enables SMMU Deathmatch 3.0 (barrels respawn, players drop backpacks [currently broken]).

==Savegames==
* -loadgame <n> : Loads the savegame in slot n (0-7).
* -save <path> : Sets the directory from/to which savegames are loaded and saved.

==Sound engine==
* -nomusic : Disables the music engine.
* -nosfx : Disables the digital sound engine.
* -nosound : Disables sound and music.

==Video==
* -8in32 : Runs Eternity in a 32-bit video mode and crossblits the 8-bit framebuffer to the screen. Circumvents some SDL palette issues, but is slower.
* -directx : Windows only. Selects the DirectX 5.0 SDL video driver.
* -frame : Creates a main window with a frame (this is on by default for windowed modes and off for fullscreen).
* -fullscreen : Toggles fullscreen mode.
* -gdi : Windows only. Selects the Win32 GDI SDL video driver.
* -geom <geomstring> : Sets the video mode using a [[Geom string]].
* -noblit : Disables blitting for benchmark testing.
* -nodraw : Disables all screen drawing.
* -noframe : Opposite of -frame, creates a frameless window, if possible on the current platform.
* -nofullscreen : Alias for -window.
* -novsync : Disables waiting for vsync.
* -vheight <n> : Sets screen height to n; current limits are 200 to 1600.
* -vsync : Enables waiting for vsync.
* -vwidth <n> : Sets screen width to n; current limits are 320 to 2560.
* -window : Toggles windowed mode.

==Wads and other files==
* -base <path> : Sets the base path to the indicated path. The path must be a directory, not a file.
* -config <filename> : Game will use the given configuration file.
* -file <filename> ... : Loads one or more WAD or lump files. Lump file names must be 8 characters or less with .lmp extension added.
* -game <name> : Causes Eternity to use the named game folder under its current base path.
* -gfs <filename> : Loads the given GFS script. GFS scripts may load WADs, DEH/BEX files, EDF, and console scripts.
* -iwad <filename> : Specifies the given WAD file as the IWAD.
* -noload : Disables autoloaded WADs and DEH/BEX patches during this play session only.
* -nowadhacks : Disables automatic application of wad directory hacks to known broken WAD files, such as Gothic DM 2.
* -showhashes : Enables display of WAD header/directory SHA-1 hashes on the system console.

==Demos==
* -donut <height> <pic> : Enables donut overflow emulation using the specified parameters.
* -fastdemo <filename> : Plays the given demo as fast as possible.
* -longtics : Enables v1.91 longtics demo recording when used with -vanilla.
* -maxdemo <n> : Sets the initial size of the demo recording buffer. This is no longer a hard limit, and the buffer will expand if the given limit is exceeded.
* -play : Alias for -playdemo.
* -playdemo <filename> : Plays the given demo.
* -record <filename> : Records this play session as a demo named "filename".
* -recorddemo : Alias for -record.
* -recordfrom
* -spechit <number> : Enables spechits overflow emulation with the given magic number.
* -timedemo <filename> : Plays the given demo normally and reports FPS information at exit.
* -vanilla : Enables recording of v1.9-compatible demo files.

Small

2011-07-13T16:39:34Z

Bloodshedder: rv

{{deprecatednotice|reason=Small is deprecated because its bytecode is not portable to 64-bit architecture! Support for Small will possibly be removed in future versions of Eternity, and should not be expected to be available on any 64-bit binary build.}}

'''Small''' is a scripting language created by ITB CompuPhase; it uses a [[Wikipedia:C programming language|C]]-like syntax and is [[Eternity]]'s main scripting language, replacing the [[Fragglescript]] of earlier versions. To be used in Eternity, the script files must first be compiled using the <tt>sc</tt> executable. Script files usually have the extension <tt>.sma</tt>, but files of any extension can be compiled. Assuming the script has no errors, the compiler should output an <tt>.amx</tt> file, which can be loaded into a [[Doom wiki:WAD|WAD]] for use with Eternity.

== Script types ==

There are two types of script: gamescript and levelscript. Gamescripts work over a whole gaming session, while levelscripts only work on maps which have specified that script in their level info. To use a script file as a gamescript, the compiled script file should be loaded into a WAD and given the lump name <tt>GAMESCR</tt>. These gamescript files will work over every level.

Levelscripts are loaded using a different method. To specify a script for use in a single map, <tt>levelscript=MYSCRIPT</tt> should be added to the map's [[MapInfo]]. Here, <tt>MYSCRIPT</tt> should be replaced with your script's lump name, which can be anything.

== Triggering scripts ==

There are many ways to start a script. They can be triggered by a linedef, the start of a map, or a codepointer specified on a Thing.

=== Triggering via linedef ===

The most common way is to start a script when a linedef is triggered. To do this, first give the linedef you want to trigger the script a <tt>Start</tt> script action (linedef actions 273-280) and a unique tag number. For example, if we want our script to start when the player walks over a linedef, use linedef action 280 and give the linedef a tag of 1. The script would then look like this:

public Script1()
{
_Printf( _MSG_NORMAL, "Hello World");
}

Note that the Script## number is the same as the linedef's tag. Compile your script and set up the wad as explained above. Assuming all things have been set up properly, when you walk over that linedef, it will output "Hello World" to the screen.

=== Triggering on map start ===

Another way of starting a script is using the <tt>OnInit()</tt> function.

public OnInit()
{
_Printf( _MSG_NORMAL, "Hello World");
}

This script will output "Hello World" when the map starts up. This could be useful for starting a series of callbacks for animating HUD sprites or raising/lowering sectors.

=== Triggering by Thing codepointer ===

The final way is to use the StartScript codepointer on a Thing's frame. The StartScript codepointer uses the first two args to decide the script number to execute and the script type (whether it is levelscript or gamescript). For example, the [[EDF]] file to do this is:

stdinclude(root.edf)
framedelta
{
name = S_TROO_DIE1 // Frame we want to start the script on
action = StartScript // The startscript codepointer
args = {1,0} // Codepointer's arguments, starts script 1 and sets the type to game (0)
}

Load the EDF with your map and script, and whenever you kill an imp (therefore going onto the frame S_TROO_DIE1, it will run script 1, outputting "Hello World". As this script is a gamescript, it will do this on every map.

== Functions ==
=== Core Small functions ===
*[[heapspace]]
*[[funcidx]]
*[[numargs]]
*[[getarg]]
*[[setarg]]
*[[strlen]]
*[[strpack]]
*[[strunpack]]
*[[tolower]]
*[[toupper]]
*[[swapchars]]
*[[min]]
*[[max]]
*[[clamp]]
=== Invocation Functions ===
*[[_GetInvokeType]]
*[[_GetCcmdSrc]]
*[[_GetPlayerSrc]]
*[[_GetThingSrc]]
*[[_SetCallback]]
*[[_ExecGS]]
*[[_ExecLS]]
*[[_GetLevelVar]]
*[[_SetLevelVar]]
*[[_GetGameVar]]
*[[_SetGameVar]]
=== Input/output ===
*[[_ConsolePrint]]
*[[_ConsoleHR]]
*[[_ConsoleBeep]]
*[[_Itoa]]
*[[_Printf]]
*[[_CenterMsgTimed]]
=== Fixed-point math library ===
*[[_ffloat]]
*[[_fmul]]
*[[_fdiv]]
*[[_fabs]]
*[[fixed]]
*[[_ffract]]
*[[_ffloor]]
*[[_fceil]]
*[[_ftoi]]
=== Random number generators ===
*[[_P_Random]]
*[[_M_Random]]
=== Heads-up display ===
*[[_NewPatchWidget]]
*[[_SetWidgetPatch]]
*[[_PatchWidgetColor]]
*[[_NewTextWidget]]
*[[_GetWidgetText]]
*[[_SetWidgetText]]
*[[_ToggleWidget]]
*[[_MoveWidget]]
*[[_GetHUDMode]]
*[[_InAutomap]]
=== Game functions ===
*[[_ExitLevel]]
*[[_ExitSecret]]
*[[_StartGame]]
*[[_GameSkill]]
*[[_GameType]]
*[[_EngineVersion]]
*[[_GetPlayerName]]
=== Mapthings ===
*[[_ThingKill]]
*[[_ThingHurt]]
*[[_ThingMassacre]]
*[[_ThingHate]]
*[[_ThingNumForName]]
*[[_ThingNumForDEHNum]]
*[[_ThingUnknown]]
*[[_ThingCheckType]]
*[[_ThingSpawn]]
*[[_ThingSpawnSpot]]
*[[_ThingGetProperty]]
*[[_ThingSetProperty]]
*[[_ThingFlagsFromStr]]
*[[_ThingThrust]]
*[[_ThingThrust3f]]
*[[_ThingGetPos]]
*[[_GetFreeTID]]
=== Sounds ===
*[[_SoundGlobal]]
*[[_SoundGlobalNum]]
*[[_SectorSound]]
*[[_SectorSoundNum]]
*[[_ThingSound]]
*[[_ThingSoundNum]]
*[[_ThingInfoSound]]
=== Particles ===
*[[_PtclExplosionPos]]
*[[_PtclExplosionThing]]
=== Sectors ===
*[[_SectorSpecial]]
*[[_SectorColormap]]
=== Parameterized line specials ===
*[[_SpecialMode]]
*[[_ByteAngleToDegrees]]
*[[_DegreesToByteAngle]]
*[[_ByteAngleToFixed]]
*[[_FixedToByteAngle]]
*[[_Door_Raise]]
*[[_Door_Open]]
*[[_Door_Close]]
*[[_Door_CloseWaitOpen]]
*[[_Door_WaitRaise]]
*[[_Door_WaitClose]]
*[[_Floor_RaiseToHighest]]
*[[_Floor_LowerToHighest]]
*[[_Floor_RaiseToLowest]]
*[[_Floor_LowerToLowest]]
*[[_Floor_RaiseToNearest]]
*[[_Floor_LowerToNearest]]
*[[_Floor_RaiseToLowestCeiling]]
*[[_Floor_LowerToLowestCeiling]]
*[[_Floor_RaiseToCeiling]]
*[[_Floor_RaiseByTexture]]
*[[_Floor_LowerByTexture]]
*[[_Floor_RaiseByValue]]
*[[_Floor_LowerByValue]]
*[[_Floor_MoveToValue]]
*[[_Floor_RaiseInstant]]
*[[_Floor_LowerInstant]]
*[[_Floor_ToCeilingInstant]]
*[[_Ceiling_RaiseToHighest]]
*[[_Ceiling_ToHighestInstant]]
*[[_Ceiling_RaiseToNearest]]
*[[_Ceiling_LowerToNearest]]
*[[_Ceiling_RaiseToHighestFloor]]
*[[_Ceiling_LowerToHighestFloor]]
*[[_Ceiling_ToFloorInstant]]
*[[_Ceiling_LowerToFloor]]
*[[_Ceiling_RaiseByTexture]]
*[[_Ceiling_LowerByTexture]]
*[[_Ceiling_RaiseByValue]]
*[[_Ceiling_LowerByValue]]
*[[_Ceiling_MoveToValue]]
*[[_Ceiling_RaiseInstant]]
*[[_Ceiling_LowerInstant]]
*[[_Stairs_BuildUpDoom]]
*[[_Stairs_BuildDownDoom]]
*[[_Stairs_BuildUpDoomSync]]
*[[_Stairs_BuildDownDoomSync]]
*[[_Polyobj_DoorSlide]]
*[[_Polyobj_DoorSwing]]
*[[_Polyobj_Move]]
*[[_Polyobj_OR_Move]]
*[[_Polyobj_RotateRight]]
*[[_Polyobj_OR_RotateRight]]
*[[_Polyobj_RotateLeft]]
*[[_Polyobj_OR_RotateLeft]]
*[[_Pillar_Build]]
*[[_Pillar_BuildAndCrush]]
*[[_Pillar_Open]]
=== Cameras ===
*[[_ToggleChasecam]]
*[[_IsChasecamOn]]
=== Special Functions ===
*[[_ForceLightning]]
[[Category:Scripting]]

EMAPINFO

2011-07-13T16:39:10Z

Bloodshedder: rv

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

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

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

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

'''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. This value is currently only used for DOOM II and Ultimate DOOM episode 4 maps. 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 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

'''levelname'''
:This is the name of the level which will be displayed in the automap. This value overrides any string provided via DeHackEd. For 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. Note: you cannot currently specify the graphic to be shown for the next map. This is a known bug in MapInfo and may not be repaired due to the new edf-intername feature. This value is only used for DOOM and DOOM II maps. For example:
levelpic = E1M1PIC

'''levelscript'''
:Name of a compiled Small script lump which will serve as the Levelscript for this map. See the Small Usage Documentation for full information on how the Levelscript works. There are no naming restrictions on script lumps. For example:
levelscript = SCRIPT01

'''leveltype'''
:String value that declares what type of level the current map is classified as. Possible values are "doom" and "heretic". This variable affects the automatic translation of thing types and line specials. For example:
leveltype = heretic

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

'''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
stnmov
pstop
pstart
bdcls
bdopn
dorcls
doropn

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]]

Main Page

2009-08-15T22:58:44Z

Bloodshedder:

Talk:Main Page

2009-05-21T23:11:00Z

Bloodshedder: Protected "Talk:Main Page" [edit=autoconfirmed:move=autoconfirmed]