forked from Mirrors/openclonk
50 lines
2.0 KiB
XML
50 lines
2.0 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>Explode</title>
|
|
<category>Objects</category>
|
|
<subcat>Existence</subcat>
|
|
<version>5.1 OC</version>
|
|
<syntax>
|
|
<rtype>void</rtype>
|
|
<params>
|
|
<param>
|
|
<type>int</type>
|
|
<name>level</name>
|
|
<desc>Explosion level. This determines the amount of explosion damage caused and the type of explosion sound played. Up to level 29 the explosion is a Blast1, 30 to 39 is a Blast2, and above is a Blast3.</desc>
|
|
</param>
|
|
<param>
|
|
<type>id</type>
|
|
<name>effect</name>
|
|
<desc>If specified, an object of this type is created instead of a particle. It is assumed that the newly created object will perform the explosion effect.</desc>
|
|
<optional />
|
|
</param>
|
|
<param>
|
|
<type>string</type>
|
|
<name>particle</name>
|
|
<desc>Type of particle to be created instead of the normal explosion particle.</desc>
|
|
<optional />
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Makes an object explode. The explosion will affect landscape and objects and the object including all of its contents is removed. If the object is contained, the explosion will also damage all other objects in that container. The owner of the exploding object is considered to have caused the explosion.</desc>
|
|
<remark>See notice for <funclink>RemoveObject</funclink>.</remark>
|
|
<examples>
|
|
<example>
|
|
<code><funclink>GetHiRank</funclink>(0)->Explode(25);</code>
|
|
<text>The first player's highest ranking clonk explodes.</text>
|
|
</example>
|
|
</examples>
|
|
<related>
|
|
<funclink>RemoveObject</funclink>
|
|
<funclink>BlastObjects</funclink>
|
|
<funclink>BlastFree</funclink>
|
|
</related>
|
|
</func>
|
|
<author>Sven2</author><date>2001-11</date>
|
|
<author>Clonkonaut</author><date>2008-04</date>
|
|
</funcs>
|