1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
|
<?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>GetCommand</title>
<category>Objects</category>
<subcat>Commands</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>any</rtype>
<params>
<param>
<type>int</type>
<name>element</name>
<optional />
<desc>Data to be returned. Unspecified or 0: Name, 1: Target, 2: TargetX, 3: TargetY, 4: Target2, 5: Data</desc>
</param>
<param>
<type>int</type>
<name>command_num</name>
<optional />
<desc>Number of the command. 0 is the currently active command, other values are the following (super-level) commands.</desc>
</param>
</params>
</syntax>
<desc>Returns information on a current command of an object. If the object does not have any commands set, <code>nil</code> is returned for all queries.</desc>
<examples>
<example>
<code>func Timer()
{
if(GetCommand() == "Enter" && GetCommand(1) == <funclink>FindBase</funclink>(<funclink>GetOwner</funclink>()))
<funclink>Enter</funclink>(<funclink>FindBase</funclink>(<funclink>GetOwner</funclink>()));
}</code>
<text>If the object has been commanded to enter the home base, this script will warp the object there directly.</text>
</example>
</examples>
<related>
<funclink>SetCommand</funclink>
<funclink>AddCommand</funclink>
<funclink>AppendCommand</funclink>
</related>
</func>
<author>PeterW</author><date>2001-11</date>
</funcs>
|