forked from Mirrors/openclonk
51 lines
2.0 KiB
XML
51 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>bool</type>
|
|
<name>silent</name>
|
|
<desc>If true, then no sound will be played for the explosion.</desc>
|
|
<optional />
|
|
</param>
|
|
<param>
|
|
<type>int</type>
|
|
<name>damage_level</name>
|
|
<desc>If specified, then this value overrides the damage that is caused to objects by the explosion.</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>
|
|
<author>Marky</author><date>2015-07</date>
|
|
</funcs>
|