openclonk/docs/sdk/script/fn/PlaceVegetation.xml

56 lines
2.1 KiB
XML

<?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>PlaceVegetation</title>
<category>Environment</category>
<version>5.1 OC</version>
<syntax>
<rtype>object</rtype>
<params>
<param>
<type>id</type>
<name>id</name>
<desc>ID of the object to be created.</desc>
</param>
<param>
<type>int</type>
<name>x</name>
<desc>Top left corner of the target rectangle; X coordinate.</desc>
</param>
<param>
<type>int</type>
<name>y</name>
<desc>Top left corner of the target rectangle; Y coordinate.</desc>
</param>
<param>
<type>int</type>
<name>width</name>
<desc>Width of the target rectangle.</desc>
</param>
<param>
<type>int</type>
<name>height</name>
<desc>Height of the target rectangle.</desc>
</param>
<param>
<type>int</type>
<name>growth</name>
<desc>Growth phase of the target object. Value -1 places vegetation at random growth, otherwise the valid range is 1-100000 (1-100%).</desc>
</param>
<param>
<type>proplist</type>
<name>area</name>
<desc>If supplied, this may be a <emlink href="script/Shape.html">Shape</emlink>-proplist, which overrides the area given by (x,y,width.height) and places the object within the given shape only.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Places vegetation in the specified target rectangle. In local calls, the specified coordinates are an offset to the position of the calling object. Note that if an area-proplist is given, that shape is always assumed in global coordinates. Returns a pointer to the newly created plant.</desc>
<related><funclink>PlaceAnimal</funclink></related>
</func>
<author>jwk</author><date>2002-08</date>
</funcs>