UltimateZoneBuilder/Help/gc_formatsettings.html

167 lines
5.3 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>Game Configuration - Map Format Settings</title>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<link rel="stylesheet" type="text/css" href="default.css" media="screen" title="Default" />
</head>
<body>
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e">
<param name="keyword" value="Configurations">
<param name="keyword" value="Game Configurations">
</object>
<div id="title"><h1>Game Configuration - Map Format Settings</h1></div>
<div id="contents">
<p>
<b class="fat">formatinterface</b> (string)<br />
Interface class name in Doom Builder that is used to read and write the map data.
<ul>
<li>For Doom map format, use "DoomMapSetIO". This is a map format that uses numeric flags.
<li>For Hexen map format, use "HexenMapSetIO". This is a map format that uses numeric flags.
<li>For UDMF map format, use "UniversalMapSetIO". This is a map format that uses named flags.
</ul>
<br />
<b class="fat">gamedetect</b> (structure)<br />
This is used to determine if the Game Configuration is suitable for the opened WAD file. None of the settings in this structure have any impact on the actual editing, limitations or storage of the map, but only assist the user when opening WAD files that have not been opened with Doom Builder before (when no .dbs file is available). The setting names in this structure are the lump names that must be checked for. The value of these settings (integers) indicates which rule applies to the lump name for a positive check. Valid values are:
<ul>
<li><b>1</b> - At least one of these lumps must exist.
<li><b>2</b> - None of these lumps must exist.
<li><b>3</b> - All of these lumps must exist.
</ul>
Example:<br />
<pre>
gamedetect
{
TEXTMAP = 2;
ENDMAP = 2;
EXTENDED = 2;
BEHAVIOR = 3;
E1M1 = 2;
E1M2 = 2;
E1M3 = 2;
MAP01 = 1;
MAP02 = 1;
MAP03 = 1;
}
</pre>
<br />
<b class="fat">maplumpnames</b> (structure)<br />
This structure describes the lumps that make up the complete map, including scripts and nodes. It must also indicate what Doom Builder is supposed to do with these lumps and/or where the lumps come from. These lumps are normally written by the map format interface class, but some could be generated by the nodebuilder compiler or stored by Doom Builder directly. In this structure, there should be a structure for every map lump. The name of the structure should be the lump name, in uppercase. For the map header (which name differs) you can use the name <b>~MAP</b>. The following settings should be in the lump structure (unless the default value applies):<br />
<ul>
<li><b class="fat">required</b> (boolean).<br />
<b>True</b> to indicate that this lump is a required lump for the map. Default is <b>false</b>.<br />
<br />
<li><b class="fat">blindcopy</b> (boolean).<br />
Set this to <b>true</b> when Doom Builder should copy this lump along with the map without using it. Default is <b>false</b>.<br />
<br />
<li><b class="fat">nodebuild</b> (boolean).<br />
When set to <b>true</b>, this indicates that the nodebuilder compiler generates or modifies this lump. Default is <b>false</b>.<br />
<br />
<li><b class="fat">allowempty</b> (boolean).<br />
Set to <b>true</b> to allow the nodebuilder to leave this lump empty. Default is <b>false</b>.<br />
<br />
<li><b class="fat">script</b> (string).<br />
When this is set, it indicates that this lump can be edited with the script editor. The contents of this lump will be loaded in the script editor automatically. Set the value to the .cfg filename (without path) of a Script Configuration to use.<br />
<br />
<li><b class="fat">scriptbuild</b> (boolean) - <span class="red">GZDB only</span>.<br />
When this is set, it indicates that this lump can be edited with the script editor. Currently chosen script configuration will be used to build this lump. The contents of this lump will be loaded in the script editor automatically.<br />
</ul>
Example:<br />
<pre>
maplumpnames
{
~MAP
{
required = true;
blindcopy = true;
nodebuild = false;
}
THINGS
{
required = true;
nodebuild = true;
allowempty = true;
}
LINEDEFS
{
required = true;
nodebuild = true;
allowempty = false;
}
SIDEDEFS
{
required = true;
nodebuild = true;
allowempty = false;
}
VERTEXES
{
required = true;
nodebuild = true;
allowempty = false;
}
SEGS
{
required = false;
nodebuild = true;
allowempty = false;
}
SSECTORS
{
required = false;
nodebuild = true;
allowempty = false;
}
NODES
{
required = false;
nodebuild = true;
allowempty = false;
}
SECTORS
{
required = true;
nodebuild = true;
allowempty = false;
}
REJECT
{
required = false;
nodebuild = true;
allowempty = false;
}
BLOCKMAP
{
required = false;
nodebuild = true;
allowempty = false;
}
SCRIPTS
{
required = false;
nodebuild = false;
script = "ZDoom_ACS.cfg";
}
}
</pre>
<br />
</p>
</div>
</body>