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

52 lines
1.5 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>LaunchVolcano</title>
<category>Environment</category>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>int</type>
<name>x</name>
<desc>X position, in global coordinates.</desc>
</param>
<param>
<type>int</type>
<name>y</name>
<desc>Y position, in global coordinates.</desc>
</param>
<param>
<type>int</type>
<name>strength</name>
<desc>Strength of the volcano, the width of the lava stream in 1/4 pixels. Defaults to 4, maximum strength is 100.</desc>
<optional />
</param>
<param>
<type>string</type>
<name>material_name</name>
<desc>Name of the material. The default is "Lava".</desc>
<optional />
</param>
<param>
<type>int</type>
<name>angle</name>
<desc>Direction into which to erupt. 0 (default) is straight up.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Launches a volcano at the specified position.</desc>
<related>
<funclink>LaunchLightning</funclink>
<funclink>LaunchEarthquake</funclink>
</related>
</func>
<author>Newton</author><date>2013-12</date>
<author>Marky</author><date>2018-02</date>
</funcs>