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

36 lines
1.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>ObjectDistance</title>
<category>Objects</category>
<version>5.1 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>object</type>
<name>obj2</name>
<desc>Second object.</desc>
</param>
<param>
<type>object</type>
<name>obj</name>
<desc>First object. Can be <code>nil</code> in local calls.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Returns the distance between two objects. If obj is <code>nil</code> the distance between the calling object and obj2 is measured.</desc>
<related>
<funclink>Distance</funclink>
<funclink>Sqrt</funclink>
<funclink>Sin</funclink>
<funclink>Cos</funclink>
</related>
</func>
<author>jwk</author><date>2002-08</date>
</funcs>