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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
<?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>FindObjects</title>
<category>Objects</category>
<subcat>Search</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>array</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>Creates a list of objects which fulfill the specified search criteria. Search criteria are composed of Find_x() values.</desc>
<remark>As opposed to <funclink>FindObject</funclink>, an object using FindObjects in local calls will also find itself. This can be avoided through use of <funclink>Find_Exclude</funclink>().</remark>
<remark>Criteria are specified in the same way as with <funclink>FindObject</funclink> and <funclink>ObjectCount</funclink>.</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>for</funclink>(var vehicle in FindObjects (<funclink>Find_Owner</funclink>(1), <funclink>Find_Category</funclink>(<funclink>C4D_Vehicle</funclink>)))
<funclink>RemoveObject</funclink> (vehicle);</code>
<text>Removes all vehicles of player 2.</text>
</example>
<example>
<code>protected func Hit()
{
<funclink>for</funclink>(var structure in FindObjects(<funclink>Find_AtPoint</funclink>(), <funclink>Find_Category</funclink>(<funclink>C4D_Structure</funclink>), <funclink>Find_OCF</funclink>(<funclink>OCF_Inflammable</funclink>)))
Incinerate(structure);
<funclink>RemoveObject</funclink>();
}</code>
<text>Arsonist flint: incinerates all buildings at the point of impact.</text>
</example>
<example>
<code><funclink>for</funclink>(var obj in FindObjects( <funclink>Find_Not</funclink>(<funclink>Find_Owner</funclink>(<funclink>NO_OWNER</funclink>)) ))
obj-><funclink>SetOwner</funclink>(<funclink>NO_OWNER</funclink>);</code>
<text>Anarchy! No object is owned by any player anymore.</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_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>ObjectCount</funclink>
</related>
</func>
<author>Clonkonaut</author><date>2006-07</date>
</funcs>
|
