File: SetPosition.xml

package info (click to toggle)
openclonk 8.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 169,656 kB
  • sloc: cpp: 180,484; ansic: 108,988; xml: 31,371; python: 1,223; php: 767; makefile: 148; sh: 101; javascript: 34
file content (46 lines) | stat: -rw-r--r-- 1,593 bytes parent folder | download | duplicates (6)
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>SetPosition</title>
    <category>Objects</category>
    <subcat>Position</subcat>
    <version>5.1 OC</version>
    <syntax>
      <rtype>void</rtype>
      <params>
        <param>
          <type>int</type>
          <name>x</name>
          <desc>New X position of the object.</desc>
        </param>
        <param>
          <type>int</type>
          <name>y</name>
          <desc>New Y position of the object.</desc>
        </param>
        <param>
          <type>bool</type>
          <name>check_bounds</name>
          <desc>Only applies to objects using the <emlink href="definition/properties.html">BorderBound property</emlink>. Ensures that the position is always within the limits specified by the object.</desc>
          <optional />
        </param>
        <param>
          <type>int</type>
          <name>prec</name>
          <desc>Precision. Coordinates are divided by this value to enable movement to fractional positions. Defaults to 1.</desc>
          <optional />
        </param>
      </params>
    </syntax>
    <desc>Moves the object to the specified position. This will set the exact pixel position and any internal sub-pixel offsets will be reset.</desc>
    <related>
      <funclink>GetX</funclink>
      <funclink>GetY</funclink>
    </related>
  </func>
  <author>Sven2</author><date>2002-08</date>
  <author>Clonkonaut</author><date>2008-04</date>
</funcs>