File: Find_Func.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 (39 lines) | stat: -rw-r--r-- 1,644 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_Func</title>
    <category>Objects</category>
    <subcat>Search</subcat>
    <version>5.1 OC</version>
    <syntax>
      <rtype>array</rtype>
      <params>
        <param>
          <type>string</type>
          <name>function</name>
          <desc>Function to call</desc>
        </param>
        <param>
          <type/>
          <name>...</name>
          <desc>Parameters of the function.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Search criterion: finds all objects which return <code>true</code> to a call of the specified function. If the function is defined locally, the local function will be called, otherwiese a global function.</desc>
    <remark><strong>Warning:</strong> never use this with a function which might have side effects. If your function may have side effects, do not use Find_Func but walk through the list of found objects instead.</remark>
    <remark>For additional information on the use of this function see <funclink>FindObjects</funclink>.</remark>
    <examples>
      <example>
        <code><funclink>FindObjects</funclink>(<funclink>Find_Func</funclink>(&quot;IsClonk&quot;))</code>
        <text>Returns all clonks of any types (all clonks that return <code>true</code> on the call IsClonk).</text>
      </example>
    </examples>
    <related><funclink>FindObjects</funclink></related>
  </func>
  <author>Clonkonaut</author><date>2006-07</date>
</funcs>