Eternity Wiki - User contributions [en]

EDF item effects and inventory

2017-08-13T16:46:11Z

Quasar: Change style

<div style="margin-left: 1.6em; margin-bottom: 0.5em">''For information on current development progress, see [[{{PAGENAME}}/Weapons-branch|weapons-branch]]''</div>

Define what happens when an item is picked up (and eventually, used or dropped from the inventory - this is not complete yet).

There are many different types of item effect definitions:
===artifact===
An artifact is an item which, when collected, goes into the player's inventory.

artifact <name>
{
amount <int> // amount gained with one pickup
maxamount <int> // max amount that can be carried in inventory
interhubamount <int> // max amount carryable between levels in different hubs;
// -1 if this field should not apply at all
sortorder <int> // key used for sorting the player's inventory
icon <str> // name of icon graphic for invbar (currently unused)
usesound <str> // sound made when item is used (currently unused)
useeffect <str> // name of item effect to use for activation (unused)

[+-]undroppable // if +, cannot be dropped from inventory
[+-]invbar // if +, appears in invbar; otherwise, invisible
[+-]keepdepleted // if +, will remain in inventory with amount of zero
[+-]fullamountonly // if +, cannot pickup unless full amount is needed

// artifacttype determines what sort of artifact this is.
artifacttype <str> // "Normal", "Ammo", "Key", "Puzzle", "Power", "Weapon",
// or "Quest"

// The following fields apply only to certain artifact types. They have no
// effect if specified on other types.

// Ammo
ammo.backpackamount <int> // amount of this ammo type given by a Backpack
ammo.backpackmaxamount <int> // max amount after collecting a Backpack
}
===healtheffect===
A health effect gives the player health in one of many possible ways.
healtheffect <name>
{
amount <int> // amount of health to give
maxamount <int> // max amount this item can health to; if player has greater
// health, the item cannot be picked up at all.
lowmessage <str> // alternate message to give instead of pickupfx message when
// health is < amount; if starts with $, is a BEX mnemonic.

[+-]alwayspickup // if +, item is picked up even when unneeded (ie Health Bonus)
[+-]sethealth // if +, item SETS health rather than adding to it (ie Megasphere)
}
===armoreffect===
An armor effect defines the properties of player armor
armoreffect <name>
{
saveamount <int> // amount of armor given
savefactor <int> // numerator of fraction determining save percentage
savedivisor <int> // denominator of fraction determining save percentage
maxsaveamount <int> // max amount his item can give; if player has greater
// armor, the item cannot be picked up at all

[+-]alwayspickup // item is picked up even when unneeded (ie Armor Bonus)
[+-]bonus // if +, is a bonus (adds to current armor type without
// changing the protective qualities)
}
===ammoeffect===
Ammo givers give an Ammo type artifact to the player.
ammoeffect <name>
{
ammo <str> // Name of an Ammo-type artifact definition
amount <int> // Amount to give for an ordinary pickup
dropamount <int> // Amount to give if dropped by an enemy

[+-]ignoreskill // if +, does not double on skills that give double ammo
}

EDF item effects and inventory/Weapons-branch

2017-08-13T16:39:32Z

Quasar: Quasar moved page EDF item effects and inventory/Weaopns-branch to EDF item effects and inventory/Weapons-branch without leaving a redirect

'''REMOVE THIS WARNING AT A LATER DATE: Much of this page is in-development features, from inventory-branch-2016, and its successor: weapons-branch. This exists solely for the purpose of easily moving this article back over when weapons-branch is to be merged back into master, and should under no circumstances be used as a reference.'''

Define what happens when an item is picked up and used (and eventually, dropped from the inventory - this is not complete yet).

There are many different types of item effect definitions:

{{Backto|EDF item effects and inventory}}
===artifact===
An artifact is an item which, when collected, goes into the player's inventory.

artifact <name>
{
amount <int> // amount gained with one pickup
maxamount <int> // max amount that can be carried in inventory
interhubamount <int> // max amount carryable between levels in different hubs;
// -1 if this field should not apply at all
sortorder <int> // key used for sorting the player's inventory
icon <str> // name of icon graphic for invbar
usesound <str> // sound made when item is used
useeffect <str> // name of item effect to use for activation

[+-]undroppable // if +, cannot be dropped from inventory
[+-]invbar // if +, appears in invbar; otherwise, invisible
[+-]keepdepleted // if +, will remain in inventory with amount of zero
[+-]fullamountonly // if +, cannot pickup unless full amount is needed

// artifacttype determines what sort of artifact this is.
artifacttype <str> // "Normal", "Ammo", "Key", "Puzzle", "Power", "Weapon",
// or "Quest"

// The following fields apply only to certain artifact types. They have no
// effect if specified on other types.

// Ammo
ammo.backpackamount <int> // amount of this ammo type given by a Backpack
ammo.backpackmaxamount <int> // max amount after collecting a Backpack
}
===healtheffect===
A health effect gives the player health in one of many possible ways.
healtheffect <name>
{
amount <int> // amount of health to give
maxamount <int> // max amount this item can health to; if player has greater
// health, the item cannot be picked up at all.
lowmessage <str> // alternate message to give instead of pickupfx message when
// health is < amount; if starts with $, is a BEX mnemonic.

[+-]alwayspickup // if +, item is picked up even when unneeded (ie Health Bonus)
[+-]sethealth // if +, item SETS health rather than adding to it (ie Megasphere)
}
===armoreffect===
An armor effect defines the properties of player armor
armoreffect <name>
{
saveamount <int> // amount of armor given
savefactor <int> // numerator of fraction determining save percentage
savedivisor <int> // denominator of fraction determining save percentage
maxsaveamount <int> // max amount his item can give; if player has greater
// armor, the item cannot be picked up at all

[+-]alwayspickup // item is picked up even when unneeded (e.g. Armor Bonus)
[+-]bonus // if +, is a bonus (adds to current armor type without
// changing the protective qualities)
}
===ammoeffect===
Ammo givers give an Ammo type artifact to the player.
ammoeffect <name>
{
ammo <str> // Name of an Ammo-type artifact definition
amount <int> // Amount to give for an ordinary pickup
dropamount <int> // Amount to give if dropped by an enemy

[+-]ignoreskill // if +, does not double on skills that give double ammo
}
===powereffect===
Power givers give a power to the player.
powereffect <name>
{
duration <int> // Length of time to last in tics
type <str> // Name of power to give

[+-]additivetime // if +, adds to current duration
[+-]permanent // if +, lasts forever
[+-]overridesself // if +, getting the power again while still under its influence is allowed
}
===weapongiver===
Weapon givers give a Weapon type artifact to the player, and optionally any number of Ammo artifact types.
weapongiver <name>
{
weapon <str> // Name of a weaponinfo to give to the player
ammogiven <ammo>, <amount> [, <dropammount> [, <dmammount> [, <coopweaponsstay>]]] // Ammo type artifact given, and the amounts
// given based on how it was picked up. If the
// last three are left blank, only "amount" is used.
}

Talk:List of codepointers

2016-10-02T08:19:26Z

Quasar: Reverted edits by 89.178.207.116 (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-10-02T08:16:02Z

Quasar: Reverted edits by 89.178.207.116 (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.

Category:Templates

2016-10-02T07:59:40Z

Quasar: Cat

Category for all templates. Most templates should be placed in a subcategory.

[[Category:Categories]]

Category:External link templates

2016-10-02T07:59:10Z

Quasar: Cat

Templates for linking to external sites

[[Category:Templates]]

Template:Doomwiki

2016-10-02T07:58:43Z

Quasar: Doom Wiki linking template

[[doom_wiki:{{{1}}}|{{{2|{{{1}}}}}}]]<noinclude>
==Purpose==
Create a link to the [[doom_wiki:Doom Wiki|Doom Wiki]].

===Args===
# Article name on the Doom Wiki
# Optional; Text to display instead of the exact article name.

[[Category:External link templates]]</noinclude>

Creating a projectile

2016-10-02T07:49:29Z

Quasar: Use interwiki

In this tutorial, we will look at the projectile we made during [[creating a monster]] in greater detail.

First off we need to define two files, EDFROOT and EPRJCTLS (or any other name of your choosing). EDFROOT should look like this.
stdinclude("root.edf")

// New projectiles:
lumpinclude("EPRJCTLS") // Change this based on whatever you're calling your equivalent of EPRJCTLS.

Now we'll create a new projectile that replaces the rockets entirely, using solely IWAD assets, within EPRJCTLS.

thingtype DriftingEnergyNuke // This name is given due to it lazily drifting along before exploding.
{
basictype PlayerProjectile // Flags: NOBLOCKMAP | NOGRAVITY | DROPOFF | MISSILE | NOCROSS | SPACMISSILE
dehackednum 34 // This tells the engine that this thing type has the same dehackednum as the rocket,
// meaning that players and Cyberdemons will shoot this instead. You can still access
// RocketShot by summoning it though.
radius 13.0
height 8.0
speed 4.0 // As this is a projectile, this value is used as a constant speed.
damage 10 // Damage dealt uses the formula damage*random(1,8).
seesound keenpn // Keen pain sound.
deathsound keendt // Keen death sound.
addflags TRANSLUCENT // Makes the projectile translucent.

States
@"
Spawn:
BAL1 AB 1 Bright A_Tracer // The projectile doesn't have the SEEKERMISSILE flag set so it can't actually
BAL2 AB 1 Bright A_Tracer // trace our target, but we're only placing it here for the trail anyways.
APLS AB 1 Bright A_Tracer
PLSS AB 1 Bright A_Tracer
Loop
Death:
BAL1 CDE 5 Bright A_Mushroom // A_Mushroom is what gives the explosive property of our projectile.
// It spawns an explosion, and then a number of MancubusShot projectiles.
Stop // As the previous frame has a finite duration, this function is called and
// the projectile will disappear.
"@
}

Simply going into the game and firing a rocket launcher, being fired at by a Cyberdemon, or using "summon DriftingEnergyNuke" will create this new projectile that we've created.
For the projectile we will be using new assets. Like the prior tutorial, we want to import the entries from SS_START to SS_END from [http://www.realm667.com/index.php/en/component/docman/?task=doc_download&gid=285 the aracnorb] from the Realm667 bestiary by [[doom_wiki:James Paddock (Jimmy)|James Paddock (Jimmy)]].

thingtype AracnorbBall
{
basictype Seeker // This uses a predefined set of flags for this object. basictype FlyingMonster is equivalent
// to setting cflags as NOBLOCKMAP | NOGRAVITY | DROPOFF | MISSILE | NOCROSS | SEEKERMISSILE.
// SEEKERMISSILE is the flag that allows this to trace targets.
radius 13.0
height 8.0
speed 8.0
damage 3
seesound plasma
deathsound firxpl
addflags TRANSLUCENT|SPACMISSILE // This adds the flags so that the projectile is translucent and can activate
// generalised linedefs marked with the MISSILE special activation flag.
States
@"
Spawn:
ACNF AABB 1 Bright A_GenTracer // This causes the projectile to trace its target. Not calling this would mean that
// the projectile travels in a straight line.
Loop
Death:
ACNF CDEFG 5 Bright
Stop
"@
}

We can now put "summon AracnorbBall" in the console to create this projectile, and if we were to create a monster that uses this (which we did in [[Creating a monster]], we would find that it traces our movement.

Creating a monster

2016-10-02T07:48:30Z

Quasar: Use interwiki

Though not quite as easy as [[creating a simple decoration]], creating a monster is still a relatively basic task. In this tutorial we will define two monsters: one which only uses IWAD assets, and one that uses brand new sprites. We will also start using [[includes]] in order to keep both these monsters in separate EDF lumps.

Much like creating a simple decoration, we will start by creating a text lump named EDFROOT, but for this tutorial we will also make another two text lumps called EZOMBIE and EARACORB. We will include these lumps in EDFROOT so that the monsters defined in the files can be used.

stdinclude("root.edf") // Includes the file base/root.edf, which in turns includes the other files
// that are required for definition of all sprites, sounds, things etc.

// New monsters:
lumpinclude("EZOMBIE") // A new monster using already defined assets
lumpinclude("EARACORB") // A new monster using brand new sprites

Now we will start editing EZOMBIE to define on of our new monsters. For this tutorial we will start using [[DECORATE state syntax]].

thingtype MutatedZombie
{
doomednum 30001 // This is the thing number used to place the object in a map.

basictype Monster // This uses a predefined set of flags for this object. basictype Monster is equivalent
// to setting cflags as SOLID | SHOOTABLE | COUNTKILL | FOOTCLIP | SPACMONSTER | PASSMOBJ.

spawnhealth 30 // The amount of health the monster spawns with.
painchance 128 // The likelihood that the monster goes to a pain state if it is hit.
// Percentage chance is (painchance/255)*100, so for this monster it would be roughly 50%.

speed 8 // The monster moves an amount relative to this value each time it uses the Chase codepointer.

radius 20.0 // The radius and height set the physical size
height 56.0 // of the object, for collision detection.

droptype AmmoClip // The thingtype dropped by the monster when it dies.

seesound sawup // The sounds made when the monster sees, attacks, is put in pain state, dies,
attacksound sawhit // and makes ambient noise respectively. These particular sounds are defined by sounds.edf
painsound sawful // and are the DeHackEd names for the chainsaw noises.
deathsound sawidl
activesound sawhit

obituary_normal "was turned to goo by a mutated zombie" // The message displayed when the player is killed by this
// monster, using a projectile or other miscellaneous attack.

acs_spawndata // The identification number used by various parameterised specials, like Thing_Spawn.
{ // it also limits the number to a game namespace. Heretic objects use "modes heretic"
num 255 // instead of "modes doom". Do note that the number must be <256.
modes doom
}

states // This declares that the following block is the thingtype's states.
@" // The equivalent to an opening curly brace.
Spawn: // State the thing is spawned at.
POSS AB 10 A_Look // Call the function A_Look, using sprites POSSA and POSSB, each for 10 frames.
loop // Loop back to the start of this label.
See: // State the monster goes into after seeing a target.
POSS AABBCCDD 4 A_Chase // Call the function A_Chase, calling it twice for sprites POSSA-D, each time for 4 frames.
loop
Missile: // State the monster goes into when deciding to shoot its target.
POSS E 10 A_FaceTarget // Call the action function A_FaceTarget.
POSS F 8 A_MissileAttack(MBFBetaPlasma1) // Call the action function A_MissileAttack with parameter MBFBetaPlasma1,
// and leave the rest of the parameters as default (all 0 in this case).
POSS E 8
goto See // Jump to state See. Note that the next line after a goto MUST be labelled,
// unlike ZDoom.
Pain: // State it goes into when hit by attack that successfully triggers this pain state.
POSS G 3
POSS G 3 A_Pain
goto See
Death: // State it goes into when killed or otherwise destroyed.
POSS H 5
POSS I 5 A_Scream
POSS J 5 A_Fall
POSS K 5
POSS L -1
stop
XDeath: // Optional state it goes into when killed with very high damage.
POSS M 5
POSS N 5 A_XScream
POSS O 5 A_Fall
POSS PQRST 5
POSS U -1 // This frame has infinite duration as it has been given a length of -1.
stop // This is the equivalent of setting the next frame to 0. If the last frame
// has a finite duration (not -1), then it will disappear. otherwise it's often
// used after -1 duration frames when nothing is expected to follow.
Raise: // Optional state that the corpse goes into when revived by an Arch-vile.
POSS KJIH 5
goto See
"@ // The equivalent to a closing brace.
}

Now either type "summon MutatedZombie" (not case-sensitive) in the console, or place a thing with doomednum 30001 in the map, and we should have a Mutated Zombie walking around the map, making chainsaw noises and firing beta plasma balls at you. With this out of the way we can move on to defining a new monster that doesn't use IWAD assets. For the purposes of this tutorial we will be using [http://www.realm667.com/index.php/en/component/docman/?task=doc_download&gid=285 the aracnorb] from the Realm667 bestiary by [[doom_wiki:James Paddock (Jimmy)|James Paddock (Jimmy)]].

Start by copying over the contents of the wad from SS_START to SS_END inclusive into whatever wad you were previously working in. To follow this up you will need to convert the three sound files provided into Doom Sound Format, and place them in the wad. Now we will start by editing EARACORB. This example won't use comments in areas already covered by the previous one. The ACNFI states will need to be changed so that all I's are replaced with H's and ACNF is replaced with ACNB. Don't focus too much on the AracnorbBall thingtype, as we will look further into that in [[Creating a projectile]].

thingtype Aracnorb
{
doomednum 30002
basictype FlyingMonster // This uses a predefined set of flags for this object. basictype FlyingMonster is equivalent
// to setting cflags as SOLID | SHOOTABLE | COUNTKILL | NOGRAVITY | FLOAT | SPACMONSTER | PASSMOBJ.
addflags FLOATBOB // This makes it so that on top of the already defined flags, this thingtype also has the flag FLOATBOB.

spawnhealth 170
painchance 150

speed 12
radius 24.0
height 56.0
mass 400 // Represents mass factor for the thingtype. This determines thrust when damaged, or how much an
// Arch-vile's attack will affect it.
xscale 0.85 // How much the horizontal component of this sprite is to be scaled.
yscale 0.85 // How much the vertical component of this sprite is to be scaled.

// This thingtype drops nothing when it dies, so no droptype is defined and it uses the default value (nothing).

seesound "aracnorb/sight" // This uses sound mnemonics defined at the bottom of this EDF file, as well as pre-defined
attacksound "aracnorb/melee" // Arachnotron sounds from the IWAD.
painsound dmpain
deathsound "aracnorb/death"
activesound bspact

obituary_normal "suffered psychic trauma from an aracnorb's brainwaves."
obituary_melee "had their skull chewed by an aracnorb." // The message displayed when killed by the thingtype's melee attack.

acs_spawndata
{
num 254
modes doom
}

States
@"
Spawn:
ACNB A 1 A_Look
Loop // Note that you can capitalise keywords if you so wish.
See:
ACNB A 2 A_Chase
Loop
Melee:
ACNB AB 5
ACNB C 6 A_Scratch(3, 6, "aracnorb/melee") // This calls a generalised melee function. The parameters tell it to use the
// 2nd parameter as damage, do 6 damage, and call the sound "aracnorb/melee".
Goto See
Missile:
ACNB B 12 Bright A_FaceTarget // The "Bright" keyword causes this thing to light up when performing this action.
ACNB C 2 Bright A_MissileAttack("AracnorbBall", 1) // Attack spawning a projectile "AracnorbBall", and allow
// ball to trace (home in on) its target.
ACNB B 2 Bright
ACNB D 0 A_Jump(32,"See") // Have a 32/255 chance to jump to the state "See".
ACNB D 0 A_SpidRefire
Goto Missile+1 // This skips the first line of Missile, and goes straight to attacking.
Pain:
ACNB I 2
ACNB I 2 A_Pain
Goto See
Death:
ACNB D 0 A_UnSetFlags(0, "FLOATBOB") // Set the flag FLOATBOB to false, so that once it dies it stops bobbing.
ACNB D 0 A_Scream
ACNB D 6 A_Fall
ACNB D 1
Wait
Crash: // Optional state that is called when the corpse falls and hits the floor.
ACNB EFG 6
ACNB H -1
Stop
Raise:
ACNB HGFEDA 8
ACNB A 0 A_SetFlags(0, "FLOATBOB") // Set the flag FLOATBOB back to true, so that it bobs once resurrected.
Goto See
"@
}

thingtype AracnorbBall
{
basictype Seeker // This uses a predefined set of flags for this object. basictype FlyingMonster is equivalent
// to setting cflags as NOBLOCKMAP | NOGRAVITY | DROPOFF | MISSILE | NOCROSS | SEEKERMISSILE.
radius 13.0
height 8.0
speed 8.0
damage 3
seesound plasma
deathsound firxpl
addflags TRANSLUCENT|SPACMISSILE // This adds the flags so that the projectile is translucent and can activate
// generalised linedefs marked with the MISSILE special activation flag
States
@"
Spawn:
ACNF AABB 1 Bright A_GenTracer // This causes the projectile to trace its target.
Loop
Death:
ACNF CDEFG 5 Bright
Stop
"@
}

sound "aracnorb/sight" { lump = "DSARACST"; } // Define the sound "aracnorb/sight" as the lump DSARACST.
sound "aracnorb/death" { lump = "DSARACDT"; }
sound "aracnorb/attack" { lump = "DSARACFR"; }
sound "aracnorb/melee" { lump = "DSARACML"; }

Now just type "summon Aracnorb" into the console or place a thing with doomednum 30002 on the map and you should see your brand new monster that fires a custom homing projectile.

[[Category:Tutorials]]

Doom Wiki

2016-10-02T07:46:45Z

Quasar: Update link to use https

The '''Doom Wiki''' at [https://doomwiki.org DoomWiki.org] is a project to document everything related to id Software's classic games Doom and Doom II.

Articles that are more closely related to Doom in general, other source ports, or non-[[Eternity]] specific editing aspects should be placed there. Interwiki links to the Doom Wiki are created like this: <nowiki>[[Doom Wiki:Doom|Doom]]</nowiki>, creating [[Doom Wiki:Doom|Doom]].

User:Quasar

2016-10-02T07:45:44Z

Quasar: Update link to use https

Hello, I'm Quasar, founder of [[Team Eternity]] and one of the principal programmers of the [[Eternity Engine]]. I am a mod on the Wiki, naturally, and I'll soon be adding tons of material here.

Some of my websites:
* [[doom_wiki:User:Quasar|My user page]] on [https://doomwiki.org DoomWiki.org], the ''real'' Doom Wiki. Anything else is not blessed or maintained by me.
* [[zdoom:User:Quasar|My user page]] at the ZDoom Wiki.
* http://dk.youfailit.net - Dungeon Keeper Millennium

MediaWiki:Common.css

2016-08-22T12:28:54Z

Quasar: Import padding adjustment from DoomWiki

/* CSS placed here will be applied to all skins */

/* Default wikitable padding is terrible; left/right increased to 0.5em to move text away from borders. */
table.wikitable > tr > th, table.wikitable > tr > td, table.wikitable > * > tr > th, table.wikitable > * > tr > td {
padding: 0.2em 0.5em 0.2em 0.5em;
}

EDF sound reference

2016-02-24T20:30:50Z

Quasar: grr

==Sounds==
The [[EDF]] '''Sound''' block defines sounds to be used in the game. They are linked to the sound lumps included in wads, and the default Doom and Heretic entries have the same names as the lumps, minus the DS prefix (for Doom).
{{backto|EDF}}

===Syntax===
sound <mnemonic>
{
lump <string>
prefix <boolean>
singularity <singularity class>
priority <number>
link <sound mnemonic>
alias <sound mnemonic>
random <sound mnemonic list>
skinindex <skin index type>
linkvol <number>
linkpitch <number>
clipping_dist <number>
close_dist <number>
pitchvariance <pitch variance type>
subchannel <subchannel class>
pcslump <string>
nopcsound <boolean>
dehackednum <number>
}
===Fields===
*'''lump'''
:Default: If a value is not provided to this field, then this sound's mnemonic will be copied directly to this field. In this case, the default value for the prefix field becomes "true". This means that the mnemonic will be prefixed with the "DS" prefix to construct the final sound lump name. If an explicit value is provided to this field, then the default value of the prefix field becomes "false". This means the lump name, as provided, becomes the final sound lump name and will not be prefixed in any way.
:The lump field indicates the lump name that this sound resource will have in WAD files. If the prefix field below is true, the prefix "DS" will be appended to this name when looking for the sound. Otherwise, this name will be used exactly as it is provided. In the event a sound is not found, a default sound for the current game mode (DSPISTOL in DOOM, GLDHIT in Heretic) will be played instead.
*'''prefix'''
:Default = Depends on presence of lump field
:This boolean field indicates whether to prefix the lump name with DS when searching for this sound's lump. Values of false/no/off mean that the lump will not be prefixed. Values of true/yes/on mean that it should be prefixed. If the lump field is provided, the default value of this field changes from true to false.
*'''singularity'''
:Default = ''sg_none''
:This field indicates a singularity class for this sound. If another sound of the same singularity class is playing when this sound is played, the former will be stopped. This is used to implement appropriate player sound behavior in an extensible and modifiable manner. The possible values for the singularity class are as follows:
:*sg_none
:*sg_itemup
:*sg_wpnup
:*sg_oof
:*sg_getpow
*'''priority'''
:Default = 64
:This field establishes a relative priority for this sound. When sounds must be stopped in order to start new ones, those with the lowest priority will be replaced first. Priority scales down with distance, so sounds playing at higher volume or closer to the player have priority over quieter and more distant sounds. Please note carefully that a higher value in this field means a lower priority. So 0 is the highest priority possible, and 255 is the lowest priority (priorities lower than 255 will be capped into range).
*'''link'''
:Default = "none"
:This field links this sound definition to another existing sound definition. Its value must either be "none," or another valid sound mnemonic. When a linked sound is played, the sound that is linked to will be played instead, using the linkvol and linkpitch parameters provided in this sound entry. All parameters for playing the sound, including priority, singularity, pitch variance, and clipping distances come from this sound definition, and not from the sound to which this one is linked.
*'''alias'''
:Default = "none"
:This field causes this sound definition to become an alias for another existing sound. Its value must either be "none," or another valid sound mnemonic. When this sound is played, the aliased sound will be played instead, using all the data defined in the aliased sound (when an alias references another alias, the resolution is done recursively until a non- aliased sound is found).
*'''random'''
:Default = no list
:This fields allows this sound to have random alternatives when it's played. Include the list of sound mnemonics, separated by commas, within curly braces.
*'''skinindex'''
:Default = ''sk_none''
:This field indicates a player skin sound index for this sound. If the player object plays this sound, it will become subject to remapping through the player's skin. The following values are possible for skin index, and each corresponds to one of the fields in the extended Legacy skin format:
:*sk_none
:*sk_plpain
:*sk_pdiehi
:*sk_oof
:*sk_slop
:*sk_punch
:*sk_radio
:*sk_pldeth
:*sk_plfall
:*sk_plfeet
:*sk_fallht
*'''linkvol'''
:Default = 127 (full volume)
:This field provides a value to be added to the sound's volume when a linked sound is played through this sound definition. Volume range is from 0 to 127, but this field may be any value. The resulting value when added to the base volume will be capped into range. For example, if a sound normally plays at full volume, specifying a negative value in this field will reduce the volume.
*'''linkpitch'''
:Default = 127 (normal)
:This field provides a pitch value to be used when a linked sound is played through this sound definition. Pitch values should be between 0 and 255 when provided.
*'''clipping_dist'''
:Default = 1200
:This value specifies the distance from the origin at which this sound will be completely clipped out; that is, reduced to zero volume and therefore killed completely. The sound engine currently only considers an approximate distance on the X-Y plane, so this behavior may be slightly more rough than expected. The value of this field should be greater than the value of the close_dist field below. If not, the sound will always be played at full volume (this can be intentionally exploited).
*'''close_dist'''
:Default = 200
:This value specifies the distance from the origin at which this sound will be at full volume. Attenuation between the clipping_dist and close_dist values is currently always linear. The sound engine currently only considers an approximate distance on the X-Y plane, so this behavior may be slightly more rough than expected. The value of this field should be less than the value of the clipping_dist field above. If not, the sound will always be played at full volume (this can be intentionally exploited).
*'''pitchvariance'''
:Default = none
:This field allows specification of the type of pitch variation this sound plays with when pitched sounds are enabled. The following values are allowed:
:*none -- No pitch variation
:*Doom -- Pitch variation similar to that used in DOOM v1.1 for most sounds
:*DoomSaw -- Pitch variation similar to that used for saw sounds in DOOM v1.1.
:*Heretic -- Pitch variation similar to that used in Heretic
:*HereticAmbience -- Pitch variation similar to that used in Heretic for global ambience.
:In general, DOOM types provide less variation than Heretic types. Note that Eternity has now repaired some bugs in the BOOM sound pitch variation code, and so the effect works much better than it did previously.
*'''subchannel'''
:Default = Auto
:This field allows allocating a sound to a specific subchannel, so that an actor can play several sounds at once, unlike vanilla Doom behavior. Possible values are:
:*Auto - default sound channel
:*Weapon
:*Voice
:*Item
:*Body
:*SoundSlot5
:*SoundSlot6
:*SoundSlot7
*'''pcslump'''
:Default = ""
:Allows associating a PC speaker sound lump with this sound definition. Required if the sound does not use a DS or DP '''prefix''' or if the DP* version of the lump is missing.
*'''nopcsound'''
:Default = false
:If set to true, forces the PC sound to NOT be played even if a valid lump exists for this entry. Default Doom monster pain and active sounds have this flag set to true.
*'''dehackednum'''
:Default = -1
:In order to be accessible to Dehacked patches, a sound definition must be given a unique DeHackEd number. The value zero is reserved and cannot be used. In order to avoid conflict, and to remain compatible with future versions of the Eternity Engine, user sounds should either use DeHackEd numbers between 10000 and 32768, or simply use the value -1 if no thing/frame or DeHackEd access is necessary.
===Example===
# Define some new sounds
# This one is only accessible via scripting because it doesn't have a DeHackEd number.
# (Although a DeHackEd number may be auto-assigned to it if something in EDF attempts
# to use its DeHackEd number...)

sound MySound
{
lump = foo # this will play FOO, since prefix defaults to false when
# a lump name is explicitly provided. Note that this case is
# affected by the change in EDF v1.7. Previously, this would have
# played the sound DSFOO, even though the lump name is specified
# as "foo". Automatic prefixing now ONLY applies to sounds which
# copy their mnemonic to the lumpname and allow prefix to default.
}

# This entry uses its mnemonic to double as the sound lump name, but already provides
# the standard DS prefix in the mnemonic.

sound dsblah
{
prefix = false # Because we did not explicitly specify a lump name, the
# lump name has become "dsblah", and the default value of
# prefix is true. That means we have to change it to false,
# or else the game would try to play DSDSBLAH, which is
# wrong. This has not changed.

dehackednum = 10000
}

# This entry also uses the mnemonic as the sound name, but with prefixing.
# Since prefix defaults to true when the lump name is not explicitly provided,
# the sound lump played will be "DSEXPLOD". This has also not changed.

sound explod
{
priority = 128
dehackednum = 10001
}

# This entry links to another sound.
sound BlahLink
{
link = dsblah # we've linked this entry to the dsblah sound
linkvol = 64 # use some suitable values for these (must experiment)
linkpitch = 72
dehackednum = 10002
}

# This entry overrides a previously defined sound.
sound explod
{
priority = 96 # Maybe we like 96 better than 128...
dehackednum = 10001 # We can reuse the same DeHackEd number, since it overwrites
}

# This sound is just an alias for explod. It will play using all the parameters
# as they are defined in explod. Anything else we defined in this sound would be
# totally ignored.

sound Explosion { alias = explod }

==Sound sequences==
Sound sequences are effects that play while a sector is moving, a polyobject is moving, or when a Heretic-style (environmental) ambient sound is under way. Similar to things, frames or individual sounds, sequences are defined in EDF by using the '''soundsequence''' block. The mnemonic must be at most 32 characters long. Sound sequence definitions can be cascaded, and the latter ones will overwrite other identically named sequences.

Sector movement sequences are used by placing thing types #1400 to #1500 on the map, inside the designated sectors. The ones numbered from #1400 to #1499 will play the sequence with the '''id''' between 0 and 99, while #1500 will use its first argument in the [[ExtraData]] definition.

Polyobject sequences are set up from the [[Polyobject_linedef_types|Polyobj_StartLine and Polyobj_ExplicitLine]] ExtraData linedef specials. '''Polyobj_StartLine''' uses the 3rd argument for this, while '''Polyobj_ExplicitLine''' uses the 4th.

Environmental sequences are set up similarly with sector sequences, by placing thing types #1200 to #1300 anywhere inside the map. #1200 to #1299 use the last two digits to designate the number, while #1300 uses the first ExtraData argument.

'''NOTE:''' You can include all '''soundsequence''' blocks inside a '''ESNDSEQ''' lump. It will be loaded automatically at game startup, independent of '''EDFROOT'''.

===Syntax===

soundsequence <mnemonic>
{
id <number>
cmds { <string>, ... }
commands <heredoc string>
type <sequence type>
stopsound <sound mnemonic>
attenuation <attenuation type>
randomplayvol <boolean>
volume <number>
minvolume <number>
nostopcutoff <boolean>
doorsequence <sound sequence mnemonic>
platsequence <sound sequence mnemonic>
floorsequence <sound sequence mnemonic>
ceilingsequence <sound sequence mnemonic>
}

===Parameters===
The fields are as follows:

*'''id'''
:''Default:'' -1
:Sets up the sound sequence number to recognize it in maps. Environmental sequences use a different namespace from sector ones, and sector sequences can be separated in door, platform and general sequences (see below)

*'''cmds'''
:''Default:'' { "end" }
:'''(Deprecated)''' The list of Hexen-style commands to control the playing of sounds. Each command is written as a string, separated with a comma from the others. While this syntax will continue to be supported, it is recommended that new modifications use the heredoc-enabled syntax via the '''commands''' field instead.

*'''commands'''
:''Default'': @" end "@
:The commands field allows specification of sound sequences in the natural Hexen-derived syntax, without quotations or commas, by embedding the commands one per line inside an EDF heredoc (a literally interpreted string delimited by @" and "@ sequences). This is the recommended method of specification. '''SVN r1420+'''

*'''type'''
:''Default:'' "sector"
:There are four separate namespaces: sector, door, plat and environment. The second is restricted to doors and polys; the third to general moving floors/ceilings and lifts.

*'''stopsound'''
:''Default:'' "none"
:The sound mnemonic to play when the sector stops. Will never happen if this is an environmental sequence.

*'''attenuation'''
:''Default:'' "normal"
:Can be: normal, idle, static, none.

*'''randomplayvol'''
:''Default:'' false
:If set to true, every normal "play" command which doesn't specify a volume will begin at a randomized volume level which may be modified by the user's s_enviro_volume setting. This property exists to support Heretic-compatible global environmental sequence behavior. '''SVN r1420+'''

*'''volume'''
:''Default'': 127

*'''minvolume'''
:''Default:'' -1

*'''nostopcutoff'''
:''Default'': false

===Sequence commands===
*play <sound>
: The indicated sound will be played but the sequence will not delay in moving to the next command. If this is the last sound in the sequence, the sound might be cutoff unless other properties prevent this.
*playuntildone <sound>
: The indicated sound will be played, and the sequence will not move on to the next command or terminate until the sound has finished playing.
*playtime <sound> <time>
: The indicated sound will be played and the sequence will pause for the number of gametics (35 per second) before moving on to the next command.
*playrepeat <sound>
: The indicated sound will be played continuously without interruption. This command never ends, so the sequence will not terminate unless something such as a sector action stops it externally. This command should not be used in global environmental sequences.
*playloop <sound> <time>
: The indicated sound will be played in a loop every "time" gametics. As above, this command will never end.
*playabsvol <sound> <vol>
: Like the play command, but allows specification of the sound's base volume from 0 to 127.
*playrelvol <sound> <vol>
: Like the play command, but specifies a volume which is relative to the sound sequence's previous volume setting.
*delay <tics>
: Stop the sound sequence from progressing for the indicated number of gametics.
*delayrand <min> <max>
: Delay the sound sequence from progressing for a random number of gametics between and including "min" and "max".
*volume <vol>
: Set the sequence's current absolute volume level to the indicated value between 0 and 127.
*relvolume <vol>
: Modify the sequence's current absolute volume level by the indicated amount. The number specified should be negative to make the sequence more quiet.
*attenuation <attn>
: Set the sequence's attenuation value. This command is executed at game startup and therefore the last one specified is the only one that will take effect.
*stopsound <snd>
: Set the sequence's stopsound attribute. This command is executed at game startup and therefore the last one specified is the only one that will take effect.
*nostopcutoff
: Set the sequence's nostopcutoff attribute. This command is executed at game startup and therefore the last one specified is the only one that will take effect.
*restart
: Restart the current sound sequence. This command should not be used in global environmental sequences.
*end
: End the sequence. This command is not required by the Eternity Engine, and exists for Hexen compatibility.

===Example===
// This is a sequence playable by name only. It is one of the default sector sequences
// defined in sounds.edf, and is used by Heretic doors when they close.
soundsequence EEDoorCloseNormal
{
cmds =
{
"play EE_DoorOpen",
"stopsound EE_DoorClose"
}
}

// This is an environmental sequence for Heretic, which is used by placing a thing of
// type 1200 anywhere on the map. It is started by the environmental sequence manager
// at random, with the probability of it being played being determined by the proportion
// of 1200 objects to other environmental sequence spots on the map.
soundsequence EEHticAmbScream
{
type = environment
id = 0
cmds = { "playuntildone ht_amb1" }

volume = 96
minvolume = 32
attenuation = none
}

// This is a sound sequence meant to be played by a PolyObject. It could also use
// type sector and would still work, but using type door is more explicit. PolyObjects
// always use door-type actions when starting sequences, so they check the door lookup
// first for id numbers between 0 and 63.
soundsequence PolyDoor
{
type = door
id = 0
cmds =
{
"play EE_BDoorOpen",
"stopsound EE_PlatStop"
}
}

// This is one of the more complicated environmental sequences from sounds.edf.
// It plays two alternating footstep sounds every 15 gametics at a constantly
// decreasing volume level.
soundsequence EEHticSlowFootSteps
{
type = environment
id = 3
cmds =
{
"playtime ht_amb4 15",
"playrelvol ht_amb11 -3",
"delay 15",
"playrelvol ht_amb4 -3",
"delay 15",
"playrelvol ht_amb11 -3",
"delay 15",
"playrelvol ht_amb4 -3",
"delay 15",
"playrelvol ht_amb11 -3",
"delay 15",
"playrelvol ht_amb4 -3",
"delay 15",
"playrelvol ht_amb11 -3",
"nostopcutoff"
}

volume = 96
minvolume = 32
attenuation = none
}

// Yes, sound sequences can be completely silent :) All fields are defaulting, and
// the only command in the command list is "end".
soundsequence EEPlatSilent
{
}

==Ambience==
'''Ambience''' sections allow the user to define the behavior of ambient sound spots, which can be placed on maps using DoomEd numbers 14001 through 14065. The first 64 of these objects automatically use the ambience sections with numeric indexes 1 through 64. Object 14065 accepts the index number in its first argument field, which may be specified either through the use of ExtraData via the Hexen map format or via the upcoming UDMF format.

===Syntax===
ambience
{
sound = <sound mnemonic>
index = <number>
volume = <number>
attenuation = <attenuation type>
type = <ambience behavior type>
period = <number>
minperiod = <number>
maxperiod = <number>
}

===Usage===
*'''sound'''
:Default = "none"
:This field specifies the sound to be played by an ambience object using this definition. If the value provided to this field is invalid, no sound will be played.
*'''index'''
:Default = 0
:Defines the index of this ambience definition. This may be an integer of any value zero or greater, although only the first 256 ambience definitions are usable via the Hexen map format. When an ambience definition has the same index as a previously defined ambience definition, it will overwrite that previous definition. Note that if a thing placed on a map references an invalid ambience sequence, that object will do nothing.
*'''volume'''
:Default = 127
:The relative volume of this ambient sound, ranging from 0 to 127. This is multiplied by the user's volume setting so that the true range of volume is from 0 to the user's setting. For all attenuation types except "none", the volume is additionally decreased by the user's distance from the ambience object.
*'''attenuation'''
:Default = "normal"
:This field defines the attenuation behavior of the ambience object. Attenuation is how the sound changes with distance between the listener and the ambience object. The following values are available for this field:
:*normal -- Use the close_dist and clipping_dist fields defined in the sound definition.
:*idle -- Use DOOM's normal default sound attenuation behavior.
:*static -- Fades quickly (inaudible from 512 units).
:*none -- Plays at this ambience definition's volume level regardless of distance.

*'''type'''
:Default = "continuous"
:This field defines the repetition behavior of this ambience definition. The following values are available for this field:
:*continuous -- loops the sound seamlessly
:*periodic -- restarts the sound every "period" number of gametics
:*random -- restarts the sound after a randomized wait period determined by the minperiod and maxperiod fields

*'''period'''
:Default = 35
:For periodic ambience definitions, this field defines how frequently the sound is restarted in gametics (1/35 of a second).
*'''minperiod'''
:Default = 35
:For random ambience definitions, this field defines the shortest wait period before the sound will be restarted.
*'''maxperiod'''
:Default = 35
:For random ambience definitions, this field defines the longest wait period before the sound will be restarted. The ambience object will wait a period of time somewhere between minperiod and maxperiod gametics, inclusive. For proper behavior, maxperiod should be a number greater than minperiod.
===Example===
ambience
{
index = 0
sound = ht_waterfl
type = continuous
volume = 127
attenuation = static
}

ambience
{
index = 1
sound = ht_bstsit
type = periodic
volume = 64
attenuation = none
period = 70
}

ambience
{
index = 2
sound = ht_bstatk
type = random
volume = 127
attenuation = idle
minperiod = 35
maxperiod = 105
}

==Environmental Sequence Manager==
EDF can alter basic properties of the environmental ambience sound sequence manager. This system runs in every level and randomly chooses environmental sequences to play based on what objects with DoomEd numbers 1200 through 1300 are present on the level (these objects are collected in much the same way as Boss Brain spots or D'Sparil's teleport landings). The probability of a given sequence playing on any particular event is determined solely by how many objects on the level specify that sequence as compared to the total number of objects.

There can be any number of enviromanager blocks specified, but only the values in the last one parsed will be used.

===Syntax===
enviromanager
{
minstartwait = <number> // minimum wait time at level start in tics
maxstartwait = <number> // maximum wait time at level start in tics
minwait = <number> // minimum wait time between sequences in tics
maxwait = <number> // maximum wait time between sequences in tics
}
In all cases, the minimum wait times should be less than the maximum. The engine will adjust the values to make this true if it is not.

==Sound environments==
Use of sound environments allows addition of reverberation effects to areas within levels called "sound zones." Sound zones are sets of contiguous sectors which connect to each other by two-sided lines which are not marked with a new ExtraData linedef flag, ZONEBOUNDARY.

To assign a specific sound environment to a zone, use ExtraData to create an EESoundEnvironment object in one of the sectors inside that zone with its first two map arguments set to the two ID numbers of the EDF reverb definition you want to apply while a player is inside that area.

// Defines a reverb sound environment. ID1 and ID2 are required and must be
// numbers between 0 and 255.
reverb <name> : <id1>, <id2>
{
// Roomsize defines the decay time and "volume" of reverberation; the larger
// the value, the bigger the space.
// Range 0.0 to 1.07143; default 0.5
roomsize <float>

// Damping defines the amount of high-frequency rolloff in the reverb filters.
// A higher value is analogous to a space filled with fewer reflective objects.
// Range 0.0 to 1.0; default 0.5
damping <float>

// Wet scale defines the amount of reverberated signal in the reverb output.
// Range 0.0 to 1.0; default 0.333...
wetscale <float>

// Dry scale defines the amount of dry (input) signal in the reverb output.
// Range 0.0 to 1.0; default 0.0
dryscale <float>

// Width defines the amount of stereo phasing/cross-over in the reverberation.
// Range 0.0 to 1.0; default 1.0
width <float>

// Predelay defines the amount of time between sound emission and the first
// reverb response. Defined in milliseconds; Range 0 to 250; default 0.
predelay <int>

// The equalized flag, if specified as +equalized, will turn on a three-band
// equalization pass after the reverb filters. This allows tweaking the amount
// of low- and high-frequency sound for adjusting the "luminosity" of the
// effect. Default is -equalized.
[+-]equalized

// These parameters apply when +equalized is specified:

eq.lowfreq <float> // Low band upper edge in Hz; 20-20000; default = 250.0
eq.highfreq <float> // High band lower edge in Hz; 20-20000; default = 4000.0
eq.lowgain <float> // Volume factor for low freqs; 0.0-1.0; default 1.0
eq.midgain <float> // Volume factor for mid freqs; 0.0-1.0; default 1.0
eq.highgain <float> // Volume factor for hi freqs; 0.0-1.0; default 1.0
}
Adjustments have also been made to EDF ambience and soundsequence definitions which allow either to exclude themselves from application of sound zones. To exclude either type of definition from environmental effects, use the -reverb flag as such:
ambience <name>
{
...
-reverb
}

soundsequence <name>
{
...
-reverb
}
By default, environments apply to all ambience and soundsequence definitions.

[[category:EDF]]

EDF sound reference

2016-02-24T20:30:12Z

Quasar: Fix header levels

==Sounds==
The [[EDF]] '''Sound''' block defines sounds to be used in the game. They are linked to the sound lumps included in wads, and the default Doom and Heretic entries have the same names as the lumps, minus the DS prefix (for Doom).
{{backto|EDF}}

===Syntax===
sound <mnemonic>
{
lump <string>
prefix <boolean>
singularity <singularity class>
priority <number>
link <sound mnemonic>
alias <sound mnemonic>
random <sound mnemonic list>
skinindex <skin index type>
linkvol <number>
linkpitch <number>
clipping_dist <number>
close_dist <number>
pitchvariance <pitch variance type>
subchannel <subchannel class>
pcslump <string>
nopcsound <boolean>
dehackednum <number>
}
===Fields===
*'''lump'''
:Default: If a value is not provided to this field, then this sound's mnemonic will be copied directly to this field. In this case, the default value for the prefix field becomes "true". This means that the mnemonic will be prefixed with the "DS" prefix to construct the final sound lump name. If an explicit value is provided to this field, then the default value of the prefix field becomes "false". This means the lump name, as provided, becomes the final sound lump name and will not be prefixed in any way.
:The lump field indicates the lump name that this sound resource will have in WAD files. If the prefix field below is true, the prefix "DS" will be appended to this name when looking for the sound. Otherwise, this name will be used exactly as it is provided. In the event a sound is not found, a default sound for the current game mode (DSPISTOL in DOOM, GLDHIT in Heretic) will be played instead.
*'''prefix'''
:Default = Depends on presence of lump field
:This boolean field indicates whether to prefix the lump name with DS when searching for this sound's lump. Values of false/no/off mean that the lump will not be prefixed. Values of true/yes/on mean that it should be prefixed. If the lump field is provided, the default value of this field changes from true to false.
*'''singularity'''
:Default = ''sg_none''
:This field indicates a singularity class for this sound. If another sound of the same singularity class is playing when this sound is played, the former will be stopped. This is used to implement appropriate player sound behavior in an extensible and modifiable manner. The possible values for the singularity class are as follows:
:*sg_none
:*sg_itemup
:*sg_wpnup
:*sg_oof
:*sg_getpow
*'''priority'''
:Default = 64
:This field establishes a relative priority for this sound. When sounds must be stopped in order to start new ones, those with the lowest priority will be replaced first. Priority scales down with distance, so sounds playing at higher volume or closer to the player have priority over quieter and more distant sounds. Please note carefully that a higher value in this field means a lower priority. So 0 is the highest priority possible, and 255 is the lowest priority (priorities lower than 255 will be capped into range).
*'''link'''
:Default = "none"
:This field links this sound definition to another existing sound definition. Its value must either be "none," or another valid sound mnemonic. When a linked sound is played, the sound that is linked to will be played instead, using the linkvol and linkpitch parameters provided in this sound entry. All parameters for playing the sound, including priority, singularity, pitch variance, and clipping distances come from this sound definition, and not from the sound to which this one is linked.
*'''alias'''
:Default = "none"
:This field causes this sound definition to become an alias for another existing sound. Its value must either be "none," or another valid sound mnemonic. When this sound is played, the aliased sound will be played instead, using all the data defined in the aliased sound (when an alias references another alias, the resolution is done recursively until a non- aliased sound is found).
*'''random'''
:Default = no list
:This fields allows this sound to have random alternatives when it's played. Include the list of sound mnemonics, separated by commas, within curly braces.
*'''skinindex'''
:Default = ''sk_none''
:This field indicates a player skin sound index for this sound. If the player object plays this sound, it will become subject to remapping through the player's skin. The following values are possible for skin index, and each corresponds to one of the fields in the extended Legacy skin format:
:*sk_none
:*sk_plpain
:*sk_pdiehi
:*sk_oof
:*sk_slop
:*sk_punch
:*sk_radio
:*sk_pldeth
:*sk_plfall
:*sk_plfeet
:*sk_fallht
*'''linkvol'''
:Default = 127 (full volume)
:This field provides a value to be added to the sound's volume when a linked sound is played through this sound definition. Volume range is from 0 to 127, but this field may be any value. The resulting value when added to the base volume will be capped into range. For example, if a sound normally plays at full volume, specifying a negative value in this field will reduce the volume.
*'''linkpitch'''
:Default = 127 (normal)
:This field provides a pitch value to be used when a linked sound is played through this sound definition. Pitch values should be between 0 and 255 when provided.
*'''clipping_dist'''
:Default = 1200
:This value specifies the distance from the origin at which this sound will be completely clipped out; that is, reduced to zero volume and therefore killed completely. The sound engine currently only considers an approximate distance on the X-Y plane, so this behavior may be slightly more rough than expected. The value of this field should be greater than the value of the close_dist field below. If not, the sound will always be played at full volume (this can be intentionally exploited).
*'''close_dist'''
:Default = 200
:This value specifies the distance from the origin at which this sound will be at full volume. Attenuation between the clipping_dist and close_dist values is currently always linear. The sound engine currently only considers an approximate distance on the X-Y plane, so this behavior may be slightly more rough than expected. The value of this field should be less than the value of the clipping_dist field above. If not, the sound will always be played at full volume (this can be intentionally exploited).
*'''pitchvariance'''
:Default = none
:This field allows specification of the type of pitch variation this sound plays with when pitched sounds are enabled. The following values are allowed:
:*none -- No pitch variation
:*Doom -- Pitch variation similar to that used in DOOM v1.1 for most sounds
:*DoomSaw -- Pitch variation similar to that used for saw sounds in DOOM v1.1.
:*Heretic -- Pitch variation similar to that used in Heretic
:*HereticAmbience -- Pitch variation similar to that used in Heretic for global ambience.
:In general, DOOM types provide less variation than Heretic types. Note that Eternity has now repaired some bugs in the BOOM sound pitch variation code, and so the effect works much better than it did previously.
*'''subchannel'''
:Default = Auto
:This field allows allocating a sound to a specific subchannel, so that an actor can play several sounds at once, unlike vanilla Doom behavior. Possible values are:
:*Auto - default sound channel
:*Weapon
:*Voice
:*Item
:*Body
:*SoundSlot5
:*SoundSlot6
:*SoundSlot7
*'''pcslump'''
:Default = ""
:Allows associating a PC speaker sound lump with this sound definition. Required if the sound does not use a DS or DP '''prefix''' or if the DP* version of the lump is missing.
*'''nopcsound'''
:Default = false
:If set to true, forces the PC sound to NOT be played even if a valid lump exists for this entry. Default Doom monster pain and active sounds have this flag set to true.
*'''dehackednum'''
:Default = -1
:In order to be accessible to Dehacked patches, a sound definition must be given a unique DeHackEd number. The value zero is reserved and cannot be used. In order to avoid conflict, and to remain compatible with future versions of the Eternity Engine, user sounds should either use DeHackEd numbers between 10000 and 32768, or simply use the value -1 if no thing/frame or DeHackEd access is necessary.
===Example===
# Define some new sounds
# This one is only accessible via scripting because it doesn't have a DeHackEd number.
# (Although a DeHackEd number may be auto-assigned to it if something in EDF attempts
# to use its DeHackEd number...)

sound MySound
{
lump = foo # this will play FOO, since prefix defaults to false when
# a lump name is explicitly provided. Note that this case is
# affected by the change in EDF v1.7. Previously, this would have
# played the sound DSFOO, even though the lump name is specified
# as "foo". Automatic prefixing now ONLY applies to sounds which
# copy their mnemonic to the lumpname and allow prefix to default.
}

# This entry uses its mnemonic to double as the sound lump name, but already provides
# the standard DS prefix in the mnemonic.

sound dsblah
{
prefix = false # Because we did not explicitly specify a lump name, the
# lump name has become "dsblah", and the default value of
# prefix is true. That means we have to change it to false,
# or else the game would try to play DSDSBLAH, which is
# wrong. This has not changed.

dehackednum = 10000
}

# This entry also uses the mnemonic as the sound name, but with prefixing.
# Since prefix defaults to true when the lump name is not explicitly provided,
# the sound lump played will be "DSEXPLOD". This has also not changed.

sound explod
{
priority = 128
dehackednum = 10001
}

# This entry links to another sound.
sound BlahLink
{
link = dsblah # we've linked this entry to the dsblah sound
linkvol = 64 # use some suitable values for these (must experiment)
linkpitch = 72
dehackednum = 10002
}

# This entry overrides a previously defined sound.
sound explod
{
priority = 96 # Maybe we like 96 better than 128...
dehackednum = 10001 # We can reuse the same DeHackEd number, since it overwrites
}

# This sound is just an alias for explod. It will play using all the parameters
# as they are defined in explod. Anything else we defined in this sound would be
# totally ignored.

sound Explosion { alias = explod }

==Sound sequences==
Sound sequences are effects that play while a sector is moving, a polyobject is moving, or when a Heretic-style (environmental) ambient sound is under way. Similar to things, frames or individual sounds, sequences are defined in EDF by using the '''soundsequence''' block. The mnemonic must be at most 32 characters long. Sound sequence definitions can be cascaded, and the latter ones will overwrite other identically named sequences.

Sector movement sequences are used by placing thing types #1400 to #1500 on the map, inside the designated sectors. The ones numbered from #1400 to #1499 will play the sequence with the '''id''' between 0 and 99, while #1500 will use its first argument in the [[ExtraData]] definition.

Polyobject sequences are set up from the [[Polyobject_linedef_types|Polyobj_StartLine and Polyobj_ExplicitLine]] ExtraData linedef specials. '''Polyobj_StartLine''' uses the 3rd argument for this, while '''Polyobj_ExplicitLine''' uses the 4th.

Environmental sequences are set up similarly with sector sequences, by placing thing types #1200 to #1300 anywhere inside the map. #1200 to #1299 use the last two digits to designate the number, while #1300 uses the first ExtraData argument.

'''NOTE:''' You can include all '''soundsequence''' blocks inside a '''ESNDSEQ''' lump. It will be loaded automatically at game startup, independent of '''EDFROOT'''.

===Syntax===

soundsequence <mnemonic>
{
id <number>
cmds { <string>, ... }
commands <heredoc string>
type <sequence type>
stopsound <sound mnemonic>
attenuation <attenuation type>
randomplayvol <boolean>
volume <number>
minvolume <number>
nostopcutoff <boolean>
doorsequence <sound sequence mnemonic>
platsequence <sound sequence mnemonic>
floorsequence <sound sequence mnemonic>
ceilingsequence <sound sequence mnemonic>
}

===Parameters===
The fields are as follows:

*'''id'''
:''Default:'' -1
:Sets up the sound sequence number to recognize it in maps. Environmental sequences use a different namespace from sector ones, and sector sequences can be separated in door, platform and general sequences (see below)

*'''cmds'''
:''Default:'' { "end" }
:'''(Deprecated)''' The list of Hexen-style commands to control the playing of sounds. Each command is written as a string, separated with a comma from the others. While this syntax will continue to be supported, it is recommended that new modifications use the heredoc-enabled syntax via the '''commands''' field instead.

*'''commands'''
:''Default'': @" end "@
:The commands field allows specification of sound sequences in the natural Hexen-derived syntax, without quotations or commas, by embedding the commands one per line inside an EDF heredoc (a literally interpreted string delimited by @" and "@ sequences). This is the recommended method of specification. '''SVN r1420+'''

*'''type'''
:''Default:'' "sector"
:There are four separate namespaces: sector, door, plat and environment. The second is restricted to doors and polys; the third to general moving floors/ceilings and lifts.

*'''stopsound'''
:''Default:'' "none"
:The sound mnemonic to play when the sector stops. Will never happen if this is an environmental sequence.

*'''attenuation'''
:''Default:'' "normal"
:Can be: normal, idle, static, none.

*'''randomplayvol'''
:''Default:'' false
:If set to true, every normal "play" command which doesn't specify a volume will begin at a randomized volume level which may be modified by the user's s_enviro_volume setting. This property exists to support Heretic-compatible global environmental sequence behavior. '''SVN r1420+'''

*'''volume'''
:''Default'': 127

*'''minvolume'''
:''Default:'' -1

*'''nostopcutoff'''
:''Default'': false

===Sequence commands===
*play <sound>
: The indicated sound will be played but the sequence will not delay in moving to the next command. If this is the last sound in the sequence, the sound might be cutoff unless other properties prevent this.
*playuntildone <sound>
: The indicated sound will be played, and the sequence will not move on to the next command or terminate until the sound has finished playing.
*playtime <sound> <time>
: The indicated sound will be played and the sequence will pause for the number of gametics (35 per second) before moving on to the next command.
*playrepeat <sound>
: The indicated sound will be played continuously without interruption. This command never ends, so the sequence will not terminate unless something such as a sector action stops it externally. This command should not be used in global environmental sequences.
*playloop <sound> <time>
: The indicated sound will be played in a loop every "time" gametics. As above, this command will never end.
*playabsvol <sound> <vol>
: Like the play command, but allows specification of the sound's base volume from 0 to 127.
*playrelvol <sound> <vol>
: Like the play command, but specifies a volume which is relative to the sound sequence's previous volume setting.
*delay <tics>
: Stop the sound sequence from progressing for the indicated number of gametics.
*delayrand <min> <max>
: Delay the sound sequence from progressing for a random number of gametics between and including "min" and "max".
*volume <vol>
: Set the sequence's current absolute volume level to the indicated value between 0 and 127.
*relvolume <vol>
: Modify the sequence's current absolute volume level by the indicated amount. The number specified should be negative to make the sequence more quiet.
*attenuation <attn>
: Set the sequence's attenuation value. This command is executed at game startup and therefore the last one specified is the only one that will take effect.
*stopsound <snd>
: Set the sequence's stopsound attribute. This command is executed at game startup and therefore the last one specified is the only one that will take effect.
*nostopcutoff
: Set the sequence's nostopcutoff attribute. This command is executed at game startup and therefore the last one specified is the only one that will take effect.
*restart
: Restart the current sound sequence. This command should not be used in global environmental sequences.
*end
: End the sequence. This command is not required by the Eternity Engine, and exists for Hexen compatibility.

===Example===
// This is a sequence playable by name only. It is one of the default sector sequences
// defined in sounds.edf, and is used by Heretic doors when they close.
soundsequence EEDoorCloseNormal
{
cmds =
{
"play EE_DoorOpen",
"stopsound EE_DoorClose"
}
}

// This is an environmental sequence for Heretic, which is used by placing a thing of
// type 1200 anywhere on the map. It is started by the environmental sequence manager
// at random, with the probability of it being played being determined by the proportion
// of 1200 objects to other environmental sequence spots on the map.
soundsequence EEHticAmbScream
{
type = environment
id = 0
cmds = { "playuntildone ht_amb1" }

volume = 96
minvolume = 32
attenuation = none
}

// This is a sound sequence meant to be played by a PolyObject. It could also use
// type sector and would still work, but using type door is more explicit. PolyObjects
// always use door-type actions when starting sequences, so they check the door lookup
// first for id numbers between 0 and 63.
soundsequence PolyDoor
{
type = door
id = 0
cmds =
{
"play EE_BDoorOpen",
"stopsound EE_PlatStop"
}
}

// This is one of the more complicated environmental sequences from sounds.edf.
// It plays two alternating footstep sounds every 15 gametics at a constantly
// decreasing volume level.
soundsequence EEHticSlowFootSteps
{
type = environment
id = 3
cmds =
{
"playtime ht_amb4 15",
"playrelvol ht_amb11 -3",
"delay 15",
"playrelvol ht_amb4 -3",
"delay 15",
"playrelvol ht_amb11 -3",
"delay 15",
"playrelvol ht_amb4 -3",
"delay 15",
"playrelvol ht_amb11 -3",
"delay 15",
"playrelvol ht_amb4 -3",
"delay 15",
"playrelvol ht_amb11 -3",
"nostopcutoff"
}

volume = 96
minvolume = 32
attenuation = none
}

// Yes, sound sequences can be completely silent :) All fields are defaulting, and
// the only command in the command list is "end".
soundsequence EEPlatSilent
{
}

==Ambience==
'''Ambience''' sections allow the user to define the behavior of ambient sound spots, which can be placed on maps using DoomEd numbers 14001 through 14065. The first 64 of these objects automatically use the ambience sections with numeric indexes 1 through 64. Object 14065 accepts the index number in its first argument field, which may be specified either through the use of ExtraData via the Hexen map format or via the upcoming UDMF format.

===Syntax===
ambience
{
sound = <sound mnemonic>
index = <number>
volume = <number>
attenuation = <attenuation type>
type = <ambience behavior type>
period = <number>
minperiod = <number>
maxperiod = <number>
}

===Usage==
*'''sound'''
:Default = "none"
:This field specifies the sound to be played by an ambience object using this definition. If the value provided to this field is invalid, no sound will be played.
*'''index'''
:Default = 0
:Defines the index of this ambience definition. This may be an integer of any value zero or greater, although only the first 256 ambience definitions are usable via the Hexen map format. When an ambience definition has the same index as a previously defined ambience definition, it will overwrite that previous definition. Note that if a thing placed on a map references an invalid ambience sequence, that object will do nothing.
*'''volume'''
:Default = 127
:The relative volume of this ambient sound, ranging from 0 to 127. This is multiplied by the user's volume setting so that the true range of volume is from 0 to the user's setting. For all attenuation types except "none", the volume is additionally decreased by the user's distance from the ambience object.
*'''attenuation'''
:Default = "normal"
:This field defines the attenuation behavior of the ambience object. Attenuation is how the sound changes with distance between the listener and the ambience object. The following values are available for this field:
:*normal -- Use the close_dist and clipping_dist fields defined in the sound definition.
:*idle -- Use DOOM's normal default sound attenuation behavior.
:*static -- Fades quickly (inaudible from 512 units).
:*none -- Plays at this ambience definition's volume level regardless of distance.

*'''type'''
:Default = "continuous"
:This field defines the repetition behavior of this ambience definition. The following values are available for this field:
:*continuous -- loops the sound seamlessly
:*periodic -- restarts the sound every "period" number of gametics
:*random -- restarts the sound after a randomized wait period determined by the minperiod and maxperiod fields

*'''period'''
:Default = 35
:For periodic ambience definitions, this field defines how frequently the sound is restarted in gametics (1/35 of a second).
*'''minperiod'''
:Default = 35
:For random ambience definitions, this field defines the shortest wait period before the sound will be restarted.
*'''maxperiod'''
:Default = 35
:For random ambience definitions, this field defines the longest wait period before the sound will be restarted. The ambience object will wait a period of time somewhere between minperiod and maxperiod gametics, inclusive. For proper behavior, maxperiod should be a number greater than minperiod.
===Example===
ambience
{
index = 0
sound = ht_waterfl
type = continuous
volume = 127
attenuation = static
}

ambience
{
index = 1
sound = ht_bstsit
type = periodic
volume = 64
attenuation = none
period = 70
}

ambience
{
index = 2
sound = ht_bstatk
type = random
volume = 127
attenuation = idle
minperiod = 35
maxperiod = 105
}

==Environmental Sequence Manager==
EDF can alter basic properties of the environmental ambience sound sequence manager. This system runs in every level and randomly chooses environmental sequences to play based on what objects with DoomEd numbers 1200 through 1300 are present on the level (these objects are collected in much the same way as Boss Brain spots or D'Sparil's teleport landings). The probability of a given sequence playing on any particular event is determined solely by how many objects on the level specify that sequence as compared to the total number of objects.

There can be any number of enviromanager blocks specified, but only the values in the last one parsed will be used.

===Syntax===
enviromanager
{
minstartwait = <number> // minimum wait time at level start in tics
maxstartwait = <number> // maximum wait time at level start in tics
minwait = <number> // minimum wait time between sequences in tics
maxwait = <number> // maximum wait time between sequences in tics
}
In all cases, the minimum wait times should be less than the maximum. The engine will adjust the values to make this true if it is not.

==Sound environments==
Use of sound environments allows addition of reverberation effects to areas within levels called "sound zones." Sound zones are sets of contiguous sectors which connect to each other by two-sided lines which are not marked with a new ExtraData linedef flag, ZONEBOUNDARY.

To assign a specific sound environment to a zone, use ExtraData to create an EESoundEnvironment object in one of the sectors inside that zone with its first two map arguments set to the two ID numbers of the EDF reverb definition you want to apply while a player is inside that area.

// Defines a reverb sound environment. ID1 and ID2 are required and must be
// numbers between 0 and 255.
reverb <name> : <id1>, <id2>
{
// Roomsize defines the decay time and "volume" of reverberation; the larger
// the value, the bigger the space.
// Range 0.0 to 1.07143; default 0.5
roomsize <float>

// Damping defines the amount of high-frequency rolloff in the reverb filters.
// A higher value is analogous to a space filled with fewer reflective objects.
// Range 0.0 to 1.0; default 0.5
damping <float>

// Wet scale defines the amount of reverberated signal in the reverb output.
// Range 0.0 to 1.0; default 0.333...
wetscale <float>

// Dry scale defines the amount of dry (input) signal in the reverb output.
// Range 0.0 to 1.0; default 0.0
dryscale <float>

// Width defines the amount of stereo phasing/cross-over in the reverberation.
// Range 0.0 to 1.0; default 1.0
width <float>

// Predelay defines the amount of time between sound emission and the first
// reverb response. Defined in milliseconds; Range 0 to 250; default 0.
predelay <int>

// The equalized flag, if specified as +equalized, will turn on a three-band
// equalization pass after the reverb filters. This allows tweaking the amount
// of low- and high-frequency sound for adjusting the "luminosity" of the
// effect. Default is -equalized.
[+-]equalized

// These parameters apply when +equalized is specified:

eq.lowfreq <float> // Low band upper edge in Hz; 20-20000; default = 250.0
eq.highfreq <float> // High band lower edge in Hz; 20-20000; default = 4000.0
eq.lowgain <float> // Volume factor for low freqs; 0.0-1.0; default 1.0
eq.midgain <float> // Volume factor for mid freqs; 0.0-1.0; default 1.0
eq.highgain <float> // Volume factor for hi freqs; 0.0-1.0; default 1.0
}
Adjustments have also been made to EDF ambience and soundsequence definitions which allow either to exclude themselves from application of sound zones. To exclude either type of definition from environmental effects, use the -reverb flag as such:
ambience <name>
{
...
-reverb
}

soundsequence <name>
{
...
-reverb
}
By default, environments apply to all ambience and soundsequence definitions.

[[category:EDF]]

User:Quasar

2016-02-17T01:29:12Z

Quasar:

Hello, I'm Quasar, founder of [[Team Eternity]] and one of the principal programmers of the [[Eternity Engine]]. I am a mod on the Wiki, naturally, and I'll soon be adding tons of material here.

Some of my websites:
* [[doom_wiki:User:Quasar|My user page]] on [http://doomwiki.org DoomWiki.org], the ''real'' Doom Wiki. Anything else is not blessed or maintained by me.
* [[zdoom:User:Quasar|My user page]] at the ZDoom Wiki.
* http://dk.youfailit.net - Dungeon Keeper Millennium

Doom Wiki

2015-06-19T21:17:55Z

Quasar: tag line

The '''Doom Wiki''' at [http://doomwiki.org DoomWiki.org] is a project to document everything related to id Software's classic games Doom and Doom II.

Articles that are more closely related to Doom in general, other source ports, or non-[[Eternity]] specific editing aspects should be placed there. Interwiki links to the Doom Wiki are created like this: <nowiki>[[Doom Wiki:Doom|Doom]]</nowiki>, creating [[Doom Wiki:Doom|Doom]].

Doom Wiki

2015-06-19T21:17:07Z

Quasar: Holy fuck :P

The '''Doom Wiki''' is a project to document everything related to id Software's classic games Doom and Doom II.

Articles that are more closely related to Doom in general, other source ports, or non-[[Eternity]] specific editing aspects should be placed there. Interwiki links to the Doom Wiki are created like this: <nowiki>[[Doom Wiki:Doom|Doom]]</nowiki>, creating [[Doom Wiki:Doom|Doom]].

Eternity Engine

2015-02-26T22:40:43Z

Quasar: /* Linked portals */ LOS do work through line portals now.

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

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

==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. Note that while they have been implemented in the official releases, linked portals don't yet support certain gameplay features: hitscan weapons, line-of-sight checks through floors or ceilings, seamless sprite rendering or actor physics.

===[[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
* {{latest}} "Bifröst" - January 19, 2014

==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 at [http://devbuilds.drdteam.org/eternity/ DRDTeam's website]. For OS X they can be downloaded from [http://www.doomworld.com/vb/post/1083196 this Doomworld thread]. 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]]

User:Quasar

2015-02-26T20:44:07Z

Quasar: Update user page

Hello, I'm Quasar, founder of [[Team Eternity]] and one of the principal programmers of the [[Eternity Engine]]. I am a mod on the Wiki, naturally, and I'll soon be adding tons of material here.

Some of my websites:
* [[doom_wiki:User:Quasar|My user page]] on [http://doomwiki.org DoomWiki.org], the ''real'' Doom Wiki. Anything else is not blessed or maintained by me.
* http://dk.youfailit.net - Dungeon Keeper Millennium

Geom string

2014-03-19T15:32:31Z

Quasar: /* Syntax */ Resolution no longer limited

A '''geom string''' is a special configuration setting in [[Eternity]] which allows specification of all of the characteristics of a video mode in a single string.

==Syntax==
The syntax of a geom string is as follows:

<code>
WWWWxHHHH[flags]
</code>

Where WWWW is the width, between 320 and the maximum supported system window width; HHHH is the height, between 200 and the maximum supported system window height; and [flags] is an optional valid combination of the following single-letter specifiers:
{| class="wikitable" style="font-size: 85%"; text-align: center; width: auto
!style="background-color: #C5D0E1"| Flag
!style="background-color: #E3EEFF"| Description
|-style="background-color: #F5F5F5"
| w
| Selects windowed mode.
|-style="background-color: #D9D9D9"
| f
| Selects fullscreen mode.
|-style="background-color: #F5F5F5"
| a
| Selects "asynchronous" or non-page-flipped updating.
|-style="background-color: #D9D9D9"
| v
| Selects page-flipped updating.
|-style="background-color: #F5F5F5"
| s
| Selects "software" surface.
|-style="background-color: #D9D9D9"
| h
| Selects "hardware" surface (eg. DirectDraw acceleration)
|-style="background-color: #F5F5F5"
| n
| Creates primary window without a window frame, where supported.
|-
!style="background-color: #C5D0E1"| Flag
!style="background-color: #E3EEFF"| Description
|}

==Examples==
The following are examples of valid geom strings.

<code>
320x200w
640x480f
1024x768wan
1280x800fvh
</code>

ZIP

2013-12-08T08:08:02Z

Quasar: Wrong ordering.

Instead of using the WAD format, Eternity mods can use ZIP archives. The extension .PKE or .PK3 instead of .ZIP is recommended to make it clear that the content should not be extracted.

Certain resources must be placed into special directories according to their type. The rest must go in the "global" namespace, which is the root folder of the ZIP. The optional directories allow compatibility with ZDoom but are treated as being part of the global namespace by Eternity.

{| class="wikitable" style="font-size: 95%;"
|-
! Directory !! Description
|-
| '''acs/''' || contains ACS libraries normally found between '''A_START''' and '''A_END'''.
|-
| '''colormaps/''' || contains Boom colormaps normally found between '''C_START''' and '''C_END'''.
|-
| '''demos/''' || contains demos.
|-
| '''flats/''' || contains flats normally found between '''FF_START''' and '''FF_END'''.
|-
| '''sprites/''' || contains sprites normally found between '''S_START''' and '''S_END'''.
|-
| '''textures/''' || contains PNG, patch, or linear images which can be used directly as textures, normally found between '''TX_START''' and '''TX_END'''
|-
| '''translations/''' || contains translations.
|-
! colspan="2" | Optional directories
|-
| '''graphics/''' || contains graphics other than sprites, textures, and flats.
|-
| '''sounds/''' || contains all sound files.
|-
| '''music/''' || contains all data that is used as music.
|}

ZIP

2013-12-08T08:07:23Z

Quasar: Add textures namespace now available as of r2736

Instead of using the WAD format, Eternity mods can use ZIP archives. The extension .PKE or .PK3 instead of .ZIP is recommended to make it clear that the content should not be extracted.

Certain resources must be placed into special directories according to their type. The rest must go in the "global" namespace, which is the root folder of the ZIP. The optional directories allow compatibility with ZDoom but are treated as being part of the global namespace by Eternity.

{| class="wikitable" style="font-size: 95%;"
|-
! Directory !! Description
|-
| '''acs/''' || contains ACS libraries normally found between '''A_START''' and '''A_END'''.
|-
| '''colormaps/''' || contains Boom colormaps normally found between '''C_START''' and '''C_END'''.
|-
| '''demos/''' || contains demos.
|-
| '''flats/''' || contains flats normally found between '''FF_START''' and '''FF_END'''.
|-
| '''sprites/''' || contains sprites normally found between '''S_START''' and '''S_END'''.
|-
| '''translations/''' || contains translations.
|-
| '''textures/''' || contains PNG, patch, or linear images which can be used directly as textures, normally found between '''TX_START''' and '''TX_END'''
|-
! colspan="2" | Optional directories
|-
| '''graphics/''' || contains graphics other than sprites, textures, and flats.
|-
| '''sounds/''' || contains all sound files.
|-
| '''music/''' || contains all data that is used as music.
|}

List of command line parameters

2012-01-15T21:50:26Z

Quasar: /* Miscellaneous */ Removed -cdrom, which does not exist any longer

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
* -edf-show-warnings : Displays verbose EDF warning information on the system console at startup.

==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.
* -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 : Specifies the peer-to-peer player node to use and the IP addresses of the other players.
* -timer <n> : Sets timelimit for Deathmatch to n minutes.
* -trideath : Enables SMMU Deathmatch 3.0 (barrels respawn, players drop backpacks [currently broken]).

===Multiplayer Example===

Eternity supports up to 4 player multiplayer. For example:

* Player 1's IP Address: 192.168.1.12
* Player 2's IP Address: 192.168.1.13
* Player 3's IP Address: 192.168.1.28
* Player 4's IP Address: 192.168.1.8

Player 1's command-line:
eternity.exe -iwad C:\Doom\WADs\doom2.wad -net 1 192.168.1.13 192.168.1.28 192.168.1.8

Player 2's command-line:
eternity.exe -iwad C:\Doom\WADs\doom2.wad -net 2 192.168.1.12 192.168.1.28 192.168.1.8

Player 3's command-line:
eternity.exe -iwad C:\Doom\WADs\doom2.wad -net 3 192.168.1.12 192.168.1.13 192.168.1.8

Player 4's command-line:
eternity.exe -iwad C:\Doom\WADs\doom2.wad -net 4 192.168.1.12 192.168.1.13 192.168.1.28

Once all players have connected, the game will start.

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

List of command line parameters

2012-01-15T21:46:34Z

Quasar: /* EDF */ Added -edf-show-warnings

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
* -edf-show-warnings : Displays verbose EDF warning information on the system console at startup.

==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 : Specifies the peer-to-peer player node to use and the IP addresses of the other players.
* -timer <n> : Sets timelimit for Deathmatch to n minutes.
* -trideath : Enables SMMU Deathmatch 3.0 (barrels respawn, players drop backpacks [currently broken]).

===Multiplayer Example===

Eternity supports up to 4 player multiplayer. For example:

* Player 1's IP Address: 192.168.1.12
* Player 2's IP Address: 192.168.1.13
* Player 3's IP Address: 192.168.1.28
* Player 4's IP Address: 192.168.1.8

Player 1's command-line:
eternity.exe -iwad C:\Doom\WADs\doom2.wad -net 1 192.168.1.13 192.168.1.28 192.168.1.8

Player 2's command-line:
eternity.exe -iwad C:\Doom\WADs\doom2.wad -net 2 192.168.1.12 192.168.1.28 192.168.1.8

Player 3's command-line:
eternity.exe -iwad C:\Doom\WADs\doom2.wad -net 3 192.168.1.12 192.168.1.13 192.168.1.8

Player 4's command-line:
eternity.exe -iwad C:\Doom\WADs\doom2.wad -net 4 192.168.1.12 192.168.1.13 192.168.1.28

Once all players have connected, the game will start.

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

EDF

2011-05-08T22:09:29Z

Quasar: /* Implementation */ Eternity never loads modules as "default fallbacks" any longer so that section has been removed.

'''EDF''', Eternity Definition File, is a language used to define and modify monsters, decorations, sounds, text strings, menus, terrain types, and other data in Eternity Engine.

==Syntax==
===EDF is Free-form===

Whitespace and token positioning are totally free-form in EDF. In addition, semicolons are discarded as whitespace and can therefore be used to terminate field assignments, lists, etc. as in C or C++. Also, the equal sign (as a standalone operator) used to connect keywords with values is no longer required. As an example, all of the following are strictly equivalent:

thingtype w00t { mass = 1000 }

thingtype w00t
{
mass 1000;
}

thingtype
w00t
{
mass =
1000 ;;;;;;
}

The usage of a clean and consistent format is encouraged, even though it is not required. To reduce cluttering, examples and definitions throughout this wiki will be written without the equal operator.
===Value types===
Fields in EDF can take character string, heredoc, numeric values or lists of values.
====Strings====
Many fields in EDF take strings. Strings, if they do not contain whitespace or any character that needs to be escaped, may be unquoted. Unquoted strings additionally cannot contain any of the following characters: " ' = { } ( ) + , # / ;

If any of those characters are found, the unquoted string will be terminated at the last valid character.

Example:

spritenames += { SPR1, SPR2, SPR3 }

The items SPR1, SPR2, and SPR3 are unquoted strings. Note how the commas serve to separate the items in a list, and therefore do not become part of the strings.

Many fields more or less require quoted strings. Quoted strings must start and end with either single or double quotes (the beginning and ending quote types must match). Quoted strings may contain any character except a line break, including those not allowed in unquoted strings. In addition, quoted strings also support the following escape codes for non-typable characters:

* \n : Hard line break
* \t : Tab
* \b : Backspace
* \a : Beep (causes a sound when printed to the console)
* \\ : Literal \ character.
* \" : Literal ", necessary to use in double-quoted strings only
* \' : Literal ', necessary to use in single-quoted strings only
* \0 : Null character
* \K : Changes text color to "brick" range where supported.
* \1 : Changes text color to "tan" range where supported.
* \2 : Changes text color to "gray" range where supported.
* \3 : Changes text color to "green" range where supported.
* \4 : Changes text color to "brown" range where supported.
* \5 : Changes text color to "gold" range where supported.
* \6 : Changes text color to "red" range where supported.
* \7 : Changes text color to "blue" range where supported.
* \8 : Changes text color to "orange" range where supported.
* \9 : Changes text color to "yellow" range where supported.
* \N : Changes text color to gamemode "normal" range where supported.
* \H : Changes text color to gamemode "hilite" range where supported.
* \E : Changes text color to gamemode "error" range where supported.
* \S : Toggles text shadowing where supported.
* \C : Toggles absolute centering of text where supported.

If \ is followed by any other character, the slash is discarded and the next character is treated normally (ie, \d becomes d). Avoid doing this, however, to maintain forward compatibility.

Examples:

thingtype w00t
{
obituary_normal = "w00ts"
<nowiki>obituary_melee = 'says \'w00t\''</nowiki>
}

Line Continuation:

Starting with Eternity Engine v3.31 Delta, line continuation can be used to split quoted strings across multiple lines. The syntax for doing this is demonstrated in the following example:

frame S_MYFRAME
{
cmp = "TROO|A|*|6 \
TroopAttack|@next"
}

The "\" character, when followed immediately by a line break, signifies that line continuation should be triggered. Whitespace before the line continuation will be included in the string, but any spaces or tabs at the beginning of the next line will NOT be included (this is the same as line continuation in BEX files). This allows the following continued parts of the string to be arbitrarily indented for purposes of beautification. A string can be split across any number of lines in this fashion.

NOTE: Simply adding "\" will not result in a newline character even if the continued string appears multiline in the EDF file. For text that is supposed to be multiline, use heredocs instead.

====Heredocs====
EDF supports heredocs, which are multi-line strings. A heredoc is delimited by @" and "@, and can be placed interchangeably with a string, especially where more lines are needed. Heredocs are commonly used where non-EDF code is implemented, such as in DECORATE-style state definition or sound sequencing. Note: in heredocs, ''any'' character is taken into account, such as whitespaces at the beginning of a line. It is up to the interpreter reading the contents of the heredoc to remove extraneous whitespaces, and such characters ''will'' appear where literal text is to be written.

====Numbers====

Most non-string fields in EDF are numbers, either integer or floating-point. Starting with EDF 1.1, decimal, octal, and hexadecimal integers will be accepted in all number fields. Octal numbers start with a zero, and hexadecimal numbers start with the sequence 0x -- Examples:

# this is a normal, decimal number (base 10)
spriteframe = 16
...
# this is an octal number (base 8)
spriteframe = 020
...
# this is a hexadecimal number (base 16)
spriteframe = 0x10

Floating-point numbers must have a decimal point in them, as in "20.0". Floating-point numbers are always base 10.

====Value lists====
Fields can take multiple values, enclosed in curly braces and separates by commas. The '''spritenames''' block includes such an example, or other situations such as non-heredoc sound sequences.

Note: commas are ''not'' interchangeable with semicolons, and are used only to separate values inside lists, whereas semicolons are simple substitutes to white space in general parts of the code.

===Comments===

EDF files can use three forms of comments:

* # Comments: Like in DeHackEd, this comment type extends to the end of the line.
* // Comments: An alternate form of single-line comment, equivalent to #.
* /* */ Comments: This type of comment is multiline, and extends from the opening /* to the first */ found. This type of comment CANNOT be nested. Nested multiline comments will cause a syntax error.

Examples:

# Single line comment

// Another single line comment

/*

This is a multiline comment

*/

==Implementation==

===Loading EDF===

By default, Eternity loads the EDF file from the relative path: ''base\root.edf''. The root file can be substituted as follows, either from an external file or a WAD lump:

* To load an EDF root from a WAD file, the name of the root EDF lump must be "EDFROOT".
* To include an EDF file from the command line, use the -edf parameter. For example: ''eternity -edf c:\blah\root.edf''
* A [[GFS]] file can specify the root EDF file with the '''edffile''' keyword. Only one EDF file can be specified in a GFS. If -edf is used when a GFS is loaded, the command-line parameter will take precedence. See the GFS documentation for further information.

Unless the intention is to redefine the entire game structure, the overriding root EDF file must contain a command at the top to include the ''base\root.edf'' file, by using this function: ''stdinclude("root.edf")''. Note that it is possible to load several wads containing EDFROOT; they will be processed additively.

===Including files===
Use of include files is critical for several purposes. First, it's unorganized and difficult to maintain EDF files when everything is put haphazardly into one file.

To include a file or wad lump normally, with a path relative to the current file doing the inclusion, use the include function, like in these examples:

# include examples

include("myfile.edf")
include("../prevdir.edf"); # remember, semicolons are purely optional

This example would include "myfile.edf" from the same directory that the current file is in, and "prevdir.edf" from the parent directory. It is important to note that this function can only include files when called from within a file, and it can only include WAD lumps when called from within a WAD lump. This restriction is necessary due to how the complete path of the included file must be formed.

In order to remain compatible with future versions of Eternity, and to greatly reduce EDF file sizes, include the standard, default EDF files into your own. To include the files from Eternity's ''base'' directory, use the '''stdinclude''' function:

stdinclude("root.edf")

Note: to ensure backward and forward compatibility, do not include other EDF files from the ''base'' directory than ''root.edf''.

Include statements may only be located at the topmost level of an EDF file, and not inside any section.

The '''userinclude''' function allows the optional inclusion of a file from Eternity's ''base'' folder. This function is identical to '''stdinclude''', except that it will test to see if the file exists beforehand, and if it does not, no error will occur. This function is NOT for use by EDF editors in projects. This function is intended for end-user modification of EDF settings, including but not limited to the custom user menu. Example:

userinclude("user.edf")

This example can be found in Eternity's root.edf, where it exists to include the optional user-defined "user.edf" file. You should never attempt to overwrite the user.edf file with one from your own project, as this is outside the scope of its purpose and will be offensive to the end user.

===Including lumps===

This '''lumpinclude''' function includes a wad lump when called from either a file or a lump. The lump named must exist, or an error will occur. The name must also be no longer than eight characters. Case of the lump name will be ignored as usual.
Example:

lumpinclude("MYEDFLMP")

Another function, ''include_prev()'' may be encountered in EDF files or lumps for older versions of Eternity. It has been deprecated and has no effect.

Note: including a lump or file several times is safe.

===Including BEX files{{deprecated}}===
It is possible to include BEX files by using:

bexinclude("file.bex")

but it is recommended to use the DEHACKED lump or GFS files rather than EDF.

===Base EDF files===
This section explains the contents of each of the standard default EDF modules. Note that some are game-dependent and are in consequence included in their respective folders, as well as the base folder for the common features.

* cast.edf -- contains '''castinfo''' (Doom 2 cast call) definitions
* fonts.edf -- contains '''font''' definitions -- game dependent
* frames.edf -- contains '''frame''' definitions -- game dependent
* misc.edf -- contains '''boss_spawner_types''' and some Heretic-specific '''string''' blocks
* player.edf -- contains '''skin''' and '''playerclass''' definitions
* root.edf -- includes all other modules
* sounds.edf -- contains '''sound''' and '''soundsequence''' definitions -- game dependent
* sprites.edf -- contains '''spritenames''' and '''pickupitem''' definitions
* sounds.edf -- contains sound definitions
* terrain.edf -- contains '''splash''', '''terrain''', '''floor''' definitions
* things.edf -- contains '''thingtype''' and '''damagetype''' definitions
* user.edf -- optional user-defined EDF file which may contain any definitions

Click on any of the links for reference on how to use the specific blocks.

===Lumps besides EDFROOT that are automatically loaded===
Eternity can load other EDF lumps, besides EDFROOT. Previously, they were dedicated to specific blocks, but now can be used for any purpose. They don't need to be explicitly included from EDFROOT, but it is no danger in doing so.

*ESTRINGS
*ETERRAIN
*EMENUS
*ESNDSEQ
*ESNDINFO
*EFONTS

===Reserved identifiers===

This section describes classes of identifiers (such as thing, frame, and sound mnemonics) which are considered reserved by the Eternity Engine. You should avoid using any identifier in the following classes for objects which you define yourself. Failure to do so could result in incompatibility of your project with future versions of the Eternity Engine due to conflicts with newly added game engine features.

* All identifiers beginning with _ (underscore)
* All identifiers beginning with EE or ee (this prefix means "Eternity Engine" and is therefore reserved for use by the source port's authors only).
* All identifiers containing ANY non-alphanumeric character excepting non-leading underscores (ex: $ is reserved).

For maximum safety, it is recommended that you develop a consistent and unique naming scheme for objects you create yourself. This has the positive side effect, of improving the ability of your EDF patches to combine with those of others.

==Verbose EDF logging==
Eternity includes a verbose logging feature in the EDF processor that allows a view of more detailed information on what is occuring while EDF is being processed. This can help nail down the location of any errors or omissions. To enable verbose EDF logging, use the command-line parameter -edfout. This will cause Eternity to write an "edfout##.txt" log file in its current working directory, where ## is a unique number from 0 to 99.

==Tutorials==
* [[Creating a simple decoration]]
* [[Creating a monster]]
* [[Creating a projectile]]
* [[Creating a pickup]]
* [[Creating terrain types]]
* [[Using inheritance]]
* [[Using deltas to modify existing definitions]]

==Editing Reference==
{{EDF_REF}}

List of command line parameters

2011-05-06T18:21:23Z

Quasar: /* Demos */ Added new -play and -recorddemo aliases from 3.40.10

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.

List of command line parameters

2011-05-06T18:17:54Z

Quasar: /* Wads and other files */ New wad-related command-line parameters added in 3.40.10

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.
* -playdemo <filename> : Plays the given demo.
* -record <filename> : Records this play session as a demo named "filename".
* -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.

User talk:Mithran Denizen

2011-05-06T18:09:39Z

Quasar: Hi

Thanks for registering, and welcome to the wiki. --[[User:Quasar|Quasar]] 18:09, 6 May 2011 (UTC)

ExtraData

2011-05-06T18:08:16Z

Quasar: /* extflags */ Added BLOCKALL linedef extflag

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.

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

User talk:46.33.241.237

2011-05-04T04:44:20Z

Quasar: /* Blocked for two weeks */ new section

== Frames ==
I appreciate your initiative in trying to help out, but in editing pages, please make sure that you are not reverting updates. The information which you removed from the Frames article was correct and up-to-date, and I have restored it. Also, when others revert your edits, please do not edit-war. Instead open a discussion on the article's Talk page. --[[User:Quasar|Quasar]] 00:22, 22 March 2011 (UTC)

== Blocked for two weeks ==

You have been blocked for two weeks since you failed to accept my advice and destructively reversed my revisions to the Frame article. --[[User:Quasar|Quasar]] 04:44, 4 May 2011 (UTC)

EDF state reference

2011-03-22T00:49:46Z

Quasar: Restored some beneficial portions of the previous edit and made a few of my own.

The Frame EDF block allows definition of each individual actor frame in Eternity, independent from the thing types. Frames are commonly referred to by name in the [[thingtype]] definitions. Their data structure resembles the Dehacked "Frame" block, but is expanded upon, and uses different keywords.
=Syntax=
==Expanded form==
The following is the expanded, uncompressed frame definition. It is seldom needed to be specified this way in Eternity, unless [[delta structures]] are employed, which use these keywords. Instead, the compressed frame definitions are preferred.

Any field may be omitted, resulting in Eternity assigning them default values.
frame <unique mnemonic>
{
sprite <four-letter name>
spriteframe <one-letter index, or number>
fullbright <true/false or yes/no or on/off>
tics <integer number>
action <[[List of codepointers|codepointer]] name> [(arg, ...)]
nextframe <frame mnemonic or '@' keyword>
misc1 <numeric or identifier data>
misc2 <numeric or identifier data>
particle_event <particle event identifier>
args { <argument value>, ... }
dehackednum <integer unique number>
}
==Compressed form==
This form allows frames to be conveniently written on one line without becoming difficult to read.
frame <unique mnemonic> {cmp "sprite|frame|bright|tics|action(arg, ...)|nextframe|p_event|misc1|misc2"}
Defaulted fields ''which are in the middle'' may '''not''' be simply omitted, they must use the '''*''' character in their place. Trailing fields may be omitted.

Previous versions of Eternity supported specification of args at the end of the cmp frame, but this is now deprecated. Any arguments placed in a compressed frame definition should be put inside parentheses immediately after the action.

Note that dehackednum is not supported inside the '''cmp''' field, but unless Dehacked patch support is intended, it's not required.

===Examples===

''These frames do not exist in the original game and are only referenced for example purposes''

frame killerimp_fire6 {cmp "KILL|6|*|6|[[MissileAttack]](killerfire,homing,8,5,killerimp_claw)|@next"}
In this case, the frame will use sprite KILL, frame number 6 from a 0-based index (which is G, which could have as well been written in the '''cmp''' definition), non-fullbright (default being F, specified in this case with a defaulting '''*'''), taking 6 tics, and calling a parameterized MissileAttack, then going to the next frame defined in the file, whichever that may be. All the subsequent fields are left at their null defaults.
frame monster_thinkdecide {cmp "MONS|D|*|0|[[RandomJump]]|monster_withdraw|*|monster_engage|100"}
Here, the frame takes 0 tics, as it uses a frame-scripting action (see the '''tics''' description), the next frame is explicitly named (so this definition can be placed anywhere in the file), and the '''misc1''', '''misc2''' parameters of RandomJump are specified individually - see below.
==Fields==
*'''sprite'''
:Default: BLANK
:Specifies the four-letter part of the sprite lump to be used by the calling actor, or the special word BLANK, which results in not drawing anything. If the name contains special characters or spaces, it has to be enclosed in quotation marks. Make sure to write the sprite name exactly as the four-letter lump stem, because it's case sensitive.
*'''spriteframe'''
:Default: 0
:Specifies the sprite frame letter or 0-based index. For example, C is equivalent to 2, A to 0 and so on. In Doom-engine games the sprite lump is named of a four letter stem (specified by the '''sprite''' field) followed by one or two pairs of a letter (specified by '''spriteframe''') and a rotation number. In-game the sprite will be viewed normally when the actor gets the first letter from the name, at the designated rotation, or viewed flipped when it gets the second letter, also at the designated rotation. Possible rotations are numbered from 0 to 8. 0 means that the lump name will be used no matter how the actor is oriented against the viewport, while 1-8 mean face-to-face rotated progressively by 45 degrees. There may be more lumps for the same letter (such as Zombieman's POSSA1, POSSA2A8 etc.) and single lumps servicing two letters (SPIDA1D1, SPIDB1E1...)
*'''fullbright'''
:Default: false
:If true, the sprite will always be seen full bright in the map, even in pitch darkness. Technically the brightness is achieved by using [[colormap]] 0 over the sprite, which in normal games is an identity function.
*'''tics'''
:Default: 1
:Specifies how many gametics (units of 1/35 second each) this frame lasts. In frame loops, at least one of the frames has to take longer than 0 tics, otherwise the game will hang. For certain types of frames, whose purpose includes scripting and random or controlled frame jumping, this value is usually set to 0, because the engine jumps to target frames instantly if a condition is met, regardless of '''tics'''. For static, non-animated things, as well as all non-disintegrating corpses, the '''tics''' value is usually -1 (forever), and is required to be this way if the corpse in question is supposed to be resurrectable by a monster with [[VileChase]] walking frames.
*'''action'''
:Default: NULL
:Specifies the action [[List of codepointers|pointer]] that this frame will call when accessed by the actor. Action functions which use the '''args''' field otherwise, can also be implemented by including the arguments in parantheses on the same line as the '''action''' field, removing the need for the '''args''' property. Note that '''misc1''', '''misc2''' requiring actions are NOT subject to this and must be used separately with their fields. These include a few pointers which were inherited from [[MBF]], before the '''args''' field was introduced: [[Face]], [[Mushroom]], [[PlaySound]], [[RandomJump]], [[Spawn]] and [[Turn]].
*'''nextframe'''
:Default: S_NULL
:Specifies the frame to go to after the '''tics''' duration expires. It can be a frame mnemonic just like this frame's name, or one of these four keywords:
:*'''@next''' - go to the next frame in the EDF file.
:*'''@prev''' - go to the previous frame in the EDF file.
:*'''@this''' - loop to this same frame.
:*'''@null''' - go to the S_NULL frame. In effect, it removes the actor from the game.
*'''misc1'''
:Default: 0
:This is the first argument, used by certain [[list of codepointers|codepointers]] which were inherited from MBF, see their enumeration above.
*'''misc2'''
:Default: 0
:This is the second argument used by some MBF inherited codepointers.
*'''particle_event'''
:Default: pevt_none
:Specifies a special particle effect to occur when the actor enters this frame. Possible values are:
:*'''pevt_none''' - No effect. The default.
:*'''pevt_rexpl''' - Rocket explosion effect. Orange dots exploding in all directions from the thing's origin.
:*'''pevt_bfgexpl''' - BFG explosion effect. Same as rocket explosion, except green.
:For other particle effects, which continuously affect the actor, see the [[Thingtype]] definition.
*'''args'''
:Default: all arguments default to 0.
:This is a comma-separated list of codepointer arguments, in the form of numbers or identifiers. As of Eternity Engine v3.35.92, frames support any number of arguments, and argument evaluation is performed at runtime and is specific to each action function.
:For normal frame definitions, setting the arguments from the '''args''' field is no longer required. It is instead preferred to include them in the '''action''' property, inside parentheses, appended to the action name. '''args''' may still be useful for frame [[delta structures]], however.
*'''dehackednum'''
:Default: -1
:Specifies what number to be used if Dehacked patches are used to tweak the gameplay defined by an EDF code. Safe user values are greater than or equal to 10000.

----
''Back to [[Editing reference]]''

User talk:46.33.241.237

2011-03-22T00:22:29Z

Quasar: Created page with '== Frames == I appreciate your initiative in trying to help out, but in editing pages, please make sure that you are not reverting updates. The information which you removed from…'

EDF state reference

2011-03-22T00:19:29Z

Quasar: Undo revision 2530 by 46.33.241.237 (Talk)

The Frame EDF block allows definition of each individual actor frame in Eternity, independent from the thing types. Frames are commonly referred to by name in the [[thingtype]] definitions. Their data structure resembles the Dehacked "Frame" block, but is expanded upon, and uses different keywords.
=Syntax=
==Expanded form==
The following is the expanded, uncompressed frame definition. It is seldom needed to be specified this way in Eternity, unless [[delta structures]] are employed, which use these keywords. Instead, the compressed frame definitions are preferred.

Any field may be omitted, resulting in Eternity assigning them default values.
frame <unique mnemonic>
{
sprite <four-letter name>
spriteframe <one-letter index, or number>
fullbright <true/false or yes/no or on/off>
tics <integer number>
action <[[List of codepointers|codepointer]] name> [(arg, ...)]
nextframe <frame mnemonic or '@' keyword>
misc1 <numeric or identifier data>
misc2 <numeric or identifier data>
particle_event <particle event identifier>
args { <argument value>, ... }
dehackednum <integer unique number>
}
==Compressed form==
This form allows frames to be conveniently written on one line without becoming difficult to read.
frame <unique mnemonic> {cmp "sprite|frame|bright|tics|action(arg, ...)|nextframe|p_event|misc1|misc2"}
Defaulted fields ''which are in the middle'' may '''not''' be simply omitted, they must use the '''*''' character in their place. Trailing fields may be omitted.

Previous versions of Eternity supported specification of args at the end of the cmp frame, but this is now deprecated. Any arguments placed in a compressed frame definition should be put inside parentheses immediately after the action.

Note that dehackednum is not supported inside the '''cmp''' field, but unless Dehacked patch support is intended, it's not required.

===Examples===

''These frames do not exist in the original game and are only referenced for example purposes''

frame killerimp_fire6 {cmp "KILL|6|*|6|[[MissileAttack]](killerfire,homing,8,5,killerimp_claw)|@next"}
In this case, the frame will use sprite KILL, frame number 6 from a 0-based index (which is G, which could have as well been written in the '''cmp''' definition), non-fullbright (default being F, specified in this case with a defaulting '''*'''), taking 6 tics, and calling a parameterized MissileAttack, then going to the next frame defined in the file, whichever that may be. All the subsequent fields are left at their null defaults.
frame monster_thinkdecide {cmp "MONS|D|*|0|[[RandomJump]]|monster_withdraw|*|monster_engage|100"}
Here, the frame takes 0 tics, as it uses a frame-scripting action (see the '''tics''' description), the next frame is explicitly named (so this definition can be placed anywhere in the file), and the '''misc1''', '''misc2''' parameters of RandomJump are specified individually - see below.
==Fields==
*'''sprite'''
:Default: BLANK
:Specifies the four-letter part of the sprite lump to be used by the calling actor, or the special word BLANK, which results in not drawing anything. If the name contains special characters or spaces, it has to be enclosed in quotation marks. Make sure to write the sprite name exactly as the four-letter lump step, because it's case sensitive.
*'''spriteframe'''
:Default: 0
:Specifies the sprite frame letter or 0-based index. For example, C is equivalent to 2, A to 0 and so on. In Doom-engine games the sprite lump is named of a four letter stem (specified by the '''sprite''' field) followed by one or two pairs of letter (specified by '''spriteframe''') and rotation number. In-game the sprite will be viewed normally when the actor gets the first letter from the name, at the designated rotation, or viewed flipped when it gets the second letter, also at the designated rotation. Possible rotations are numbered from 0 to 8. 0 means that the lump name will be used no matter how the actor is oriented against the viewport, while 1-8 mean face-to-face rotated progressively by 45 degrees. There may be more lumps for the same letter (such as Zombieman's POSSA1, POSSA2A8 etc.) and single lumps servicing two letters (SPIDA1D1, SPIDB1E1...)
*'''fullbright'''
:Default: false
:If true, the sprite will always be seen full bright in the map, even in pitch darkness. Technically the brightness is achieved by using [[colormap]] 0 over the sprite, which in normal games is an identity function.
*'''tics'''
:Default: 1
:Specifies how many gametics (units of 1/35 second each) this frame lasts. In frame loops, at least one of the frames has to take longer than 0 tics, otherwise the game will hang. For certain types of frames, whose purpose includes scripting and random or controlled frame jumping, this value is usually set to 0, because the engine jumps to target frames instantly if a condition is met, regardless of '''tics'''. For static, non-animated things, as well as all non-disintegrating corpses, the '''tics''' value is usually -1 (forever), and is required to be this way if the corpse in question is supposed to be resurrectable by a monster with [[VileChase]] walking frames.
*'''action'''
:Default: NULL
:Specifies the action [[List of codepointers|pointer]] that this frame will call when accessed by the actor. Action functions which use the '''args''' field otherwise, can also be implemented by including the arguments in parantheses on the same line as the '''action''' field, removing the need for the '''args''' property. Note that '''misc1''', '''misc2''' requiring actions are NOT subject to this and must be used separately with their fields. These include a few pointers which were inherited from [[MBF]], before the '''args''' field was introduced: [[Face]], [[Mushroom]], [[PlaySound]], [[RandomJump]], [[Spawn]] and [[Turn]].
*'''nextframe'''
:Default: S_NULL
:Specifies the frame to go to after the '''tics''' duration expires. It can be a frame mnemonic just like this frame's name, or one of these four keywords:
:*'''@next''' - go to the next frame in the EDF file.
:*'''@prev''' - go to the previous frame in the EDF file.
:*'''@this''' - loop to this same frame.
:*'''@null''' - go to the S_NULL frame. In effect, it removes the actor from the game.
*'''misc1'''
:Default: 0
:This is the first argument, used by certain [[list of codepointers|codepointers]] which were inherited from MBF, see their list above.
*'''misc2'''
:Default: 0
:This is the second argument used by some MBF inherited codepointers.
*'''particle_event'''
:Default: pevt_none
:Specifies a special particle effect to occur when the actor enters this frame. Possible values are:
:*'''pevt_none''' - No effect. The default.
:*'''pevt_rexpl''' - Rocket explosion effect. Orange dots exploding in all directions from the thing's origin.
:*'''pevt_bfgexpl''' - BFG explosion effect. Same as rocket explosion, except green.
:For other particle effects, which continuously affect the actor, see the [[Thingtype]] definition.
*'''args'''
:Default: all arguments default to 0.
:This is a comma-separated list of codepointer arguments, in the form of numbers or identifiers. As of Eternity Engine v3.35.92, frames support any number of arguments, and argument evaluation is performed at runtime and is specific to each action function.
:For normal frame definitions, setting the arguments from the '''args''' field is no longer required, preferring to include them in the '''action''' property, inside parentheses, appended to the action name. '''args''' may still be useful for frame [[delta structures]], however.
*'''dehackednum'''
:Default: -1
:Specifies what number to be used if Dehacked patches are used to tweak the gameplay defined by an EDF code. Safe user values are greater than or equal to 10000.

----
''Back to [[Editing reference]]''

EDF state reference

2011-03-22T00:17:21Z

Quasar: Reverted edits by Quasar (Talk) to last revision by 46.33.241.237

The Frame EDF block allows definition of each individual actor frame in Eternity, independent from the thing types. Frames are commonly referred to by name in the [[thingtype]] definitions. Their data structure resembles the Dehacked "Frame" block, but is expanded upon, and uses different keywords.
=Syntax=
==Expanded form==
The following is the expanded, uncompressed frame definition. It is seldom needed to be specified this way in Eternity, unless [[delta structures]] are employed, which use these keywords. Instead, the compressed frame definitions are preferred.

Any field may be omitted, resulting in Eternity assigning them default values.
frame <unique mnemonic>
{
sprite <four-letter name>
spriteframe <one-letter index, or number>
fullbright <true/false or yes/no or on/off>
tics <integer number>
action <[[List of codepointers|codepointer]] name>
nextframe <frame mnemonic or '@' keyword>
misc1 <numeric or identifier data>
misc2 <numeric or identifier data>
particle_event <particle event identifier>
args {<data1>, <data2>, <data3>, <data4>, <data5>}
dehackednum <integer unique number>
}
==Compressed form==
This form allows frames to be conveniently written on one line without becoming difficult to read.
frame <unique mnemonic> {cmp "sprite|frame|bright|tics|action|nextframe|p_event|misc1|misc2|args1|args2|args3|args4|args5"}
Defaulted fields ''which are in the middle'' may '''not''' be simply omitted, they must use the '''*''' character in their place. Trailing fields may be omitted.

Note that dehackednum is not supported inside the '''cmp''' field, but unless Dehacked patch support is intended, it's not required.

===Examples===

''These frames do not exist in the original game and are only referenced for example purposes''

frame killerimp_fire6 {cmp "KILL|6|*|6|[[MissileAttack]](killerfire,homing,8,5,killerimp_claw)|@next"}
In this case, the frame will use sprite KILL, frame number 6 from a 0-based index (which is G, which could have as well been written in the '''cmp''' definition), non-fullbright (default being F, specified in this case with a defaulting '''*'''), taking 6 tics, and calling a parameterized MissileAttack, then going to the next frame defined in the file, whichever that may be. All the subsequent fields are left at their null defaults.
frame monster_thinkdecide {cmp "MONS|D|*|0|[[RandomJump]]|monster_withdraw|*|monster_engage|100"}
Here, the frame takes 0 tics, as it uses a frame-scripting action (see the '''tics''' description), the next frame is explicitly named (so this definition can be placed anywhere in the file), and the '''misc1''', '''misc2''' parameters of RandomJump are specified individually - see below.
==Fields==
*'''sprite'''
:Default: BLANK
:Specifies the four-letter part of the sprite lump to be used by the calling actor, or the special word BLANK, which results in not drawing anything. If the name contains special characters or spaces, it has to be enclosed in quotation marks. Make sure to write the sprite name exactly as the lump name, because it's case sensitive.
*'''spriteframe'''
:Default: 0
:Specifies the sprite frame letter or 0-based index. For example, C is equivalent to 2, A to 0 and so on. In Doom-engine games the sprite lump is named of a four letter word (specified by the '''sprite''' field) followed by one or two pairs of letter (specified by '''spriteframe''') and rotation number. In-game the sprite will be viewed normally when the actor gets the first letter from the name, at the designated rotation, or viewed flipped when it gets the second letter, also at the designated rotation. Possible rotations are numbered from 0 to 8. 0 means that the lump name will be used no matter how the actor is oriented against the viewport, while 1-8 mean face-to-face rotated progressively by 45 degrees. There may be more lumps for the same letter (such as Zombieman's POSSA1, POSSA2A8 etc.) and single lumps servicing two letters (SPIDA1D1, SPIDB1E1...)
*'''fullbright'''
:Default: false
:If true, the sprite will always be seen full bright in the map, even in pitch darkness. Technically the brightness is achieved by using [[colormap]] 0 over the sprite, which in normal games is an identity function.
*'''tics'''
:Default: 1
:Specifies how many tics (units of 1/35 second each) this frame lasts. In frame loops, at least one of the frames has to take longer than 0 tics, otherwise the game will hang. For certain types of frames, whose purpose includes scripting and random or controlled frame jumping, this value is usually set to 0, because the engine jumps to target frames instantly if a condition is met, regardless of '''tics'''. For static, non-animated things, as well as all non-disintegrating corpses, the '''tics''' value is usually -1, and is required to be this way if the corpse in question is supposed to be resurrectable by a monster with [[VileChase]] walking frames.
*'''action'''
:Default: NULL
:Specifies the action [[List of codepointers|pointer]] that this frame will call when accessed by the actor. Action functions which use the '''args''' field otherwise, can also be implemented by including the arguments in parantheses on the same line as the '''action''' field, removing the need for the '''args''' property. Note that '''misc1''', '''misc2''' requiring actions are NOT subject to this and must be used separately with their fields. These include a few pointers which were inherited from [[MBF]], before the '''args''' field was introduced: [[Face]], [[Mushroom]], [[PlaySound]], [[RandomJump]], [[Spawn]] and [[Turn]].
*'''nextframe'''
:Default: S_NULL
:Specifies the frame to go to after the '''tics''' duration expires. It can be a frame mnemonic just like this frame's name, or one of these four keywords:
:*'''@next''' - go to the next frame in the EDF file.
:*'''@prev''' - go to the previous frame in the EDF file.
:*'''@this''' - loop to this same frame.
:*'''@null''' - go to the S_NULL frame. In effect, it removes the actor from the game.
*'''misc1'''
:Default: 0
:This is the first argument, used by certain [[list of codepointers|codepointers]] which were inherited from MBF, see their enumeration above.
*'''misc2'''
:Default: 0
:This is the second argument used by some MBF inherited codepointers.
*'''particle_event'''
:Default: pevt_none
:Specifies a special particle effect to occur when the actor enters this frame. Possible values are:
:*'''pevt_none''' - no effect. The default.
:*'''pevt_rexpl''' - rocket explosion effect. Yellow dots exploding in all directions from the thing's origin.
:*'''pevt_bfgexpl''' - similar to the rocket explosion, but using green dots.
:For other particle effects, which continuously affect the actor, see the [[Thingtype]] definition.
*'''args'''
:Default: {0,0,0,0,0}
:This is a list of codepointer arguments, in the form of numbers or identifiers. If the called codepointer uses fewer than 5 arguments, it is safe to write less than 5 in the EDF file. Any omitted argument will default to 0. They have to be separated by commas.
:For normal frame definitions, setting the arguments from the '''args''' field is no longer required, preferring to include them in the '''action''' property, inside parantheses, appending the pointer name. '''Args''' may still be useful for frame [[delta structures]].
*'''dehackednum'''
:Default: -1
:Specifies what number to be used if Dehacked patches are used to tweak the gameplay originally defined by an EDF code. Safe values are greater than or equal to 10000, others may be used by Eternity subsequent versions.

----
''Back to [[Editing reference]]''

EDF state reference

2011-03-22T00:16:12Z

Quasar: Added back optional argument list after action. Why was this removed?

The Frame EDF block allows definition of each individual actor frame in Eternity, independent from the thing types. Frames are commonly referred to by name in the [[thingtype]] definitions. Their data structure resembles the Dehacked "Frame" block, but is expanded upon, and uses different keywords.
=Syntax=
==Expanded form==
The following is the expanded, uncompressed frame definition. It is seldom needed to be specified this way in Eternity, unless [[delta structures]] are employed, which use these keywords. Instead, the compressed frame definitions are preferred.

Any field may be omitted, resulting in Eternity assigning them default values.
frame <unique mnemonic>
{
sprite <four-letter name>
spriteframe <one-letter index, or number>
fullbright <true/false or yes/no or on/off>
tics <integer number>
action <[[List of codepointers|codepointer]] name> <(''optional arg list'')>
nextframe <frame mnemonic or '@' keyword>
misc1 <numeric or identifier data>
misc2 <numeric or identifier data>
particle_event <particle event identifier>
args {<data1>, <data2>, <data3>, <data4>, <data5>}
dehackednum <integer unique number>
}
==Compressed form==
This form allows frames to be conveniently written on one line without becoming difficult to read.
frame <unique mnemonic> {cmp "sprite|frame|bright|tics|action|nextframe|p_event|misc1|misc2|args1|args2|args3|args4|args5"}
Defaulted fields ''which are in the middle'' may '''not''' be simply omitted, they must use the '''*''' character in their place. Trailing fields may be omitted.

Note that dehackednum is not supported inside the '''cmp''' field, but unless Dehacked patch support is intended, it's not required.

===Examples===

''These frames do not exist in the original game and are only referenced for example purposes''

frame killerimp_fire6 {cmp "KILL|6|*|6|[[MissileAttack]](killerfire,homing,8,5,killerimp_claw)|@next"}
In this case, the frame will use sprite KILL, frame number 6 from a 0-based index (which is G, which could have as well been written in the '''cmp''' definition), non-fullbright (default being F, specified in this case with a defaulting '''*'''), taking 6 tics, and calling a parameterized MissileAttack, then going to the next frame defined in the file, whichever that may be. All the subsequent fields are left at their null defaults.
frame monster_thinkdecide {cmp "MONS|D|*|0|[[RandomJump]]|monster_withdraw|*|monster_engage|100"}
Here, the frame takes 0 tics, as it uses a frame-scripting action (see the '''tics''' description), the next frame is explicitly named (so this definition can be placed anywhere in the file), and the '''misc1''', '''misc2''' parameters of RandomJump are specified individually - see below.
==Fields==
*'''sprite'''
:Default: BLANK
:Specifies the four-letter part of the sprite lump to be used by the calling actor, or the special word BLANK, which results in not drawing anything. If the name contains special characters or spaces, it has to be enclosed in quotation marks. Make sure to write the sprite name exactly as the lump name, because it's case sensitive.
*'''spriteframe'''
:Default: 0
:Specifies the sprite frame letter or 0-based index. For example, C is equivalent to 2, A to 0 and so on. In Doom-engine games the sprite lump is named of a four letter word (specified by the '''sprite''' field) followed by one or two pairs of letter (specified by '''spriteframe''') and rotation number. In-game the sprite will be viewed normally when the actor gets the first letter from the name, at the designated rotation, or viewed flipped when it gets the second letter, also at the designated rotation. Possible rotations are numbered from 0 to 8. 0 means that the lump name will be used no matter how the actor is oriented against the viewport, while 1-8 mean face-to-face rotated progressively by 45 degrees. There may be more lumps for the same letter (such as Zombieman's POSSA1, POSSA2A8 etc.) and single lumps servicing two letters (SPIDA1D1, SPIDB1E1...)
*'''fullbright'''
:Default: false
:If true, the sprite will always be seen full bright in the map, even in pitch darkness. Technically the brightness is achieved by using [[colormap]] 0 over the sprite, which in normal games is an identity function.
*'''tics'''
:Default: 1
:Specifies how many tics (units of 1/35 second each) this frame lasts. In frame loops, at least one of the frames has to take longer than 0 tics, otherwise the game will hang. For certain types of frames, whose purpose includes scripting and random or controlled frame jumping, this value is usually set to 0, because the engine jumps to target frames instantly if a condition is met, regardless of '''tics'''. For static, non-animated things, as well as all non-disintegrating corpses, the '''tics''' value is usually -1, and is required to be this way if the corpse in question is supposed to be resurrectable by a monster with [[VileChase]] walking frames.
*'''action'''
:Default: NULL
:Specifies the action [[List of codepointers|pointer]] that this frame will call when accessed by the actor. Action functions which use the '''args''' field otherwise, can also be implemented by including the arguments in parantheses on the same line as the '''action''' field, removing the need for the '''args''' property. Note that '''misc1''', '''misc2''' requiring actions are NOT subject to this and must be used separately with their fields. These include a few pointers which were inherited from [[MBF]], before the '''args''' field was introduced: [[Face]], [[Mushroom]], [[PlaySound]], [[RandomJump]], [[Spawn]] and [[Turn]].
*'''nextframe'''
:Default: S_NULL
:Specifies the frame to go to after the '''tics''' duration expires. It can be a frame mnemonic just like this frame's name, or one of these four keywords:
:*'''@next''' - go to the next frame in the EDF file.
:*'''@prev''' - go to the previous frame in the EDF file.
:*'''@this''' - loop to this same frame.
:*'''@null''' - go to the S_NULL frame. In effect, it removes the actor from the game.
*'''misc1'''
:Default: 0
:This is the first argument, used by certain [[list of codepointers|codepointers]] which were inherited from MBF, see their enumeration above.
*'''misc2'''
:Default: 0
:This is the second argument used by some MBF inherited codepointers.
*'''particle_event'''
:Default: pevt_none
:Specifies a special particle effect to occur when the actor enters this frame. Possible values are:
:*'''pevt_none''' - no effect. The default.
:*'''pevt_rexpl''' - rocket explosion effect. Yellow dots exploding in all directions from the thing's origin.
:*'''pevt_bfgexpl''' - similar to the rocket explosion, but using green dots.
:For other particle effects, which continuously affect the actor, see the [[Thingtype]] definition.
*'''args'''
:Default: {0,0,0,0,0}
:This is a list of codepointer arguments, in the form of numbers or identifiers. If the called codepointer uses fewer than 5 arguments, it is safe to write less than 5 in the EDF file. Any omitted argument will default to 0. They have to be separated by commas.
:For normal frame definitions, setting the arguments from the '''args''' field is no longer required, preferring to include them in the '''action''' property, inside parantheses, appending the pointer name. '''Args''' may still be useful for frame [[delta structures]].
*'''dehackednum'''
:Default: -1
:Specifies what number to be used if Dehacked patches are used to tweak the gameplay originally defined by an EDF code. Safe values are greater than or equal to 10000, others may be used by Eternity subsequent versions.

----
''Back to [[Editing reference]]''

Soundsequence

2011-01-13T00:25:54Z

Quasar: Added documentation for all commands, and documentation of features new to SVN r1420.

Sound sequences are effects that play while a sector is moving, a polyobject is moving, or when a Heretic-style (environmental) ambient sound is under way. Similar to things, frames or individual sounds, sequences are defined in EDF by using the '''soundsequence''' block. The mnemonic must be at most 32 characters long. Sound sequence definitions can be cascaded, and the latter ones will overwrite other identically named sequences.

Sector movement sequences are used by placing thing types #1400 to #1411 on the map, inside the designated sectors. The ones numbered from #1400 to #1410 will play the sequence with the '''id''' between 0 and 10, while #1411 will use its first argument in the [[ExtraData]] definition.

Polyobject sequences are set up from the [[Polyobject_linedef_types|Polyobj_StartLine and Polyobj_ExplicitLine]] ExtraData linedef specials. '''Polyobj_StartLine''' uses the 3rd argument for this, while '''Polyobj_ExplicitLine''' uses the 4th.

Environmental sequences are set up similarly with sector sequences, by placing thing types #1200 to #1300 anywhere inside the map. #1200 to #1299 use the last two digits to designate the number, while #1300 uses the first ExtraData argument.

'''NOTE:''' You can include all '''soundsequence''' blocks inside a '''ESNDSEQ''' lump. It will be loaded automatically at game startup, independent of '''EDFROOT'''.

==Syntax==

soundsequence <mnemonic>
{
id <number>
cmds { <string>, ... }
commands <heredoc string>
type <sequence type>
stopsound <sound mnemonic>
attenuation <attenuation type>
randomplayvol <boolean>
volume <number>
minvolume <number>
nostopcutoff <boolean>
doorsequence <sound sequence mnemonic>
platsequence <sound sequence mnemonic>
floorsequence <sound sequence mnemonic>
ceilingsequence <sound sequence mnemonic>
}

==Parameters==
The fields are as follows:

*'''id'''
:''Default:'' -1
:Sets up the sound sequence number to recognize it in maps. Environmental sequences use a different namespace from sector ones, and sector sequences can be separated in door, platform and general sequences (see below)

*'''cmds'''
:''Default:'' { "end" }
:'''(Deprecated)''' The list of Hexen-style commands to control the playing of sounds. Each command is written as a string, separated with a comma from the others. While this syntax will continue to be supported, it is recommended that new modifications use the heredoc-enabled syntax via the '''commands''' field instead.

*'''commands'''
:''Default'': @" end "@
:The commands field allows specification of sound sequences in the natural Hexen-derived syntax, without quotations or commas, by embedding the commands one per line inside an EDF heredoc (a literally interpreted string delimited by @" and "@ sequences). This is the recommended method of specification. '''SVN r1420+'''

*'''type'''
:''Default:'' "sector"
:There are four separate namespaces: sector, door, plat and environment. The second is restricted to doors and polys; the third to general moving floors/ceilings and lifts.

*'''stopsound'''
:''Default:'' "none"
:The sound mnemonic to play when the sector stops. Will never happen if this is an environmental sequence.

*'''attenuation'''
:''Default:'' "normal"
:Can be: normal, idle, static, none.

*'''randomplayvol'''
:''Default:'' false
:If set to true, every normal "play" command which doesn't specify a volume will begin at a randomized volume level which may be modified by the user's s_enviro_volume setting. This property exists to support Heretic-compatible global environmental sequence behavior. '''SVN r1420+'''

*'''volume'''
:''Default'': 127

*'''minvolume'''
:''Default:'' -1

*'''nostopcutoff'''
:''Default'': false

==Sequence commands==
*play <sound>
: The indicated sound will be played but the sequence will not delay in moving to the next command. If this is the last sound in the sequence, the sound might be cutoff unless other properties prevent this.
*playuntildone <sound>
: The indicated sound will be played, and the sequence will not move on to the next command or terminate until the sound has finished playing.
*playtime <sound> <time>
: The indicated sound will be played and the sequence will pause for the number of gametics (35 per second) before moving on to the next command.
*playrepeat <sound>
: The indicated sound will be played continuously without interruption. This command never ends, so the sequence will not terminate unless something such as a sector action stops it externally. This command should not be used in global environmental sequences.
*playloop <sound> <time>
: The indicated sound will be played in a loop every "time" gametics. As above, this command will never end.
*playabsvol <sound> <vol>
: Like the play command, but allows specification of the sound's base volume from 0 to 127.
*playrelvol <sound> <vol>
: Like the play command, but specifies a volume which is relative to the sound sequence's previous volume setting.
*delay <tics>
: Stop the sound sequence from progressing for the indicated number of gametics.
*delayrand <min> <max>
: Delay the sound sequence from progressing for a random number of gametics between and including "min" and "max".
*volume <vol>
: Set the sequence's current absolute volume level to the indicated value between 0 and 127.
*relvolume <vol>
: Modify the sequence's current absolute volume level by the indicated amount. The number specified should be negative to make the sequence more quiet.
*attenuation <attn>
: Set the sequence's attenuation value. This command is executed at game startup and therefore the last one specified is the only one that will take effect.
*stopsound <snd>
: Set the sequence's stopsound attribute. This command is executed at game startup and therefore the last one specified is the only one that will take effect.
*nostopcutoff
: Set the sequence's nostopcutoff attribute. This command is executed at game startup and therefore the last one specified is the only one that will take effect.
*restart
: Restart the current sound sequence. This command should not be used in global environmental sequences.
*end
: End the sequence. This command is not required by the Eternity Engine, and exists for Hexen compatibility.

ExtraData

2011-01-13T00:03:09Z

Quasar: /* Sectors */ Added documentation of portal flags and overlays.

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

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.

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

Eternity Engine

2010-10-19T03:45:34Z

Quasar: /* Version 3.39 */ Forgot version name

Eternity Engine

2010-10-19T03:43:41Z

Quasar: /* Version 3.37 */ Added 3.39 header

Eternity Engine

2010-10-19T03:42:52Z

Quasar: /* Releases */ Added 3.39.20

ExtraData

2010-10-18T03:45:29Z

Quasar: Added documentation of ExtraData sectors, which debut in the next release.

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 WinTex (though WinTex has some bugs which make the process more complicated), XWE or SLumpEd.

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 Decimal Hex Meaning
------------------------------------------------------------------------------
EASY 1 0x0001 Thing appears in easy difficulties
NORMAL 2 0x0002 Thing appears in "Hurt Me Plenty"
HARD 4 0x0004 Thing appears in Ultra-Violence and Nightmare
AMBUSH 8 0x0008 Thing is "deaf", will not wake up via sound
NOTSINGLE 16 0x0010 Thing doesn't appear in single-player mode
NOTDM 32 0x0020 Thing doesn't appear in deathmatch
NOTCOOP 64 0x0040 Thing doesn't appear in cooperative multiplayer
FRIEND 128 0x0080 Thing uses MBF friendly logic
DORMANT 512 0x0200 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>, ... }
}
===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 Decimal Hex Meaning
---------------------------------------------------------------------------------------
CROSS 1 0x0001 Linedef can be activated by being crossed.
USE 2 0x0002 Linedef can be activated by being used.
IMPACT 4 0x0004 Linedef can be activated by being shot.
PUSH 8 0x0008 Linedef can be activated by being pushed.
PLAYER 16 0x0010 Linedef can be activated by players.
MONSTER 32 0x0020 Linedef can be activated by objects with SPACMONSTER flag.
MISSILE 64 0x0040 Linedef can be activated by objects with SPACMISSILE flag.
REPEAT 128 0x0080 Linedef action is repeatable.
1SONLY 256 0x0100 Linedef can only be activated from first side.
---------------------------------------------------------------------------------------

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

=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>
flagsadd <sector flag list>
flagsremove <sector flag list>
damage <integer>
damagemask <integer>
damagemod <method of damage type>
damageflags <sector damage flags list>
damageflagsadd <sector damage flags list>
damageflagsremove <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>
}
===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" }

====flagsadd====
:''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.

====flagsremove====
:''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.

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

====damageflagsadd====
:''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.

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

As with damageflagsadd, 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.

Template:Latest

2010-10-18T03:00:14Z

Quasar: Updated for new version

[http://www.doomworld.com/vb/eternity/52873-eternity-engine-v3-39-20-resheph/ 3.39.20]

ExtraData

2010-04-19T18:10:08Z

Quasar: Added documentation of ability to bypass line special 270 and use parameterized special #'s directly in the map.

ExtraData

2010-04-19T18:01:05Z

Quasar: Corrections, updates, and removal of documentation for deprecated features

Polyobject

2010-04-19T17:46:16Z

Quasar: Some corrections and updates.

PolyObjects are special sets of one-sided linedefs which, unlike any other lines, can be moved on the map during gameplay. Unlike the Hexen and ZDoom implementation of PolyObjects, Eternity does not restrict these objects to one per subsector, and they are also allowed to move any distance from their spawn point, even across subsector boundaries.

PolyObjects fully clip normal objects such as the player and enemies, optionally doing crushing damage depending upon the type of spawn spot used. They also block bullet tracers and monsters' lines of sight. They do not, however, clip sound propagation, so it may be necessary to use sound blocking lines near areas where PolyObjects are meant to function as a normal wall until they move.

Although Eternity does allow PolyObjects to move between different subsectors, this will only work properly if the subsectors on both sides of a line have the same properties (floor & ceiling heights, light level, and flat). However, since the implementation of [[dynaseg]]s, Eternity does not require a "PolyObject-aware" node builder.

Finally, unlike ZDoom, Eternity allows PolyObjects to be used in DOOM-format maps via the use of [[ExtraData]]. See the subsections below for more information on how to create and move PolyObjects.

==Creating PolyObjects==

PolyObjects are a combination of a set of 1S lines, which are typically placed in a "control sector" area outside of the main map, and exactly two mapthings: one spawn spot, and one anchor point. There are two different methods for grouping lines into a PolyObject.

*'''Method 1: The ''Polyobj_StartLine'' Special'''

:The Polyobj_StartLine special marks the first line in a PolyObject which is made up of a cyclic set of linedefs (that is, each line "points toward" the next line, ending at the first vertex of the first line).

:Diagrammatic Example:
[Control Sector] [Main Map Area]
+-------------------+ +-------------------------------+
| | | |
| | | | |
| +--->+ | | |
| ^ | | | |
| | |_ | | |
| A -| B | | | C |
| | v | | |
| +<---+ | | |
| | | | |
| | | |
+-------------------+ +-------------------------------+
:Assume that the linedef A is assigned the Polyobj_StartLine special and has argument #1 set to "1" -- this is its PolyObject ID number, which must be unique amongst all on the map, and must be a number greater than zero.

:Starting from line A, the engine will go from vertex to vertex, adding the first line found which shares the current line's second vertex as its first vertex. In this example, since the object is closed as is required, the process will end at the first vertex of line A, and there will be four lines in the PolyObject (note that unlike Hexen, there is NO limit to the number of lines that can be placed in one PolyObject).

:Now, once the lines are added, it is necessary to define the control objects. Points B and C are the two required objects:
:* B: This is the PolyObject's anchor point (type EEPolyObjAnchor with DoomEd #9300). It defines the point relative to which all the lines in the PolyObject will be translated to the spawn point. This object's angle must be set to the same value as the StartLine's first argument (the PolyObject ID). There must be one and only one of these objects for each PolyObject ID.
:* C: This is the PolyObject's spawn point (one of EEPolyObjSpawnSpot [9301] or EEPolyObjSpawnSpotCrush [9302]). It defines the point where the PolyObject will initially spawn on the map. The anchor point will be translated to this exact location, and all lines in the PolyObject will maintain their relative positions to it. This object must also have its angle field set to the same value as both the StartLine's first argument and the anchor point's angle field. There must be one and only one of these objects for each PolyObject ID. Use 9302 to cause the PolyObject to do crushing damage to things that block it while it is in motion.

:Note that when you use this method, the other lines belonging to the PolyObject can be given their own line specials, including ones which affect the PolyObject itself. When the player presses the PolyObject, the specials will work as expected.

:The complete arguments to Polyobj_StartLine are as follows:
:* ''polyobj_id'' : the unique ID number (greater than zero) of the PolyObject
:* ''mirror_id'' : the ID number of a PolyObject that you want to mirror every action that affects this PolyObject. This number cannot be the same as the PolyObject's own ID.

:In order to use this line special in a DOOM-format map, it is necessary to use [[ExtraData]]. In that case, you must give the line you want to have the Polyobj_StartLine special the ExtraData linedef control special (#270) instead, and then specify Polyobj_StartLine and its arguments in its corresponding ExtraData linedef record.

*'''Method 2: The ''Polyobj_ExplicitLine'' Special '''

:The Polyobj_ExplicitLine special demarcates every line that will be added to a PolyObject and the exact order in which the lines will be added. This affords a bit more flexibility in the construction of PolyObjects at the price of not allowing any other line specials to be placed on the object itself.

:Diagrammatic Example:
[Control Sector] [Main Map Area]
+-------------------+ +-------------------------------+
| 2 | | |
| | | | |
| +--->+ | | |
| ^ | | | |
| | |_ 4 | | |
| 1 -| B | | | C |
| | v | | |
| +<---+ | | |
| | | | |
| 3 | | |
+-------------------+ +-------------------------------+
:Assume that the linedefs labeled 1 through 4 are assigned the Polyobj_ExplicitLine special, all have argument #1 set to "1" -- this is its PolyObject ID number, which must be unique amongst all on the map, and must be a number greater than zero -- and all have argument #2 set to the integer values 1 through 4, corresponding to their labels in the diagram.

:The game engine will search through all linedefs in the entire map for ones with the current PolyObject ID in argument #1 and a value greater than zero in argument #2. The lines will be collected and then sorted by the value in their second argument and added to the PolyObject in that order. Note that unlike Hexen, it is not necessary for the numbers in the second argument to be sequential (ie, a sequence such as { 5, 10, 15, 20 } would also work).

:Now, once the lines are added, it is necessary to define the control objects. This is exactly the same as it is for the StartLine special above.
:* B: This is the PolyObject's anchor point (type EEPolyObjAnchor with DoomEd #9300). It defines the point relative to which all the lines in the PolyObject will be translated to the spawn point. This object's angle must be set to the same value as the ExplicitLines' first argument (the PolyObject ID). There must be one and only one of these objects for each PolyObject ID.
:* C: This is the PolyObject's spawn point (one of EEPolyObjSpawnSpot [9301] or EEPolyObjSpawnSpotCrush [9302]). It defines the point where the PolyObject will initially spawn on the map. The anchor point will be translated to this exact location, and all lines in the PolyObject will maintain their relative positions to it. This object must also have its angle field set to the same value as both the ExplicitLines' first argument and the anchor point's angle field. There must be one and only one of these objects for each PolyObject ID. Use 9302 to cause the PolyObject to do crushing damage to things that block it while it is in motion.

:The complete arguments to Polyobj_ExplicitLine are as follows:
:* ''polyobj_id'' : the unique ID number (greater than zero) of the PolyObject
:* ''number'' : specifies the order in which the line will be added to the PolyObject. This number should be unique amongst all lines to be added to the same object, and must be a value greater than zero.
:* ''mirror_id'' : the ID number of a PolyObject that you want to mirror every action that affects this PolyObject. This number cannot be the same as the PolyObject's own ID.

:In order to use this line special in a DOOM-format map, it is necessary to use ExtraData. In that case, you can either give the lines you want to have the Polyobj_ExplicitLine special the ExtraData linedef control special (#270) instead, and then specify Polyobj_ExplicitLine and its arguments in all the corresponding ExtraData linedef records; or simply use the line special normally, and specify the ExtraData record number in the linedef's tag, specifying only the arguments inside the ExtraData record.

==Moving PolyObjects==

There are two types of basic motion which PolyObjects can currently undergo: translation and rotation. Using "override" actions, it is possible to combine the two to have a PolyObject which rotates while moving in the xy plane.

'''Translating PolyObjects'''

To move a PolyObject in the xy plane, use one of the following line specials:
* Polyobj_Move
* Polyobj_OR_Move

Both of these line specials use the same arguments:
* ''polyobj_id'' : Specifies which PolyObject to intially move. If the object is already moving, nothing will happen unless the action is Polyobj_OR_Move. If this object has a mirror, the same action will be recursively applied to every mirror PolyObject, reversing the angle of movement for each subsequent mirror.
* ''speed'' : Speed of the motion in eighths of a unit per tic.
* ''angle'' : Byte angle specifying the direction of motion. To convert from degrees to byte angles, use this formula: byteangle = (degrees * 256) / 360. Round or chop the result to an integer. 0 means East, 64 means North, 128 means West, and 192 means South.
* ''dist'' : The total distance to move the object in units.

All PolyObjects will inflict thrust on objects which block them with force proportional to the speed of motion. If the PolyObject was spawned with the EEPolyObjSpawnSpotCrush object (DoomEd num 9302), then if the object does not fit at the location it is being pushed toward, it will be damaged 3 hitpoints per tic (105 damage per second).

'''Rotating PolyObjects '''

To rotate a PolyObject, use one of the following line specials:
* Polyobj_RotateRight
* Polyobj_OR_RotateRight
* Polyobj_RotateLeft
* Polyobj_OR_RotateLeft
All these line specials use the same arguments:
* ''polyobj_id'' : Specifies which PolyObject to initially rotate. If the object is already moving, nothing will happen unless the action is Polyobj_OR_RotateRight or Polyobj_OR_RotateLeft. If this object has a mirror, the same action will be recursively applied to every mirror PolyObject, reversing the direction of rotation for each subsequent mirror.
* ''aspeed'' : Angular speed of the rotation in byte angles per tic. Same as for the "angle" parameter to Move actions.
* ''adist'' : Angular distance to rotate in byte angles. Same as for aspeed, except with two special caveats:

The byte angle value 0 (zero) means to rotate exactly 360 degrees.

The byte angle value 255 means to rotate perpetually. This type of action never ends and thus only override actions can subsequently be applied to the PolyObject.

==PolyObject Doors==

There are two distinct types of actions provided to allow PolyObjects to function as doors. There are no override versions of door actions, and applying other overrides to currently moving PolyObject doors will most likely cause the doors to malfunction and move erratically.

All PolyObject doors accept a delay parameter, and this specifies the amount of time the door will wait before closing. A door which is closing will reopen if blocked by an object.
* Polyobj_DoorSlide
:This action creates a sliding door from a PolyObject and takes the following arguments:
:* ''polyobj_id'' : The ID number of PolyObject to affect. Mirroring works for doors as well and is the most common use for PolyObject mirroring.
:* ''speed'' : Speed of the door's opening and closing in eighths of a unit per tic.
:* ''angle'' : Byte angle of door's initial motion. This angle is reversed when the door closes.
:* ''dist'' : Distance the door moves when opening, and again when closing, in units.
:* ''delay'' : Amount of time before the door attempts to close after fully opening in tics. If the door is forced to reopen due to being blocked, it will also wait this amount of time before once again closing.
* Polyobj_DoorSwing
This action creates a swinging door from a PolyObject and takes the following arguments:
:* ''polyobj_id'' : The ID number of PolyObject to affect. Mirroring works for doors as well and is the most common use for PolyObject mirroring.
:* ''aspeed'' : Angular speed in byte angles per tic.
:* ''adist'' : Angular distance to rotate when opening, and again but in the opposite direction when closing.
:* ''delay'' : Amount of time before the door attempts to close after fully opening in tics. If the door is forced to reopen due to being blocked, it will also wait this amount of time before once again closing.
Swinging doors currently only rotate left. A right-rotating swinging door special will be added in the near future.

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

Thing type flags

2010-04-09T15:22:54Z

Quasar: Added new flags implemented in SVN r1096

Thing type flags are properties that can be set on or off, to control special behavior. They belong to thing classes, such as Zombieman or BaronOfHell, and shouldn't be confused with the mapthing flags, which affect individual objects in a level, regardless of species (see [[ExtraData#options|ExtraData mapthing options]] for that type of flags).

Thingtype flags are used by the [[thingtype]] block in EDF, with the fields: '''flags''', '''flags2''', '''flags3''', '''flags4''', '''cflags''', '''addflags''' and '''remflags'''. They are also used by the [[SetFlags]] and [[UnSetFlags]] [[List of codepointers|codepointers]].

The flags (or bits) are grouped (currently) into four categories, because only 32 bits can enter a long integer block. This was once important for Eternity editing, such as via DeHackEd, but since the extension of EDF arguments to a runtime evaluation system, there is no longer any need to use the original restricted '''flags''' fields.

'''flags''' up to '''flags4''' can only use bits from their own namespaces, while '''cflags''', '''addflags''' and '''remflags''' combine all flags into a single namespace, excepting the '''flags''' bit '''SLIDE'''.

=flags=
{| class="wikitable" style="font-size: 85%"; text-align: center; width: auto
!style="background-color: #C5D0E1"| Flag name
!style="background-color: #E3EEFF"| Bit number
!style="background-color: #C5D0E1"| Decimal
!style="background-color: #E3EEFF"| Hexadecimal
!style="background-color: #C5D0E1"| Description
|-style="background-color: #F5F5F5"
| '''SPECIAL'''
| 0
| 1
| 0x01
| Collectable item (can be picked up).
|-style="background-color: #D9D9D9"
| '''SOLID'''
| 1
| 2
| 0x02
| Blocks other objects.
|-style="background-color: #F5F5F5"
| '''SHOOTABLE'''
| 2
| 4
| 0x04
| Can take damage and be targeted.
|-style="background-color: #D9D9D9"
| '''NOSECTOR'''
| 3
| 8
| 0x08
| Not linked into sectors. Invisible, but can be hit. Never appears in automap, even with cheats.
|-style="background-color: #F5F5F5"
| '''NOBLOCKMAP'''
| 4
| 16
| 0x10
| Not linked into the blockmap. Cannot be hit, but can hit other objects.
|-style="background-color: #D9D9D9"
| '''AMBUSH'''
| 5
| 32
| 0x20
| Always has "AMBUSH" mapthing flag behavior. Will only wake up when an enemy is seen.
|-style="background-color: #F5F5F5"
| '''JUSTHIT'''
| 6
| 64
| 0x40
| Internal flag, monster will attack as soon as it is activated.
|-style="background-color: #D9D9D9"
| '''JUSTATTACKED'''
| 7
| 128
| 0x80
| Internal flag, delays a bit before attacking.
|-style="background-color: #F5F5F5"
| '''SPAWNCEILING'''
| 8
| 256
| 0x100
| Spawns on the ceiling instead of the floor.
|-style="background-color: #D9D9D9"
| '''NOGRAVITY'''
| 9
| 512
| 0x200
| Is not subject to gravity.
|-style="background-color: #F5F5F5"
| '''DROPOFF'''
| 10
| 1024
| 0x400
| Can pass over ledges higher than 24 units.
|-style="background-color: #D9D9D9"
| '''PICKUP'''
| 11
| 2048
| 0x800
| Can pick up items. Currently only works on player class objects.
|-style="background-color: #F5F5F5"
| '''NOCLIP'''
| 12
| 4096
| 0x1000
| Is not clipped against other objects or lines.
|-style="background-color: #D9D9D9"
| '''SLIDE'''
| 13
| 8192
| 0x2000
| For compatibility only, has no effect. Use '''flags3''' bit '''SLIDE''' instead.
|-style="background-color: #F5F5F5"
| '''FLOAT'''
| 14
| 16384
| 0x4000
| Has floating monster behavior.
|-style="background-color: #D9D9D9"
| '''TELEPORT'''
| 15
| 32768
| 0x8000
| Unused vanilla flag. Can go over steps of any height, has other odd behaviors. Use not recommended.
|-style="background-color: #F5F5F5"
| '''MISSILE'''
| 16
| 65536
| 0x10000
| Is a projectile.
|-style="background-color: #D9D9D9"
| '''DROPPED'''
| 17
| 131072
| 0x20000
| Internal flag for dropped items (trooper clips, etc). Can be crushed, never respawns.
|-style="background-color: #F5F5F5"
| '''SHADOW'''
| 18
| 262144
| 0x40000
| Renders as spectre fuzz. Monsters aiming at this thing will suffer inaccuracy.
|-style="background-color: #D9D9D9"
| '''NOBLOOD'''
| 19
| 524288
| 0x80000
| Doesn't bleed when hit by tracer attacks; spawns bullet puffs instead.
|-style="background-color: #F5F5F5"
| '''CORPSE'''
| 20
| 1048576
| 0x100000
| Is a corpse and may slide over ledges. Also checked by Arch-viles.
|-style="background-color: #D9D9D9"
| '''INFLOAT'''
| 21
| 2097152
| 0x200000
| Internal flag, used for floating monster AI.
|-style="background-color: #F5F5F5"
| '''COUNTKILL'''
| 22
| 4194304
| 0x400000
| Counts toward kill score when defeated, and is considered a valid target. See also '''KILLABLE'''.
|-style="background-color: #D9D9D9"
| '''COUNTITEM'''
| 23
| 8388608
| 0x800000
| Counts toward item score when collected. May respawn if item respawning is enabled.
|-style="background-color: #F5F5F5"
| '''SKULLFLY'''
| 24
| 16777216
| 0x1000000
| Internal flag, used for charging monster maintenance.
|-style="background-color: #D9D9D9"
| '''NOTDMATCH'''
| 25
| 33554432
| 0x2000000
| Is not spawned at level start in Deathmatch game modes.
|-style="background-color: #F5F5F5"
| '''TRANSLATION1'''
| 26
| 67108864
| 0x4000000
| Remaps green to gray in sprites.
|-style="background-color: #D9D9D9"
| '''TRANSLATION2'''
| 27
| 134217728
| 0x8000000
| Remaps green to brown, or gray to red if combined with '''TRANSLATION1'''.
|-style="background-color: #F5F5F5"
| '''TOUCHY'''
| 28
| 268435456
| 0x10000000
| Dies on contact with solid things of other species, excepting Lost Souls and Pain Elementals.
|-style="background-color: #D9D9D9"
| '''BOUNCES'''
| 29
| 536870912
| 0x20000000
| Bounces. Can be combined with other flags for various effects. See below.
|-style="background-color: #F5F5F5"
| '''FRIEND'''
| 30
| 1073741824
| 0x40000000
| Friendly monster, MBF/Eternity variety.
|-style="background-color: #D9D9D9"
| '''TRANSLUCENT'''
| 31
| 2147483648
| 0x80000000
| Renders with BOOM-style translucency, controlled by user translucency level setting.
|-
!style="background-color: #C5D0E1"| Flag name
!style="background-color: #E3EEFF"| Bit number
!style="background-color: #C5D0E1"| Decimal
!style="background-color: #E3EEFF"| Hexadecimal
!style="background-color: #C5D0E1"| Description
|}

*'''BOUNCES'''
Bounces. Different behaviors may be achieved by combining with other flags:
:BOUNCES+MISSILE: as a missile, bounces off floors and ceilings but explodes everywhere else. Useful for not allowing the BFG to conveniently explode.
:BOUNCES+NOGRAVITY: bounces off all surfaces. Can be used for projectiles despite lack of MISSILE flag.
:BOUNCES+FLOAT: usable for monsters, letting them pogo-jump to most heights.
:BOUNCES+FLOAT+DROPOFF: even higher jumping.
:BOUNCES: can be used for projectiles, allowing grenades to be implemented.

=flags2=
{| class="wikitable" style="font-size: 85%"; text-align: center; width: auto
!style="background-color: #C5D0E1"| Flag name
!style="background-color: #E3EEFF"| Bit number
!style="background-color: #C5D0E1"| Decimal
!style="background-color: #E3EEFF"| Hexadecimal
!style="background-color: #C5D0E1"| Description
|-style="background-color: #F5F5F5"
| '''LOGRAV'''
| 0
| 1
| 0x01
| Is subject to 1/3rd normal gravity. Does not combine with '''BOUNCES'''.
|-style="background-color: #D9D9D9"
| '''NOSPLASH'''
| 1
| 2
| 0x02
| Cannot trigger [[terrain]] effects.
|-style="background-color: #F5F5F5"
| '''NOSTRAFE'''
| 2
| 4
| 0x04
| Never uses MBF strafing logic even if enabled.
|-style="background-color: #D9D9D9"
| '''NORESPAWN'''
| 3
| 8
| 0x08
| Never respawns, even in Nightmare skill or with -respawn active.
|-style="background-color: #F5F5F5"
| '''ALWAYSRESPAWN'''
| 4
| 16
| 0x10
| Always respawns regardless of skill or settings.
|-style="background-color: #D9D9D9"
| '''REMOVEDEAD'''
| 5
| 32
| 0x20
| Is randomly removed from the level after death, instead of respawning. Not for player class objects.
|-style="background-color: #F5F5F5"
| '''NOTHRUST'''
| 6
| 64
| 0x40
| Is not affected by BOOM environmental pushers (wind, force points, conveyors, water currents).
|-style="background-color: #D9D9D9"
| '''NOCROSS'''
| 7
| 128
| 0x80
| Cannot trigger DOOM-style walk-over linedef specials.
|-style="background-color: #F5F5F5"
| '''JUMPDOWN'''
| 8
| 256
| 0x100
| When friendly, may jump down off ledges to follow player, subject to dog jumping setting.
|-style="background-color: #D9D9D9"
| '''PUSHABLE'''
| 9
| 512
| 0x200
| Can be pushed, like Heretic pods.
|-style="background-color: #F5F5F5"
| '''MAP07BOSS1'''
| 10
| 1024
| 0x400
| Is a boss for the MAP07_1 boss special (tag 666).
|-style="background-color: #D9D9D9"
| '''MAP07BOSS2'''
| 11
| 2048
| 0x800
| Is a boss for the MAP07_2 boss special (tag 667).
|-style="background-color: #F5F5F5"
| '''E1M8BOSS'''
| 12
| 4096
| 0x1000
| Is a boss for the E1M8 boss special (tag 666).
|-style="background-color: #D9D9D9"
| '''E2M8BOSS'''
| 13
| 8192
| 0x2000
| Is a boss for the E2M8 boss special (exits level, or tag 666 in Heretic).
|-style="background-color: #F5F5F5"
| '''E3M8BOSS'''
| 14
| 16384
| 0x4000
| Is a boss for the E3M8 boss special (exits level, or tag 666 in Heretic).
|-style="background-color: #D9D9D9"
| '''BOSS'''
| 15
| 32768
| 0x8000
| Roars loudly, and is immune to blast radii and certain other attacks.
|-style="background-color: #F5F5F5"
| '''E4M6BOSS'''
| 16
| 65536
| 0x10000
| Is a boss for the E4M6 boss special (tag 666).
|-style="background-color: #D9D9D9"
| '''E4M8BOSS'''
| 17
| 131072
| 0x20000
| Is a boss for the E4M8 boss special (tag 666).
|-style="background-color: #F5F5F5"
| '''FOOTCLIP'''
| 18
| 262144
| 0x40000
| Is subject to liquid terrain effects (lowered view point, missiles, feet are clipped).
|-style="background-color: #D9D9D9"
| '''FLOATBOB'''
| 19
| 524288
| 0x80000
| Bobs perpetually on the z axis, like Heretic and Hexen powerups.
|-style="background-color: #F5F5F5"
| '''DONTDRAW'''
| 20
| 1048576
| 0x100000
| Doesn't generate a sprite (invisible, but appears on automap).
|-style="background-color: #D9D9D9"
| '''SHORTMRANGE'''
| 21
| 2097152
| 0x200000
| Has a limited missile range, like the Arch-vile.
|-style="background-color: #F5F5F5"
| '''LONGMELEE'''
| 22
| 4194304
| 0x400000
| Has a restricted non-missile proximity area, like the Revenant.
|-style="background-color: #D9D9D9"
| '''RANGEHALF'''
| 23
| 8388608
| 0x800000
| Considers only half the distance to its target, giving a higher missile attack probability.
|-style="background-color: #F5F5F5"
| '''HIGHERMPROB'''
| 24
| 16777216
| 0x1000000
| Additional boost to missile attack probability at a distance, as with the Cyberdemon.
|-style="background-color: #D9D9D9"
| '''CANTLEAVEFLOORPIC'''
| 25
| 33554432
| 0x2000000
| Cannot cross into sectors with a different floor flat. Useful for water monsters.
|-style="background-color: #F5F5F5"
| '''SPAWNFLOAT'''
| 26
| 67108864
| 0x4000000
| Spawns at a randomized height within the range of its sector, like Heretic Gargoyle.
|-style="background-color: #D9D9D9"
| '''INVULNERABLE'''
| 27
| 134217728
| 0x8000000
| Takes no damage if damage is less than 10000. Does not react to damage.
|-style="background-color: #F5F5F5"
| '''DORMANT'''
| 28
| 268435456
| 0x10000000
| Spawns as dormant and invulnerable regardless of mapthing flags. Must be awakened by script or line special.
|-style="background-color: #D9D9D9"
| '''SEEKERMISSILE'''
| 29
| 536870912
| 0x20000000
| Is considered a homing projectile, for reflection purposes.
|-style="background-color: #F5F5F5"
| '''DEFLECTIVE'''
| 30
| 1073741824
| 0x40000000
| If paired with REFLECTIVE, causes reflection at a wide angle.
|-style="background-color: #D9D9D9"
| '''REFLECTIVE'''
| 31
| 2147483648
| 0x80000000
| Reflects projectiles. Still takes damage unless also '''INVULNERABLE'''.
|-
!style="background-color: #C5D0E1"| Flag name
!style="background-color: #E3EEFF"| Bit number
!style="background-color: #C5D0E1"| Decimal
!style="background-color: #E3EEFF"| Hexadecimal
!style="background-color: #C5D0E1"| Description
|}

=flags3=
{| class="wikitable" style="font-size: 85%"; text-align: center; width: auto
!style="background-color: #C5D0E1"| Flag name
!style="background-color: #E3EEFF"| Bit number
!style="background-color: #C5D0E1"| Decimal
!style="background-color: #E3EEFF"| Hexadecimal
!style="background-color: #C5D0E1"| Description
|-style="background-color: #F5F5F5"
| '''GHOST'''
| 0
| 1
| 0x01
| Is a Heretic ghost. Translucent, monsters will aim inaccurately, and '''THRUGHOST''' missiles will pass through.
|-style="background-color: #D9D9D9"
| '''THRUGHOST'''
| 1
| 2
| 0x02
| Missiles with this flag will pass through objects with the '''GHOST''' flag.
|-style="background-color: #F5F5F5"
| '''NODMGTHRUST'''
| 2
| 4
| 0x04
| Will not inflict thrust on objects that this object inflicts damage upon directly.
|-style="background-color: #D9D9D9"
| '''ACTSEESOUND'''
| 3
| 8
| 0x08
| Has a 50% chance of making its seesound instead of its activesound at each opportunity.
|-style="background-color: #F5F5F5"
| '''LOUDACTIVE'''
| 4
| 16
| 0x10
| Makes activesound at full volume.
|-style="background-color: #D9D9D9"
| '''E5M8BOSS'''
| 5
| 32
| 0x20
| Is a boss for the E5M8 boss special (tag 666). Used by Maulotaurs.
|-style="background-color: #F5F5F5"
| '''DMGIGNORED'''
| 6
| 64
| 0x40
| Monsters will never retaliate against this object when it damages them, as with Arch-viles.
|-style="background-color: #D9D9D9"
| '''BOSSIGNORE'''
| 7
| 128
| 0x80
| Will not attack other species with this flag. '''This flag is deprecated and should not be used in EDF.'''
|-style="background-color: #F5F5F5"
| '''SLIDE'''
| 8
| 256
| 0x100
| Slides against walls when moving into them; used by players and Heretic pods.
|-style="background-color: #D9D9D9"
| '''TELESTOMP'''
| 9
| 512
| 0x200
| Can telefrag shootable objects, including monsters and players.
|-style="background-color: #F5F5F5"
| '''WINDTHRUST'''
| 10
| 1024
| 0x400
| Is affected by Heretic wind sector effects.
|-style="background-color: #D9D9D9"
| '''FIREDAMAGE'''
| 11
| 2048
| 0x800
| Damage inflicted directly by this object will be changed to use the '''Fire''' damagetype.
|-style="background-color: #F5F5F5"
| '''KILLABLE'''
| 12
| 4096
| 0x1000
| Is a living monster, but does not count for kill percentage. Used instead of '''COUNTKILL''' for Lost Souls.
|-style="background-color: #D9D9D9"
| '''DEADFLOAT'''
| 13
| 8192
| 0x2000
| '''NOGRAVITY''' flag is not removed when this object dies, as with Lost Souls.
|-style="background-color: #F5F5F5"
| '''NOTHRESHOLD'''
| 14
| 16384
| 0x4000
| Turns against most recent attacker instantly, as with Arch-viles and in Quake AI.
|-style="background-color: #D9D9D9"
| '''FLOORMISSILE'''
| 15
| 32768
| 0x8000
| Missiles with this flag can hug the floor and move up steps.
|-style="background-color: #F5F5F5"
| '''SUPERITEM'''
| 16
| 65536
| 0x10000
| An item with this flag will only respawn if the '''super items respawn''' dmflag is asserted.
|-style="background-color: #D9D9D9"
| '''NOITEMRESP'''
| 17
| 131072
| 0x20000
| Items with this flag never respawn, but cannot be crushed as with '''DROPPED'''.
|-style="background-color: #F5F5F5"
| '''SUPERFRIEND'''
| 18
| 262144
| 0x40000
| Adds absolute loyalty to '''FRIEND''' monsters; will never retaliate if attacked by a friend.
|-style="background-color: #D9D9D9"
| '''INVULNCHARGE'''
| 19
| 524288
| 0x80000
| Is invulnerable when '''SKULLFLY'''-charging, as with Maulotaurs.
|-style="background-color: #F5F5F5"
| '''EXPLOCOUNT'''
| 20
| 1048576
| 0x100000
| Missile will not explode if counter 1 < counter 2, but increments counter 1. Used by Iron Lich tornadoes.
|-style="background-color: #D9D9D9"
| '''CANNOTPUSH'''
| 21
| 2097152
| 0x200000
| Is unable to push objects with the '''PUSHABLE''' flag.
|-style="background-color: #F5F5F5"
| '''TLSTYLEADD'''
| 22
| 4194304
| 0x400000
| Uses additive translucency as determined by the thingtype's [[thingtype|'''alpha''' property]].
|-style="background-color: #D9D9D9"
| '''SPACMONSTER'''
| 23
| 8388608
| 0x800000
| Can activate parameterized linedefs which are marked with the MONSTER special activation flag.
|-style="background-color: #F5F5F5"
| '''SPACMISSILE'''
| 24
| 16777216
| 0x1000000
| Can activate parameterized linedefs which are marked with the MISSILE special activation flag.
|-style="background-color: #D9D9D9"
| '''NOFRIENDDMG'''
| 25
| 33554432
| 0x2000000
| Does not take damage from '''FRIEND''' objects, excepting possibly itself.
|-style="background-color: #F5F5F5"
| '''3DDECORATION'''
| 26
| 67108864
| 0x4000000
| Object clips missiles at its normal height even when '''comp_theights''' is off. Used by DOOM decor objects.
|-style="background-color: #D9D9D9"
| '''ALWAYSFAST'''
| 27
| 134217728
| 0x8000000
| Always exhibits -fast/Nightmare increased reaction time and attack rate in all skill levels.
|-style="background-color: #F5F5F5"
| '''PASSMOBJ'''
| 28
| 268435456
| 0x10000000
| Is considered fully three dimensional when '''comp_overunder''' is off (3D object clipping enabled).
|-style="background-color: #D9D9D9"
| '''DONTOVERLAP'''
| 29
| 536870912
| 0x20000000
| Tries to avoid overlapping with other objects even when 3D object clipping is enabled.
|-style="background-color: #F5F5F5"
| '''CYCLEALPHA'''
| 30
| 1073741824
| 0x40000000
| '''alpha''' will cycle continuously if '''alphavelocity''' is greater than zero.
|-style="background-color: #D9D9D9"
| '''RIP'''
| 31
| 2147483648
| 0x80000000
| Missile will pass through '''SHOOTABLE''' objects, dealing damage repeatedly as long as contact is sustained.
|-
!style="background-color: #C5D0E1"| Flag name
!style="background-color: #E3EEFF"| Bit number
!style="background-color: #C5D0E1"| Decimal
!style="background-color: #E3EEFF"| Hexadecimal
!style="background-color: #C5D0E1"| Description
|}

=flags4=
{| class="wikitable" style="font-size: 85%"; text-align: center; width: auto
!style="background-color: #C5D0E1"| Flag name
!style="background-color: #E3EEFF"| Bit number
!style="background-color: #C5D0E1"| Decimal
!style="background-color: #E3EEFF"| Hexadecimal
!style="background-color: #C5D0E1"| Description
|-style="background-color: #F5F5F5"
| '''AUTOTRANSLATE'''
| 0
| 1
| 0x01
| Adapts a built-in palette translation if spawned in games other than Doom; used by EE objects such as MBFHelperDog.
|-style="background-color: #D9D9D9"
| '''NORADIUSDMG'''
| 1
| 2
| 0x02
| Object will not take radius damage from most sources.
|-style="background-color: #F5F5F5"
| '''FORCERADIUSDMG'''
| 2
| 4
| 0x04
| As an inflictor, forces all objects (including '''BOSS''' and '''NORADIUSDMG''') to take radius damage.
|-style="background-color: #D9D9D9"
| '''LOOKALLAROUND'''
| 3
| 8
| 0x08
| Has a 360-degree field of vision, same as monsters given the '''AMBUSH''' flag after hearing a shot.
|-style="background-color: #F5F5F5"
| '''NODAMAGE'''
| 4
| 16
| 0x10
| Is invulnerable to damage < 10000, but still reacts as if damage has been taken (thrust, blood, and pain).
|-style="background-color: #D9D9D9"
| '''SYNCHRONIZED'''
| 5
| 32
| 0x20
| Will not have its spawnstate tics randomized when spawned on the map at level start. '''SVN r1096+'''
|-style="background-color: #F5F5F5"
| '''NORANDOMIZE'''
| 6
| 64
| 0x40
| As a missile or bouncing explosive, will not have its spawnstate and first deathstate tics randomized. Note that the semantics of this flag are opposite of [[ZDoom]], due to compatibility requirements. '''SVN r1096+'''
|-
!style="background-color: #C5D0E1"| Flag name
!style="background-color: #E3EEFF"| Bit number
!style="background-color: #C5D0E1"| Decimal
!style="background-color: #E3EEFF"| Hexadecimal
!style="background-color: #C5D0E1"| Description
|}

Eternity Engine

2010-04-01T15:49:33Z

Quasar: /* History */ Some updates and redactions.

List of command line parameters

2010-04-01T15:41:06Z

Quasar: /* Gameplay */ Added new -solo-net

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.

==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.
* -playdemo <filename> : Plays the given demo.
* -record <filename> : Records this play session as a demo named "filename".
* -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.

Geom string

2010-03-05T00:01:56Z

Quasar: Explanation of geom strings and documentation of flag values.

A '''geom string''' is a special configuration setting in [[Eternity]] which allows specification of all of the characteristics of a video mode in a single string.

==Syntax==
The syntax of a geom string is as follows:

<code>
WWWWxHHHH[flags]
</code>

Where WWWW is the width, between 320 and 2560; HHHH is the height, between 200 and 1600; and [flags] is an optional valid combination of the following single-letter specifiers:
{| class="wikitable" style="font-size: 85%"; text-align: center; width: auto
!style="background-color: #C5D0E1"| Flag
!style="background-color: #E3EEFF"| Description
|-style="background-color: #F5F5F5"
| w
| Selects windowed mode.
|-style="background-color: #D9D9D9"
| f
| Selects fullscreen mode.
|-style="background-color: #F5F5F5"
| a
| Selects "asynchronous" or non-page-flipped updating.
|-style="background-color: #D9D9D9"
| v
| Selects page-flipped updating.
|-style="background-color: #F5F5F5"
| s
| Selects "software" surface.
|-style="background-color: #D9D9D9"
| h
| Selects "hardware" surface (eg. DirectDraw acceleration)
|-style="background-color: #F5F5F5"
| n
| Creates primary window without a window frame, where supported.
|-
!style="background-color: #C5D0E1"| Flag
!style="background-color: #E3EEFF"| Description
|}

==Examples==
The following are examples of valid geom strings.

<code>
320x200w
640x480f
1024x768wan
1280x800fvh
</code>

Basic Portals

2010-03-04T07:22:39Z

Quasar: Remove double redirect.

#REDIRECT [[Portal]]