Document PathFree2 and CoordinateSpace

docs/sdk/playercontrols.xml

@@ -66,6 +66,11 @@
           <col>C4ID</col>
           <col>Optional ID that is passed to the script function. See <emlink href="playercontrols.xml#ExtraData">ExtraData</emlink>.</col>
         </row>
+        <row>
+          <literal_col>CoordinateSpace</literal_col>
+          <col>Game, Viewport</col>
+          <col>For viewport the given coordinates are relative to the players top left corner of the window. Default ist Game.</col>
+        </row>
         <row>
           <literal_col>SendCursorPos</literal_col>
           <col>Boolean</col>
@@ -218,7 +223,7 @@
        </row>
        <row>
          <literal_col>TriggerMode</literal_col>
-         <col>bitmask</col>
+         <col>Bitmask</col>
          <col>
            <text>
              Trigger mode of this mapping. Bitmask based on the following values:

docs/sdk/script/fn/PathFree.xml

@@ -50,6 +50,7 @@ for(var living in <funclink>FindObjects</funclink>(<funclink>Find_OCF</funclink>
       <funclink>GetMaterial</funclink>
       <funclink>GBackSolid</funclink>
       <funclink>GetPathLength</funclink>
+      <funclink>PathFree2</funclink>
     </related>
   </func>
   <author>Sven2</author><date>2002-08</date>

docs/sdk/script/fn/PathFree2.xml

@@ -0,0 +1,55 @@
+<?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>PathFree2</title>
+    <category>Landscape</category>
+    <version>5.1 OC</version>
+    <syntax>
+      <rtype>array</rtype>
+      <params>
+        <param>
+          <type>int</type>
+          <name>x1</name>
+          <desc>X coordinate of the start point</desc>
+        </param>
+        <param>
+          <type>int</type>
+          <name>y1</name>
+          <desc>Y coordinate of the start point</desc>
+        </param>
+        <param>
+          <type>int</type>
+          <name>x2</name>
+          <desc>X coordinate of the end point</desc>
+        </param>
+        <param>
+          <type>int</type>
+          <name>y2</name>
+          <desc>Y coordinate of the end point</desc>
+        </param>
+      </params>
+    </syntax>
+    <desc>Works like <emlink href="script/fn/PathFree.html">PathFree</emlink>, but instead returns an array containing the coordinates of the first solid pixel found on line. Returns nil if the path is free.</desc>
+    <remark>All coordinates are global, even in local calls.</remark>
+    <examples>
+      <example>
+        <code>var x = <funclink>Random</funclink>(<funclink>LandscapeWidth</funclink>()),
+	pos = PathFree2(x, 0, x, <funclink>LandscapeHeight</funclink>());
+if(pos)
+	<funclink>CreateObject</funclink>(Idol, pos[0], pos[1]);
+</code>
+        <text>Creates an Idol somewhere on the surface of the landscape.</text>
+      </example>
+    </examples>
+    <related>
+      <funclink>GetMaterial</funclink>
+      <funclink>GBackSolid</funclink>
+      <funclink>GetPathLength</funclink>
+      <funclink>PathFree</funclink>
+    </related>
+  </func>
+  <author>Apfelclonk</author><date>2014-04</date>
+</funcs>