File: DrawDefMap.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 (51 lines) | stat: -rw-r--r-- 1,987 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>DrawDefMap</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</name>
          <desc>Name of the map to be used from Landscape.txt.</desc>
        </param>
      </params>
    </syntax>
    <desc>Draws a dynamic map within the specified rectangle over the old landscape using a given map specification from Landscape.txt.</desc>
    <remark>The Landscape.txt component is usually removed from memory after scenario initialization. To keep it in memory for later use by this command you should specify the option KeepMapCreator=1 in Scenario.txt section [Landscape].</remark>
    <examples>
      <example>
        <code>DrawDefMap(0,0,<funclink>LandscapeWidth</funclink>(), <funclink>LandscapeHeight</funclink>(), &quot;TheMap&quot;);</code>
        <text>Draws 'TheMap' over the complete landscape. 'TheMap' must be defined in Landscape.txt.</text>
      </example>
    </examples>
    <related><funclink>DrawMap</funclink></related>
  </func>
  <author>Sven2</author><date>2002-04</date>
</funcs>