add documentation for BlastFree

docs/sdk/material/ocm.xml

@@ -23,7 +23,7 @@
         <row>
           <col>ColorAnimation</col>
           <col>Integer</col>
-          <col>0 oder 1. Color animation.</col>
+          <col>0 or 1. Color animation.</col>
         </row>
         <row>
           <col>Shape</col>
@@ -33,7 +33,7 @@
         <row>
           <col>Density</col>
           <col>Integer</col>
-          <col>Density: 50 solid, 25 liquid (other values not allowed).</col>
+          <col>A density of 25 and above is liquid. 50 and above is solid. <funclink>BlastFree</funclink> offers a parameter to only blast solid materials of a given density or lower.</col>
         </row>
         <row>
           <col>Friction</col>
@@ -43,12 +43,12 @@
         <row>
           <col>DigFree</col>
           <col>Integer</col>
-          <col>0 oder 1. Determines wether the material can be dug into.</col>
+          <col>0 or 1. Determines wether the material can be dug into.</col>
         </row>
         <row>
           <col>BlastFree</col>
           <col>Integer</col>
-          <col>0 oder 1. Determines whether the material can be blasted away.</col>
+          <col>0 or 1. Determines whether the material can be blasted away.</col>
         </row>
         <row>
           <col>Blast2Object</col>
@@ -83,7 +83,7 @@
         <row>
           <col>Instable</col>
           <col>Integer</col>
-          <col>0 oder 1. Stability.</col>
+          <col>0 or 1. Stability.</col>
         </row>
         <row>
           <col>MaxAirSpeed</col>

docs/sdk/script/fn/BlastFree.xml

@@ -0,0 +1,54 @@
+<?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>BlastFree</title>
+    <category>Landscape</category>
+    <version>5.1 OC</version>
+    <syntax>
+      <rtype>int</rtype>
+      <params>
+        <param>
+          <type>int</type>
+          <name>x</name>
+          <desc>X coordinate</desc>
+        </param>
+        <param>
+          <type>int</type>
+          <name>y</name>
+          <desc>Y coordinate</desc>
+        </param>
+        <param>
+          <type>int</type>
+          <name>radius</name>
+          <desc>Radius</desc>
+        </param>
+        <param>
+          <type>int</type>
+          <name>caused_by</name>
+          <desc>The controller of objects that are created by the blast. See Blast2Objects in <emlink href="material/ocm.html">material definitions</emlink>. If not set, the controller is the owner of the calling object.</desc>
+		  <optional />
+        </param>
+        <param>
+          <type>int</type>
+          <name>max_density</name>
+          <desc>Only materials of the given density or lower are blasted by this explosion. If not specified, any material is blasted.</desc>
+		  <optional />
+        </param>
+      </params>
+    </syntax>
+    <desc>Blasts a hole in solid materials. </desc>
+    <examples>
+      <example>
+        <code>BlastFree(300, 300, 40, nil, 70);</code>
+        <text>Blasts a hole into the landscape with the center of the blast being 300,300. Additionally, only materials of a density of 70 or lower are blasted, so this blast does not blast granite.</text>
+      </example>
+    </examples>
+    <related>
+      <funclink>Explode</funclink>
+    </related>
+  </func>
+  <date>2014-01</date>
+</funcs>

docs/sdk/script/fn/DigFree.xml

@@ -29,11 +29,13 @@
           <type>bool</type>
           <name>no_dig2objects</name>
           <desc>Prevent objects from being dug out</desc>
+          <optional />
         </param>
         <param>
           <type>bool</type>
           <name>no_instability_check</name>
           <desc>Does not perform instability checks around dug pixels, i.e. prevents surrounding single pixels and liquids from becoming loose.</desc>
+          <optional />
         </param>
       </params>
     </syntax>
@@ -46,8 +48,7 @@
     </examples>
     <related>
       <funclink>DigFreeRect</funclink>
-      <funclink>Explode</funclink>
     </related>
   </func>
-  <author>jwk</author><date>2002-04</date>
+  <date>2013-03</date>
 </funcs>

docs/sdk/script/fn/DigFreeRect.xml

@@ -34,11 +34,13 @@
           <type>bool</type>
           <name>no_dig2objects</name>
           <desc>Prevent objects from being dug out</desc>
+          <optional />
         </param>
         <param>
           <type>bool</type>
           <name>no_instability_check</name>
           <desc>Does not perform instability checks around dug pixels, i.e. prevents surrounding single pixels and liquids from becoming loose.</desc>
+          <optional />
         </param>
       </params>
     </syntax>
@@ -52,5 +54,5 @@
     </examples>
     <related><funclink>DigFree</funclink></related>
   </func>
-  <author>jwk</author><date>2002-04</date>
+  <date>2013-03</date>
 </funcs>

docs/sdk/script/fn/Explode.xml

@@ -41,7 +41,8 @@
     <related>
       <funclink>RemoveObject</funclink>
       <funclink>BlastObjects</funclink>
-    </related>
+      <funclink>BlastFree</funclink>
+	</related>
   </func>
   <author>Sven2</author><date>2001-11</date>
   <author>Clonkonaut</author><date>2008-04</date>