forked from Mirrors/openclonk
49 lines
1.8 KiB
XML
49 lines
1.8 KiB
XML
<?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>EffectCall</title>
|
|
<category>Effects</category>
|
|
<version>5.1 OC</version>
|
|
<syntax>
|
|
<rtype>any</rtype>
|
|
<params>
|
|
<param>
|
|
<type>object</type>
|
|
<name>target</name>
|
|
<desc>Target object of the effect the of which you want to access variables. <code>nil</code> for global effects.</desc>
|
|
<optional />
|
|
</param>
|
|
<param>
|
|
<type>proplist</type>
|
|
<name>effect</name>
|
|
<desc>The effect.</desc>
|
|
</param>
|
|
<param>
|
|
<type>string</type>
|
|
<name>command</name>
|
|
<desc>Function to be called. The prefix 'Fx' is automatically prepended to the function name. Do not include 'Fx' in the parameter.</desc>
|
|
</param>
|
|
<param>
|
|
<type>any</type>
|
|
<name>...</name>
|
|
<desc>Additional parameters</desc>
|
|
</param>
|
|
</params>
|
|
</syntax>
|
|
<desc>Makes a function call in the specified effect. The call is made within the context of the effect. The first two parameters are always the target object and the effect. The remaining parameters can be freely chosen.</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>CreateEffect</funclink>
|
|
<funclink>CheckEffect</funclink>
|
|
<funclink>GetEffectCount</funclink>
|
|
<funclink>GetEffect</funclink>
|
|
<funclink>RemoveEffect</funclink>
|
|
</related>
|
|
</func>
|
|
<author>Sven2</author><date>2004-03</date>
|
|
</funcs>
|