File: DrawMap.xml

package info (click to toggle)
openclonk 8.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 169,656 kB
  • sloc: cpp: 180,484; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 148; sh: 101; javascript: 34
file content (51 lines) | stat: -rw-r--r-- 1,930 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
<?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>DrawMap</title>
    <category>Landscape</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>bool</rtype>
      <params>
        <param>
          <type>int</type>
          <name>x</name>
          <desc>Left border of the rectangle in which to draw the map.</desc>
        </param>
        <param>
          <type>int</type>
          <name>y</name>
          <desc>Top border of the rectangle in which to draw the map.</desc>
        </param>
        <param>
          <type>int</type>
          <name>width</name>
          <desc>Width of the rectangle in which to draw the map.</desc>
        </param>
        <param>
          <type>int</type>
          <name>height</name>
          <desc>Height of the rectangle in which to draw the map.</desc>
        </param>
        <param>
          <type>string</type>
          <name>map</name>
          <desc>Definition of the dynamic map. The enclosing map { ... } tag must be present.</desc>
        </param>
      </params>
    </syntax>
    <desc>Draws a dynamic map within the specified rectangle over the old landscape. This is done using the same evaluation as with Landscape.txt components.</desc>
    <remark>As maximum string length in C4Script is limited by internal buffers you should use <funclink>DrawDefMap</funclink> for very complex maps.</remark>
    <examples>
      <example>
        <code>DrawMap(0,0,<funclink>LandscapeWidth</funclink>(), <funclink>LandscapeHeight</funclink>()/2, &quot;map Earth{overlay{mat = Earth;};};&quot;);</code>
        <text>Fills the top half of the map with earth.</text>
      </example>
    </examples>
    <related><funclink>DrawDefMap</funclink></related>
  </func>
  <author>Sven2</author><date>2002-04</date>
</funcs>