File: GetEffectCount.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 (45 lines) | stat: -rw-r--r-- 1,599 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
<?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>GetEffectCount</title>
    <category>Effects</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>string</type>
          <name>mask</name>
          <desc>Search mask for effect names. You can use '*' or '?' wildcards or specify an effect name directly. If unspecified, all effects are counted.</desc>
          <optional />
        </param>
        <param>
          <type>object</type>
          <name>target</name>
          <desc>Target object the effects of which you want to count. If unspecified, the global effects will be counted.</desc>
          <optional />
        </param>
        <param>
          <type>int</type>
          <name>max_priority</name>
          <desc>If not 0, only those effects are counted which have the specified priority or lower.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Counts object effects or global effects.</desc>
    <remark>For an example see <funclink>GetEffect</funclink>.</remark>
    <related>
      <emlink href="script/Effects.html">Effects Documentation</emlink>
      <funclink>CreateEffect</funclink>
      <funclink>CheckEffect</funclink>
      <funclink>EffectCall</funclink>
      <funclink>GetEffect</funclink>
      <funclink>RemoveEffect</funclink>
    </related>
  </func>
  <author>Sven2</author><date>2004-03</date>
</funcs>