File: Distance.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 (45 lines) | stat: -rw-r--r-- 1,568 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
39
40
41
42
43
44
45
<?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>Distance</title>
    <category>Arithmetics</category>
    <version>5.1 OC</version>
    <syntax>
      <rtype>int</rtype>
      <params>
        <param>
          <type>int</type>
          <name>x1</name>
          <desc>X coordinate of the first point.</desc>
        </param>
        <param>
          <type>int</type>
          <name>y1</name>
          <desc>Y coordinate of the first point.</desc>
        </param>
        <param>
          <type>int</type>
          <name>x2</name>
          <desc>X coordinate of the second point.</desc>
        </param>
        <param>
          <type>int</type>
          <name>y2</name>
          <desc>Y coordinate of the second point.</desc>
        </param>
      </params>
    </syntax>
    <desc>Calculates the distance between two points. Same as Sqrt((x2-x1)^2 + (y2-y1)^2;).</desc>
    <examples>
      <example>
        <code><funclink>GetCursor</funclink>(0)-&gt;Message(&quot;Quick, you are only %d Clonks away from the goal!&quot;, Distance(<funclink>GetX</funclink>(<funclink>GetCursor</funclink>(0)), <funclink>GetY</funclink>(<funclink>GetCursor</funclink>(0)), 1000, 200));</code>
        <text>Displays the distance of the clonk from point 1000/200.</text>
      </example>
    </examples>
    <related><funclink>ObjectDistance</funclink></related>
  </func>
  <author>Sven2</author><date>2001-11</date>
</funcs>