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

19 lines
904 B
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_Random</title>
<category>Objects</category>
<subcat>Search</subcat>
<version>5.1 OC</version>
<syntax><rtype>array</rtype></syntax>
<desc>Sort criterion: Sorts the found objects randomly.</desc>
<remark>Sort_Random should not be used together with <funclink>FindObject</funclink> to find a random, matching object. Instead the first object of a <funclink>FindObjects</funclink> search with a SortRandom parameter can be used for instance.</remark>
<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>