File: SetComDir.xml

package info (click to toggle)
openclonk 8.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 169,520 kB
  • sloc: cpp: 180,479; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 145; sh: 101; javascript: 34
file content (38 lines) | stat: -rw-r--r-- 1,580 bytes parent folder | download | duplicates (7)
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
<?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>