2010-08-22 13:13:17 +00:00
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
< !DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
2009-05-09 13:11:51 +00:00
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs >
2010-08-22 13:13:17 +00:00
<func >
<title > DrawMap</title>
<category > Landscape</category>
2011-06-30 10:52:55 +00:00
<version > 5.1 OC</version>
2010-08-22 13:13:17 +00:00
<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>
2012-02-19 16:57:33 +00:00
<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>
2010-08-22 13:13:17 +00:00
<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 >
2012-02-19 16:57:33 +00:00
<code > DrawMap(0,0,<funclink > LandscapeWidth</funclink> (), <funclink > LandscapeHeight</funclink> ()/2, " map Earth{overlay{mat = Earth;};};" );</code>
<text > Fills the top half of the map with earth.</text>
2010-08-22 13:13:17 +00:00
</example>
</examples>
<related > <funclink > DrawDefMap</funclink> </related>
</func>
<author > Sven2</author> <date > 2002-04</date>
</funcs>