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

40 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>Find_OCF</title>
<category>Objects</category>
<subcat>Search</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>array</rtype>
<params>
<param>
<type>int</type>
<name>ocf</name>
<desc>Object character flag of the objects to find.</desc>
</param>
</params>
</syntax>
<desc>Search criterion: finds all objects which have the specified Object Character Flag set.</desc>
<remark>For additional information on the use of this function see <funclink>FindObjects</funclink>.</remark>
<examples>
<example>
<code><funclink>ObjectCount</funclink>(Find_OCF(<funclink>OCF_InLiquid</funclink> | <funclink>OCF_InSolid</funclink>))</code>
<text>Returns the number of objects which are currently in a liquid or stuck in the ground.</text>
</example>
<example>
<code><funclink>FindObject</funclink>(Find_OCF(<funclink>OCF_Alive</funclink>), Find_OCF(<funclink>OCF_OnFire</funclink>))</code>
<text>Returns the first found burning object, if one can be found.</text>
</example>
</examples>
<related>
<funclink>FindObjects</funclink>
<emlink href="definition/ocf.html">Object character flags</emlink>
</related>
</func>
<author>Clonkonaut</author><date>2006-07</date>
</funcs>