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

63 lines
2.2 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>BlastObjects</title>
<category>Objects</category>
<version>1.0 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<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>level</name>
<desc>Strength.</desc>
</param>
<param>
<type>object</type>
<name>container</name>
<optional />
<desc>Container of the objects to be blasted.</desc>
</param>
<param>
<type>int</type>
<name>caused_by</name>
<optional />
<desc>Number of the player who has caused the damage. If not specified, the the controller of the calling object is considered to have caused the damage in local calls.</desc>
</param>
<param>
<type>int</type>
<name>damage_level</name>
<desc>If specified, then this value overrides the damage that is caused to objects.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Applies explosion damage to all objects at the specified position. x and y are always global coordinates. If a container is specified, damage is only applied to objects contained in that container. Explosion damage can cause incineration or fling away living objects.</desc>
<examples>
<example>
<code>BlastObjects(<funclink>GetX</funclink>(), <funclink>GetY</funclink>(), 60, <funclink>this</funclink>);</code>
<text>The calling object causes explosion damage of level 60 to its contents.</text>
</example>
</examples>
<related>
<funclink>Explode</funclink>
</related>
</func>
<author>jwk</author><date>2002-04</date>
<author>Clonkonaut</author><date>2008-04</date>
<author>Marky</author><date>2015-07</date>
</funcs>