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

44 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>ShakeObjects</title>
<category>Objects</category>
<version>5.1 OC</version>
<syntax>
<rtype>void</rtype>
<params>
<param>
<type>int</type>
<name>x</name>
<desc>X center position of the circular area to be shaken. Always global.</desc>
</param>
<param>
<type>int</type>
<name>y</name>
<desc>Y center position of the circular area to be shaken. Always global.</desc>
</param>
<param>
<type>int</type>
<name>radius</name>
<desc>Radius of the circular area to be shaken.</desc>
</param>
</params>
</syntax>
<desc>Shakes all living beings within a given radius. This is comparable to calls to <funclink>Fling</funclink>() with low random values to all objects in the target area.</desc>
<examples>
<example>
<code>ShakeObjects(<funclink>LandscapeWidth</funclink>()/2, <funclink>LandscapeHeight</funclink>()/2, <funclink>Distance</funclink>(<funclink>LandscapeWidth</funclink>(), <funclink>LandscapeHeight</funclink>())/2);</code>
<text>Shakes all living beings.</text>
</example>
</examples>
<related>
<funclink>ShakeFree</funclink>
<funclink>BlastObjects</funclink>
</related>
</func>
<author>Sven2</author><date>2003-06</date>
</funcs>