EDF - Revision history

Printz at 06:05, 30 April 2018

2018-04-30T06:05:20Z

Gio: Color update

2013-12-09T21:52:02Z

Color update

← Older revision		Revision as of 17:52, 9 December 2013
Line 48:		Line 48:
	* \" : Literal ", necessary to use in double-quoted strings only		* \" : Literal ", necessary to use in double-quoted strings only
	* \' : Literal ', necessary to use in single-quoted strings only		* \' : Literal ', necessary to use in single-quoted strings only
	* \~~0 : Null character~~		* \x80 : Changes text color to "brick" range where supported.
	* \K : Changes text color to "brick" range where supported.		* \x81 : Changes text color to "tan" range where supported.
	* \1 : Changes text color to "tan" range where supported.		* \x82 : Changes text color to "gray" range where supported.
	* \2 : Changes text color to "gray" range where supported.		* \x83 : Changes text color to "green" range where supported.
	* \3 : Changes text color to "green" range where supported.		* \x84 : Changes text color to "brown" range where supported.
	* \4 : Changes text color to "brown" range where supported.		* \x85 : Changes text color to "gold" range where supported.
	* \5 : Changes text color to "gold" range where supported.		* \x86 : Changes text color to "red" range where supported.
	* \6 : Changes text color to "red" range where supported.		* \x87 : Changes text color to "blue" range where supported.
	* \7 : Changes text color to "blue" range where supported.		* \x88 : Changes text color to "orange" range where supported.
	* \8 : Changes text color to "orange" range where supported.		* \x89 : Changes text color to "yellow" range where supported.
	* \9 : Changes text color to "yellow" range where supported.		* \x8a : Changes text color to CUSTOM COLOR 1.
	* \N : Changes text color to gamemode "normal" range where supported.		* \x8b : Changes text color to CUSTOM COLOR 2.
	* \H : Changes text color to gamemode "hilite" range where supported.		* \x8c : Changes text color to CUSTOM COLOR 3.
	* \E : Changes text color to gamemode "error" range where supported.		* \x8d : Changes text color to CUSTOM COLOR 4.
	* \S : Toggles text shadowing where supported.		* \xfa : Changes text color to "translucent" where supported.
	* \C : Toggles absolute centering of text where supported.		* \xfb : Changes text color to gamemode "normal" range where supported.
			* \xfc : Changes text color to gamemode "hilite" range where supported.
			* \xfd : Changes text color to gamemode "error" range where supported.
			* \xfe : Toggles text shadowing where supported.
			* \xff : Toggles absolute centering of text where supported.

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

Printz at 08:39, 9 March 2012

2012-03-09T08:39:41Z

← Older revision		Revision as of 04:39, 9 March 2012
Line 2:		Line 2:

	{{Backto\|Eternity Engine}}		{{Backto\|Eternity Engine}}
			{{editref}}
	==Syntax==		==Syntax==
	===EDF is Free-form===		===EDF is Free-form===

Printz: /* Default fallbacks */

2012-03-04T16:09:59Z

Default fallbacks

← Older revision		Revision as of 12:09, 4 March 2012
Line 201:		Line 201:
	* user.edf -- optional user-defined EDF file which may contain any definitions		* user.edf -- optional user-defined EDF file which may contain any definitions
	===Default fallbacks===		===Default fallbacks===
	As of 3.37.00, default fallback no longer exists.		As of 3.39.20, default fallback no longer exists.

	===Lumps besides EDFROOT that are automatically loaded===		===Lumps besides EDFROOT that are automatically loaded===

Printz: /* Default fallbacks */

2012-03-04T16:09:19Z

Default fallbacks

← Older revision		Revision as of 12:09, 4 March 2012
Line 201:		Line 201:
	* user.edf -- optional user-defined EDF file which may contain any definitions		* user.edf -- optional user-defined EDF file which may contain any definitions
	===Default fallbacks===		===Default fallbacks===
	~~Default~~ fallback no longer exists.		As of 3.37.00, default fallback no longer exists.

	===Lumps besides EDFROOT that are automatically loaded===		===Lumps besides EDFROOT that are automatically loaded===

Printz: /* Default fallbacks */

2012-03-04T16:09:08Z

Default fallbacks

← Older revision		Revision as of 12:09, 4 March 2012
Line 201:		Line 201:
	* user.edf -- optional user-defined EDF file which may contain any definitions		* user.edf -- optional user-defined EDF file which may contain any definitions
	===Default fallbacks===		===Default fallbacks===
	As a failsafe to allow old EDF modifications to continue working, EDF is now capable of loading default modules individually when it determines there are zero definitions of certain sections. The following modules will be loaded as fallbacks when the given conditions are met:		Default fallback no longer exists.
	*sprites.edf -- Loaded when zero sprite names are defined. Note that even if pickup items are defined by the user EDF, they will be overridden by the pickup items defined in sprites.edf.
	*sounds.edf -- Loaded when zero sounds are defined.
	*things.edf -- Loaded when zero thingtypes are defined.
	* frames.edf -- Loaded when zero frames are defined.
	*cast.edf -- Loaded when zero cast members are defined.
	* terrain.edf -- Loaded when zero splash, terrain, and floor objects are defined.
	~~Note that misc.edf cannot currently be used as a~~ fallback. Also, this functionality is NOT meant to allow users to neglect including the minimum required number of sections. This functionality is only intended to preserve maximum backward compatibility with old EDF modifications. Relying on fallback behavior in new EDFs may have unexpected results, including possibly having your new definitions ignored.

	~~As mentioned earlier, to prevent default terrain loading, it will be necessary to define at least one splash, terrain, or floor object in the root EDF or ETERRAIN lump.~~

	~~If the engine-default EDF files cannot be found or parsed for any reason, EDF processing will cease immediately~~.

	===Lumps besides EDFROOT that are automatically loaded===		===Lumps besides EDFROOT that are automatically loaded===

Printz at 19:49, 3 March 2012

2012-03-03T19:49:41Z

← Older revision		Revision as of 15:49, 3 March 2012
Line 1:		Line 1:
	'''EDF''', Eternity Definition File, is a language used to define and modify monsters, decorations, sounds, text strings, menus, terrain types, and other data in Eternity Engine.		'''EDF''', Eternity Definition File, is a language used to define and modify monsters, decorations, sounds, text strings, menus, terrain types, and other data in Eternity Engine.

			{{Backto\|Eternity Engine}}

	==Syntax==		==Syntax==

Printz at 19:05, 3 March 2012

2012-03-03T19:05:13Z

← Older revision		Revision as of 15:05, 3 March 2012
Line 343:		Line 343:
	==Editing Reference==		==Editing Reference==
	{{EDF_REF}}		{{EDF_REF}}
			[[category:EDF]]

Printz at 18:59, 3 March 2012

2012-03-03T18:59:58Z

← Older revision		Revision as of 14:59, 3 March 2012
Line 236:		Line 236:

	The number of EDF warnings that happen will be reported unconditionally. To see the actual warning messages on the system console (as well as in the verbose log where they will always appear unconditionally), use the -edf-show-warnings parameter.		The number of EDF warnings that happen will be reported unconditionally. To see the actual warning messages on the system console (as well as in the verbose log where they will always appear unconditionally), use the -edf-show-warnings parameter.

			==Enable Functions==
			Starting with EDF 1.2, special functions are provided which allow the user to enable or disable options within the EDF parser. The primary use for these functions is to instruct the parser to skip definitions for game modes other than the one currently being played. Although all the thing, frame, sound, and sprite definitions will not conflict and can be loaded with each other, most of the time this is unnecessary and requires a significant amount of memory which will never be used. Allowing such definitions to be discarded during parsing speeds up processing and reduces memory usage. Note that all of these functions are only valid at the topmost level of an EDF file, and not within definitions.

			Enable Functions

			====enable(<option>) ====

			This function enables the provided option from the point of its call onward. If the option is already enabled, no change takes place. If an invalid option name is provided, an error will occur.

			====disable(<option>) ====

			This function disables the provided option from the point of its call onward. If the option is already disabled, no change takes place. If an invalid option name is provided, an error will occur.

			====ifenabled(<option>, ...) ====

			This function tests if the the provided option is enabled. If so, nothing will change. Otherwise, the EDF parser will be instructed to skip forward until it finds an endif function (see below). The endif function will then be invoked. If the option provided is invalid, an error will occur. Note that ifenabled/endif pairs cannot be nested.

			As of EDF 1.5, it is possible to provide any number of valid enable options to this function. In the case that more than one enable option is provided, all specified options must be enabled or the section will be skipped.

			====ifenabledany(<option>, ...) ====

			New to EDF 1.5, this function tests if any of the provided options are enabled. If any are, nothing will change. Otherwise, parsing will skip to the next endif function.

			====ifdisabled(<option>, ...) ====

			New to EDF 1.5, this function tests if all of the provided options are disabled. If all options are disabled, nothing will change. Otherwise, parsing will skip to the next endif function.

			====ifdisabledany(<option>, ...) ====

			New to EDF 1.5, this function tests if any of the provided options are disabled. If any of the options are disabled, nothing will change. Otherwise, parsing will skip to the next endif function.

			====endif() ====

			This function marks the end of a section of the file started by an ifenabled, ifenabledany, ifdisabled, ifdisabledany, ifgametype, or ifngametype call.

			When any of the aforementioned functions tests an option or value that is not enabled or is set to a different value, the parser will look for this function and then call it. This function will cause the parser to start recognizing definitions again from its line onward. If this function does not appear after one of the mentioned functions and before the end of the current file, a "missing conditional function" error will occur.

			Available Options
			====DOOM ====

			When this option is enabled, DOOM thing, frame, state, and sound definitions will be available. This variable is enabled by default for all user EDFs, but is disabled if the game is loaded in Heretic mode and the default root.edf file in Eternity's directory is loaded.

			====HERETIC ====

			When this option is enabled, Heretic thing, frame, state, and sound definitions will be available. This variable is enabled by default for all user EDFs, but is disabled if the game is loaded in DOOM or DOOM II mode and the default root.edf in Eternity's directory is loaded.

			Notes on Game Mode Options:

			As mentioned in their descriptions, the DOOM and HERETIC options will be enabled by default when user EDF files are loaded. However, user EDF files can explicitly call the disable function to turn off one or both options before including any of Eternity's defaults. It is best to do this when you know you will not be using any of one of the game modes' definitions.

			Example:
			// this thing type is only available if HERETIC is enabled

			ifenabled(HERETIC)

			thingtype foo { spawnstate = S_FOO1 }

			endif()

			Note on command-line option "-edfenables": The -edfenables command-line option allows the user to override the default behavior explicitly and enable all gamemodes' definitions without adding an EDF file. This does not interfere with explicit usage of enable functions in user EDFs, but it does allow older DeHackEd patches and WADs which might assume Heretic definitions are available in DOOM or vice versa to work.

			==Gametype Functions==
			Starting with EDF 1.5, special functions are provided which allow the EDF parser to evaluate definitions conditionally depending on the actual type of game being played. This enables definitions which should only exist in one game type or another to be placed within a single EDF module without conflict or unnecessary waste of memory and processing time. Note that all of these functions are only valid at the topmost level of an EDF file, and not within definitions.

			Gametype Functions
			====ifgametype(<gametype>, ...) ====

			This function tests the active gametype against every gametype listed as a parameter. If the gametype matches any of the listed types, nothing will change. Otherwise, processing will skip to the next endif function.

			====ifngametype(<option>, ...) ====

			This function tests the active gametype against every gametype listed as a parameter. If the gametype matches none of the listed types, nothing will change. Otherwise, processing will skip to the next endif function.

			Gametype Values
			====DOOM ====

			This gametype is used for DOOM, Ultimate DOOM, DOOM II, and Final DOOM.

			====HERETIC ====

			This gametype is used for Heretic and Heretic: Shadow of the Serpent Riders.

			Notes on Gametype Values:

			Gametype values, like the rest of EDF, are case-insensitive. Only values listed above should be used with the gametype detection functions.

			Example:
			// this TerrainTypes floor is only available when Heretic is being played

			ifgametype(HERETIC)

			floor { flat = FLATHUH1; terrain = Lava }

			endif()

	==Tutorials==		==Tutorials==

Printz: /* Verbose EDF logging */

2012-03-03T18:52:44Z

Verbose EDF logging

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

			The number of EDF warnings that happen will be reported unconditionally. To see the actual warning messages on the system console (as well as in the verbose log where they will always appear unconditionally), use the -edf-show-warnings parameter.

	==Tutorials==		==Tutorials==