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

46 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>Distance</title>
<category>Arithmetics</category>
<version>1.0 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>int</type>
<name>x1</name>
<desc>X coordinate of the first point.</desc>
</param>
<param>
<type>int</type>
<name>y1</name>
<desc>Y coordinate of the first point.</desc>
</param>
<param>
<type>int</type>
<name>x2</name>
<desc>X coordinate of the second point.</desc>
</param>
<param>
<type>int</type>
<name>y2</name>
<desc>Y coordinate of the second point.</desc>
</param>
</params>
</syntax>
<desc>Calculates the distance between two points. Same as Sqrt((x2-x1)^2 + (y2-y1)^2;).</desc>
<examples>
<example>
<code><funclink>GetCursor</funclink>(0)-&gt;Message(&quot;Quick, you are only %d Clonks away from the goal!&quot;, Distance(<funclink>GetX</funclink>(<funclink>GetCursor</funclink>(0)), <funclink>GetY</funclink>(<funclink>GetCursor</funclink>(0)), 1000, 200));</code>
<text>Displays the distance of the clonk from point 1000/200.</text>
</example>
</examples>
<related><funclink>ObjectDistance</funclink></related>
</func>
<author>Sven2</author><date>2001-11</date>
</funcs>