Eternity Wiki - User contributions [en]

File:EEwiki.png

2023-07-29T03:15:03Z

Altazimuth: PNG version of Eternity Engine wiki logo

== Summary ==
PNG version of Eternity Engine wiki logo

UDMF

2023-07-16T01:47:31Z

Altazimuth: Update skew fields

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

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

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

Maps designed in UDMF no longer need ExtraData.

The standard was defined by James "Quasar" Haley and has also been successfully implemented in Vavoom, ZDoom and the ZDoom-derivative ports.

* See also the [https://www.doomworld.com/eternity/engine/stuff/udmf11.txt base UDMF specifications]

==Basics==

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

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

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

===Node format===

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

==Linedefs==
linedef
{
blocklandmonsters = <boolean>;
blockplayers = <boolean>;

polycross = <boolean>;
monstershoot = <boolean>;

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

portal = <integer>;

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

==Sidedefs==
sidedef
{
offsetx = <floating-point>;
offsety = <floating-point>;
offsetx_top = <floating-point>;
offsety_top = <floating-point>;
offsetx_middle = <floating-point>;
offsety_middle = <floating-point>;
offsetx_bottom = <floating-point>;
offsety_bottom = <floating-point>;

skew_top_type = <string>;
skew_middle_type = <string>;
skew_bottom_type = <string>;
}

===Explanation of fields===
*'''offsetx''', '''offsety'''
:Overall horizontal and vertical offsets for the top, middle, and bottom textures of this sidedef.
*'''offsetx_top''', '''offsety_top''', '''offsetx_middle''', '''offsety_middle''', '''offsetx_bottom''', '''offsety_bottom'''
:Horizontal and vertical offsets for the individual top, middle, and bottom portions of this sidedef.
*'''skew_top_type''', '''skew_bottom_type''', '''skew_middle_type'''
:The type of skewing that the a given texture of this sidedef has. This skew starts at the left side of the sidedef (if viewing the sidedef straight-on) and conforms to either the slope on the front or back side of the line the sidedef is on. Either the floor or ceiling slope can be picked as the slope for the skewing to conform to. Values are "none", "front_floor", "front_ceiling", "back_floor", and "back_ceiling", with "none" being the default.

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

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

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

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

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

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

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

phasedlight = <boolean>;
lightsequence = <boolean>;
lightseqalt = <boolean>;

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

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

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

soundsequence = <string>;

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

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

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

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

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

UDMF

2023-06-25T11:57:13Z

Altazimuth: Updated the sidedef section to reflect the new properties added.

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

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

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

Maps designed in UDMF no longer need ExtraData.

The standard was defined by James "Quasar" Haley and has also been successfully implemented in Vavoom, ZDoom and the ZDoom-derivative ports.

* See also the [https://www.doomworld.com/eternity/engine/stuff/udmf11.txt base UDMF specifications]

==Basics==

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

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

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

===Node format===

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

==Linedefs==
linedef
{
blocklandmonsters = <boolean>;
blockplayers = <boolean>;

polycross = <boolean>;
monstershoot = <boolean>;

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

portal = <integer>;

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

==Sidedefs==
sidedef
{
offsetx = <floating-point>;
offsety = <floating-point>;
offsetx_top = <floating-point>;
offsety_top = <floating-point>;
offsetx_middle = <floating-point>;
offsety_middle = <floating-point>;
offsetx_bottom = <floating-point>;
offsety_bottom = <floating-point>;

skew_top_type = <string>;
skew_middle_type = <string>;
skew_bottom_type = <string>;
}

===Explanation of fields===
*'''offsetx''', '''offsety'''
:Overall horizontal and vertical offsets for the top, middle, and bottom textures of this sidedef.
*'''offsetx_top''', '''offsety_top''', '''offsetx_middle''', '''offsety_middle''', '''offsetx_bottom''', '''offsety_bottom'''
:Horizontal and vertical offsets for the individual top, middle, and bottom portions of this sidedef.
*'''skew_top_type''', '''skew_bottom_type'''
:The type of skewing that the top or bottom texture of this sidedef have. This skew starts at the left side of the sidedef (if viewing the sidedef straight-on) and conforms to either the slope on the front or back side of the line the sidedef is on. The slope used for this is the ceiling and floor for top and bottom respectively. Values are "none", "back", and "front", with "none" being the default.
*'''skew_middle_type'''
:The type of skewing that the middle texture of this sidedef has. Behavior is the similar as top and bottom skew properties. Either the floor or ceiling slope can be picked as the slope for the skewing to conform to. Values are "none", "front_floor", "front_ceiling", "back_floor", and "back_ceiling", with "none" being the default.

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

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

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

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

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

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

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

phasedlight = <boolean>;
lightsequence = <boolean>;
lightseqalt = <boolean>;

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

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

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

soundsequence = <string>;

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

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

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

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

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

List of codepointers

2021-02-09T15:18:13Z

Altazimuth: Add CounterDiceRoll to list.

This '''list of codepointers''' is a list of all the action routines which can be performed by [[thingtype|things]] from [[EDF]] [[frame]]s. They are common for all games, so for example Heretic codepointers can be used in Doom.

You can specify the codepointers with or without their internal A_ prefix, even inside [[DECORATE state syntax]]. For simplicity, they will be referred in this wiki without the prefix.

Note that some codepointers, inherited from MBF, use the '''misc1''' and '''misc2''' frame properties, instead of the more general '''args''' list. Side effects aside, this also means that in the DECORATE syntax they will have to use the '''offset'''(''misc1'', ''misc2'') specifier. They all have DECORATE-friendly equivalents however.

'''IMPORTANT:''' Do not provide more nonzero arguments to the codepointers than specified in the reference. Doing so may break forward compatibility with versions of Eternity that implement new functionality to codepointers.

{{backto|EDF state reference}}
{{backto|Eternity Engine}}

==Player guns==
===Weapon maintenance===
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[CheckReload]]||Super shotgun reload check.||Doom 2
|-
||[[CheckReloadEx]]||Extended version of [[CheckReload]] that allows counter comparison.||Eternity
|-
||[[GunFlash]]||Produces a gun flash sprite without firing anything at the current moment.||Doom
|-
||[[JumpIfNoAmmo]]||Jumps to a state if ammo is gone.||ZDoom
|-
||[[Light0]]||Resets the gun flash light level.||Doom
|-
||[[Light1]]||Sets the gun flash light level to 1.||Doom
|-
||[[Light2]]||Sets the gun flash light level to 2.||Doom
|-
||[[Lower]]||Action during a weapon's lowering sequence.||Doom
|-
||[[Raise]]||Action during a weapon's raise sequence.||Doom
|-
||[[ReFire]]||Skip frame if shooting is sustained (e.g. for plasma rifle's cooldown effect).||Doom
|-
||[[SubtractAmmo]]||Consumes one ammo unit without firing.||Eternity
|-
||[[WeaponReady]]||Action during a weapon's idle sequence.||Doom
|}

===Player attacks===
====Classic Doom====
{|class="wikitable sortable"
! Name
! Description
! Specifics
! First game it appeared
|-
||[[BFGsound]]||Plays the BFG charge-up sound effect.||BFG||Doom
|-
||[[CloseShotgun2]]||Plays the super shotgun closing sound effect. Also includes [[ReFire]].||Super shotgun||Doom 2
|-
||[[FireBFG]]||BFG9000 attack.||BFG||Doom
|-
||[[FireCGun]]||Chaingun attack.||||Doom
|-
||[[FireMissile]]||Rocket launcher attack.||||Doom
|-
||[[FireOldBFG]]||Alpha Doom BFG attack (made available since [[MBF]]).||||Doom
|-
||[[FirePistol]]||Pistol attack.||||Doom
|-
||[[FirePlasma]]||Plasma rifle attack.||||Doom
|-
||[[FireShotgun]]||Shotgun attack.||||Doom
|-
||[[FireShotgun2]]||Super shotgun attack.||Super shotgun||Doom 2
|-
||[[LoadShotgun2]]||Plays the super shotgun loading sound effect.||Super shotgun||Doom 2
|-
||[[OpenShotgun2]]||Plays the super shotgun opening sound effect.||Super shotgun||Doom 2
|-
||[[Punch]]||Fist attack.||||Doom
|-
||[[Saw]]||Chainsaw attack.||||Doom
|}
====Classic Heretic====
These exist to support the vanilla Doom and Heretic player attacks.
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[FireBlasterPL1]]||Dragon claw attack.||Heretic
|-
||[[FireCrossbowPL1]]||Ethereal crossbow attack.||Heretic
|-
||[[FireCrossbowPL2]]||Ethereal crossbow attack with Tome of Power.||Heretic
|-
||[[FireGoldWandPL1]]||Elven wand attack.||Heretic
|-
||[[FireGoldWandPL2]]||Elven wand attack with Tome of Power.||Heretic
|-
||[[FireMacePL1]]||Fire mace attack.||Heretic
|-
||[[FireMacePL2]]||Fire mace attack with Tome of Power.||Heretic
|-
||[[FirePhoenixPL1]]||[[Doom Wiki:Phoenix Rod|Phoenix Rod]] attack.||Heretic
|-
||[[FirePhoenixPL2]]||Phoenix rod attack with Tome of Power.||Heretic
|-
||[[FireSkullRodPL1]]||[[Doom Wiki:Hellstaff|Hellstaff]] attack.||Heretic
|-
||[[GauntletAttack]]||Gauntlets of the Necromancer attack.||Heretic
|-
||[[InitPhoenixPL2]]||Heretic Tome of Power Phoenix Rod startup.||Heretic
|}

====Parameterized====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[CustomPlayerMelee]]||Configurable player melee attack.||Eternity
|-
||[[EjectCasing]]||Used for the effect of throwing casing.||Eternity
|-
||[[FireCustomBullets]]||Configurable player bullet (hitscan) attack.||Eternity
|-
||[[FirePlayerMissile]]||Configurable player projectile attack.||Eternity
|-
||[[PlayerThunk]]||{{deprecated}} Run monster-specific codepointers as weapon actions.||Eternity
|}

===Weapon frame scripting===
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[PlayerStartScript]]||Starts map script, as from a player weapon.||Eternity
|-
||[[WeaponCopyCtr]]||Copy counter value to another counter.||Eternity
|-
||[[WeaponCtrOp]]||Computer operation between two counters, storing result into another counter.||Eternity
|-
||[[WeaponCtrJump]]||Change to a given state, based on a counter's value.||Eternity
|-
||[[WeaponCtrSwitch]]||Change to a state from a given list, depending on a counter's value.||Eternity
|-
||[[WeaponSetCtr]]||Assign value to a counter.||Eternity
|}

==Map objects==
===Simple movement===
These operations perform simple effects on thing's direction, position or velocity. The available codepointers are:
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[Face]]||Face a specified angle.||MBF
|-
||[[Stop]]||Set velocity to 0.||MBF beta emulation
|-
||[[Turn]]||Turn around by a specified angle.||MBF
|}

===Explosions and flames===
====BFG9000====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[BFG11KHit]]||[[SMMU]] BFG variant.||SMMU
|-
||[[BFGBurst]]||Produces a burst of smaller plasma projectiles.||MagDOOM by Cephaler
|-
||[[BFGSpray]]||Original Doom BFG explosion damage-inflicting afterglow.||Doom
|-
||[[BouncingBFG]]||SMMU bouncing BFG.||SMMU
|}

====DOOM 2 Final boss====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[BrainExplode]]||Brain perpetual explosion controller.||Doom 2
|-
||[[BrainScream]]||Giant demon wall explosion sequence.||Doom 2
|-
||[[SpawnFly]]||Spawn cube controller.||Doom 2
|}

====Explosions====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[Detonate]]||Thing damage controlled explosion.||MBF
|-
||[[DetonateEx]]||Parameterized detonate action.||Eternity
|-
||[[Explode]]||Rocket/barrel splash damage.||Doom
|-
||[[Mushroom]]||[[MBF]]-style mushroom explosion.||MBF
|-
||[[MushroomEx]]||Extended mushroom explosion codepointer.||Eternity
|-
||[[Nailbomb]]||[[SMMU]]-style explosion with shrapnels.||SMMU
|}
=====Heretic=====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[DeathBallImpact]]||Heretic super firemace sphere impact.||Heretic
|-
||[[HticExplode]]||Heretic-compatible explosion.||Heretic
|-
||[[MaceBallImpact]]||Heretic small firemace sphere impact.||Heretic
|-
||[[MaceBallImpact2]]||Heretic medium firemace sphere impact.||Heretic
|}

====Homing projectiles====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[GenTracer]]||Generic homing projectile.||Eternity
|-
||[[HticTracer]]||Heretic nitrogolem homing projectile (generalized).||Heretic
|-
||[[MummyFX1Seek]]||Heretic nitrogolem homing projectile (particular).||Heretic
|-
||[[Tracer]]||Revenant homing projectile.||Doom 2
|}

====Others====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[Fire]]||Stick on the face of attacker's target, like the archvile's fire effect.||Doom 2
|}
=====Heretic specific=====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[FlameEnd]]||Phoenix rod flame rising.||Heretic
|-
||[[FloatPuff]]||Phoenix rod flame hitting wall.||Heretic
|-
||[[BeastPuff]]||Weredragon fire projectile smoke.||Heretic
|-
||[[BoltSpark]]||Ethereal arrow trail.||Heretic
|-
||[[BlueSpark]]||Create a blue D'sparil attack projectile.||Heretic
|-
||[[GenWizard]]||Spawn a disciple of D'sparil.||Heretic
|-
||[[LichFireGrow]]||Expand the iron lich fire column projectile.||Heretic
|-
||[[LichIceImpact]]||Explode iron lich ice globe into shards.||Heretic
|-
||[[MacePL1Check]]||Small Heretic mace sphere maintenance.||Heretic
|-
||[[MntrFloorFire]]||Used by the maulotaur ground fire projectile.||Heretic
|-
||[[PhoenixPuff]]||Phoenix rod missile trail.||Heretic
|-
||[[PodPain]]||Special effect when pod is damaged.||Heretic
|-
||[[VolcBallImpact]]||Heretic volcano lava ball impact.||Heretic
|-
||[[WhirlwindSeek]]||Homing behaviour used by iron lich tornado projectiles.||Heretic
|}

===AI===
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[AlertMonsters]]||Shout so other monsters chase the player.||ZDoom
|-
||[[Chase]]||Pursue a target and check for attacks||Doom
|-
||[[CPosRefire]]||Go to '''seestate''' if target is out of sight.||Doom 2
|-
||[[FaceTarget]]||Turn to target, looking around it if it's partially invisible.||Doom
|-
||[[GenRefire]]||Customizable refire control.||Eternity
|-
||[[KeepChasing]]||pursue target without attacking.||Eternity
|-
||[[Look]]||Stand in guard, looking for targets.||Doom
|-
||[[RandomWalk]]||Random wandering for inactive enemies.||Eternity
|-
||[[Sor1Chase]]||D'sparil's mount specific chase.||Heretic
|-
||[[Sor1Pain]]||D'sparil's mount specific twitch. Calls Pain.||Heretic
|-
||[[SpidRefire]]||Like CPosRefire, slightly modified.||Doom
|-
||[[VileChase]]||Same as Chase, but resurrects encountered cadavres.||Doom 2
|}

===AI attacks===
====Parameterized====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[BetaSkullAttack]]||Remote melee attack, as used by the Doom alpha lost souls (available since [[MBF]]).||MBF beta emulation
|-
||[[BulletAttack]]||Generic bullet (hitscan) shooting.||Eternity
|-
||[[MissileAttack]]||Generic projectile shooting.||Eternity
|-
||[[MissileSpread]]||'''MissileAttack''' variation, supports shooting in spread patterns.||Eternity
|-
||[[SargAttack12]]||Old Doom 1.2 style monster melee attack which uses hitscan similar to player's fist.||Doom v1.2
|-
||[[Scratch]]||Generic melee attack.||MBF
|-
||[[ThingSummon]]||Generic creature summoning.||Eternity
|}

====Original Doom====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[BrainSpit]]||cube spawn||Doom 2
|-
||[[BruisAttack]]||baron/knight of hell||Doom
|-
||[[BspiAttack]]||arachnotron||Doom 2
|-
||[[CPosAttack]]||pistol attack w/ shotgn noise||Doom 2
|-
||[[CyberAttack]]||rocket launching||Doom
|-
||[[FatAttack1]]||mancubus left attack||Doom 2
|-
||[[FatAttack2]]||mancubus right attack||Doom 2
|-
||[[FatAttack3]]||mancubus front attack||Doom 2
|-
||[[HeadAttack]]||cacodemon||Doom
|-
||[[PainAttack]]||elemental||Doom 2
|-
||[[PainDie]]||elemental death (3 souls)||Doom 2
|-
||[[PosAttack]]||former human||Doom
|-
||[[SargAttack]]||demon bite||Doom
|-
||[[SkelFist]]||revenant punch||Doom 2
|-
||[[SkelMissile]]||revenant missile||Doom 2
|-
||[[SkullAttack]]||flying skull||Doom
|-
||[[SPosAttack]]||sergeant||Doom
|-
||[[TroopAttack]]||imp||Doom
|-
||[[VileAttack]]||arch vile toss||Doom 2
|-
||[[VileTarget]]||spawn a vile fire effect on target||Doom 2
|}

====Heretic====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[BeastAttack]]||weredragon||Heretic
|-
||[[ClinkAttack]]||sabreclaw||Heretic
|-
||[[ImpChargeAtk]]||gargoyle charge||Heretic
|-
||[[ImpMeleeAtk]]||gargoyle scratch||Heretic
|-
||[[ImpMissileAtk]]||gargoyle fire||Heretic
|-
||[[KnightAttack]]||undead warrior||Heretic
|-
||[[LichAttack]]||iron lich random attack **only one which includes ice globes**||Heretic
|-
||[[LichFire]]||iron lich fire column||Heretic
|-
||[[LichWhirlwind]]||iron lich tornado||Heretic
|-
||[[MinotaurAtk1]]||maulotaur melee damage||Heretic
|-
||[[MinotaurAtk2]]||spreadshot||Heretic
|-
||[[MinotaurAtk3]]||straight flame snake||Heretic
|-
||[[MinotaurCharge]]||maulotaur charge||Heretic
|-
||[[MinotaurDecide]]||maulotaur ranged attack choosing||Heretic
|-
||[[MummyAttack]]||golem melee||Heretic
|-
||[[MummyAttack2]]||nitrogolem range||Heretic
|-
||[[SnakeAttack]]||ophidian blue spark||Heretic
|-
||[[SnakeAttack2]]||ophidian yellow shot||Heretic
|-
||[[Srcr1Attack]]||d'sparil mount attack||Heretic
|-
||[[Srcr2Attack]]||d'sparil sorcerer attack||Heretic
|-
||[[Srcr2Decide]]||d'sparil decide whether to teleport||Heretic
|-
||[[VolcanoBlast]]||volcano burst||Heretic
|-
||[[WizardAtk3]]||disciple tri-ball||Heretic
|}

===Alterations===
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[BossDeath]]||special monster death functions (such as Baron death in E1M8)||Doom
|-
||[[BrainDie]]||exits the level||Doom 2
|-
||[[CasingThrust]]||movement for ejected casing||Eternity
|-
||[[Die]]||causes suicide||MBF
|-
||[[Fall]]||remove SOLID flag (used on dying monsters)||Doom
|-
||[[KeenDie]]||open 666-tagged doors on death of all like-named monsters||Doom 2
|-
||[[KillChildren]]||destroy all summoned things||ZDoom
|-
||[[LineEffect]]||activate a tag using a special||MBF
|-
||[[PainNukeSpec]]||Pain elemental nuke cheat handler.||Eternity
|-
||[[RestoreArtifact]]||Adds the SPECIAL flag back to an object, sets the object back into its spawnstate, and plays the object's seesound.||Heretic
|-
||[[RestoreSpecialThing1]]||Removes the DONTDRAW flag from an object. If the object defines the itemrespawnat property, it will at this time be moved to a random spot if any such spots exist on the map (otherwise the item will remain where it spawned originally). The item will play its seesound.||Heretic
|-
||[[RestoreSpecialThing2]]||Adds the SPECIAL flag back to an object and sets the object back into its spawnstate.||Heretic
|-
||[[SelfDestruct]]||Projectile-compatible counterpart to '''Die'''.||Eternity
|-
||[[SetFlags]]||alter flags||Eternity
|-
||[[SetSpecial]]||alter thing's special and args||ZDoom
|-
||[[ShowMessage]]||display text message||Eternity
|-
||[[Spawn]]||create another object on top of this one||MBF
|-
||[[SpawnEx]]||enhanced spawn variant||Eternity
|-
||[[SteamSpawn]]||create steam effects||Eternity
|-
||[[UnSetFlags]]||alter flags||Eternity
|}
====Visual====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[ClearSkin]]||Removes the sprite skin.||Eternity
|-
||[[FadeIn]]||increments alpha||ZDoom
|-
||[[FadeOut]]||decrements alpha, DOESN'T destroy the thing||ZDoom
|-
||[[HideThing]]||Sets DONTDRAW flag on an object||ZDoom
|-
||[[SetTranslucent]]||modify alpha amount; setup additiveness or fuzziness||ZDoom
|-
||[[UnHideThing]]||Unsets DONTDRAW flag on an object||ZDoom
|-
|}
====Heretic====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[AccelGlitter]]||accelerate upwards||Heretic
|-
||[[DripBlood]]||spawn heretic blood||Heretic
|-
||[[GhostOff]]||Remove the ghost effect||Heretic
|-
||[[HticBossDeath]]||special monster death functions for Heretic||Heretic
|-
||[[Fall|HticDrop]]||{{deprecated}} same thing as [[Fall]]||Heretic
|-
||[[ImpDeath]]||special death for gargoyle||Heretic
|-
||[[ImpExplode]]||crash for gargoyle||Heretic
|-
||[[ImpXDeath1]]||special extreme death for gargoyle, stage 1||Heretic
|-
||[[ImpXDeath2]]||special extreme death for gargoyle, stage 2||Heretic
|-
||[[InitKeyGizmo]]||Heretic key lock orb statue maintenance||Heretic
|-
||[[MakePod]]||generate a pod||Heretic
|-
||[[MummySoul]]||create raising soul||Heretic
|-
||[[PlayerSkull]]||player death effect, when the skull tosses in air||Heretic
|-
||[[RemovePod]]||notifies the generator that this pod was destroyed||Heretic
|-
||[[Sor2DthInit]]||d'sparil death maintenance||Heretic
|-
||[[Sor2DthLoop]]||d'sparil death maintenance||Heretic
|-
||[[SorcererRise]]||d'sparil waking up after mount crash||Heretic
|-
||[[SorcNukeSpec]]||D'sparil handling of the nuke cheat.||Heretic
|-
||[[SpawnAbove]]||spawns above the summoner||Heretic
|-
||[[SpawnGlitter]]||create teleportation sparkle||Heretic
|-
||[[WizardAtk1]]||face target and clear GHOST flag||Heretic
|-
||[[WizardAtk2]]||face target and set GHOST flag||Heretic
|}

===Sound effects===
====Generic====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[AmbientThinker]]||ambient sound maintenance||Eternity
|-
||[[Pain]]||play pain sound||Doom
|-
||[[PlayerScream]]||player-specific, health-dependent (death) sound||Doom
|-
||[[PlaySound]]||custom sound||MBF
|-
||[[PlaySoundEx]]||extended custom sound||ZDoom
|-
||[[Scream]]||play death sound||Doom
|-
||[[XScream]]||extreme death gut noise||Doom
|}
====Game specific====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[BrainAwake]]||loud bossit sound effect||Doom 2
|-
||[[BrainPain]]||loud bospn sound effect||Doom 2
|-
||[[ContMobjSound]]||Heretic knight axe and nitrogolem missile sounds||Heretic
|-
||[[ESound]]||Heretic water and wind ambiend sounds||Heretic
|-
||[[FlameSnd]]||Heretic player burning death sound||Heretic
|-
||[[RavenPlayerScream]]||Heretic player scream||Heretic
|-
||'''SorDBon'''||Plays sound 329 ('''ht_sordbon''')||Heretic
|-
||'''SorDExp'''||Plays sound 328 ('''ht_sordexp''')||Heretic
|-
||'''SorDSph'''||Plays sound 327 ('''ht_sordsph''')||Heretic
|-
||'''SorRise'''||Plays sound 322 ('''ht_sorrise''')||Heretic
|-
||'''SorSightSnd'''||Plays sound 323 ('''ht_sorsit''')||Heretic
|-
||'''SorZap'''||Plays sound 321 ('''ht_sorzap''')||Heretic
|-
||[[StartFire]]||flamst sound effect — also includes "Fire" action!||Doom 2
|-
||[[VileStart]]||archvile heat-up noise||Doom 2
|}
=====Combined=====
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[BabyMetal]]||bspwlk sound effect — also includes Chase!||Doom 2
|-
||[[FatRaise]]||mancubus warning — also includes FaceTarget||Doom 2
|-
||[[FireCrackle]]||flame sound effect — also includes "Fire" action!||Doom 2
|-
||[[Hoof]]||cyberdemon hoof sound — also includes Chase!||Doom
|-
||[[Metal]]||metal sound effect — also includes Chase!||Doom
|-
||[[SkelWhoosh]]||revenant swing noise — also includes FaceTarget||Doom 2
|-
||[[SpawnSound]]||boscub sound effect — also includes SpawnFly||Doom 2
|}

===Frame scripting===
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[AproxDistance]]||assign distance from target to a variable||Eternity
|-
||[[CheckPlayerDone]]||jump to a frame if not under player control||ZDoom
|-
||[[CopyCounter]]||copy a variable to another variable||Eternity
|-
||[[CounterDiceRoll]]||set a variable to the result of a damage calculation||Eternity
|-
||[[CounterJump]]||counter-based next frame||Eternity
|-
||[[CounterJumpEx]]||DECORATE-compatible counter-based next frame||Eternity
|-
||[[CounterOp]]||set a variable to an operation of another 2 variables||Eternity
|-
||[[CounterSwitch]]||counter-based set of frames||Eternity
|-
||[[CounterSwitchEx]]||DECORATE-compatible counter-based set of states||Eternity
|-
||[[HealthJump]]||health-based next frame||Eternity
|-
||[[JumpIfTargetInLOS]]||jump to frame if target is in the field of view||ZDoom
|-
||[[RandomJump]]||random next frame||MBF
|-
||[[Jump]]||Decorate-compatible alternative to RandomJump.||ZDoom
|-
||[[SetCounter]]||set a variable||Eternity
|-
||[[SetTics]]||set frame duration||Eternity
|-
||[[StartScript]]||run map script||Eternity
|-
||[[StartScriptNamed]]||run named map script||Eternity
|-
||[[TargetJump]]||go to designated frame if having a target||Eternity
|}

===Powerup use===
These are triggered from [[EDF_item_effects_and_inventory#artifact|artifact]]'s '''useaction''' field, not from states.
{|class="wikitable sortable"
! Name
! Description
! First game it appeared
|-
||[[HticArtiTele]]||Chaos Device action||Heretic
|-
||[[HticSpawnFireBomb]]||Time Bomb of the Ancients action||Heretic
|}

[[Category:Codepointers|*]]
[[Category:EDF]]

CounterDiceRoll

2021-02-09T14:51:07Z

Altazimuth: Add A_CounterDiceRoll.

{{codepointer
|description=
Calculates damage numbers the same way that one might for a tabletop role-playing game, rolling multiple dice with a certain number of sides. This value is then assigned or added to a counter.
|usage=
'''CounterDiceRoll'''(''ctr'', ''multiplier'', ''dicesides'', ''staticdmg'', ''setoradd'', ''randomtype'')
|parameters=
*''ctr'': the counter to assign or add to
*''multiplier'': the multiplier of the dice outctome, or the number of dice to roll
*''dicesides'': the number of sides each die has
*''staticdmg'': static damage to add to the result regardless of dice roll outcome
*''setoradd'': one of the following:
:'''assign''' or 0: assigns the result of the calculation to ctr
:'''add''' or 1: adds the result of the calculation to ctr
*randomtype: one of the following:
:'''multiplyone''' or 0: roll for damage once then multiply by ''multiplier'' and add ''staticdmg''
:'''rollmany''' or 1: roll for damage ''multiplier'' times, summing up the rolls, then add ''staticdmg''
|seealso=
*[[CounterOp]]
*[[SetCounter]]
}}

Eternity Engine

2020-10-14T14:15:46Z

Altazimuth: Add 4.01.00, and update the 4.00.00 thread link.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==Major Features==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==Cross-platform development==
For [[Wikipedia:Windows|Windows]], Eternity has a [[Wikipedia:Visual Studio|Visual Studio]] project. For [[Wikipedia:macOS|macOS]], it has an [[Wikipedia:Xcode|Xcode]] project. For other platforms (most notably [[Wikipedia:Linux|Linux]]), Eternity can be compiled by using the [[Wikipedia:CMake|CMake]] utility. You can download the Eternity [[Wikipedia:source code|source code]] from [[Wikipedia:GitHub|GitHub]] and execute CMake. Eternity's source code repository, as well as the latest releases, are located [https://github.com/team-eternity/eternity/ here].

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

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

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

[[Category:Source ports]]

Template:Latest

2020-10-14T14:11:46Z

Altazimuth: 4.01.00 is out!

[https://www.doomworld.com/forum/topic/117429-eternity-engine-40100-tyrfing/ 4.01.00]

EDF puff type reference

2020-04-25T12:25:08Z

Altazimuth: Rename ALWAYSPUFF to PUFFONACTORS

Puffs are special effects spawned at hitscan attack impact points. Hitscan attacks are those 'projectiles' which travel instantly, which includes all gunshots from Doom and the elven wand and dragon claw from Heretic. The syntax is as follows:
pufftype <name> [ : <base> ]
{
thingtype <name>
sound <name>
hitsound <name>
hitpufftype <name>
nobloodpufftype <name>
upspeed <floating-point value>
zspread <floating-point value>
punchhack <frame name>
particles <number>
+|-PUFFONACTORS
+|-BLOODLESS
+|-LOCALTHRUST
+|-RANDOMTICS
+|-TARGETSHOOTER
}
==Explanation of fields==
*'''base'''
:Optional ancestor puff type whose attributes to inherit. If you don't want inheritance, remove both ':' and the base name.
*'''thingtype'''
:[[Thingtype|Class of thing]] to spawn when puff is produced. Can be omitted if no visible thing is intended.
*'''sound'''
:Optional sound to play when puff is spawned. Only works if '''thingtype''' is set. Example: the Heretic staff puff has this.
*'''hitsound'''
:Alternate sound to play if the hitscan hits a shootable thing, and if the puff is not replaced by a blood splat. Example: the dragon claw hit puff has this.
*'''hitpufftype'''
:If this one is set and a shootable thing is hit, use this alternate puff type instead of the one defined here. Example: the dragon claw spark has this.
*'''nobloodpufftype'''
:Optional alternate puff type when hitting things with the '''NOBLOOD''' flag. Note that this has priority over '''hitpufftype''' but only against '''NOBLOOD''' targets.
*'''upspeed'''
:Default: 0
:Speed by which the puff thing moves up.
*'''zspread'''
:Default: 4
:Vertical spread by which spawned things are randomly created.
*'''punchhack'''
:Limited use special handler for DOOM fist puff's special behaviour of switching to a different frame (as given by this field) when using the fist attack codepointer. New mods should use dedicated puff types for custom melee attacks.
*'''particles'''
:Optional number of smoke particles to spawn when enabled in the settings. Does not spawn if '''punchhack''' is active and player uses fist.
===Flags===
Prefix these with + or - to add or remove them.
*'''PUFFONACTORS''': make sure to spawn puff even when hitting a bleeding target. Common with Heretic hitscans.
*'''BLOODLESS''': avoid showing blood when hitting a bleeding target.
*'''LOCALTHRUST''': when hitting shootable things, make sure to thrust them from wherever the puff appears, not from attacker.
*'''RANDOMTICS''': if set, the spawned thing will have its first frame duration randomized
*'''TARGETSHOOTER''': sets puff thing's "target" (originator) to the shooter. In effect, it will act like a projectile explosion, and any codepointer such as [[DetonateEx]] or [[BFGSpray]] from the puff thing will use the shooter as an originator for damage purposes.

==Delta structure==
You can use <code>puffdelta</code> to modify an already defined '''pufftype'''. The syntax is:
puffdelta
{
name <puff name>
<fields>
}
The ''fields'' are the same as those from '''pufftype''', modifying anything already defined in a <code>pufftype <puff name></code> block.
==Tips==
*If you use the '''TARGETSHOOTER''' flag and intend to turn the puff into an explosion, beware that, as with all thing types, the explosion will fail if it's triggered from the very first spawn state. Make sure to use the second one onwards.
[[Category:EDF]]
[[Category:Editing]]

A FireCustomBullets

2020-02-23T00:44:46Z

Altazimuth:

{{Codepointer |
description=FireCustomBullets is a parameterized player weapon codepointer. This codepointer can be used for the construction of custom player bullet weapons. The sound, accuracy, number of tracers, and randomized damage range of the tracers are all selectable via the argument fields. |
usage='''FireCustomBullets''' (''soundname'', ''accuracy'', ''tracers'', ''dmgfactor'', ''dmgmod'', ''flashstate'', [''horizontal'', ''vertical'']) |
parameters=*soundname: The "nice name" of the sound to play. See [[sound|the sound EDF block]] for how to define this.
*''accuracy'': Select accuracy type:
**'''always''': Always accurate on every shot.
**'''first''': Accurate on first fire only ("never" accurate afterward)
**'''never''': Never accurate (5-degree horizontal spread with no vertical error)
**'''ssg''': Super Shotgun accuracy (10-degree horizontal spread with 5-degree vertical error)
**'''monster''': Monster accuracy (20-degree horizontal spread)
**'''custom''': custom accuracy. Use ''horizontal'' and ''vertical'' arguments to specify the spread.
*''tracers'': Number of bullet tracers to fire.
*''dmgfactor'': Damage factor. Damage formula is: ''dmgfactor'' * ((rnd%''dmgmod'') + 1))
*''dmgmod'': Damage modulus (Clamped into range of 1 to 256)
*''flashstate'': optional flash state to display. If 0, it will use weapon's defined flash state.
*''horizontal'': if ''accuracy'' is '''custom''', specify the '''overall''' horizontal spread in degrees (as opposed to spread each side of firing thing's current angle). Keep in mind the distribution is not uniform; it's concentrated on the centre, just like the preset spread types.
*''vertical'': also if ''accuracy'' is '''custom''', specify the overall vertical spread. Same distribution as for ''horizontal''.
|notes=It is possible to recreate any of the other bullet attacks in the game using this pointer, as well as create many totally new ones. |
seealso=
*[[CustomPlayerMelee]]
*[[FirePlayerMissile]]}}

A FireCustomBullets

2020-02-23T00:44:02Z

Altazimuth: Make description for angle parameters less ambiguous.

{{Codepointer |
description=FireCustomBullets is a parameterized player weapon codepointer. This codepointer can be used for the construction of custom player bullet weapons. The sound, accuracy, number of tracers, and randomized damage range of the tracers are all selectable via the argument fields. |
usage='''FireCustomBullets''' (''soundname'', ''accuracy'', ''tracers'', ''dmgfactor'', ''dmgmod'', ''flashstate'', [''horizontal'', ''vertical'']) |
parameters=*soundname: The "nice name" of the sound to play. See [[sound|the sound EDF block]] for how to define this.
*''accuracy'': Select accuracy type:
**'''always''': Always accurate on every shot.
**'''first''': Accurate on first fire only ("never" accurate afterward)
**'''never''': Never accurate (5-degree horizontal spread with no vertical error)
**'''ssg''': Super Shotgun accuracy (10-degree horizontal spread with 5-degree vertical error)
**'''monster''': Monster accuracy (20-degree horizontal spread)
**'''custom''': custom accuracy. Use ''horizontal'' and ''vertical'' arguments to specify the spread.
*''tracers'': Number of bullet tracers to fire.
*''dmgfactor'': Damage factor. Damage formula is: ''dmgfactor'' * ((rnd%''dmgmod'') + 1))
*''dmgmod'': Damage modulus (Clamped into range of 1 to 256)
*''flashstate'': optional flash state to display. If 0, it will use weapon's defined flash state.
*''horizontal'': if ''accuracy'' is '''custom''', specify the *overall* horizontal spread in degrees (as opposed to spread each side of firing thing's current angle). Keep in mind the distribution is not uniform; it's concentrated on the centre, just like the preset spread types.
*''vertical'': also if ''accuracy'' is '''custom''', specify the overall vertical spread. Same distribution as for ''horizontal''.
|notes=It is possible to recreate any of the other bullet attacks in the game using this pointer, as well as create many totally new ones. |
seealso=
*[[CustomPlayerMelee]]
*[[FirePlayerMissile]]}}

EDF item effects and inventory

2020-02-16T20:20:53Z

Altazimuth: Add link to "Creating a pickup" article.

Define what happens when an item is picked up and used (and eventually, dropped from the inventory - this is not complete yet). A tutorial on defining each of these can be found at [[Creating a pickup]].

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
usesound <str> // sound made when item is used
useeffect <str> // name of item effect to use for activation
useaction <action function> // codepointer and arguments called (e.g. A_GauntletAttack(1))

[+-]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
[+-]noshareware // if +, non-shareware

// 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.
lowmessage <str> // alternate message to give instead of pickupfx message when
// health is less than amount; if starts with $, is a BEX mnemonic.

[+-]alwayspickup // if +, item is picked up even when unneeded (e.g. Health Bonus)
[+-]sethealth // if +, item SETS health rather than adding to it (e.g. 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)
[+-]additive // if +, adds to the current amount of armor
[+-]setabsorption // if +, sets absorption values (savefactor & savedivisor)
}
===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
// Note that you can specify as many ammogiven properties as you want in a single weapongiver
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.
}

[[Category:EDF]]

EDF weapon reference

2019-02-07T19:31:53Z

Altazimuth: Update selectionorder type and default

Weapon info define weapons, simple as. They have unique names, or mnemonics, for easy identification. They're currently referenced solely by weapongivers (see [[EDF item effects and inventory]] for more info on those).

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

New objects, created via EDF files or wad lumps, can be later tweaked with weapon deltas. New weapon info should not be given a '''dehackednum''' property, as this is reserved solely for internal weapons so that mods that modify weapons with DeHackEd (BEX) patches remain compatible with Eternity.

{{See|Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>
ammotype2 <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>
attackstate2 <frame>
flashstate2 <frame>
holdstate2 <frame>

ammouse <number>
ammouse2 <number>

selectionorder <floating-point number>
slotnumber <number>
slotselectionorder <floating-point number>

sisterweapon <weapon info mnemonic>

flags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <floating-point number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this weapon accessible from other weapon info. Default games' (Doom, Heretic) weapon info use externalized frames for all weapon info, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other weaponinfo, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like weapon (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[ReFire|A_ReFire]] if the player is still holding the primary attack button.
*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

====Selection Order and Weapon Slots====
*'''selectionorder'''
:Default = -1.0
:Sets the priority for selection of the weapon. The lower the number, the higher its priority.
*'''slotnumber'''
:Default = -1
:Sets the weapon slot that the weapon occupies in the global weapon slots structure. For assigning to player class weapon slots, read [[weapon slots]].
*'''slotselectionorder'''
:Default = -1.0
:Sets the in-slot priority for the weapon in the global weapon slots structure. The lower the number, the higher its priority. Read [[weapon slots]] if you wish to understand the specifics of how in-slot priority works interacts with player class weapon slots.

====Sister Weapon====
*'''sisterweapon'''
:Default = ""
:Defines a weapon that is also provided when this weapon is picked up. This is can be used either for [[doom_wiki:Tome of Power|Tome of Power]] variants, or for weapons with two different firing modes (used by Strife weapons).

====Flags====
*'''flags'''
:Default = ""
:This field controls a number of weapon info properties using bit flags, where each bit in the field stands for some effect, and has the value of being either on or off. See the [[Weapon info flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''addflags'''
:Default = ""
:This field specifies a combined list of flags to be added to the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned on" in the weapon. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance.
*'''remflags'''
:Default = ""
:This field specifies a combined list of flags to be subtracted from the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned off" in the weapon, as if they had never been listed. If flags are listed here which are not already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance. This field will be applied AFTER the addflags field is applied, so it could potentially turn off flags turned on by that field.

====Damage Properties====
*'''mod'''
:Default = UNKNOWN (0)
:Originally standing for "Means of Death", this field allows you to associate a '''[[damagetype]]''' to the weapon info (though this property needs to be applied to projectiles for non-hitscan weapons). Then, you'll be able to make thing types resistant to the given damage type by using the thingtype '''damagefactor''' field. You can give them specific pain or death states as well. This property also have the role in multiplayer to specify what obituaries are shown depending on which weapon the player uses.
:The mnemonics were initially hard-coded, but are now available inside ''base\things.edf'' as '''damagetype''' blocks. Notice that the default damage types (means of death) have been differentiated for each player attack, as well as for the various slime types and whatnot, so as to have the obituaries differentiated.

====Recoil & Haptics Properties====
*'''recoil'''
:Default = 0.0
:This field designates the backwards thrust provided to the player when they fire the weapon (in 32nds of map-units). By default users have to opt-in to weapons having recoil, but if the flag ALWAYSRECOIL is set on the weapon then it will cause recoil regardless of the player's settings.

File:Pickup Assets.7z

2018-12-29T18:07:15Z

Altazimuth: Altazimuth uploaded a new version of File:Pickup Assets.7z

Assets and completed EDF for the tutorial [[Creating a pickup]] (located at User:Altazimuth at the time of upload).

Creating a pickup

2018-12-29T18:06:05Z

Altazimuth: Change tutorial to use Alfheim dialect.

Creating a pickup is effectively [[creating a simple decoration]], but with a few more steps. You should read that tutorial first before continuing on here. In this tutorial we will define several pickups, each with its own section. In addition, the multiple ways in which a pickup can be defined will also be explored.

Before starting out you should grab the resources for this tutorial from [[File:Pickup Assets.7z]], and make sure to either rename or delete all the EDF files currently present (as it's already completed).

Much like creating a simple decoration, we will start by creating a text lump named EDFROOT, but for this tutorial each pickup will have its own unique lump which contains the necessary EDF. We will include these lumps in EDFROOT so that the relevant pickups defined in the files can be used. For this tutorial we will use [[DECORATE state syntax]] when defining the thingtypes that our pickups require, as well as [[EDF_thing_reference#Eternity_Alfheim_syntax|Alfheim syntax]].

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.

setdialect("Alfheim") // Sets the dialect to Alfheim, which will impact all the lumpincluded files.
// This means that the syntax "thingtype Whatever : Mobj, doomednum" can be used.

'''Please note that you can call the lumps whatever you want. The lump names used here (besides EDFROOT) are just example lump names.'''

==Thing-based pickup==
Thing-based pickups offer a more streamlined end-user experience than sprite-based pickups, and so it is suggested that you use thing-based pickups. In addition, thing-based pickups take priority over sprite-based pickups, and if a pickup has both available, it will only use the one that is in its thingtype definition.

===Health===
Create a new lump, called EHEALTH. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EHEALTH") // A new health pickup

Now, start editing EHEALTH.

// This defines the thingtype UglyKit as a thing with doomednum 30001. Mobj is currently a dummy value.
thingtype UglyKit : Mobj, 30001
{
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects UglyKit // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got health, but you didn't like it..." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
UMED A -1
stop
"@
}

healtheffect UglyKit
{
amount 15 // The amount of health given per pickup.
maxamount 150 // The maximum amount the pickup will heal up to.

lowmessage "You got health, but you're not sure how to feel about it." // The message displayed if the player
// has less then twice the health given.
}

Now either type "summon UglyKit" (not case-sensitive) in the console, or place a thing with doomednum 30001 in the map. When you pick it up, it should heal you up to 150 health, and if your health is less than 30 prior to pickup then it will display the lowmessage.

===Armor===
Create a new lump, called EARMOR. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EARMOR") // A new armor pickup

Now, start editing EARMOR.

// This defines the thingtype RedArmor as a thing with doomednum 30002. Mobj is currently a dummy value.
thingtype RedArmor : Mobj, 30002
{
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedArmor // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up the HyperArmor!" // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RARM A 6
RARM B 7 bright
loop
"@
}

armoreffect RedArmor
{
saveamount 150 // The number the armor % is set to.
savefactor 2 // The numerator for the damage multiplier fraction (2/n).
savedivisor 3 // The denominator for the damage multiplier fraction (n/3).
// These two properties combine to the player taking 2/3 times the damage they usually would (66%).
}

Now either type "summon RedArmor" (not case-sensitive) in the console, or place a thing with doomednum 30002 in the map. When you pick it up, it should set your armor to 150. In addition, 66% of damage dealt to you will be absorbed by the armor.

===Ammo===
Create a new lump, called EAMMO. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EAMMO") // A new ammo pickup

Now, start editing EAMMO.

// This defines the thingtype RedAmmoBox as a thing with doomednum 30003. Mobj is currently a dummy value.
thingtype RedAmmoBox : Mobj, 30003
{
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedAmmoBox // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got lazily-recolored ammo." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RAMM A -1
stop
"@
}

ammoeffect RedAmmoBox
{
ammo AmmoClip // The type of ammo given
amount 75 // The amount of ammo given

+ignoreskill // ignoreskill is a flag. When + it makes it so it ignores skills that double ammo
}

Now either type "summon RedAmmoBox" (not case-sensitive) in the console, or place a thing with doomednum 30003 in the map. When you pick it up, it should give you 75 bullets, regardless of difficulty.

===Weapon===
Create a new lump, called EWEAPON. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EWEAPON") // A new ammo pickup

Now, start editing EWEAPON.

// This defines the thingtype BlueLauncher as a thing with doomednum 30004. Mobj is currently a dummy value.
thingtype BlueLauncher : Mobj, 30004
{
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects BlueLauncher // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got an offensively blue missile launcher." // The message given when picked up.
sound wpnup // The sound made when the item is picked up.
}

states
@"
Spawn:
BLUL A -1
stop
"@
}

weapongiver BlueLauncher
{
weapon MissileLauncher // The weaponinfo given by the weaponinfo
ammogiven AmmoMissile, 2, 1, 5, 2 // Ammo type given, and values in order, normal, dropped,
// DM w/ weapons stay, coop w/ weapons stay
ammogiven AmmoCell, 10 // You can define as many as you want. In this case, it gives 10 cells always
// (but is doubled for certain skill levels).
}

Now either type "summon BlueLauncher" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up, it should give you a rocket launcher, some rockets, and cells.

===Power-up===
Create a new lump, called EPOWER. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EPOWER") // A new ammo pickup

Now, start editing EPOWER.

// This defines the thingtype Torch as a thing with doomednum 30005. Mobj is currently a dummy value.
thingtype Torch : Mobj, 30005
{
doomednum 30005 // This is the thing number used to place the object in a map.
addflags SPECIAL|COUNTITEM|FLOATBOB // Sets flags for item, which in this case means it's a collectable item, counts in the items end tally, and floats.

pickupeffect // This defines what happens when the item is picked up.
{
effects Torch // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got a hideous torch." // The message given when picked up.
sound getpow // The sound made when the item is picked up.
}
states
@"
Spawn:
TRCH ABC 3 bright
loop
"@
}

powereffect Torch
{
duration 120 // How long the power lasts in seconds.
type PowerTorch // The type of power given, in this case Heretic's flickering torch.
}

Now either type "summon Torch" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up, it should provide you with the Heretic-style

===Artifact===
Create a new lump, called EKEY. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EKEY") // A new ammo pickup

Now, start editing EKEY.

// This defines the thingtype GreyCard as a thing with doomednum 30002. Mobj is currently a dummy value.
thingtype GreyCard : Mobj, 30006
{
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects GreyCard // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up a grey keycard." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
flags ALWAYSPICKUP|LEAVEINMULTI // These flags set it so it's always picked up, but isn't removed in multiplayer.
}

states
@"
Spawn:
GKEY A -1
stop
"@
}

artifact GreyCard
{
+invbar // This means that the key will show up in the Heretic-style inventory bar.
icon GKEYA0 // The icon for the graphic in the (Heretic-style) inventory bar.
// Bear in mind these offsets are combined with the patch offsets instead of overriding them.
icon.offset.x -15 // Patch-style x offset for inventory bar (positive is left).
icon.offset.y -26 // Patch-style y offset for inventory bar (positive is up).
artifacttype Key // This designates this artifact as a key. This means that the idk cheat would give this new item.
// The other types are Normal, Ammo, Puzzle, Power, Weapon, and Quest. Of these types Normal
// is the default. You will likely only ever need to make Normal (implicitly), Ammo, or Key artifacts.
}

// Don't worry about this, as lockdefs will probably be covered another day
lockdef 300
{
require GreyCard
mapcolor "#AAAAAA" // This is matched as closely as possible to the current palette

message "You need a grey card to activate this door"
remotemessage "You need a grey card to activate this object"
}

Now either type "summon GreyCard" (not case-sensitive) in the console, or place a thing with doomednum 30006 in the map. When you pick it up open your inventory bar (you'll need keys bound for that) and it should be in there.

==Sprite-based pickup==
Sprite-based pickups are what almost all IWAD pickups use, and are mostly there for backwards-compatibility.

User:Altazimuth/Creating a pickup

2018-12-27T23:01:01Z

Altazimuth: Altazimuth moved page User:Altazimuth/Creating a pickup to Creating a pickup: The article is ready to be in main.

#REDIRECT [[Creating a pickup]]

Creating a pickup

2018-12-27T23:01:01Z

Altazimuth: Altazimuth moved page User:Altazimuth/Creating a pickup to Creating a pickup: The article is ready to be in main.

Creating a pickup is effectively [[creating a simple decoration]], but with a few more steps. You should read that tutorial first before continuing on here. In this tutorial we will define several pickups, each with its own section. In addition, the multiple ways in which a pickup can be defined will also be explored.

Before starting out you should grab the resources for this tutorial from [[File:Pickup Assets.7z]], and make sure to either rename or delete all the EDF files currently present (as it's already completed).

Much like creating a simple decoration, we will start by creating a text lump named EDFROOT, but for this tutorial each pickup will have its own unique lump which contains the necessary EDF. We will include these lumps in EDFROOT so that the relevant pickups defined in the files can be used. For this tutorial we will use [[DECORATE state syntax]] when defining the the thingtypes that our pickups require.

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.

'''Please note that you can call the lumps whatever you want. The lump names used here (besides EDFROOT) are just example lump names.'''

==Thing-based pickup==
Thing-based pickups offer a more streamlined end-user experience than sprite-based pickups, and so it is suggested that you use thing-based pickups. In addition, thing-based pickups take priority over sprite-based pickups, and if a pickup has both available, it will only use the one that is in its thingtype definition.

===Health===
Create a new lump, called EHEALTH. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EHEALTH") // A new health pickup

Now, start editing EHEALTH.

thingtype UglyKit
{
doomednum 30001 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects UglyKit // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got health, but you didn't like it..." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states // This declares that the following block is the thingtype's states.
@"
Spawn:
UMED A -1
stop
"@
}

healtheffect UglyKit
{
amount 15 // The amount of health given per pickup.
maxamount 150 // The maximum amount the pickup will heal up to.

lowmessage "You got health, but you're not sure how to feel about it." // The message displayed if the player
// has less then twice the health given.
}

Now either type "summon UglyKit" (not case-sensitive) in the console, or place a thing with doomednum 30001 in the map. When you pick it up, it should heal you up to 150 health, and if your health is less than 30 prior to pickup then it will display the lowmessage.

===Armor===
Create a new lump, called EARMOR. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EARMOR") // A new armor pickup

Now, start editing EARMOR.

thingtype RedArmor
{
doomednum 30002 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedArmor // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up the HyperArmor!" // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RARM A 6
RARM B 7 bright
loop
"@
}

armoreffect RedArmor
{
saveamount 150 // The number the armor % is set to.
savefactor 2 // The numerator for the damage absorption fraction (2/n).
savedivisor 3 // The denominator for the damage absorption fraction (n/3).
// These two properties combine to the armor absorbing 2/3 the damage the player would usually would take (66%).
}

Now either type "summon RedArmor" (not case-sensitive) in the console, or place a thing with doomednum 30002 in the map. When you pick it up, it should set your armor to 150. In addition, 66% of damage dealt to you will be absorbed by the armor.

===Ammo===
Create a new lump, called EAMMO. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EAMMO") // A new ammo pickup

Now, start editing EAMMO.

thingtype RedAmmoBox
{
doomednum 30003 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedAmmoBox // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got lazily-recolored ammo." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RAMM A -1
stop
"@
}

ammoeffect RedAmmoBox
{
ammo AmmoClip // The type of ammo given
amount 75 // The amount of ammo given

+ignoreskill // ignoreskill is a flag. When + it makes it so it ignores skills that double ammo
}

Now either type "summon RedAmmoBox" (not case-sensitive) in the console, or place a thing with doomednum 30003 in the map. When you pick it up, it should give you 75 bullets, regardless of difficulty.

===Power-up===
Create a new lump, called EPOWER. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EPOWER") // A new ammo pickup

Now, start editing EPOWER.

thingtype Torch
{
doomednum 30005 // This is the thing number used to place the object in a map.
addflags SPECIAL|COUNTITEM|FLOATBOB // Sets flags for item, which in this case means it's a collectable item, counts in the items end tally, and floats.

pickupeffect // This defines what happens when the item is picked up.
{
effects Torch // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got a hideous torch." // The message given when picked up.
sound getpow // The sound made when the item is picked up.
}
states
@"
Spawn:
TRCH ABC 3 bright
loop
"@
}

powereffect Torch
{
duration 120 // How long the power lasts in seconds.
type PowerTorch // The type of power given, in this case Heretic's flickering torch.
}

Now either type "summon Torch" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up, it should provide you with the Heretic-style

===Weapon===
Create a new lump, called EWEAPON. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EWEAPON") // A new ammo pickup

Now, start editing EWEAPON.

thingtype BlueLauncher
{
doomednum 30005 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects BlueLauncher // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got an offensively blue missile launcher." // The message given when picked up.
sound wpnup // The sound made when the item is picked up.
}

states
@"
Spawn:
BLUL A -1
stop
"@
}

weapongiver BlueLauncher
{
weapon MissileLauncher // The weaponinfo name given by the weapongiver.
ammogiven AmmoMissile, 2, 1, 5, 2 // Ammo type given, and values in order, normal, dropped,
// DM w/ weapons stay, coop w/ weapons stay.
ammogiven AmmoCell, 10 // You can define as many as you want. In this case, it gives 10 cells always
// (but is doubled for certain skill levels).
}

Now either type "summon BlueLauncher" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up, it should give you a rocket launcher, some rockets, and cells.

===Artifact===
Create a new lump, called EKEY. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EKEY") // A new ammo pickup

Now, start editing EKEY.

thingtype GreyCard
{
doomednum 30006 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects GreyCard // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up a grey keycard." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
flags ALWAYSPICKUP|LEAVEINMULTI // These flags set it so it's always picked up, but isn't removed in multiplayer.
}

states
@"
Spawn:
GKEY A -1
stop
"@
}

artifact GreyCard
{
+invbar // This means that the key will show up in the Heretic-style inventory bar.
icon GKEYA0 // The icon for the graphic in the (Heretic-style) inventory bar.
// Bear in mind these offsets are combined with the patch offsets instead of overriding them.
icon.offset.x -15 // Patch-style x offset for inventory bar (positive is left).
icon.offset.y -26 // Patch-style y offset for inventory bar (positive is up).
artifacttype Key // This designates this artifact as a key. This means that the idk cheat would give this new item.
// The other types are Normal, Ammo, Puzzle, Power, Weapon, and Quest. Of these types Normal
// is the default. You will likely only ever need to make Normal (implicitly), Ammo, or Key artifacts.
}

// Don't worry about this, as lockdefs will probably be covered another day
lockdef 300
{
require GreyCard
mapcolor "#AAAAAA" // This is matched as closely as possible to the current palette

message "You need a grey card to activate this door"
remotemessage "You need a grey card to activate this object"
}

Now either type "summon GreyCard" (not case-sensitive) in the console, or place a thing with doomednum 30006 in the map. When you pick it up open your inventory bar (you'll need keys bound for that) and it should be in there.

==Sprite-based pickup==
Sprite-based pickups are what almost all IWAD pickups use, and are mostly there for backwards-compatibility.

Creating a pickup

2018-12-27T23:00:12Z

Altazimuth: Add link to resources prior to moving out of user-space.

Creating a pickup is effectively [[creating a simple decoration]], but with a few more steps. You should read that tutorial first before continuing on here. In this tutorial we will define several pickups, each with its own section. In addition, the multiple ways in which a pickup can be defined will also be explored.

Before starting out you should grab the resources for this tutorial from [[File:Pickup Assets.7z]], and make sure to either rename or delete all the EDF files currently present (as it's already completed).

Much like creating a simple decoration, we will start by creating a text lump named EDFROOT, but for this tutorial each pickup will have its own unique lump which contains the necessary EDF. We will include these lumps in EDFROOT so that the relevant pickups defined in the files can be used. For this tutorial we will use [[DECORATE state syntax]] when defining the the thingtypes that our pickups require.

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.

'''Please note that you can call the lumps whatever you want. The lump names used here (besides EDFROOT) are just example lump names.'''

==Thing-based pickup==
Thing-based pickups offer a more streamlined end-user experience than sprite-based pickups, and so it is suggested that you use thing-based pickups. In addition, thing-based pickups take priority over sprite-based pickups, and if a pickup has both available, it will only use the one that is in its thingtype definition.

===Health===
Create a new lump, called EHEALTH. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EHEALTH") // A new health pickup

Now, start editing EHEALTH.

thingtype UglyKit
{
doomednum 30001 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects UglyKit // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got health, but you didn't like it..." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states // This declares that the following block is the thingtype's states.
@"
Spawn:
UMED A -1
stop
"@
}

healtheffect UglyKit
{
amount 15 // The amount of health given per pickup.
maxamount 150 // The maximum amount the pickup will heal up to.

lowmessage "You got health, but you're not sure how to feel about it." // The message displayed if the player
// has less then twice the health given.
}

Now either type "summon UglyKit" (not case-sensitive) in the console, or place a thing with doomednum 30001 in the map. When you pick it up, it should heal you up to 150 health, and if your health is less than 30 prior to pickup then it will display the lowmessage.

===Armor===
Create a new lump, called EARMOR. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EARMOR") // A new armor pickup

Now, start editing EARMOR.

thingtype RedArmor
{
doomednum 30002 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedArmor // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up the HyperArmor!" // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RARM A 6
RARM B 7 bright
loop
"@
}

armoreffect RedArmor
{
saveamount 150 // The number the armor % is set to.
savefactor 2 // The numerator for the damage absorption fraction (2/n).
savedivisor 3 // The denominator for the damage absorption fraction (n/3).
// These two properties combine to the armor absorbing 2/3 the damage the player would usually would take (66%).
}

Now either type "summon RedArmor" (not case-sensitive) in the console, or place a thing with doomednum 30002 in the map. When you pick it up, it should set your armor to 150. In addition, 66% of damage dealt to you will be absorbed by the armor.

===Ammo===
Create a new lump, called EAMMO. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EAMMO") // A new ammo pickup

Now, start editing EAMMO.

thingtype RedAmmoBox
{
doomednum 30003 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedAmmoBox // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got lazily-recolored ammo." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RAMM A -1
stop
"@
}

ammoeffect RedAmmoBox
{
ammo AmmoClip // The type of ammo given
amount 75 // The amount of ammo given

+ignoreskill // ignoreskill is a flag. When + it makes it so it ignores skills that double ammo
}

Now either type "summon RedAmmoBox" (not case-sensitive) in the console, or place a thing with doomednum 30003 in the map. When you pick it up, it should give you 75 bullets, regardless of difficulty.

===Power-up===
Create a new lump, called EPOWER. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EPOWER") // A new ammo pickup

Now, start editing EPOWER.

thingtype Torch
{
doomednum 30005 // This is the thing number used to place the object in a map.
addflags SPECIAL|COUNTITEM|FLOATBOB // Sets flags for item, which in this case means it's a collectable item, counts in the items end tally, and floats.

pickupeffect // This defines what happens when the item is picked up.
{
effects Torch // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got a hideous torch." // The message given when picked up.
sound getpow // The sound made when the item is picked up.
}
states
@"
Spawn:
TRCH ABC 3 bright
loop
"@
}

powereffect Torch
{
duration 120 // How long the power lasts in seconds.
type PowerTorch // The type of power given, in this case Heretic's flickering torch.
}

Now either type "summon Torch" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up, it should provide you with the Heretic-style

===Weapon===
Create a new lump, called EWEAPON. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EWEAPON") // A new ammo pickup

Now, start editing EWEAPON.

thingtype BlueLauncher
{
doomednum 30005 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects BlueLauncher // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got an offensively blue missile launcher." // The message given when picked up.
sound wpnup // The sound made when the item is picked up.
}

states
@"
Spawn:
BLUL A -1
stop
"@
}

weapongiver BlueLauncher
{
weapon MissileLauncher // The weaponinfo name given by the weapongiver.
ammogiven AmmoMissile, 2, 1, 5, 2 // Ammo type given, and values in order, normal, dropped,
// DM w/ weapons stay, coop w/ weapons stay.
ammogiven AmmoCell, 10 // You can define as many as you want. In this case, it gives 10 cells always
// (but is doubled for certain skill levels).
}

Now either type "summon BlueLauncher" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up, it should give you a rocket launcher, some rockets, and cells.

===Artifact===
Create a new lump, called EKEY. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EKEY") // A new ammo pickup

Now, start editing EKEY.

thingtype GreyCard
{
doomednum 30006 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects GreyCard // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up a grey keycard." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
flags ALWAYSPICKUP|LEAVEINMULTI // These flags set it so it's always picked up, but isn't removed in multiplayer.
}

states
@"
Spawn:
GKEY A -1
stop
"@
}

artifact GreyCard
{
+invbar // This means that the key will show up in the Heretic-style inventory bar.
icon GKEYA0 // The icon for the graphic in the (Heretic-style) inventory bar.
// Bear in mind these offsets are combined with the patch offsets instead of overriding them.
icon.offset.x -15 // Patch-style x offset for inventory bar (positive is left).
icon.offset.y -26 // Patch-style y offset for inventory bar (positive is up).
artifacttype Key // This designates this artifact as a key. This means that the idk cheat would give this new item.
// The other types are Normal, Ammo, Puzzle, Power, Weapon, and Quest. Of these types Normal
// is the default. You will likely only ever need to make Normal (implicitly), Ammo, or Key artifacts.
}

// Don't worry about this, as lockdefs will probably be covered another day
lockdef 300
{
require GreyCard
mapcolor "#AAAAAA" // This is matched as closely as possible to the current palette

message "You need a grey card to activate this door"
remotemessage "You need a grey card to activate this object"
}

Now either type "summon GreyCard" (not case-sensitive) in the console, or place a thing with doomednum 30006 in the map. When you pick it up open your inventory bar (you'll need keys bound for that) and it should be in there.

==Sprite-based pickup==
Sprite-based pickups are what almost all IWAD pickups use, and are mostly there for backwards-compatibility.

File:Pickup Assets.7z

2018-12-27T22:52:29Z

Altazimuth: Assets and completed EDF for the tutorial Creating a pickup (located at User:Altazimuth at the time of upload).

Assets and completed EDF for the tutorial [[Creating a pickup]] (located at User:Altazimuth at the time of upload).

Creating a pickup

2018-12-27T22:42:24Z

Altazimuth: Add Power-up section.

Creating a pickup is effectively [[creating a simple decoration]], but with a few more steps. You should read that tutorial first before continuing on here. In this tutorial we will define several pickups, each with its own section. In addition, the multiple ways in which a pickup can be defined will also be explored.

Much like creating a simple decoration, we will start by creating a text lump named EDFROOT, but for this tutorial each pickup will have its own unique lump which contains the necessary EDF. We will include these lumps in EDFROOT so that the relevant pickups defined in the files can be used. For this tutorial we will use [[DECORATE state syntax]] when defining the the thingtypes that our pickups require.

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.

'''Please note that you can call the lumps whatever you want. The lump names used here (besides EDFROOT) are just example lump names.'''

==Thing-based pickup==
Thing-based pickups offer a more streamlined end-user experience than sprite-based pickups, and so it is suggested that you use thing-based pickups. In addition, thing-based pickups take priority over sprite-based pickups, and if a pickup has both available, it will only use the one that is in its thingtype definition.

===Health===
Create a new lump, called EHEALTH. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EHEALTH") // A new health pickup

Now, start editing EHEALTH.

thingtype UglyKit
{
doomednum 30001 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects UglyKit // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got health, but you didn't like it..." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states // This declares that the following block is the thingtype's states.
@"
Spawn:
UMED A -1
stop
"@
}

healtheffect UglyKit
{
amount 15 // The amount of health given per pickup.
maxamount 150 // The maximum amount the pickup will heal up to.

lowmessage "You got health, but you're not sure how to feel about it." // The message displayed if the player
// has less then twice the health given.
}

Now either type "summon UglyKit" (not case-sensitive) in the console, or place a thing with doomednum 30001 in the map. When you pick it up, it should heal you up to 150 health, and if your health is less than 30 prior to pickup then it will display the lowmessage.

===Armor===
Create a new lump, called EARMOR. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EARMOR") // A new armor pickup

Now, start editing EARMOR.

thingtype RedArmor
{
doomednum 30002 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedArmor // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up the HyperArmor!" // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RARM A 6
RARM B 7 bright
loop
"@
}

armoreffect RedArmor
{
saveamount 150 // The number the armor % is set to.
savefactor 2 // The numerator for the damage absorption fraction (2/n).
savedivisor 3 // The denominator for the damage absorption fraction (n/3).
// These two properties combine to the armor absorbing 2/3 the damage the player would usually would take (66%).
}

Now either type "summon RedArmor" (not case-sensitive) in the console, or place a thing with doomednum 30002 in the map. When you pick it up, it should set your armor to 150. In addition, 66% of damage dealt to you will be absorbed by the armor.

===Ammo===
Create a new lump, called EAMMO. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EAMMO") // A new ammo pickup

Now, start editing EAMMO.

thingtype RedAmmoBox
{
doomednum 30003 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedAmmoBox // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got lazily-recolored ammo." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RAMM A -1
stop
"@
}

ammoeffect RedAmmoBox
{
ammo AmmoClip // The type of ammo given
amount 75 // The amount of ammo given

+ignoreskill // ignoreskill is a flag. When + it makes it so it ignores skills that double ammo
}

Now either type "summon RedAmmoBox" (not case-sensitive) in the console, or place a thing with doomednum 30003 in the map. When you pick it up, it should give you 75 bullets, regardless of difficulty.

===Power-up===
Create a new lump, called EPOWER. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EPOWER") // A new ammo pickup

Now, start editing EPOWER.

thingtype Torch
{
doomednum 30005 // This is the thing number used to place the object in a map.
addflags SPECIAL|COUNTITEM|FLOATBOB // Sets flags for item, which in this case means it's a collectable item, counts in the items end tally, and floats.

pickupeffect // This defines what happens when the item is picked up.
{
effects Torch // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got a hideous torch." // The message given when picked up.
sound getpow // The sound made when the item is picked up.
}
states
@"
Spawn:
TRCH ABC 3 bright
loop
"@
}

powereffect Torch
{
duration 120 // How long the power lasts in seconds.
type PowerTorch // The type of power given, in this case Heretic's flickering torch.
}

Now either type "summon Torch" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up, it should provide you with the Heretic-style

===Weapon===
Create a new lump, called EWEAPON. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EWEAPON") // A new ammo pickup

Now, start editing EWEAPON.

thingtype BlueLauncher
{
doomednum 30005 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects BlueLauncher // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got an offensively blue missile launcher." // The message given when picked up.
sound wpnup // The sound made when the item is picked up.
}

states
@"
Spawn:
BLUL A -1
stop
"@
}

weapongiver BlueLauncher
{
weapon MissileLauncher // The weaponinfo name given by the weapongiver.
ammogiven AmmoMissile, 2, 1, 5, 2 // Ammo type given, and values in order, normal, dropped,
// DM w/ weapons stay, coop w/ weapons stay.
ammogiven AmmoCell, 10 // You can define as many as you want. In this case, it gives 10 cells always
// (but is doubled for certain skill levels).
}

Now either type "summon BlueLauncher" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up, it should give you a rocket launcher, some rockets, and cells.

===Artifact===
Create a new lump, called EKEY. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EKEY") // A new ammo pickup

Now, start editing EKEY.

thingtype GreyCard
{
doomednum 30006 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects GreyCard // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up a grey keycard." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
flags ALWAYSPICKUP|LEAVEINMULTI // These flags set it so it's always picked up, but isn't removed in multiplayer.
}

states
@"
Spawn:
GKEY A -1
stop
"@
}

artifact GreyCard
{
+invbar // This means that the key will show up in the Heretic-style inventory bar.
icon GKEYA0 // The icon for the graphic in the (Heretic-style) inventory bar.
// Bear in mind these offsets are combined with the patch offsets instead of overriding them.
icon.offset.x -15 // Patch-style x offset for inventory bar (positive is left).
icon.offset.y -26 // Patch-style y offset for inventory bar (positive is up).
artifacttype Key // This designates this artifact as a key. This means that the idk cheat would give this new item.
// The other types are Normal, Ammo, Puzzle, Power, Weapon, and Quest. Of these types Normal
// is the default. You will likely only ever need to make Normal (implicitly), Ammo, or Key artifacts.
}

// Don't worry about this, as lockdefs will probably be covered another day
lockdef 300
{
require GreyCard
mapcolor "#AAAAAA" // This is matched as closely as possible to the current palette

message "You need a grey card to activate this door"
remotemessage "You need a grey card to activate this object"
}

Now either type "summon GreyCard" (not case-sensitive) in the console, or place a thing with doomednum 30006 in the map. When you pick it up open your inventory bar (you'll need keys bound for that) and it should be in there.

==Sprite-based pickup==
Sprite-based pickups are what almost all IWAD pickups use, and are mostly there for backwards-compatibility.

Creating a pickup

2018-12-27T15:46:31Z

Altazimuth: Fix a couple minor typos.

Creating a pickup is effectively [[creating a simple decoration]], but with a few more steps. You should read that tutorial first before continuing on here. In this tutorial we will define several pickups, each with its own section. In addition, the multiple ways in which a pickup can be defined will also be explored.

Much like creating a simple decoration, we will start by creating a text lump named EDFROOT, but for this tutorial each pickup will have its own unique lump which contains the necessary EDF. We will include these lumps in EDFROOT so that the relevant pickups defined in the files can be used. For this tutorial we will use [[DECORATE state syntax]] when defining the the thingtypes that our pickups require.

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.

'''Please note that you can call the lumps whatever you want. The lump names used here (besides EDFROOT) are just example lump names.'''

==Thing-based pickup==
Thing-based pickups offer a more streamlined end-user experience than sprite-based pickups, and so it is suggested that you use thing-based pickups. In addition, thing-based pickups take priority over sprite-based pickups, and if a pickup has both available, it will only use the one that is in its thingtype definition.

===Health===
Create a new lump, called EHEALTH. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EHEALTH") // A new health pickup

Now, start editing EHEALTH.

thingtype UglyKit
{
doomednum 30001 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects UglyKit // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got health, but you didn't like it..." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states // This declares that the following block is the thingtype's states.
@"
Spawn:
UMED A -1
stop
"@
}

healtheffect UglyKit
{
amount 15 // The amount of health given per pickup.
maxamount 150 // The maximum amount the pickup will heal up to.

lowmessage "You got health, but you're not sure how to feel about it." // The message displayed if the player
// has less then twice the health given.
}

Now either type "summon UglyKit" (not case-sensitive) in the console, or place a thing with doomednum 30001 in the map. When you pick it up, it should heal you up to 150 health, and if your health is less than 30 prior to pickup then it will display the lowmessage.

===Armor===
Create a new lump, called EARMOR. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EARMOR") // A new armor pickup

Now, start editing EARMOR.

thingtype RedArmor
{
doomednum 30002 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedArmor // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up the HyperArmor!" // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RARM A 6
RARM B 7 bright
loop
"@
}

armoreffect RedArmor
{
saveamount 150 // The number the armor % is set to.
savefactor 2 // The numerator for the damage absorption fraction (2/n).
savedivisor 3 // The denominator for the damage absorption fraction (n/3).
// These two properties combine to the armor absorbing 2/3 the damage the player would usually would take (66%).
}

Now either type "summon RedArmor" (not case-sensitive) in the console, or place a thing with doomednum 30002 in the map. When you pick it up, it should set your armor to 150. In addition, 66% of damage dealt to you will be absorbed by the armor.

===Ammo===
Create a new lump, called EAMMO. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EAMMO") // A new ammo pickup

Now, start editing EAMMO.

thingtype RedAmmoBox
{
doomednum 30003 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedAmmoBox // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got lazily-recolored ammo." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RAMM A -1
stop
"@
}

ammoeffect RedAmmoBox
{
ammo AmmoClip // The type of ammo given
amount 75 // The amount of ammo given

+ignoreskill // ignoreskill is a flag. When + it makes it so it ignores skills that double ammo
}

Now either type "summon RedAmmoBox" (not case-sensitive) in the console, or place a thing with doomednum 30003 in the map. When you pick it up, it should give you 75 bullets, regardless of difficulty.

===Power-up===

===Weapon===
Create a new lump, called EWEAPON. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EWEAPON") // A new ammo pickup

Now, start editing EWEAPON.

thingtype BlueLauncher
{
doomednum 30005 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects BlueLauncher // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got an offensively blue missile launcher." // The message given when picked up.
sound wpnup // The sound made when the item is picked up.
}

states
@"
Spawn:
BLUL A -1
stop
"@
}

weapongiver BlueLauncher
{
weapon MissileLauncher // The weaponinfo name given by the weapongiver.
ammogiven AmmoMissile, 2, 1, 5, 2 // Ammo type given, and values in order, normal, dropped,
// DM w/ weapons stay, coop w/ weapons stay.
ammogiven AmmoCell, 10 // You can define as many as you want. In this case, it gives 10 cells always
// (but is doubled for certain skill levels).
}

Now either type "summon BlueLauncher" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up, it should give you a rocket launcher, some rockets, and cells.

===Artifact===
Create a new lump, called EKEY. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EKEY") // A new ammo pickup

Now, start editing EKEY.

thingtype GreyCard
{
doomednum 30006 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects GreyCard // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up a grey keycard." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
flags ALWAYSPICKUP|LEAVEINMULTI // These flags set it so it's always picked up, but isn't removed in multiplayer.
}

states
@"
Spawn:
GKEY A -1
stop
"@
}

artifact GreyCard
{
+invbar // This means that the key will show up in the Heretic-style inventory bar.
icon GKEYA0 // The icon for the graphic in the (Heretic-style) inventory bar.
// Bear in mind these offsets are combined with the patch offsets instead of overriding them.
icon.offset.x -15 // Patch-style x offset for inventory bar (positive is left).
icon.offset.y -26 // Patch-style y offset for inventory bar (positive is up).
artifacttype Key // This designates this artifact as a key. This means that the idk cheat would give this new item.
// The other types are Normal, Ammo, Puzzle, Power, Weapon, and Quest. Of these types Normal
// is the default. You will likely only ever need to make Normal (implicitly), Ammo, or Key artifacts.
}

// Don't worry about this, as lockdefs will probably be covered another day
lockdef 300
{
require GreyCard
mapcolor "#AAAAAA" // This is matched as closely as possible to the current palette

message "You need a grey card to activate this door"
remotemessage "You need a grey card to activate this object"
}

Now either type "summon GreyCard" (not case-sensitive) in the console, or place a thing with doomednum 30006 in the map. When you pick it up open your inventory bar (you'll need keys bound for that) and it should be in there.

==Sprite-based pickup==
Sprite-based pickups are what almost all IWAD pickups use, and are mostly there for backwards-compatibility.

Creating a pickup

2018-12-27T15:45:06Z

Altazimuth: Add Artifact section.

Creating a pickup is effectively [[creating a simple decoration]], but with a few more steps. You should read that tutorial first before continuing on here. In this tutorial we will define several pickups, each with its own section. In addition, the multiple ways in which a pickup can be defined will also be explored.

Much like creating a simple decoration, we will start by creating a text lump named EDFROOT, but for this tutorial each pickup will have its own unique lump which contains the necessary EDF. We will include these lumps in EDFROOT so that the relevant pickups defined in the files can be used. For this tutorial we will use [[DECORATE state syntax]] when defining the the thingtypes that our pickups require.

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.

'''Please note that you can call the lumps whatever you want. The lump names used here (besides EDFROOT) are just example lump names.'''

==Thing-based pickup==
Thing-based pickups offer a more streamlined end-user experience than sprite-based pickups, and so it is suggested that you use thing-based pickups. In addition, thing-based pickups take priority over sprite-based pickups, and if a pickup has both available, it will only use the one that is in its thingtype definition.

===Health===
Create a new lump, called EHEALTH. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EHEALTH") // A new health pickup

Now, start editing EHEALTH.

thingtype UglyKit
{
doomednum 30001 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects UglyKit // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got health, but you didn't like it..." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states // This declares that the following block is the thingtype's states.
@"
Spawn:
UMED A -1
stop
"@
}

healtheffect UglyKit
{
amount 15 // The amount of health given per pickup.
maxamount 150 // The maximum amount the pickup will heal up to.

lowmessage "You got health, but you're not sure how to feel about it." // The message displayed if the player
// has less then twice the health given.
}

Now either type "summon UglyKit" (not case-sensitive) in the console, or place a thing with doomednum 30001 in the map. When you pick it up, it should heal you up to 150 health, and if your health is less than 30 prior to pickup then it will display the lowmessage.

===Armor===
Create a new lump, called EARMOR. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EARMOR") // A new armor pickup

Now, start editing EARMOR.

thingtype RedArmor
{
doomednum 30002 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedArmor // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up the HyperArmor!" // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RARM A 6
RARM B 7 bright
loop
"@
}

armoreffect RedArmor
{
saveamount 150 // The number the armor % is set to.
savefactor 2 // The numerator for the damage absorption fraction (2/n).
savedivisor 3 // The denominator for the damage absorption fraction (n/3).
// These two properties combine to the armor absorbing 2/3 the damage the player would usually would take (66%).
}

Now either type "summon RedArmor" (not case-sensitive) in the console, or place a thing with doomednum 30002 in the map. When you pick it up, it should set your armor to 150. In addition, 66% of damage dealt to you will be absorbed by the armor.

===Ammo===
Create a new lump, called EAMMO. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EAMMO") // A new ammo pickup

Now, start editing EAMMO.

thingtype RedAmmoBox
{
doomednum 30003 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects RedAmmoBox // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got lazily-recolored ammo." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
}

states
@"
Spawn:
RAMM A -1
stop
"@
}

ammoeffect RedAmmoBox
{
ammo AmmoClip // The type of ammo given
amount 75 // The amount of ammo given

+ignoreskill // ignoreskill is a flag. When + it makes it so it ignores skills that double ammo
}

Now either type "summon RedAmmoBox" (not case-sensitive) in the console, or place a thing with doomednum 30003 in the map. When you pick it up, it should give you 75 bullets, regardless of difficulty.

===Power-up===

===Weapon===
Create a new lump, called EWEAPON. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EWEAPON") // A new ammo pickup

Now, start editing EWEAPON.

thingtype BlueLauncher
{
doomednum 30005 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects BlueLauncher // The actual effects that happen when the item is picked up (can be a comma separated list).
message "You got an offensively blue missile launcher." // The message given when picked up.
sound wpnup // The sound made when the item is picked up.
}

states
@"
Spawn:
BLUL A -1
stop
"@
}

weapongiver BlueLauncher
{
weapon MissileLauncher // The weaponinfo name given by the weapongiver.
ammogiven AmmoMissile, 2, 1, 5, 2 // Ammo type given, and values in order, normal, dropped,
// DM w/ weapons stay, coop w/ weapons stay.
ammogiven AmmoCell, 10 // You can define as many as you want. In this case, it gives 10 cells always
// (but is doubled for certain skill levels).
}

Now either type "summon BlueLauncher" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up, it should give you a rocket launcher, some rockets, and cells.

===Artifact===
Create a new lump, called EKEY. Add the following to EDFROOT, on a line after the stdinclude.

lumpinclude("EKEY") // A new ammo pickup

Now, start editing EKEY.

thingtype GreyCard
{
doomednum 30005 // This is the thing number used to place the object in a map.
flags SPECIAL // Sets flags for item, which in this case means it's a collectable item.

pickupeffect // This defines what happens when the item is picked up.
{
effects GreyCard // The actual effects that happen when the item is picked up (can be a comma separated list).
message "Picked up a grey keycard." // The message given when picked up.
sound itemup // The sound made when the item is picked up.
flags ALWAYSPICKUP|LEAVEINMULTI // These flags set it so it's always picked up, but isn't removed in multiplayer.
}

states
@"
Spawn:
GKEY A -1
stop
"@
}

artifact GreyCard
{
+invbar // This means that the key will show up in the Heretic-style inventory bar.
icon GKEYA0 // The icon for the graphic in the (Heretic-style) inventory bar.
// Bear in mind these offsets are combined with the patch offsets instead of overriding them.
icon.offset.x -15 // Patch-style x offset for inventory bar (positive is left).
icon.offset.y -26 // Patch-style y offset for inventory bar (positive is up).
artifacttype Key // This designates this artifact as a key. This means that the idk cheat would give this new item.
// The other types are Normal, Ammo, Puzzle, Power, Weapon, and Quest. Of these types Normal
// is the default. You will likely only ever need to make Normal (implicitly), Ammo, or Key artifacts.
}

// Don't worry about this, as lockdefs will probably be covered another day
lockdef 300
{
require GreyCard
mapcolor "#AAAAAA" // This is matched as closely as possible to the current palette

message "You need a grey card to activate this door"
remotemessage "You need a grey card to activate this object"
}

Now either type "summon GreyCard" (not case-sensitive) in the console, or place a thing with doomednum 30005 in the map. When you pick it up open your inventory bar (you'll need keys bound for that) and it should be in there.

==Sprite-based pickup==
Sprite-based pickups are what almost all IWAD pickups use, and are mostly there for backwards-compatibility.

ExtraData

2018-12-17T13:00:30Z

Altazimuth: Make note that ExtraData is now deprecated, in favour of UDMF.

With support of [[Universal Doom Map Format]] in releases of Eternity, ExtraData is now considered {{Deprecated}}. In the future new features introduced into UDMF will not be supported by ExtraData. ExtraData maps will still work, but new projects should use UDMF due to its greatly streamlined mapping experience, especially if using editors such as [https://www.doomworld.com/forum/topic/96943 Doom Builder X] or [https://forum.zdoom.org/viewtopic.php?t=54957 GZDoomBuilder-Bugfix] are used (the former including specific improvements for Eternity's UDMF, such as for [[linked portals]]).

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.
{{Backto|Eternity Engine}}
{{editref}}
=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>
special <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 [[ACS]] 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 ACS functions that accept TIDs will perform an action on all mapthings which bear the same TID.

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

The thing special field, which will execute when thing dies if it's a monster or picked up if it's an item. Use '''args''' to control the parameters.

====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>, ... }
id <number>
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.
POLYOBJECT Linedef can be activated by polyobjects (only works with CROSS)
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.
ZONEBOUNDARY Linedef will work as a reverb effect boundary. Not needed for one-sided lines.
CLIPMIDTEX Linedef middle texture will not "bleed" on floor and ceiling.
LOWERPORTAL Linedef copies floor portal from its backside to its lower visible edge
UPPERPORTAL Linedef copies ceiling portal from its backside to its upper visible edge
---------------------------------------------------------------------------------------

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.

LOWERPORTAL and UPPERPORTAL are used to enable portals on the front side's upper and/or lower edges of a linedef, if the sector in front of the linedef is tall enough compared to the back sector to expose them. It is the only way to enable such portals, which will copy the sector portal(s) from the backside, if any.

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

====id====
:''Default: 0''
This field is equivalent to '''tag'''. It will only have effect if '''tag''' is not already set.

====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>
floorscalex <float>
floorscaley <float>
ceilingterrain <terrain name>
ceilingangle <float>
ceilingoffsetx <float>
ceilingoffsety <float>
ceilingscalex <float>
ceilingscaley <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
PHASEDLIGHT Sector is phased light sequence start
LIGHTSEQUENCE Sector is phased light sequence step (alternates with below flag)
LIGHTSEQALT Sector is phased light sequence alternate step (alternates with above flag)
---------------------------------------------------------------------------------------

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

sector { flags SECRET|FRICTION|KILLMOVESOUND }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

====floorscalex/floorscaley====
:''Default: 1.0''

Specifies the x and y offsets of the floor flat. A higher number means a smaller texture.

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

====ceilingoffsetx/ceilingoffsety====
:''Default: 0''

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

====ceilingscalex/ceilingscaley====
:''Default: 1.0''

Specifies the x and y offsets of the ceiling flat. A higher number means a smaller texture.

====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.floor/portalflags.ceiling====
:''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
ATTACHEDPORTAL If a linked portal is on the respective floor or ceiling, move it along
with the surface. Useful for vertically moving platforms.
---------------------------------------------------------------------------------------

====overlayalpha.floor/overlayalpha.ceiling====
:''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.

EDF weapon reference

2018-11-07T12:45:30Z

Altazimuth: Fix recoil's description being incorrect.

Weapon info define weapons, simple as. They have unique names, or mnemonics, for easy identification. They're currently referenced solely by weapongivers (see [[EDF item effects and inventory]] for more info on those).

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

New objects, created via EDF files or wad lumps, can be later tweaked with weapon deltas. New weapon info should not be given a '''dehackednum''' property, as this is reserved solely for internal weapons so that mods that modify weapons with DeHackEd (BEX) patches remain compatible with Eternity.

{{See|Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>
ammotype2 <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>
attackstate2 <frame>
flashstate2 <frame>
holdstate2 <frame>

ammouse <number>
ammouse2 <number>

selectionorder <number>
slotnumber <number>
slotselectionorder <floating-point number>

sisterweapon <weapon info mnemonic>

flags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <floating-point number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this weapon accessible from other weapon info. Default games' (Doom, Heretic) weapon info use externalized frames for all weapon info, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other weaponinfo, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like weapon (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[ReFire|A_ReFire]] if the player is still holding the primary attack button.
*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

====Selection Order and Weapon Slots====
*'''selectionorder'''
:Default = -1
:Sets the priority for selection of the weapon. The lower the number, the higher its priority.
*'''slotnumber'''
:Default = -1
:Sets the weapon slot that the weapon occupies in the global weapon slots structure. For assigning to player class weapon slots, read [[weapon slots]].
*'''slotselectionorder'''
:Default = -1.0
:Sets the in-slot priority for the weapon in the global weapon slots structure. The lower the number, the higher its priority. Read [[weapon slots]] if you wish to understand the specifics of how in-slot priority works interacts with player class weapon slots.

====Sister Weapon====
*'''sisterweapon'''
:Default = ""
:Defines a weapon that is also provided when this weapon is picked up. This is can be used either for [[doom_wiki:Tome of Power|Tome of Power]] variants, or for weapons with two different firing modes (used by Strife weapons).

====Flags====
*'''flags'''
:Default = ""
:This field controls a number of weapon info properties using bit flags, where each bit in the field stands for some effect, and has the value of being either on or off. See the [[Weapon info flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''addflags'''
:Default = ""
:This field specifies a combined list of flags to be added to the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned on" in the weapon. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance.
*'''remflags'''
:Default = ""
:This field specifies a combined list of flags to be subtracted from the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned off" in the weapon, as if they had never been listed. If flags are listed here which are not already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance. This field will be applied AFTER the addflags field is applied, so it could potentially turn off flags turned on by that field.

====Damage Properties====
*'''mod'''
:Default = UNKNOWN (0)
:Originally standing for "Means of Death", this field allows you to associate a '''[[damagetype]]''' to the weapon info (though this property needs to be applied to projectiles for non-hitscan weapons). Then, you'll be able to make thing types resistant to the given damage type by using the thingtype '''damagefactor''' field. You can give them specific pain or death states as well. This property also have the role in multiplayer to specify what obituaries are shown depending on which weapon the player uses.
:The mnemonics were initially hard-coded, but are now available inside ''base\things.edf'' as '''damagetype''' blocks. Notice that the default damage types (means of death) have been differentiated for each player attack, as well as for the various slime types and whatnot, so as to have the obituaries differentiated.

====Recoil & Haptics Properties====
*'''recoil'''
:Default = 0.0
:This field designates the backwards thrust provided to the player when they fire the weapon (in 32nds of map-units). By default users have to opt-in to weapons having recoil, but if the flag ALWAYSRECOIL is set on the weapon then it will cause recoil regardless of the player's settings.

EDF weapon reference

2018-11-04T19:18:45Z

Altazimuth: Add more fields.

Weapon info define weapons, simple as. They have unique names, or mnemonics, for easy identification. They're currently referenced solely by weapongivers (see [[EDF item effects and inventory]] for more info on those).

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

New objects, created via EDF files or wad lumps, can be later tweaked with weapon deltas. New weapon info should not be given a '''dehackednum''' property, as this is reserved solely for internal weapons so that mods that modify weapons with DeHackEd (BEX) patches remain compatible with Eternity.

{{See|Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>
ammotype2 <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>
attackstate2 <frame>
flashstate2 <frame>
holdstate2 <frame>

ammouse <number>
ammouse2 <number>

selectionorder <number>
slotnumber <number>
slotselectionorder <floating-point number>

sisterweapon <weapon info mnemonic>

flags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <floating-point number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this weapon accessible from other weapon info. Default games' (Doom, Heretic) weapon info use externalized frames for all weapon info, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other weaponinfo, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like weapon (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[ReFire|A_ReFire]] if the player is still holding the primary attack button.
*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

====Selection Order and Weapon Slots====
*'''selectionorder'''
:Default = -1
:Sets the priority for selection of the weapon. The lower the number, the higher its priority.
*'''slotnumber'''
:Default = -1
:Sets the weapon slot that the weapon occupies in the global weapon slots structure. For assigning to player class weapon slots, read [[weapon slots]].
*'''slotselectionorder'''
:Default = -1.0
:Sets the in-slot priority for the weapon in the global weapon slots structure. The lower the number, the higher its priority. Read [[weapon slots]] if you wish to understand the specifics of how in-slot priority works interacts with player class weapon slots.

====Sister Weapon====
*'''sisterweapon'''
:Default = ""
:Defines a weapon that is also provided when this weapon is picked up. This is can be used either for [[doom_wiki:Tome of Power|Tome of Power]] variants, or for weapons with two different firing modes (used by Strife weapons).

====Flags====
*'''flags'''
:Default = ""
:This field controls a number of weapon info properties using bit flags, where each bit in the field stands for some effect, and has the value of being either on or off. See the [[Weapon info flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''addflags'''
:Default = ""
:This field specifies a combined list of flags to be added to the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned on" in the weapon. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance.
*'''remflags'''
:Default = ""
:This field specifies a combined list of flags to be subtracted from the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned off" in the weapon, as if they had never been listed. If flags are listed here which are not already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance. This field will be applied AFTER the addflags field is applied, so it could potentially turn off flags turned on by that field.

====Damage Properties====
*'''mod'''
:Default = UNKNOWN (0)
:Originally standing for "Means of Death", this field allows you to associate a '''[[damagetype]]''' to the weapon info (though this property needs to be applied to projectiles for non-hitscan weapons). Then, you'll be able to make thing types resistant to the given damage type by using the thingtype '''damagefactor''' field. You can give them specific pain or death states as well. This property also have the role in multiplayer to specify what obituaries are shown depending on which weapon the player uses.
:The mnemonics were initially hard-coded, but are now available inside ''base\things.edf'' as '''damagetype''' blocks. Notice that the default damage types (means of death) have been differentiated for each player attack, as well as for the various slime types and whatnot, so as to have the obituaries differentiated.

====Recoil & Haptics Properties====
*'''recoil'''
:Default = 0.0
:This field specifies a combined list of flags to be added to the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned on" in the weapon. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance.

EDF weapon reference

2018-04-10T15:31:45Z

Altazimuth: Remove the User:Altazimuth from the Weapon info flags reference.

Weapon info define weapons, simple as. They have unique names, or mnemonics, for easy identification. They're currently referenced solely by weapongivers (see [[EDF item effects and inventory]] for more info on those).

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

New objects, created via EDF files or wad lumps, can be later tweaked with weapon deltas. New weapon info should not be given a '''dehackednum''' property, as this is reserved solely for internal weapons so that mods that modify weapons with DeHackEd (BEX) patches remain compatible with Eternity.

{{See|Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>
ammotype2 <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>
attackstate2 <frame>
flashstate2 <frame>
holdstate2 <frame>

ammouse <number>
ammouse2 <number>

selectionorder <number>
slotnumber <number>
slotselectionorder <floating-point number>

sisterweapon <weapon info mnemonic>

flags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this weapon accessible from other weapon info. Default games' (Doom, Heretic) weapon info use externalized frames for all weapon info, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other weaponinfo, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like weapon (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[ReFire|A_ReFire]] if the player is still holding the primary attack button.
*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

====Selection Order and Weapon Slots====
*'''selectionorder'''
:Default = -1
:Sets the priority for selection of the weapon. The lower the number, the higher its priority.
*'''slotnumber'''
:Default = -1
:Sets the weapon slot that the weapon occupies in the global weapon slots structure. For assigning to player class weapon slots, read [[weapon slots]].
*'''slotselectionorder'''
:Default = -1.0
:Sets the in-slot priority for the weapon in the global weapon slots structure. The lower the number, the higher its priority. Read [[weapon slots]] if you wish to understand the specifics of how in-slot priority works interacts with player class weapon slots.

====Sister Weapon====
*'''sisterweapon'''
:Default = ""
:Defines a weapon that is also provided when this weapon is picked up. This is can be used either for [[doom_wiki:Tome of Power|Tome of Power]] variants, or for weapons with two different firing modes (used by Strife weapons).

====Flags====
*'''flags'''
:Default = ""
:This field controls a number of weapon info properties using bit flags, where each bit in the field stands for some effect, and has the value of being either on or off. See the [[Weapon info flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''addflags'''
:Default = ""
:This field specifies a combined list of flags to be added to the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned on" in the weapon. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance.
*'''remflags'''
:Default = ""
:This field specifies a combined list of flags to be subtracted from the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned off" in the weapon, as if they had never been listed. If flags are listed here which are not already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance. This field will be applied AFTER the addflags field is applied, so it could potentially turn off flags turned on by that field.

EDF item effects and inventory

2018-04-10T15:08:13Z

Altazimuth: Parenthesise example.

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:

===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
useaction <action function> // codepointer and arguments called (e.g. A_GauntletAttack(1))

[+-]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
[+-]noshareware // if +, non-shareware

// 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)
[+-]additive // if +, adds to the current amount of armor
[+-]setabsorption // if +, sets absorption values (savefactor & savedivisor)
}
===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
// Note that you can specify as many ammogiven properties as you want in a single weapongiver
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.
}

EDF item effects and inventory

2018-04-10T15:07:40Z

Altazimuth: Update page to use info from EDF_item_effects_and_inventory/Weapons-branch.

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:

===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
useaction <action function> // codepointer and arguments called e.g. A_GauntletAttack(1)

[+-]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
[+-]noshareware // if +, non-shareware

// 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)
[+-]additive // if +, adds to the current amount of armor
[+-]setabsorption // if +, sets absorption values (savefactor & savedivisor)
}
===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
// Note that you can specify as many ammogiven properties as you want in a single weapongiver
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.
}

EDF item effects and inventory/Weapons-branch

2018-04-10T14:59:35Z

Altazimuth: Update all item effects to reflect current item effects and inventory properties. Remove warning.

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
useaction <action function> // codepointer and arguments called e.g. A_GauntletAttack(1)

[+-]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
[+-]noshareware // if +, non-shareware

// 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)
[+-]additive // if +, adds to the current amount of armor
[+-]setabsorption // if +, sets absorption values (savefactor & savedivisor)
}
===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
// Note that you can specify as many ammogiven properties as you want in a single weapongiver
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.
}

User:Altazimuth

2018-04-10T14:45:31Z

Altazimuth: Update things I'm working on. Toot my own horn.

Howdy; I'm Altazimuth, though feel free to abbreviate it as you wish. I am a contributor to the [[Eternity Engine]], as well as a member of [[Team Eternity]]. When unable to contribute to the codebase I try to improve documentation and general article quality around here. My end goals are to assist in making modding for the Eternity Engine easier, improve its adoption, and make it a more complete and featureful engine.

Things I've done that I'm proud enough to list here:
* Complete [[inventory]] support.
* Add EDF pickup support.
* Add [[EDF weapon reference|EDF weapon]] support.
* Migrate Eternity to SDL2.
* Probably other stuff I'm forgetting.

Eternity-related things I'm working on:
* Improving documentation of features on this wiki ([[EDF]] tutorials and action specials in particular).
* Improving, or adding, Eternity [[UDMF]] support in SLADE3 and GZDoomBuilder.
* Bugfix, add in small quality-of-life changes.

User:Altazimuth/EDF weapon reference

2018-04-10T14:37:20Z

Altazimuth: Altazimuth moved page User:Altazimuth/EDF weapon reference to EDF weapon reference: The page is ready for general use.

#REDIRECT [[EDF weapon reference]]

EDF weapon reference

2018-04-10T14:37:20Z

Altazimuth: Altazimuth moved page User:Altazimuth/EDF weapon reference to EDF weapon reference: The page is ready for general use.

Weapon info define weapons, simple as. They have unique names, or mnemonics, for easy identification. They're currently referenced solely by weapongivers (see [[EDF item effects and inventory]] for more info on those).

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

New objects, created via EDF files or wad lumps, can be later tweaked with weapon deltas. New weapon info should not be given a '''dehackednum''' property, as this is reserved solely for internal weapons so that mods that modify weapons with DeHackEd (BEX) patches remain compatible with Eternity.

{{See|User:Altazimuth/Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>
ammotype2 <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>
attackstate2 <frame>
flashstate2 <frame>
holdstate2 <frame>

ammouse <number>
ammouse2 <number>

selectionorder <number>
slotnumber <number>
slotselectionorder <floating-point number>

sisterweapon <weapon info mnemonic>

flags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this weapon accessible from other weapon info. Default games' (Doom, Heretic) weapon info use externalized frames for all weapon info, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other weaponinfo, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like weapon (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[ReFire|A_ReFire]] if the player is still holding the primary attack button.
*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

====Selection Order and Weapon Slots====
*'''selectionorder'''
:Default = -1
:Sets the priority for selection of the weapon. The lower the number, the higher its priority.
*'''slotnumber'''
:Default = -1
:Sets the weapon slot that the weapon occupies in the global weapon slots structure. For assigning to player class weapon slots, read [[weapon slots]].
*'''slotselectionorder'''
:Default = -1.0
:Sets the in-slot priority for the weapon in the global weapon slots structure. The lower the number, the higher its priority. Read [[weapon slots]] if you wish to understand the specifics of how in-slot priority works interacts with player class weapon slots.

====Sister Weapon====
*'''sisterweapon'''
:Default = ""
:Defines a weapon that is also provided when this weapon is picked up. This is can be used either for [[doom_wiki:Tome of Power|Tome of Power]] variants, or for weapons with two different firing modes (used by Strife weapons).

====Flags====
*'''flags'''
:Default = ""
:This field controls a number of weapon info properties using bit flags, where each bit in the field stands for some effect, and has the value of being either on or off. See the [[Weapon info flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''addflags'''
:Default = ""
:This field specifies a combined list of flags to be added to the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned on" in the weapon. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance.
*'''remflags'''
:Default = ""
:This field specifies a combined list of flags to be subtracted from the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned off" in the weapon, as if they had never been listed. If flags are listed here which are not already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance. This field will be applied AFTER the addflags field is applied, so it could potentially turn off flags turned on by that field.

EDF weapon reference

2018-04-10T14:36:52Z

Altazimuth: Do initial spiel.

Weapon info define weapons, simple as. They have unique names, or mnemonics, for easy identification. They're currently referenced solely by weapongivers (see [[EDF item effects and inventory]] for more info on those).

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

New objects, created via EDF files or wad lumps, can be later tweaked with weapon deltas. New weapon info should not be given a '''dehackednum''' property, as this is reserved solely for internal weapons so that mods that modify weapons with DeHackEd (BEX) patches remain compatible with Eternity.

{{See|User:Altazimuth/Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>
ammotype2 <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>
attackstate2 <frame>
flashstate2 <frame>
holdstate2 <frame>

ammouse <number>
ammouse2 <number>

selectionorder <number>
slotnumber <number>
slotselectionorder <floating-point number>

sisterweapon <weapon info mnemonic>

flags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this weapon accessible from other weapon info. Default games' (Doom, Heretic) weapon info use externalized frames for all weapon info, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other weaponinfo, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like weapon (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[ReFire|A_ReFire]] if the player is still holding the primary attack button.
*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

====Selection Order and Weapon Slots====
*'''selectionorder'''
:Default = -1
:Sets the priority for selection of the weapon. The lower the number, the higher its priority.
*'''slotnumber'''
:Default = -1
:Sets the weapon slot that the weapon occupies in the global weapon slots structure. For assigning to player class weapon slots, read [[weapon slots]].
*'''slotselectionorder'''
:Default = -1.0
:Sets the in-slot priority for the weapon in the global weapon slots structure. The lower the number, the higher its priority. Read [[weapon slots]] if you wish to understand the specifics of how in-slot priority works interacts with player class weapon slots.

====Sister Weapon====
*'''sisterweapon'''
:Default = ""
:Defines a weapon that is also provided when this weapon is picked up. This is can be used either for [[doom_wiki:Tome of Power|Tome of Power]] variants, or for weapons with two different firing modes (used by Strife weapons).

====Flags====
*'''flags'''
:Default = ""
:This field controls a number of weapon info properties using bit flags, where each bit in the field stands for some effect, and has the value of being either on or off. See the [[Weapon info flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''addflags'''
:Default = ""
:This field specifies a combined list of flags to be added to the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned on" in the weapon. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance.
*'''remflags'''
:Default = ""
:This field specifies a combined list of flags to be subtracted from the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned off" in the weapon, as if they had never been listed. If flags are listed here which are not already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance. This field will be applied AFTER the addflags field is applied, so it could potentially turn off flags turned on by that field.

EDF weapon reference

2018-04-10T13:49:38Z

Altazimuth: Update EDF weapon reference to reflect current properties.

TODO: Initial spiel.

{{See|User:Altazimuth/Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>
ammotype2 <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>
attackstate2 <frame>
flashstate2 <frame>
holdstate2 <frame>

ammouse <number>
ammouse2 <number>

selectionorder <number>
slotnumber <number>
slotselectionorder <floating-point number>

sisterweapon <weapon info mnemonic>

flags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this weapon accessible from other weapon info. Default games' (Doom, Heretic) weapon info use externalized frames for all weapon info, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other weaponinfo, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like weapon (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[ReFire|A_ReFire]] if the player is still holding the primary attack button.
*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

====Selection Order and Weapon Slots====
*'''selectionorder'''
:Default = -1
:Sets the priority for selection of the weapon. The lower the number, the higher its priority.
*'''slotnumber'''
:Default = -1
:Sets the weapon slot that the weapon occupies in the global weapon slots structure. For assigning to player class weapon slots, read [[weapon slots]].
*'''slotselectionorder'''
:Default = -1.0
:Sets the in-slot priority for the weapon in the global weapon slots structure. The lower the number, the higher its priority. Read [[weapon slots]] if you wish to understand the specifics of how in-slot priority works interacts with player class weapon slots.

====Sister Weapon====
*'''sisterweapon'''
:Default = ""
:Defines a weapon that is also provided when this weapon is picked up. This is can be used either for [[doom_wiki:Tome of Power|Tome of Power]] variants, or for weapons with two different firing modes (used by Strife weapons).

====Flags====
*'''flags'''
:Default = ""
:This field controls a number of weapon info properties using bit flags, where each bit in the field stands for some effect, and has the value of being either on or off. See the [[Weapon info flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''addflags'''
:Default = ""
:This field specifies a combined list of flags to be added to the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned on" in the weapon. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance.
*'''remflags'''
:Default = ""
:This field specifies a combined list of flags to be subtracted from the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned off" in the weapon, as if they had never been listed. If flags are listed here which are not already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance. This field will be applied AFTER the addflags field is applied, so it could potentially turn off flags turned on by that field.

Creating a pickup

2018-01-28T19:05:03Z

Altazimuth: Modify doomednum for weapon section.

Creating a pickup

2018-01-28T18:42:30Z

Altazimuth: Add weapon section.

Creating a pickup

2018-01-25T19:19:40Z

Altazimuth: Add disclaimer and ammo section.

Creating a pickup

2018-01-25T16:22:39Z

Altazimuth: Add armor section. Improve health section.

Creating a pickup

2018-01-24T22:23:39Z

Altazimuth: Add health section.

Creating a pickup

2018-01-24T13:47:22Z

Altazimuth: Add initial skeleton for tutorial.

User:Altazimuth/EDF animation and switches

2018-01-12T19:44:36Z

Altazimuth: Fix a mistake in syntax.

TODO: Initial spiel.

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

{{Backto|EDF}}

==Syntax==
animation <unique name>
{
flat <string>
wall <string>
lastpic <string>
tics <number>

flags <flag list>
pic {num <number> tics <number> random {<number>, <number>} flags <flag list>}
}
===Explanation of fields===
====ID / Type Info====
*'''flat'''
:Default = ""
:Lorem ipsum and stuff.
*'''wall'''
:Default = ""
:Lorem ipsum and stuff.
*'''lastpic'''
:Default = ""
:Lorem ipsum and stuff.
*'''tics'''
:Default = 8
:Lorem ipsum and stuff.
*'''flags'''
:Default = ""
:Lorem ipsum and stuff.
====Pic(?) Sub-Block====
*'''pic'''
:Default = (nothing)
:Lorem ipsum and stuff.
pic { name F_FOO; tics 8; random {4, 12}; flags SWIRL }
TODO: Talk here, fix above.

[[category:EDF]]

User:Altazimuth/EDF animation and switches

2018-01-12T19:40:29Z

Altazimuth: Put in initial framework for animation reference, ready for adding switches

TODO: Initial spiel.

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

{{Backto|EDF}}

==Syntax==
animation <unique name>
{
flat <string>
wall <string>
lastpic <string>
tics <number>

flags <flag list>
pic {num <number> tics <number> random {min <number> max <number>} flags <flag list>}
}
===Explanation of fields===
====ID / Type Info====
*'''flat'''
:Default = ""
:Lorem ipsum and stuff.
*'''wall'''
:Default = ""
:Lorem ipsum and stuff.
*'''lastpic'''
:Default = ""
:Lorem ipsum and stuff.
*'''tics'''
:Default = 8
:Lorem ipsum and stuff.
*'''flags'''
:Default = ""
:Lorem ipsum and stuff.
====Pic(?) Sub-Block====
*'''pic'''
:Default = (nothing)
:Lorem ipsum and stuff.
pic { name F_FOO; tics 8; random {4, 12}; flags SWIRL }
TODO: Talk here, fix above.

[[category:EDF]]

EDF weapon reference

2018-01-08T23:43:20Z

Altazimuth: Fix lazy copy-paste from EDF thing reference.

TODO: Initial spiel.

{{See|User:Altazimuth/Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>
ammotype2 <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>
attackstate2 <frame>
flashstate2 <frame>
holdstate2 <frame>

ammouse <number>
ammouse2 <number>

selectionorder <number>
nextincycle <weapon info mnemonic>
previncycle <weapon info mnemonic>

flags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this weapon accessible from other weapon info. Default games' (Doom, Heretic) weapon info use externalized frames for all weapon info, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other weaponinfo, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like weapon (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[ReFire|A_ReFire]] if the player is still holding the primary attack button.
*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

====Selection Order and Cycles====
*'''selectionorder'''
:Default = -1
:Sets the priority for selection of the weapon. The lower the number, the higher its priority.
*'''nextincycle'''
:Default = ""
:Sets the weapon moved to when the player inputs the "next weapon" command.
*'''previncycle'''
:Default = ""
:Sets the weapon moved to when the player inputs the "previous weapon" command.

====Flags====
*'''flags'''
:Default = ""
:This field controls a number of weapon info properties using bit flags, where each bit in the field stands for some effect, and has the value of being either on or off. See the [[Weapon info flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''addflags'''
:Default = ""
:This field specifies a combined list of flags to be added to the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned on" in the weapon. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance.
*'''remflags'''
:Default = ""
:This field specifies a combined list of flags to be subtracted from the weapon's existing flags values (this works the same as the flags field above). Flags in this list are "turned off" in the weapon, as if they had never been listed. If flags are listed here which are not already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance. This field will be applied AFTER the addflags field is applied, so it could potentially turn off flags turned on by that field.

EDF weapon reference

2018-01-08T23:28:40Z

Altazimuth: Update to include documentation of more fields.

TODO: Initial spiel.

{{See|User:Altazimuth/Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>
ammotype2 <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>
attackstate2 <frame>
flashstate2 <frame>
holdstate2 <frame>

ammouse <number>
ammouse2 <number>

selectionorder <number>
nextincycle <weapon info mnemonic>
previncycle <weapon info mnemonic>

flags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this weapon accessible from other weapon info. Default games' (Doom, Heretic) weapon info use externalized frames for all weapon info, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other weaponinfo, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like weapon (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[ReFire|A_ReFire]] if the player is still holding the primary attack button.
*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

====Selection Order and Cycles====
*'''selectionorder'''
:Default = -1
:Sets the priority for selection of the weapon. The lower the number, the higher its priority.
*'''nextincycle'''
:Default = ""
:Sets the weapon moved to when the player inputs the "next weapon" command.
*'''previncycle'''
:Default = ""
:Sets the weapon moved to when the player inputs the "previous weapon" command.

====Flags====
*'''flags'''
:Default = ""
:This field controls a number of weapon info properties using bit flags, where each bit in the field stands for some effect, and has the value of being either on or off. See the [[Weapon info flags]] List, for the values which can be used in this field. Remember that if whitespace or disallowed characters are used, this field's value must be enclosed in quotation marks.
*'''addflags'''
:Default = ""
:This field specifies a combined list of flags to be added to the weapon's existing flags values (this works the same as the cflags field above). Flags in this list are "turned on" in the weapon. If flags are listed here which are already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance.
*'''remflags'''
:Default = ""
:This field specifies a combined list of flags to be subtracted from the weapon's existing flags values (this works the same as the cflags field above). Flags in this list are "turned off" in the weapon, as if they had never been listed. If flags are listed here which are not already "on," there is no effect on those flags. This field is most useful within weapondelta sections and in concert with weapon info inheritance. This field will be applied AFTER the addflags field is applied, so it could potentially turn off flags turned on by that field.

EDF weapon reference

2017-10-27T10:52:29Z

Altazimuth: Update properties.

EDF item effects and inventory

2017-08-13T16:43:27Z

Altazimuth: Add link to the in-progress sub-page.

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

For information on progress in current development, see [[EDF item effects and inventory/Weapons-branch|weapons-branch]].

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:37:31Z

Altazimuth: Add BackTo template; improve English; update artifact properties

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

EDF item effects and inventory/Weapons-branch

2017-08-13T16:26:02Z

Altazimuth: Make subpage to contain in-dev stuff, so that it's ready to be made the official documentation as soon as necessary.

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

EDF weapon reference

2017-07-11T13:46:52Z

Altazimuth: Fix link to A_ReFire page.

TODO: Initial spiel.

{{See|User:Altazimuth/Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>

ammouse <number>

nextincycle <weapon info mnemonic>
previncycle <weapon info mnemonic>

cflags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

tracker <string, TO BE REMOVED>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this thing accessible from other thing types. Default games' (Doom, Heretic) thing types use externalized frames for all thing types, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other thingtypes, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a thing starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[ReFire|A_ReFire]] if the player is still holding the primary attack button.

*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

EDF weapon reference

2017-07-11T13:32:49Z

Altazimuth: Add holdstate to Syntax list of properties.

TODO: Initial spiel.

{{See|User:Altazimuth/Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>
holdstate <frame>

ammouse <number>

nextincycle <weapon info mnemonic>
previncycle <weapon info mnemonic>

cflags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

tracker <string, TO BE REMOVED>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this thing accessible from other thing types. Default games' (Doom, Heretic) thing types use externalized frames for all thing types, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other thingtypes, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a thing starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[A_ReFire]] if the player is still holding the primary attack button.

*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.

EDF weapon reference

2017-07-11T13:31:35Z

Altazimuth: Add ID and state parameters.

TODO: Initial spiel.

{{See|User:Altazimuth/Weapon info flags}}
{{Backto|EDF}}

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

==Syntax==
weaponinfo <unique name> [: <parent type> [, <dehackednum>]]
{
dehackednum <unique number>
inherits <weaponinfo>

ammotype <artifact mnemonic>

upstate <frame>
downstate <frame>
readystate <frame>
attackstate <frame>
flashstate <frame>

ammouse <number>

nextincycle <weapon info mnemonic>
previncycle <weapon info mnemonic>

cflags <flag list>
addflags <flag list>
remflags <flag list>

mod <MOD name OR number>

recoil <number>
hapticrecoil <number>
haptictime <number>

upsound <sound>
readysound <sound>

tracker <string, TO BE REMOVED>

firstdecoratestate <frame>
states <[[DECORATE state syntax]] heredoc>
}
===Explanation of fields===
====ID / Type Info====
*'''dehackednum'''
:Default = -1
:Fake array index number, for Dehacked patch (BEX or DEH file) compatibility. It has to be an unique number if not -1. Safe numbers are from 10000 up.
*'''inherits'''
:Default = (nothing)
:Sets the weapon info from which this will copy properties. All of the properties except '''dehackednum''' will be copied from the base actor type.

====States====
*'''firstdecoratestate'''
:Sets the first frame in a sequential list of dummy frames that use the internal Decorate-style defined '''states''' of this actor for [[EDF delta structures|framedelta]] compatibility. It's not required unless the intention is to make the Decorate states of this thing accessible from other thing types. Default games' (Doom, Heretic) thing types use externalized frames for all thing types, for compatibility.
*'''states'''
{{see|DECORATE state syntax}}
:Default = nothing
:Defines frames using [http://zdoom.org/wiki/DECORATE DECORATE]-style state definitions. This means it won't be necessary to define separate [[frame]] blocks for each individual frame. See the DECORATE reference at the ZDoom wiki for documentation on its syntax. Using the '''states''' field instead of any of the ones below results in more concise text, but also the newly created frames won't be accessible from outside (other thingtypes, Dehacked patches or delta structures), unless you use the '''firstdecoratestate''' field as well. Like normally, [[List of codepointers|codepointers]] may or may not be preceded by '''A_'''. The DECORATE code has to be implemented via a heredoc: a text string that spans on multiple lines. Unlike a regular string which uses quotation marks, the heredoc is marked by @" and "@ respectively. Example on an shotgun-like (the '=' sign is optional):
states =
@"
Ready:
SHTG A 1 A_WeaponReady
loop
Deselect:
SHTG A 1 A_Lower
loop
Select:
SHTG A 1 A_Raise
loop
Fire:
SHTG A 3
SHTG A 7 A_FireShotgun
SHTG BC 5
SHTG D 4
SHTG CB 5
SHTG A 3
SHTG A 7 A_ReFire
goto Ready
Flash:
SHTF A 4 Bright A_Light1
SHTF B 3 Bright A_Light2
goto LightDone
"@
*'''upstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is raised.If the object is supposed to have any dynamic purpose or be visible, do not leave the '''upstate''' at S_NULL.
*'''downstate'''
:Default = S_NULL
:Sets the frame which a weapon starts in when it is being lowered. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''downstate''' at S_NULL.
*'''readystate'''
:Default = S_NULL
:Sets the frame which a thing starts in when it is ready to be fired. If the object is supposed to have any dynamic purpose or be visible, do not leave the '''readystate''' at S_NULL.
*'''attackstate'''
:Default = S_NULL
:Sets the frame which a weapon goes to if the user tries to perform a primary attack. Though not necessary, it is suggested for weapons to have an attackstate for primary firing purposes.
*'''flashstate'''
:Default = S_NULL
:Sets the frame which a weapon jumps to if a [[List of codepointers|codepointer]] causes a weapon to flash.
*'''holdstate'''
:Default = S_NULL
:Sets the frame jumped to by [[A_ReFire]] if the player is still holding the primary attack button.

*'''attackstate2''', '''flashstate2''', '''holdstate2'''
:Default = S_NULL
: The equivalent of '''attackstate''', '''flashstate''', and '''holdstate''', but for alternate fire.