File: ObjectCount.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (80 lines) | stat: -rw-r--r-- 3,574 bytes parent folder | download | duplicates (5)
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<?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>ObjectCount</title>
    <category>Objects</category>
    <subcat>Search</subcat>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>array</type>
          <name>Criteria</name>
          <desc>Search criterion in the form of a Find_* function</desc>
        </param>
        <param>
          <type/>
          <name>...</name>
          <desc>Additional search criteria in the form of Find_* functions</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Returns the number of objects fulfilling the specified search criteria. Search criteria are composed of Find_x() function values.</desc>
    <remark>Search criteria are specified as in <funclink>FindObjects</funclink> and <funclink>FindObject</funclink>. See <funclink>FindObjects</funclink> for additional samples.</remark>
    <remark>When this function is called in object context, only objects in the same layer as the calling object are considered, i.e. an implicit check <funclink>Find_Layer</funclink>(<funclink>GetObjectLayer</funclink>()) is added. To turn off this check, either supply a manual criterion with <funclink>Find_Layer</funclink>() to check for another layer, or allow objects in any layer to be returned by passing <funclink>Find_AnyLayer</funclink>().</remark>
    <examples>
      <example>
        <code><funclink>Log</funclink>( &quot;Still %d hostile clonks!&quot;, ObjectCount(<funclink>Find_OCF</funclink>(<funclink>OCF_CrewMember</funclink>), <funclink>Find_Hostile</funclink>(<funclink>GetOwner</funclink>()) );</code>
        <text>Prints info about the strength of the enemy.</text>
      </example>
    </examples>
    <related>
      <funclink>Find_Action</funclink>
      <funclink>Find_ActionTarget</funclink>
      <funclink>Find_ActionTarget2</funclink>
      <funclink>Find_ActionTargets</funclink>
      <funclink>Find_Allied</funclink>
      <funclink>Find_And</funclink>
      <funclink>Find_AnyContainer</funclink>
      <funclink>Find_AnyLayer</funclink>
      <funclink>Find_AtPoint</funclink>
      <funclink>Find_OnLine</funclink>
      <funclink>Find_Category</funclink>
      <funclink>Find_Cone</funclink>
      <funclink>Find_Container</funclink>
      <funclink>Find_Distance</funclink>
      <funclink>Find_Exclude</funclink>
      <funclink>Find_Func</funclink>
      <funclink>Find_Hostile</funclink>
      <funclink>Find_ID</funclink>
      <funclink>Find_InArray</funclink>
      <funclink>Find_InRect</funclink>
      <funclink>Find_Layer</funclink>
      <funclink>Find_NoContainer</funclink>
      <funclink>Find_Not</funclink>
      <funclink>Find_OCF</funclink>
      <funclink>Find_OnLine</funclink>
      <funclink>Find_Or</funclink>
      <funclink>Find_Owner</funclink>
      <funclink>Find_Property</funclink>
      <funclink>Find_Team</funclink> 
      <funclink>Sort_Random</funclink>
      <funclink>Sort_Reverse</funclink>
      <funclink>Sort_Multiple</funclink>
      <funclink>Sort_Value</funclink>
      <funclink>Sort_Speed</funclink>
      <funclink>Sort_Mass</funclink>
      <funclink>Sort_Distance</funclink>
      <funclink>Sort_Func</funclink>
      <funclink>FindObject</funclink>
      <funclink>FindObjects</funclink>
      <funclink>ObjectCount</funclink>
    </related>
  </func>
  <author>Clonkonaut</author><date>2006-07</date>
</funcs>