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

34 lines
1.1 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>Sort_Distance</title>
<category>Objects</category>
<subcat>Search</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>array</rtype>
<params>
<param>
<type>int</type>
<name>x</name>
<desc>Distance reference point. In local calls, relative to the calling object.</desc>
<optional />
</param>
<param>
<type>int</type>
<name>y</name>
<desc>Distance reference point. In local calls, relative to the calling object.</desc>
<optional />
</param>
</params>
</syntax>
<desc>Sort criterion: Sorts the found objects by their distance to the indicated point. The nearest objects first.</desc>
<remark>For additional information on the use of this function see <funclink>FindObjects</funclink>.</remark>
<related><funclink>FindObjects</funclink></related>
</func>
<author>Newton</author><date>2009-07</date>
</funcs>