openclonk/docs/sdk/script/fn/Call.xml

35 lines
1.3 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>Call</title>
<category>Script</category>
<subcat>Function call</subcat>
<version>5.1 OC<extversion>5.4 OC</extversion></version>
<syntax>
<rtype>any</rtype>
<params>
<param>
<type>string or function</type>
<name>function</name>
<desc>Function to be called.</desc>
</param>
<param>
<type>any</type>
<name>...</name>
<desc>Parameters of the function.</desc>
</param>
</params>
</syntax>
<desc>Calls the specified function. If given a string, the function is looked up in the context object (<code>this</code>). For example, <code>obj->Call("Foo")</code> is the same as <code>obj->Foo()</code>. Using Call like this is primarily useful when the name of the function can vary. If "~" is prepended to the function name then the call does not fail if the function does not exist.</desc>
<related>
<funclink>GameCall</funclink>
<funclink>eval</funclink>
</related>
</func>
<author>jwk</author><date>2002-04</date>
<author>Günther</author><date>2012</date>
</funcs>