File: GetPlrViewMode.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 (37 lines) | stat: -rw-r--r-- 1,376 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
<?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>GetPlrViewMode</title>
    <category>Player</category>
    <subcat>View</subcat>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>int</type>
          <name>player</name>
          <desc>Number of the player whose view mode you want to determine.</desc>
        </param>
      </params>
    </syntax>
    <desc>
      Determines the current view mode of a player. The function returns the following values: 
      <ul>
        <li>0: Cursor - The player view follows the currently selected clonk (see <funclink>GetCursor</funclink>).</li>
        <li>1: Target - The player view follows the object set by <funclink>SetPlrView</funclink>. Also see <funclink>GetPlrView</funclink>.</li>
        <li>2: Scroll - The player is scrolling his view using the mouse.</li>
      </ul>

    </desc>
    <remark>As mouse scrolling behaviour differs on every computer, this function always returns -1 whenever in Record, Replay, or network game mode.</remark>
    <related>
      <funclink>SetPlrView</funclink>
      <funclink>GetPlrView</funclink>
    </related>
  </func>
  <author>PeterW</author><date>2003-06</date>
</funcs>