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

39 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>SetComDir</title>
<category>Objects</category>
<subcat>Movement</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>int</type>
<name>com_dir</name>
<desc>Order direction. Must be <funclink>COMD_None</funclink>, <funclink>COMD_Stop</funclink>, <funclink>COMD_Down</funclink>, <funclink>COMD_DownLeft</funclink>, <funclink>COMD_DownRight</funclink>, <funclink>COMD_Left</funclink>, <funclink>COMD_Right</funclink>, <funclink>COMD_Up</funclink>, <funclink>COMD_UpLeft</funclink> or <funclink>COMD_UpRight</funclink>.</desc>
</param>
</params>
</syntax>
<desc>Sets the command direction of an object (see <funclink>GetComDir</funclink>).</desc>
<examples>
<example>
<code>var clonk = <funclink>GetHiRank</funclink>(0);
clonk-&gt;SetComDir(<funclink>COMD_None</funclink>);
clonk-&gt;<funclink>SetCommand</funclink>(&quot;&quot;);</code>
<text>Tells the highest ranking clonk of the first player to stop. Any current activity will be stopped.</text>
</example>
</examples>
<related>
<emlink href="definition/procedures.html">Procedure</emlink>
<funclink>GetComDir</funclink>
<funclink>SetDir</funclink>
<funclink>GetProcedure</funclink>
</related>
</func>
<author>jwk</author><date>2002-08</date>
</funcs>