openclonk/docs/sdk/definition/category.xml

86 lines
2.7 KiB
XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE doc
SYSTEM '../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../clonk.xsl"?>
<doc>
<title>Object Categories</title>
<h>Object Categories</h>
<part>
<text>An object's category specifies parts of its behavior. For a definition it is set by the <code id="Category">Category</code> entry in the DefCore.txt file. Multiple categories can be combined using the binary OR operator.</text>
<text>
<table>
<rowh>
<col>Category</col>
<col>Description</col>
</rowh>
<row>
<col>C4D_StaticBack</col>
<col>Immovable object.</col>
</row>
<row>
<col>C4D_Structure</col>
<col>Unused.</col>
</row>
<row>
<col>C4D_Vehicle</col>
<col>Unused.</col>
</row>
<row>
<col>C4D_Living</col>
<col>A living being.</col>
</row>
<row>
<col>C4D_Object</col>
<col>An item that can hit alive objects.</col>
</row>
<row>
<col>C4D_Goal</col>
<col>Game goal.</col>
</row>
<row>
<col>C4D_Environment</col>
<col>Environmental control object.</col>
</row>
<row>
<col>C4D_Rule</col>
<col>Rule control object.</col>
</row>
<row>
<col>C4D_Background</col>
<col>Object is behind the landscape.</col>
</row>
<row>
<col>C4D_Parallax</col>
<col>Object moves parallax according to the Parallaxity property. For more information see <funclink>C4D_Parallax</funclink>.</col>
</row>
<row>
<col>C4D_MouseSelect</col>
<col>Object can be clicked with the mouse, causing a MouseSelection(int player) callback in the object.</col>
</row>
<row>
<col>C4D_Foreground</col>
<col>Object is always in the foreground, even before global particles.</col>
</row>
<row>
<col>C4D_MouseIgnore</col>
<col>Object cannot be selected with the mouse.</col>
</row>
<row>
<col>C4D_IgnoreFoW</col>
<col>Object is drawn above fog of war. Useful for creating status displays or gui elements using objects.</col>
</row>
</table>
</text>
<h>Example</h>
<examples>
<example>
<code>Category=C4D_StaticBack|C4D_Rule</code>
<text>Category for a rule.</text>
</example>
</examples>
</part>
<author>Sven2</author><date>2006-05</date>
<author>Newton</author><date>2005-01</date>
<author>Günther</author><date>2005, 2011</date>
</doc>