forked from Mirrors/openclonk
51 lines
1.6 KiB
XML
51 lines
1.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
<!DOCTYPE funcs
|
|
SYSTEM '../../../clonk.dtd'>
|
|
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
|
|
<funcs>
|
|
<func>
|
|
<title>ClearFreeRect</title>
|
|
<category>Landscape</category>
|
|
<version>1.0 OC</version>
|
|
<syntax>
|
|
<rtype>void</rtype>
|
|
<params>
|
|
<param>
|
|
<type>int</type>
|
|
<name>x</name>
|
|
<desc>Left limit of the rectangle. Always global coordinates.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>y</name>
|
|
<desc>Top limit of the rectangle. Always global coordinates.</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>width</name>
|
|
<desc>Width of the rectangle</desc>
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>height</name>
|
|
<desc>Height of the rectangle</desc>
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Removes all material within the specified rectangle. Coordinates are always global. Excluding the right and lower limits of the rectangle.</desc>
|
|
<remark>This call may take quite a while for large rectangles.</remark>
|
|
<examples>
|
|
<example>
|
|
<code>ClearFreeRect(0, 0, <funclink>LandscapeWidth</funclink>(), <funclink>LandscapeHeight</funclink>());</code>
|
|
<text>Empties the complete landscape.</text>
|
|
</example>
|
|
</examples>
|
|
<related>
|
|
<funclink>DigFree</funclink>
|
|
<funclink>DigFreeRect</funclink>
|
|
<funclink>BlastFree</funclink>
|
|
</related>
|
|
</func>
|
|
<date>2014-01</date>
|
|
</funcs>
|