Difference between revisions of "MAPINFO/Gameinfo definition"

From ECWolf Wiki
(Block syntax)
(Block properties)
Line 4: Line 4:
  
 
== Block properties ==
 
== Block properties ==
* '''advisorycolor = "<color>"'''
+
* <tt>advisorycolor = "<color>"</tt>
 
:Defines the color to use for the background of the advisory (aka PG13) screen.
 
:Defines the color to use for the background of the advisory (aka PG13) screen.
* '''advisorypic = "<picture>"'''
+
* <tt>advisorypic = "<picture>"</tt>
 
:Defines the texture to use for the advisory screen.
 
:Defines the texture to use for the advisory screen.
* '''border = inset, "<topcolor>", "<bottomcolor>", "<highlightcolor>"'''
+
* <tt>border = inset, "<topcolor>", "<bottomcolor>", "<highlightcolor>"</tt>
* '''<nowiki>border = <offset>, <unused>, "<tl>", "<t>", "<tr>", "<l>", "<r>", "<bl>", "<b>", "<br>"</nowiki>'''
+
* <tt>border = <offset>, <unused>, <nowiki>"<tl>", "<t>", "<tr>", "<l>", "<r>", "<bl>", "<b>", "<br>"</nowiki></tt>
 
:Sets the border for the play screen. The inset variant uses a thin solid color border. The second variant allows tiled graphics to be used for the border. The unused parameter used to be the size and is kept for ZDoom compatibility.
 
:Sets the border for the play screen. The inset variant uses a thin solid color border. The second variant allows tiled graphics to be used for the border. The unused parameter used to be the size and is kept for ZDoom compatibility.
* '''borderflat = "<texture>"'''
+
* <tt>borderflat = "<texture>"</tt>
 
:Graphic to use for the background of the border area.
 
:Graphic to use for the background of the border area.
* '''creditpage = "<texture>"'''
+
* <tt>creditpage = "<texture>"</tt>
 
:Graphic to use for the credits screen in the demo loop.
 
:Graphic to use for the credits screen in the demo loop.
* '''doorsoundsequence = "<sequence>"'''
+
* <tt>doorsoundsequence = "<sequence>"</tt>
 
:Sets the default sound sequence to use for doors. Of little use at the moment.
 
:Sets the default sound sequence to use for doors. Of little use at the moment.
* '''drawreadthis = <bool>'''
+
* <tt>drawreadthis = <bool></tt>
 
:Sets if the "read this" option should appear in the menu.
 
:Sets if the "read this" option should appear in the menu.
* '''finalemusic = "<lump>"'''
+
* <tt>finalemusic = "<lump>"</tt>
 
:Music to play during ending intermissions.
 
:Music to play during ending intermissions.
* '''gamepalette = "<lump>"'''
+
* <tt>gamepalette = "<lump>"</tt>
 
:Sets the lump to use for the game palette.
 
:Sets the lump to use for the game palette.
* '''gibfactor = <float>'''
+
* <tt>gibfactor = <float></tt>
 
:Sets the factor of the spawn health that much be reached for an extreme death to be triggered.
 
:Sets the factor of the spawn health that much be reached for an extreme death to be triggered.
* '''highscoresfont = "<font>"'''
+
* <tt>highscoresfont = "<nowiki><font></nowiki>"</tt>
 
:Font to use for high scores table.
 
:Font to use for high scores table.
* '''highscoresfontcolor = "<textcolor>"'''
+
* <tt>highscoresfontcolor = "<textcolor>"</tt>
 
:Color to use for high scores table font.
 
:Color to use for high scores table font.
* '''intermissionmusic = "<lump>"'''
+
* <tt>intermissionmusic = "<lump>"</tt>
 
:Music to play during normal intermissions.
 
:Music to play during normal intermissions.
* '''menucolor = "<border1>", "<border2>", <border3>", "<background>", "<stripe>", "<stripebg>"
+
* <tt>menucolor = "<border1>", "<border2>", <border3>", "<background>", "<stripe>", "<stripebg>"</tt>
 
:Sets the various colors for use in the menu.
 
:Sets the various colors for use in the menu.
* '''menufade = "<color>"'''
+
* <tt>menufade = "<color>"</tt>
 
:Color to use for the menu fade.
 
:Color to use for the menu fade.
* '''menufontcolor_disabled = "<textcolor>"'''
+
* <tt>menufontcolor_disabled = "<textcolor>"</tt>
 
:Color to use for unselectable menu elements.
 
:Color to use for unselectable menu elements.
* '''menufontcolor_highlight = "<textcolor>"'''
+
* <tt>menufontcolor_highlight = "<textcolor>"</tt>
 
:Color to use for highlighted menu elements.
 
:Color to use for highlighted menu elements.
* '''menufontcolor_highlightselection = "<textcolor>"'''
+
* <tt>menufontcolor_highlightselection = "<textcolor>"</tt>
 
:Color to use for selected highlighted menu elements.
 
:Color to use for selected highlighted menu elements.
* '''menufontcolor_invalid = "<textcolor>"'''
+
* <tt>menufontcolor_invalid = "<textcolor>"</tt>
 
:Color to use for invalid menu elements (unavailable episodes for example).
 
:Color to use for invalid menu elements (unavailable episodes for example).
* '''menufontcolor_invalidselection = "<textcolor>"'''
+
* <tt>menufontcolor_invalidselection = "<textcolor>"</tt>
 
:Color to use for selected invalid menu elements.
 
:Color to use for selected invalid menu elements.
* '''menufontcolor_label = "<textcolor>"'''
+
* <tt>menufontcolor_label = "<textcolor>"</tt>
 
:Color to use for normal, unselected menu elements.
 
:Color to use for normal, unselected menu elements.
* '''menufontcolor_selection = "<textcolor>"'''
+
* <tt>menufontcolor_selection = "<textcolor>"</tt>
 
:Color to use for selected menu elements.
 
:Color to use for selected menu elements.
* '''menufontcolor_title = "<textcolor>"'''
+
* <tt>menufontcolor_title = "<textcolor>"</tt>
 
:Color to use for the fonts in menu titles.
 
:Color to use for the fonts in menu titles.
* '''menumusic = "<lump>"'''
+
* <tt>menumusic = "<lump>"</tt>
 
:Music to play while the menu is active.
 
:Music to play while the menu is active.
* '''pageindexfontcolor = "<textcolor>"'''
+
* <tt>pageindexfontcolor = "<textcolor>"</tt>
 
:Color to use for art screen page index.
 
:Color to use for art screen page index.
* '''pagetime = <value>'''
+
'''* <tt>pagetime = <value></tt>
:Sets the amount of time a page is held on screen during the demo loop.
+
:Sets the amount of time a page is held on screen during the demo loop.'''
* '''playerclasses = "<class>", ...'''
+
* <tt>playerclasses = "<class>", ...</tt>
 
:Sets the selectable player classes.
 
:Sets the selectable player classes.
* '''pushwallsoundsequence = "<sequence>"'''
+
* <tt>pushwallsoundsequence = "<sequence>"</tt>
 
:Sets the default pushwall sound sequence to use. Of little use at the moment.
 
:Sets the default pushwall sound sequence to use. Of little use at the moment.
* '''quitmessages = "<string>", ...'''
+
* <tt>quitmessages = "<string>", ...</tt>
 
:Sets the messages to display when confirming the quit game action. If preceded by a $ character, it will use strings from [[LANGUAGE]].
 
:Sets the messages to display when confirming the quit game action. If preceded by a $ character, it will use strings from [[LANGUAGE]].
* '''scoresmusic = "<lump>"'''
+
* <tt>scoresmusic = "<lump>"</tt>
 
:Music to play while displaying the high scores table.
 
:Music to play while displaying the high scores table.
* '''signon = "<texture>"'''
+
* <tt>signon = "<texture>"</tt>
 
:The graphic to use for the background of the sign on screen.
 
:The graphic to use for the background of the sign on screen.
* '''titlemusic = "<lump>"'''
+
* <tt>titlemusic = "<lump>"</tt>
 
:Sets the music to use during the demo loop sequence.
 
:Sets the music to use during the demo loop sequence.
* '''titletime = <value>'''
+
* <tt>titletime = <positive integer></tt>
 
:Sets the amount of time, in seconds, the title screen is displayed during the demo loop.
 
:Sets the amount of time, in seconds, the title screen is displayed during the demo loop.
* '''translator = "<lump>"'''
+
* <tt>translator = "<lump>"</tt>
 
:The default [[map translator]] to use for binary format maps.
 
:The default [[map translator]] to use for binary format maps.

Revision as of 19:48, 4 January 2017

The gameinfo section of MAPINFO defines global properties for the game.

Block syntax

gameinfo { properties }

Block properties

  • advisorycolor = "<color>"
Defines the color to use for the background of the advisory (aka PG13) screen.
  • advisorypic = "<picture>"
Defines the texture to use for the advisory screen.
  • border = inset, "<topcolor>", "<bottomcolor>", "<highlightcolor>"
  • border = <offset>, <unused>, "<tl>", "<t>", "<tr>", "<l>", "<r>", "<bl>", "<b>", "<br>"
Sets the border for the play screen. The inset variant uses a thin solid color border. The second variant allows tiled graphics to be used for the border. The unused parameter used to be the size and is kept for ZDoom compatibility.
  • borderflat = "<texture>"
Graphic to use for the background of the border area.
  • creditpage = "<texture>"
Graphic to use for the credits screen in the demo loop.
  • doorsoundsequence = "<sequence>"
Sets the default sound sequence to use for doors. Of little use at the moment.
  • drawreadthis = <bool>
Sets if the "read this" option should appear in the menu.
  • finalemusic = "<lump>"
Music to play during ending intermissions.
  • gamepalette = "<lump>"
Sets the lump to use for the game palette.
  • gibfactor = <float>
Sets the factor of the spawn health that much be reached for an extreme death to be triggered.
  • highscoresfont = "<font>"
Font to use for high scores table.
  • highscoresfontcolor = "<textcolor>"
Color to use for high scores table font.
  • intermissionmusic = "<lump>"
Music to play during normal intermissions.
  • menucolor = "<border1>", "<border2>", <border3>", "<background>", "<stripe>", "<stripebg>"
Sets the various colors for use in the menu.
  • menufade = "<color>"
Color to use for the menu fade.
  • menufontcolor_disabled = "<textcolor>"
Color to use for unselectable menu elements.
  • menufontcolor_highlight = "<textcolor>"
Color to use for highlighted menu elements.
  • menufontcolor_highlightselection = "<textcolor>"
Color to use for selected highlighted menu elements.
  • menufontcolor_invalid = "<textcolor>"
Color to use for invalid menu elements (unavailable episodes for example).
  • menufontcolor_invalidselection = "<textcolor>"
Color to use for selected invalid menu elements.
  • menufontcolor_label = "<textcolor>"
Color to use for normal, unselected menu elements.
  • menufontcolor_selection = "<textcolor>"
Color to use for selected menu elements.
  • menufontcolor_title = "<textcolor>"
Color to use for the fonts in menu titles.
  • menumusic = "<lump>"
Music to play while the menu is active.
  • pageindexfontcolor = "<textcolor>"
Color to use for art screen page index.

* pagetime = <value>

Sets the amount of time a page is held on screen during the demo loop.
  • playerclasses = "<class>", ...
Sets the selectable player classes.
  • pushwallsoundsequence = "<sequence>"
Sets the default pushwall sound sequence to use. Of little use at the moment.
  • quitmessages = "<string>", ...
Sets the messages to display when confirming the quit game action. If preceded by a $ character, it will use strings from LANGUAGE.
  • scoresmusic = "<lump>"
Music to play while displaying the high scores table.
  • signon = "<texture>"
The graphic to use for the background of the sign on screen.
  • titlemusic = "<lump>"
Sets the music to use during the demo loop sequence.
  • titletime = <positive integer>
Sets the amount of time, in seconds, the title screen is displayed during the demo loop.
  • translator = "<lump>"
The default map translator to use for binary format maps.