User:Altazimuth/EDF animation and switches - Revision history

Printz at 21:35, 16 March 2018

2018-03-16T21:35:51Z

← Older revision		Revision as of 17:35, 16 March 2018
Line 3:		Line 3:
	Eternity supports defining animations and switches through [[EDF]]. It also supports Hexen [[ANIMDEFS]] lumps with some ZDoom extensions, allowing cross-port mods to run on it. This article describes the EDF version. New Eternity features will be added in EDF in the future, while the ANIMDEFS lump support will be updated with the GZDoom-compatible features integrated into Eternity.		Eternity supports defining animations and switches through [[EDF]]. It also supports Hexen [[ANIMDEFS]] lumps with some ZDoom extensions, allowing cross-port mods to run on it. This article describes the EDF version. New Eternity features will be added in EDF in the future, while the ANIMDEFS lump support will be updated with the GZDoom-compatible features integrated into Eternity.

			{{Backto\|EDF}}

			==Animations==
	Animations in Eternity are of two types: Doom and Hexen. The Doom animations are similar to the ones from the binary [[ANIMATED]] lump, having a start and end texture in the sequence, whereas the Hexen animations (based on Hexen's ANIMDEFS definition) require you to specify each frame but allow finer control.		Animations in Eternity are of two types: Doom and Hexen. The Doom animations are similar to the ones from the binary [[ANIMATED]] lump, having a start and end texture in the sequence, whereas the Hexen animations (based on Hexen's ANIMDEFS definition) require you to specify each frame but allow finer control.

Line 9:		Line 12:
	Below are presented the two ways these animations can be defined in EDF.		Below are presented the two ways these animations can be defined in EDF.

	~~{{Backto\|EDF}}~~		===Doom animations===

	==Doom animations==

	===Syntax===		====Syntax====
	animation		animation
	{		{
Line 24:		Line 25:
	flags <flags>		flags <flags>
	}		}
	===Explanation===		====Explanation====
	An Doom '''animation''' must have either '''flat''' or '''wall''' defined (but not both or neither). The choice of the keyword decides whether the animation is designated for floor/ceiling textures ('''flat''') or '''wall''' textures. Unlike vanilla Doom and Boom, Eternity normally allows you to interchange walls and flats, but this distinction is still useful if there are flats with the same name as wall textures. Most notably, the default Doom IWADs have STEP1 and STEP2 defined for both kinds of surfaces.		An Doom '''animation''' must have either '''flat''' or '''wall''' defined (but not both or neither). The choice of the keyword decides whether the animation is designated for floor/ceiling textures ('''flat''') or '''wall''' textures. Unlike vanilla Doom and Boom, Eternity normally allows you to interchange walls and flats, but this distinction is still useful if there are flats with the same name as wall textures. Most notably, the default Doom IWADs have STEP1 and STEP2 defined for both kinds of surfaces.

Line 31:		Line 32:
	'''Flags''' is optional and can only be '''SWIRL'''. When set, this causes the texture to spin like a liquid, using the effect introduced in [[SMMU]]. If you set '''SWIRL''', then '''lastpic''' and '''tics''' become optional, but you can also combine them. This is unlike the ANIMATED lump, which doesn't allow swirling textures to be combined with frame animations.		'''Flags''' is optional and can only be '''SWIRL'''. When set, this causes the texture to spin like a liquid, using the effect introduced in [[SMMU]]. If you set '''SWIRL''', then '''lastpic''' and '''tics''' become optional, but you can also combine them. This is unlike the ANIMATED lump, which doesn't allow swirling textures to be combined with frame animations.

	===Examples===		====Examples====
	animation { flat WATER1 lastpic WATER8 tics 4 flags SWIRL } // swirling fast-rippling water		animation { flat WATER1 lastpic WATER8 tics 4 flags SWIRL } // swirling fast-rippling water
	animation { wall WATRFAL1 lastpic WATRFAL4 tics 16 } // slow wall waterfall		animation { wall WATRFAL1 lastpic WATRFAL4 tics 16 } // slow wall waterfall
Line 40:		Line 41:
	successfully modifies the ANIMATED nukage animation by giving it the swirling effect. The frame animation is preserved. To remove it, and keep only NUKAGE1 showing up, be sure to add "tics 0" in the definition.		successfully modifies the ANIMATED nukage animation by giving it the swirling effect. The frame animation is preserved. To remove it, and keep only NUKAGE1 showing up, be sure to add "tics 0" in the definition.

	==Hexen animations==		===Hexen animations===

	===Syntax===		====Syntax====
	animation		animation
	{		{
Line 56:		Line 57:
	}		}

	===Explanation===		====Explanation====
	For Hexen animations, '''flat''' or '''wall''' is still required, having the same role as in Doom animations. The actual animation however is defined by the several '''pic''' entries. Defining '''flat''' or '''wall''' is required because, unlike Doom animations which always define ranges, Hexen animations require the exact '''flat''' or '''wall''' texture to be applied in the map editor for the sector or sidedef to animate.		For Hexen animations, '''flat''' or '''wall''' is still required, having the same role as in Doom animations. The actual animation however is defined by the several '''pic''' entries. Defining '''flat''' or '''wall''' is required because, unlike Doom animations which always define ranges, Hexen animations require the exact '''flat''' or '''wall''' texture to be applied in the map editor for the sector or sidedef to animate.

Line 63:		Line 64:
	'''Flags''' is also supported for Hexen animations and once again it can only be '''SWIRL''' if specified. It can be applied globally to the animation or locally per '''pic'''.		'''Flags''' is also supported for Hexen animations and once again it can only be '''SWIRL''' if specified. It can be applied globally to the animation or locally per '''pic'''.

	===Examples===		====Examples====
	animation // Water with random duration frames		animation // Water with random duration frames
	{		{
Line 89:		Line 90:
	pic { name 2 }		pic { name 2 }
	}		}

			==Switches==

			Switches can be defined in EDF. You can also define switches with [[ANIMDEFS]] or [[SWITCHES]], but any new Eternity features will be added in EDF as they get developed.

			They have the following syntax:
			switch <name>
			{
			on <texture>
			sound <mnemonic>
			offsound <mnemonic>
			gameindex <number>
			}
			===Explanation of fields===
			The '''name''' field is the "off" texture of the switch, and is also used to identify the entry. Usually in Doom it has a name starting with SW1, like "SW1LION" in original Doom. The '''on''' field is the activated texture, starting in Doom usually with SW2, like SW2LION.

			You can also give sounds to switches. The '''sound''' field, if specified, lets you set a custom sound to a switch. In addition, you can set '''offsound''' if you want an alternate sound to go from the '''on''' texture back to the '''name''' texture.

			'''Gameindex''' is a compatibility setting from [[SWITCHES]] which declares if the switch is available for Doom shareware, Doom registered or Doom commercial. Not meaningful for mods, so you can ignore it.

			===Example===
			switch SW1LEVER { on SW2LEVER sound clank offsound lvreset }


	[[category:EDF]]		[[category:EDF]]

Printz: Updated

2018-03-16T20:34:57Z

Updated

@@ Line 1: / Line 1: @@
 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.
+Eternity supports defining animations and switches through [[EDF]]. It also supports Hexen [[ANIMDEFS]] lumps with some ZDoom extensions, allowing cross-port mods to run on it. This article describes the EDF version. New Eternity features will be added in EDF in the future, while the ANIMDEFS lump support will be updated with the GZDoom-compatible features integrated into Eternity.
 {{Backto|EDF}}
-==Syntax==
+==Doom animations==
-  animation <unique name>
+  {
-    flat    <string>
+   // One of the following:
-    wall    <string>
+    flat <name>
-    lastpic <string>
+    wall <name>
-    tics    <number>
+    lastpic <name>
-    flags   <flag list>
+    tics <number>
-   pic     {num <number> tics <number> random {<number>, <number>} flags <flag list>}
+    flags <flags>
+  }
-===Explanation of fields===
+===Explanation===
-====ID / Type Info====
+An Doom '''animation''' must have either '''flat''' or '''wall''' defined (but not both or neither). The choice of the keyword decides whether the animation is designated for floor/ceiling textures ('''flat''') or '''wall''' textures. Unlike vanilla Doom and Boom, Eternity normally allows you to interchange walls and flats, but this distinction is still useful if there are flats with the same name as wall textures. Most notably, the default Doom IWADs have STEP1 and STEP2 defined for both kinds of surfaces.
 [[category:EDF]]

Altazimuth: Fix a mistake in syntax.

2018-01-12T19:44:36Z

Fix a mistake in syntax.

← Older revision		Revision as of 15:44, 12 January 2018
Line 14:		Line 14:

	flags <flag list>		flags <flag list>
	pic {num <number> tics <number> random {~~min~~ <number> ~~max~~ <number>} flags <flag list>}		pic {num <number> tics <number> random {<number>, <number>} flags <flag list>}
	}		}
	===Explanation of fields===		===Explanation of fields===

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

2018-01-12T19:40:29Z

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

New page

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