Difference between revisions of "MAPINFO/Map definition"

From ECWolf Wiki
(Block syntax)
m (Block properties: Looks like the forcetally setting was forgotten.)
 
(7 intermediate revisions by 2 users not shown)
Line 15: Line 15:
 
* <tt>bordertexture = "<texture>"</tt>
 
* <tt>bordertexture = "<texture>"</tt>
 
:Overrides the gameinfo border texture for this map.
 
:Overrides the gameinfo border texture for this map.
:Default: '''Undefined??'''
+
:Default: The border flat assigned in [[MAPINFO/Gameinfo definition|<tt>Gameinfo</tt>]].
* <tt>cluster = <positive number></tt>
+
* <tt>cluster = <positive integer></tt>
 
:Assigns the map to a [[MAPINFO/Cluster definition|cluster]].
 
:Assigns the map to a [[MAPINFO/Cluster definition|cluster]].
 
:Default: <tt>0</tt>
 
:Default: <tt>0</tt>
Line 24: Line 24:
 
* <tt>deathcam = <bool></tt>
 
* <tt>deathcam = <bool></tt>
 
:Enables the death cam with [[A_BossDeath]].
 
:Enables the death cam with [[A_BossDeath]].
:Default: <tt>false</tt>
+
:Default: <tt>false</tt> (Note: The Wolf3D MAPINFO sets this to true in the defaultmap.)
 
* <tt>defaultceiling = "<texture>"</tt>
 
* <tt>defaultceiling = "<texture>"</tt>
 
:Default ceiling texture to use when a map has a blank third plane.
 
:Default ceiling texture to use when a map has a blank third plane.
:Default: '''Undefined?'''
+
:Default: Undefined.  Something in the hierarchy should define this, otherwise the unknown texture will be displayed.
 
* <tt>defaultfloor = "<texture>"</tt>
 
* <tt>defaultfloor = "<texture>"</tt>
 
:Default floor texture to use when a map has a blank third plane.
 
:Default floor texture to use when a map has a blank third plane.
:Default: '''Undefined?'''
+
:Default: Undefined.  Something in the hierarchy should define this, otherwise the unknown texture will be displayed.
 
* <tt>ensureinventory = "<item>", ...</tt>
 
* <tt>ensureinventory = "<item>", ...</tt>
 
:Checks the players inventory and gives these items if they are lacking.
 
:Checks the players inventory and gives these items if they are lacking.
Line 40: Line 40:
 
:The floor number to show on the status bar.
 
:The floor number to show on the status bar.
 
:Default: <tt>1</tt>
 
:Default: <tt>1</tt>
 +
* <tt>forcetally = <bool></tt>
 +
:Run the normal intermission sequence even if levelbonus is set or during the victory sequence.
 +
:Default: <tt>false</tt>
 
* <tt>highscoresgraphic = "<picture>"</tt>
 
* <tt>highscoresgraphic = "<picture>"</tt>
 
:Small icon to display instead of the floor number on the high scores table.
 
:Small icon to display instead of the floor number on the high scores table.
Line 46: Line 49:
 
:Number of points to give for completing this level.
 
:Number of points to give for completing this level.
 
:Default: <tt>0</tt>
 
:Default: <tt>0</tt>
* <tt>levelnum = <number></tt>
+
* <tt>levelnum = <positive integer></tt>
 
:The level number which is used for warping. For MAPxy labels this number is automatically assigned.
 
:The level number which is used for warping. For MAPxy labels this number is automatically assigned.
 
:Default: <tt>0</tt>
 
:Default: <tt>0</tt>
Line 60: Line 63:
 
* <tt>[secret|victory]next = "<map>"</tt>
 
* <tt>[secret|victory]next = "<map>"</tt>
 
* <tt>[secret|victory]next = EndSequence, "<sequence>"</tt>
 
* <tt>[secret|victory]next = EndSequence, "<sequence>"</tt>
:Specifies which map to go to when the exit is activated. EndSequence will instead go to a [[MAPINFO/Intermission definition|intermission]] sequence. Secretnext is the same as next only applies to the secret exit.  Victorynext is likewise the same but is usually triggered by bosses which call the Exit_Victory special.
+
:Specifies which map to go to when the exit is activated. <tt>EndSequence</tt> will instead go to a [[MAPINFO/Intermission definition|intermission]] sequence. <tt>secretnext</tt> is the same as next only applies to the secret exit.  <tt>victorynext</tt> is likewise the same but is usually triggered by bosses which call the [[Action specials|<tt>Exit_Victory</tt>]] special.
 
:Default: '''Undefined?'''
 
:Default: '''Undefined?'''
 
* <tt>specialaction = "<actorclass>", "<special>"[, <arg0>[, <arg1>[, <arg2>[, <arg3>[, <arg4>]]]]]</tt>
 
* <tt>specialaction = "<actorclass>", "<special>"[, <arg0>[, <arg1>[, <arg2>[, <arg3>[, <arg4>]]]]]</tt>
 
:Gives a special action to be called by [[A_BossDeath]] when all of the specified type are dead.
 
:Gives a special action to be called by [[A_BossDeath]] when all of the specified type are dead.
 
:Default: No special action.
 
:Default: No special action.
 +
:'''NOTE:''' Multiple special actions can be defined.
 
* <tt>nointermission</tt>
 
* <tt>nointermission</tt>
 
:Disables the normal intermission screen and goes to the next level immediately.
 
:Disables the normal intermission screen and goes to the next level immediately.
Line 73: Line 77:
 
* <tt>translator = "<lump>"</tt>
 
* <tt>translator = "<lump>"</tt>
 
:Name of map translation lump.
 
:Name of map translation lump.
:Default: <tt>"$base"</tt> (use the default translator)
+
:Default: Whatever translator is defined in [[MAPINFO/Gameinfo definition|<tt>Gameinfo</tt>]]

Latest revision as of 14:55, 16 May 2021

A map definition sets properties for a specific map.

Block syntax

  • defaultmap { properties }
Sets the defaults that will be automatically used for all subsequent map definitions. It resets the default information so anything specified in previous defaultmap sections is lost.
  • adddefaultmap { properties }
Similar to defaultmap but keeps the existing defaultmap information and just adds to it.
Note: these properties are copied to future definitions, so changing the default map won't retroactively apply.
  • map "<maplump>" { properties }
  • map "<maplump>" "<mapname>" { properties }
  • map "<maplump>" lookup "<string>" { properties }
Defines a map block. It is recommended that the map be named through MAPINFO, but is not required. The lookup keyword will cause the string to be looked up in LANGUAGE.

Block properties

  • bordertexture = "<texture>"
Overrides the gameinfo border texture for this map.
Default: The border flat assigned in Gameinfo.
  • cluster = <positive integer>
Assigns the map to a cluster.
Default: 0
  • completionstring = "<string>"
Short message to display on the intermission screen instead of "Floor Completed".
Default: "Floor Completed"
  • deathcam = <bool>
Enables the death cam with A_BossDeath.
Default: false (Note: The Wolf3D MAPINFO sets this to true in the defaultmap.)
  • defaultceiling = "<texture>"
Default ceiling texture to use when a map has a blank third plane.
Default: Undefined. Something in the hierarchy should define this, otherwise the unknown texture will be displayed.
  • defaultfloor = "<texture>"
Default floor texture to use when a map has a blank third plane.
Default: Undefined. Something in the hierarchy should define this, otherwise the unknown texture will be displayed.
  • ensureinventory = "<item>", ...
Checks the players inventory and gives these items if they are lacking.
Default: No items are given to the player.
  • exitfade = <positive integer>
Duration in Doom tics of the exit fade.
Default: 30
  • floornumber = <positive integer>
The floor number to show on the status bar.
Default: 1
  • forcetally = <bool>
Run the normal intermission sequence even if levelbonus is set or during the victory sequence.
Default: false
  • highscoresgraphic = "<picture>"
Small icon to display instead of the floor number on the high scores table.
Default: The floor number
  • levelbonus = <positive integer>
Number of points to give for completing this level.
Default: 0
  • levelnum = <positive integer>
The level number which is used for warping. For MAPxy labels this number is automatically assigned.
Default: 0
  • music = "<lump>"
The music to play for this level.
Default: Undefined?
  • spawnwithweaponraised
Starts the level with the weapon already raised.
Default: false
  • secretdeathsounds = <bool>
Swaps all deathsounds for their secretdeathsounds.
Default: false
  • [secret|victory]next = "<map>"
  • [secret|victory]next = EndSequence, "<sequence>"
Specifies which map to go to when the exit is activated. EndSequence will instead go to a intermission sequence. secretnext is the same as next only applies to the secret exit. victorynext is likewise the same but is usually triggered by bosses which call the Exit_Victory special.
Default: Undefined?
  • specialaction = "<actorclass>", "<special>"[, <arg0>[, <arg1>[, <arg2>[, <arg3>[, <arg4>]]]]]
Gives a special action to be called by A_BossDeath when all of the specified type are dead.
Default: No special action.
NOTE: Multiple special actions can be defined.
  • nointermission
Disables the normal intermission screen and goes to the next level immediately.
Default: false (display normal intermission)
  • par = <positive integer>
The par time of the level in seconds.
Default: 0
  • translator = "<lump>"
Name of map translation lump.
Default: Whatever translator is defined in Gameinfo