Difference between revisions of "MAPINFO/Map definition"

From ECWolf Wiki
m
(Block properties)
Line 9: Line 9:
 
: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]].
 
: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 ==
 
== Block properties ==
* '''bordertexture = "<texture>"'''
+
* <tt>bordertexture = "<texture>"</tt>
 
:Overrides the gameinfo border texture for this map.
 
:Overrides the gameinfo border texture for this map.
* '''cluster = <number>'''
+
:Default: '''Undefined??'''
 +
* <tt>cluster = <positive number></tt>
 
:Assigns the map to a [[MAPINFO/Cluster definition|cluster]].
 
:Assigns the map to a [[MAPINFO/Cluster definition|cluster]].
* '''completionstring = "<string>"'''
+
:Default: <tt>0</tt>
 +
* <tt>completionstring = "<string>"</tt>
 
:Short message to display on the intermission screen instead of "Floor Completed".
 
:Short message to display on the intermission screen instead of "Floor Completed".
* '''deathcam = <bool>'''
+
:Default: <tt>"Floor Completed"</tt>
 +
* <tt>deathcam = <bool></tt>
 
:Enables the death cam with [[A_BossDeath]].
 
:Enables the death cam with [[A_BossDeath]].
* '''defaultceiling = "<texture>"'''
+
:Default: <tt>false</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.
* '''defaultfloor = "<texture>"'''
+
:Default: '''Undefined?'''
 +
* <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.
* '''ensureinventory = "<item>", ...'''
+
:Default: '''Undefined?'''
:Checks the players inventory and gies that item if they are lacking.
+
* <tt>ensureinventory = "<item>", ...</tt>
* '''exitfade = <time>'''
+
:Checks the players inventory and gives these items if they are lacking.
 +
:Default: No items are given to the player.
 +
* <tt>exitfade = <positive integer></tt>
 
:Duration in Doom tics of the exit fade.
 
:Duration in Doom tics of the exit fade.
* '''floornumber = <number>'''
+
:Default: <tt>30</tt>
 +
* <tt>floornumber = <positive integer></tt>
 
:The floor number to show on the status bar.
 
:The floor number to show on the status bar.
* '''highscoresgraphic = "<picture>"'''
+
:Default: <tt>1</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.
* '''levelbonus = <value>'''
+
:Default: The floor number
 +
* <tt>levelbonus = <positive integer></tt>
 
:Number of points to give for completing this level.
 
:Number of points to give for completing this level.
* '''levelnum = <number>'''
+
:Default: <tt>0</tt>
 +
* <tt>levelnum = <number></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.
* '''music = "<lump>"'''
+
:Default: <tt>0</tt>
 +
* <tt>music = "<lump>"</tt>
 
:The music to play for this level.
 
:The music to play for this level.
* '''spawnwithweaponraised'''
+
:Default: '''Undefined?'''
 +
* <tt>spawnwithweaponraised</tt>
 
:Starts the level with the weapon already raised.
 
:Starts the level with the weapon already raised.
* '''secretdeathsouds = <bool>'''
+
:Default: <tt>false</tt>
 +
* <tt>secretdeathsounds = <bool></tt>
 
:Swaps all deathsounds for their secretdeathsounds.
 
:Swaps all deathsounds for their secretdeathsounds.
* '''[secret|victrory]next = "<map>"'''
+
:Default: <tt>false</tt>
* '''[secret|victory]next = EndSequence, "<sequence>"'''
+
* <tt>[secret|victory]next = "<map>"</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. 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.
* '''specialaction = "<actorclass>", "<special>"[, <arg0>[, <arg1>[, <arg2>[, <arg3>[, <arg4>]]]]]
+
:Default: '''Undefined?'''
 +
* <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.
* '''nointermission'''
+
:Default: No special action.
 +
* <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.
* '''par = <time>'''
+
:Default: <tt>false</tt> (display normal intermission)
 +
* <tt>par = <positive integer></tt>
 
:The par time of the level in seconds.
 
:The par time of the level in seconds.
* '''translator = "<lump>"'''
+
:Default: <tt>0</tt>
 +
* <tt>translator = "<lump>"</tt>
 
:Name of map translation lump.
 
:Name of map translation lump.
 +
:Default: <tt>"$base"</tt> (use the default translator)

Revision as of 18:42, 4 January 2017

A map definition sets properties for a specific map.

Block syntax

  • adddefaultmap { properties }
  • defaultmap { properties }
Sets the default set of properties. Note that 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: Undefined??
  • cluster = <positive number>
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
  • defaultceiling = "<texture>"
Default ceiling texture to use when a map has a blank third plane.
Default: Undefined?
  • defaultfloor = "<texture>"
Default floor texture to use when a map has a blank third plane.
Default: Undefined?
  • 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
  • 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 = <number>
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.
  • 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: "$base" (use the default translator)