File: DigFreeRect.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (58 lines) | stat: -rw-r--r-- 1,972 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
51
52
53
54
55
56
57
58
<?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>DigFreeRect</title>
    <category>Landscape</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>int</type>
          <name>x</name>
          <desc>X coordinate</desc>
        </param>
        <param>
          <type>int</type>
          <name>y</name>
          <desc>Y coordinate</desc>
        </param>
        <param>
          <type>int</type>
          <name>width</name>
          <desc>Width</desc>
        </param>
        <param>
          <type>int</type>
          <name>height</name>
          <desc>Height</desc>
        </param>
        <param>
          <type>bool</type>
          <name>no_dig2objects</name>
          <desc>Prevent objects from being dug out</desc>
          <optional />
        </param>
        <param>
          <type>bool</type>
          <name>no_instability_check</name>
          <desc>Does not perform instability checks around dug pixels, i.e. prevents surrounding single pixels and liquids from becoming loose.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Makes a rectangular hole in semi-solid materials. The return value is the amount of pixels that were dug free. If no_dig2objects is true, the dug out material does neither create objects according to the Dig2Objects in the <emlink href="material/ocm.html">*.ocm</emlink> nor will the amount be stored in the internal buffer.</desc>
    <remark>Drills an elevator shaft.</remark>
    <examples>
      <example>
        <code>DigFreeRect(700, 1500, 15, 15);</code>
        <text>Makes a square hole in the middle of the landscape.</text>
      </example>
    </examples>
    <related><funclink>DigFree</funclink></related>
  </func>
  <date>2013-03</date>
</funcs>