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
47
48
49
|
<?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>GetPathLength</title>
<category>Landscape</category>
<version>5.1 OC</version>
<syntax>
<rtype>int</rtype>
<params>
<param>
<type>int</type>
<name>startx</name>
<desc>X coordinate of starting position. Always global coordinate.</desc>
</param>
<param>
<type>int</type>
<name>starty</name>
<desc>Y coordinate of starting position. Always global coordinate.</desc>
</param>
<param>
<type>int</type>
<name>endx</name>
<desc>X coordinate of end position. Always global coordinate.</desc>
</param>
<param>
<type>int</type>
<name>endy</name>
<desc>Y coordinate of end position. Always global coordinate.</desc>
</param>
<param>
<type>int</type>
<name>depth</name>
<desc>Determines search depth of the pathfinder algorithm (range from 1 - 10 with default 1). Warning: higher values may slow down the game. See also the PathFinder entry in the <emlink href="definition/properties.html">DefCore</emlink>.</desc>
</param>
</params>
</syntax>
<desc>Searches for a path from start point to end point using the pathfinding algorithm as used by clonks and returns the length of the found path. Returns <code>nil</code> if no path was found.</desc>
<examples>
<example>
<code>var dist = GetPathLength(<funclink>GetX</funclink>(), <funclink>GetY</funclink>(), <funclink>GetX</funclink>(<funclink>FindBase</funclink>(<funclink>GetOwner</funclink>())), <funclink>GetY</funclink>(<funclink>FindBase</funclink>(<funclink>GetOwner</funclink>())));</code>
<text>Determines the distance from an object to its closest friendly base.</text>
</example>
</examples>
</func>
<author>PeterW</author><date>2002-04</date>
</funcs>
|
