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

45 lines
1.5 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>SetActionData</title>
<category>Objects</category>
<subcat>Activity</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>any</type>
<name>data</name>
<desc>Additional parameter for the activity.</desc>
</param>
</params>
</syntax>
<desc>Sets the extra data for the current action. The application of the extra data depends on the procedure of the current action. See <emlink href="definition/procedures.html">ActMap procedures</emlink>.</desc>
<examples>
<example>
<code>func ControlUse(object clonk)
{
clonk-&gt;<funclink>SetAction</funclink>(&quot;Bridge&quot;);
clonk-&gt;SetActionData(<funclink>Material</funclink>(&quot;Gold&quot;));
clonk-&gt;<funclink>SetComDir</funclink>(<funclink>COMD_Up</funclink>);
}</code>
<text>Script for a special item: lets the clonk build a vertical gold bridge.</text>
</example>
</examples>
<related>
<funclink>SetAction</funclink>
<funclink>SetBridgeActionData</funclink>
<funclink>GetAction</funclink>
<funclink>GetActionTarget</funclink>
<funclink>SetPhase</funclink>
<funclink>SetDir</funclink>
<funclink>SetComDir</funclink>
</related>
</func>
<author>Sven2</author><date>2003-06</date>
</funcs>