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

36 lines
1.2 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>eval</title>
<category>Script</category>
<version>5.1 OC</version>
<syntax>
<rtype>any</rtype>
<params>
<param>
<type>string</type>
<name>script</name>
<desc>Script to be executed</desc>
</param>
<param>
<type>bool</type>
<name>dont_pass_errors</name>
<desc>If true and the script causes an error, the function returns nil and does not cancel its parent script execution.</desc>
</param>
</params>
</syntax>
<desc>Executes a string as script.</desc>
<examples>
<example>
<code>var v1, v2, v3, v4, v5;
for(var i = 1; i &lt;= 5; i++) eval( <funclink>Format</funclink>(&quot;v%d = %d&quot;, i, i * i) );</code>
<text>Sets the variables v1 to v5 with the squared values of 1 to 5. (The script snippets "v1 = 1", "v2 = 4" ... "v5 = 25" are created with <funclink>Format</funclink> and executed with "eval".)</text>
</example>
</examples>
</func>
<author>PeterW</author><date>2002-04</date>
</funcs>