File: ClearFreeRect.xml

package info (click to toggle)
openclonk 8.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 169,500 kB
  • sloc: cpp: 180,478; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 139; sh: 101; javascript: 34
file content (50 lines) | stat: -rw-r--r-- 1,614 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<?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>5.1 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>