MAPINFO/Episode definition

From ZDoom Wiki
Jump to: navigation, search

An episode definition begins with the keyword "episode". You can also clear previous episodes by using the "clearepisodes" keyword. All an episode does is offer a choice when starting a new game; elements such as endgame text or picture are defined in a cluster. The Doom and Heretic episodes have therefore each a corresponding cluster definition. If there is only one episode, then the player will not be prompted to select it when starting a new game.

Episode commands

clearepisodes

This clears all previous episodes. This could be used if you wish to have fewer episodes than are originally present in the IWAD that you are using. It should be specified before any episode definitions and outside any other block.

episode <maplump> { properties }
episode <maplump> teaser <maplump> { properties }

Substitute the map name of the map that you want the episode to start on for <maplump>. <maplump> can be any lump in the WAD, as long as it is a valid map file. Instead of a map lump, you can also use &wt@01. Using this will make the episode start at the map using warptrans 1 as defined in MAPINFO.
You can also specify a second maplump with the teaser keyword as above to tell ZDoom what map to use if the first is unavailable. This is used by Strife to determine which map to start at based on whether you're playing the Strife demo or the full version. It has limited usage inside PWADs.

Episode properties

The following properties are supported within an episode definition:

  • name = "<nice name>"
This is the episode's name as text. If you do not provide a picname, then ZDoom will convert this name to a graphic for you. This value must be enclosed in quotation marks. If the given name starts with $, ZDoom will first try to interpret it as a keyword for the LANGUAGE lump.
  • lookup = "<keyword>"
Alternatively, instead of name, lookup can be used to go seek the name in a LANGUAGE lump.
  • picname = "<piclump>"
Replace <piclump> with the graphic lump that you wish to use on episode selection menu screen. If you specify an invalid lump, the invalid graphic image will be used. If you specify "", no graphic will be used. If you omit this property, then the name that you provided in name will be converted into a graphic and used instead.
  • key = "<key>"
This sets a shortcut key for the menu selection. Any key on the keyboard is valid.
  • remove
This removes the episode that has just been defined.
  • noskillmenu
Disables the skill menu for this episode. Instead it always starts on skill 3 (“Hurt me plenty” or equivalent). This is for WADs that implement skill selection by an introduction map.
  • optional
Indicates that this episode should only appear in the list if the map lump specified after the episode keyword is present in the loaded IWAD/PWAD(s). This is used for Ultimate Doom episode 4.
  • extended
Indicates that this episode should only appear in the list if the EXTENDED lump is present in a loaded WAD file. This is used for Heretic - Shadow of the Serpent Riders episodes 4 and 5.

Examples

Normal episode definition:

episode e1m1
{
   picname = "M_EPI1"
   key = "k"
}

Episode starting at map with Warptrans 1:

episode "&wt@01"
{
   name = "My cool episode"
   key = "m"
}