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

64 lines
1.9 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>CastPXS</title>
<category>Landscape</category>
<version>1.0 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>string</type>
<name>material_name</name>
<desc>Material name</desc>
</param>
<param>
<type>int</type>
<name>amount</name>
<desc>Amount</desc>
</param>
<param>
<type>int</type>
<name>level</name>
<desc>Strength.</desc>
</param>
<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>angle</name>
<desc>Angle into which the material pixels are casted.</desc>
<optional />
</param>
<param>
<type>int </type>
<name>angle_variance</name>
<desc>Maximum deviation from that angle. If not given the material pixels will all be casted into all directions.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Casts material pixels at the specified position. In local calls, the coordinates are an offset to the position of the calling object.</desc>
<examples>
<example>
<code>CastPXS(&quot;Lava&quot;, 6000, 30);</code>
<text>Casts 6,000 lava pixels at the position of the calling object.</text>
</example>
</examples>
<related><funclink>CastObjects</funclink></related>
</func>
<author>jwk</author><date>2002-04</date>
<author>Newton</author><date>2009-07</date>
</funcs>