<?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>CheckEffect</title>
    <category>Effects</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>string</type>
          <name>name</name>
          <desc>Name of the effect without prepended 'Fx'.</desc>
        </param>
        <param>
          <type>object</type>
          <name>target</name>
          <desc>Target object of the effects to be notified. If <code>nil</code>, the global effects are notified.</desc>
          <optional />
        </param>
        <param>
          <type>int</type>
          <name>priority</name>
          <desc>Effect priority. Calls are made to all effects of equal or higher priority. If unspecified or 0, all effects are notified.</desc>
          <optional />
        </param>
        <param>
          <type>int</type>
          <name>timer</name>
          <optional />
          <desc>Interval for the timer calls. With <code>nil</code>, no timer calls are made and the effect stays on permanently until it is deleted by other calls.</desc>
        </param>
        <param>
          <type>any</type>
          <name>var1</name>
          <optional />
          <desc>First extra parameter to be passed to the effect callback.</desc>
        </param>
        <param>
          <type>any</type>
          <name>var2</name>
          <optional />
          <desc>Second extra parameter to be passed to the effect callback.</desc>
        </param>
        <param>
          <type>any</type>
          <name>var3</name>
          <optional />
          <desc>Third extra parameter to be passed to the effect callback.</desc>
        </param>
        <param>
          <type>any</type>
          <name>var4</name>
          <optional />
          <desc>Fourth extra parameter to be passed to the effect callback.</desc>
        </param>
      </params>
    </syntax>
    <desc>Makes Fx*Effect (and in cases Fx*Add) callbacks to the specified list of effects, without actually creating any effect. The return value is -1 if another effect has rejected the call. If an effect accepts the call, the return value is the effect number of that effect.</desc>
    <remark>For examples and more information see the <emlink href="script/Effects.html">effects documentation</emlink>.</remark>
    <related>
      <emlink href="script/Effects.html">Effects Documentation</emlink>
      <funclink>AddEffect</funclink>
      <funclink>GetEffectCount</funclink>
      <funclink>EffectCall</funclink>
      <funclink>GetEffect</funclink>
      <funclink>RemoveEffect</funclink>
    </related>
  </func>
  <author>Sven2</author><date>2004-03</date>
</funcs>
