(svn r26877) -Update: documentation about the map array

1 files changed, 53 insertions, 26 deletions

diff --git a/docs/landscape_grid.html b/docs/landscape_grid.html
index e2f3c1f97..0e0e86e34 100644
--- a/docs/landscape_grid.html
+++ b/docs/landscape_grid.html
@@ -28,13 +28,14 @@ the array so you can quickly see what is used and what is not.
 </ul>
 <p>
 <ul>
-  <li><span style="font-weight: bold;">type_height</span> - 8 bits in size, stores tile height (lower 4 bits) and tile class (upper 4 bits)</li>
+  <li><span style="font-weight: bold;">type</span> - 8 bits in size, tile class (bits 4..7), bridge (bits 2..3) tropic zone (bits 0..1, only valid in tropic climate)</li>
+  <li><span style="font-weight: bold;">height</span> - 8 bits in size, stores tile height</li>
   <li><span style="font-weight: bold;">m1</span> - 8 bits in size, used to identify the owner of that tile (eg piece of rail, bridge, etc.)</li>
   <li><span style="font-weight: bold;">m2</span> - 16 bits in size, used to identify the index of the given tile (object) in the (object-)array</li>
   <li><span style="font-weight: bold;">m3</span> - 8 bits in size, is used for general storage</li>
   <li><span style="font-weight: bold;">m4</span> - 8 bits in size, is used for general storage</li>
   <li><span style="font-weight: bold;">m5</span> - 8 bits in size, is used for general storage</li>
-  <li><span style="font-weight: bold;">m6</span> - 8 bits in size, special meaning : lower 2 bits only valid in tropic climate, upper 2 bits for bridges</li>
+  <li><span style="font-weight: bold;">m6</span> - 8 bits in size, is used for general storage</li>
   <li><span style="font-weight: bold;">m7</span> - 8 bits in size, is used for general storage</li>
 </ul>
 
@@ -42,7 +43,8 @@ the array so you can quickly see what is used and what is not.
   <tbody>
     <tr>
       <th colspan=2>class</th>
-      <th>type_height (8)</th>
+      <th>type (8)</th>
+      <th>height (8)</th>
       <th>m1 (8)</th>
       <th>m2 (16)</th>
       <th>m3 (8)</th>
@@ -55,6 +57,7 @@ the array so you can quickly see what is used and what is not.
       <td colspan=2 class="caption">bits</td>
       <td class="bits">7654 3210</td>
       <td class="bits">7654 3210</td>
+      <td class="bits">7654 3210</td>
       <td class="bits">FEDC BA98 7654 3210</td>
       <td class="bits">7654 3210</td>
       <td class="bits">7654 3210</td>
@@ -66,69 +69,75 @@ the array so you can quickly see what is used and what is not.
       <td rowspan="2">0</td>
       <td class="caption">ground</td>
       <td class="bits">XXXX XXXX</td>
+      <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">OOO</span><span class="option">~ ~~~~</span></td>
       <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
       <td class="bits">XXXX <span class="free">OOOO</span></td>
       <td class="bits">XXXX XX<span class="free">OO</span></td>
       <td class="bits">XXXX XXXX</td>
-      <td class="bits">XX<span class="free">O</span>X XXXX</td>
+      <td class="bits"><span class="free">OOO</span>X XX<span class="free">OO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">farmland</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits">XXXX XXXX XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
-      <td class="bits">XX<span class="free">O</span>X XXXX</td>
+      <td class="bits"><span class="free">OOO</span>X XX<span class="free">OO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
       <td rowspan=3>1</td>
       <td class="caption">rail</td>
       <td class="bits">XXXX XXXX</td>
+      <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">OOO</span>X XXXX</td>
       <td class="bits"><span class="free">OOOO</span> XXXX <span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO</span> XXXX</td>
       <td class="bits"><span class="free">OOOO</span> XXXX</td>
       <td class="bits">XXXX XXXX</td>
-      <td class="bits">XX<span class="free">OO OO</span>XX</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">rail with signals</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits"><span class="free">OOOO</span> XXXX XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">-inherit-</td>
-      <td class="bits">XX<span class="free">OO OO</span>XX</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">depot</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits">XXXX XXXX XXXX XXXX</td>
       <td class="bits"><span class="free">OOOO</span> XXXX</td>
       <td class="bits"><span class="free">OOOO</span> XXXX</td>
       <td class="bits">XX<span class="free">O</span>X <span class="free">OO</span>XX</td>
-      <td class="bits">XX<span class="free">OO OO</span>XX</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
       <td rowspan=3>2</td>
       <td class="caption">road</td>
       <td class="bits">XXXX XXXX</td>
+      <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">OOO</span>X XXXX</td>
       <td class="bits">XXXX XXXX XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">XXXX XXXX</td>
-      <td class="bits">XXXX X<span class="free">O</span>XX</td>
+      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
       <td class="bits">XXX<span class="free">O</span> XXXX</td>
     </tr>
     <tr>
@@ -136,10 +145,11 @@ the array so you can quickly see what is used and what is not.
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">-inherit-</td>
       <td class="bits">XXXX<span class="free"> OOO</span>X</td>
-      <td class="bits">XXXX X<span class="free">O</span>XX</td>
+      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
       <td class="bits">XXXX XXXX</td>
     </tr>
     <tr>
@@ -147,10 +157,11 @@ the array so you can quickly see what is used and what is not.
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">XX<span class="free">OO OO</span>XX</td>
-      <td class="bits">XX<span class="free">OO OO</span>XX</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">XXX<span class="free">O OOOO</span></td>
     </tr>
     <tr>
@@ -158,35 +169,38 @@ the array so you can quickly see what is used and what is not.
       <td class="caption">house</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
+      <td class="bits">XXXX XXXX</td>
       <td class="bits">XXXX XXXX XXXX XXXX</td>
       <td class="bits">XX<span class="free">O</span><span class="option">~ ~~</span>XX</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">XXX<span class="abuse">X XXXX</span></td>
-      <td class="bits"><span class="abuse">XXXX XX</span>XX</td>
+      <td class="bits"><span class="abuse">XXXX XX</span><span class="free">OO</span></td>
       <td class="bits">XXXX <span class="abuse">XXXX</span></td>
     </tr>
     <tr>
       <td>4</td>
       <td class="caption">trees</td>
       <td class="bits">XXXX XXXX</td>
+      <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">OOO</span><span class="option">~ ~~~~</span></td>
       <td class="bits"><span class="free">OOOO OOO</span>X XXXX XXXX</td>
       <td class="bits"><span class="option">~~</span>XX XXXX</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">XX<span class="free">OO O</span>XXX</td>
-      <td class="bits"><span class="free">OOOO OO</span>XX</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
       <td rowspan=7>5</td>
       <td class="caption">rail station</td>
       <td class="bits">XXXX XXXX</td>
+      <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">O</span>XXX XXXX</td>
       <td class="bits">XXXX XXXX XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OO</span>XX XXXX</td>
+      <td class="bits"><span class="free">OO</span>XX XX<span class="free">OO</span></td>
       <td class="bits">XXXX XXXX</td>
     </tr>
     <tr>
@@ -199,16 +213,18 @@ the array so you can quickly see what is used and what is not.
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
     </tr>
     <tr>
       <td class="caption">road stop</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits">XXXX <span class="free">OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="option">~~~~ ~</span>XXX</td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">O</span>XX</td>
+      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
       <td class="bits">XX<span class="free">O</span>X XXXX</td>
     </tr>
     <tr>
@@ -216,10 +232,11 @@ the array so you can quickly see what is used and what is not.
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="option">~~~~ ~</span>XXX</td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">O</span>XX</td>
+      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
@@ -227,10 +244,11 @@ the array so you can quickly see what is used and what is not.
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits">XXXX <span class="free">OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">O</span>XX</td>
+      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
       <td class="bits">XXXX XXXX</td>
     </tr>
     <tr>
@@ -238,10 +256,11 @@ the array so you can quickly see what is used and what is not.
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="option">~~~~ ~~~~</span></td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">O</span>XX</td>
+      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
@@ -249,68 +268,74 @@ the array so you can quickly see what is used and what is not.
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="option">~~~~ ~~~~</span></td>
-      <td class="bits"><span class="free">OO</span>XX X<span class="free">O</span>XX</td>
+      <td class="bits"><span class="free">OO</span>XX X<span class="free">OOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
       <td rowspan=3>6</td>
       <td class="caption">sea, shore</td>
       <td class="bits">XXXX XXXX</td>
+      <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">O</span>XXX XXXX</td>
       <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">X<span class="option">~~</span>X XXXX</td>
-      <td class="bits">XX<span class="free">OO OO</span>XX</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">canal, river</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">-inherit-</td>
-      <td class="bits">XX<span class="free">OO OO</span>XX</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
       <td class="caption">shipdepot</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
+      <td class="bits">-inherit-</td>
       <td class="bits">XXXX XXXX XXXX XXXX</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">-inherit-</td>
-      <td class="bits">XX<span class="free">OO OO</span>XX</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
     </tr>
     <tr>
       <td>8</td>
       <td class="caption">industry</td>
       <td class="bits">XXXX XXXX</td>
+      <td class="bits">XXXX XXXX</td>
       <td class="bits">XXX<span class="free">O</span> <span class="abuse">XXXX</span></td>
       <td class="bits">XXXX XXXX XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
-      <td class="bits"><span class="free">OO</span>XX XXXX</td>
+      <td class="bits"><span class="free">OO</span>XX XX<span class="free">OO</span></td>
       <td class="bits">XXXX XXXX</td>
     </tr>
     <tr>
       <td rowspan=2>9</td>
       <td class="caption">tunnel entrance</td>
       <td class="bits">XXXX XXXX</td>
+      <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">OOO</span>X XXXX</td>
       <td class="bits"><span class="free">OOOO OOOO OOOO OOOO</span></td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">X<span class="free">OO</span>X XXXX</td>
-      <td class="bits">XX<span class="free">OO OO</span>XX</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">XXXX XXXX</td>
     </tr>
     <tr>
@@ -321,19 +346,21 @@ the array so you can quickly see what is used and what is not.
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
       <td class="bits">-inherit-</td>
-      <td class="bits">XXXX XXXX</td>
+      <td class="bits">-inherit-</td>
+      <td class="bits"><span class="free">OO</span>XX XX<span class="free">OO</span></td>
       <td class="bits">-inherit-</td>
     </tr>
     <tr>
       <td rowspan=2>A</td>
       <td class="caption">objects</td>
       <td class="bits">XXXX XXXX</td>
+      <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">O</span>XXX XXXX</td>
       <td class="bits">XXXX XXXX XXXX XXXX</td>
       <td class="bits">XXXX XXXX</td>
       <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">XXXX XXXX</td>
-      <td class="bits">XX<span class="free">OO OO</span>XX</td>
+      <td class="bits"><span class="free">OOOO OOOO</span></td>
       <td class="bits">XXXX XXXX</td>
     </tr>
   </tbody>