/docs/sdk/script/fn/GetCommand.xml
https://bitbucket.org/randrian/openclonk2 · XML · 52 lines · 50 code · 2 blank · 0 comment · 0 complexity · 937e34136e8af1a8a2e94ea336c1710f MD5 · raw file
- <?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
- <!DOCTYPE funcs SYSTEM "../../../clonk.dtd">
- <?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
- <funcs>
- <func>
- <title>GetCommand</title>
- <category>Objekte</category>
- <subcat>Commands</subcat>
- <version>4.6.5.0 CP
- <extversion>4.9.1.0 GWE</extversion>
- <extversion>4.9.5.0 CE</extversion>
- </version>
- <syntax>
- <rtype>any</rtype>
- <params>
- <param>
- <type>int</type>
- <name>iElement</name>
- <optional />
- <desc>Information, die zurückgegeben werden soll. 0 oder kA: Name, 1: Target, 2: TargetX, 3: TargetY, 4: Target2, 5: Data</desc>
- </param>
- <param>
- <type>int</type>
- <name>iCommandNum</name>
- <optional />
- <desc>Nummer des Kommandos. 0 steht für das momentan aktive, 1 für das danach auszuführende usw.</desc>
- </param>
- </params>
- </syntax>
- <desc>Gibt Informationen über ein Kommando des aufrufenden Objekts zurück. Führt das Objekt momentan keine Aktion aus, so wird (bei jedem Wert von iElement) 0 zurückgegeben.</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>
- Dieser Script beamt das Objekt, falls sein Kommando ist, in seine Basis zu gehen (Kommando "Enter"), sofort dorthin. Dies würde z.B. dazu führen, dass man mit der Maussteuerung den Clonk direkt in seine Heimatbasis beamen könnte, indem man den Eingang anklickt.
- </text>
- </example>
- </examples>
- <related>
- <funclink>SetCommand</funclink>
- <funclink>AddCommand</funclink>
- <funclink>AppendCommand</funclink>
- </related>
- </func>
- <author>PeterW</author><date>November 2001</date>
- </funcs>