File: Find_OCF.xml

package info (click to toggle)
openclonk 8.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 169,656 kB
  • sloc: cpp: 180,484; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 148; sh: 101; javascript: 34
file content (39 lines) | stat: -rw-r--r-- 1,528 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<?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>