diff options
| author | Darkvater <darkvater@openttd.org> | 2005-03-11 18:31:56 +0000 |
|---|---|---|
| committer | Darkvater <darkvater@openttd.org> | 2005-03-11 18:31:56 +0000 |
| commit | fea811a4b7734e57bc982860a23574bdf96beb4b (patch) | |
| tree | a393b49aa21cda0100f9ca77740f61bab0b81896 | |
| parent | d755b7908e6df3a3f8912cc137d39ff0518a0686 (diff) | |
| download | openttd-fea811a4b7734e57bc982860a23574bdf96beb4b.tar.xz | |
(svn r1991) - Fix: Fix some of the gaping holes in the colouring, and added some additional info
| -rw-r--r-- | docs/landscape.html | 15 | ||||
| -rw-r--r-- | docs/landscape_grid.html | 155 |
2 files changed, 88 insertions, 82 deletions
diff --git a/docs/landscape.html b/docs/landscape.html index 4b57808a1..2f4f6c775 100644 --- a/docs/landscape.html +++ b/docs/landscape.html @@ -2,22 +2,19 @@ <html> <head> <meta name="Author" content="Marcin Grzegorczyk"> -<meta name="Description" content="Structure of Transport Tycoon Deluxe (TTD) savegame files"> +<meta name="Description" content="Structure of OpenTTD (OTTD) landscape arrays"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> -<title>Transport Tycoon Deluxe savegame internals</title> +<title>OpenTTD Landscape Internals</title> </head> <body> <h3><a name="Landscape">Landscape</a></h3> <p> -Five arrays are used to encode the information of the contents of each tile. These arrays are referred to as <a href="#_landscape1">map_owner</a>, <a href="#_landscape2">map2</a>, <a href="#_landscape3">map3_lo</a>, <a href="#_landscape4">type_and_height</a> and <a href="#_landscape5">map5</a>. The known encodings are listed in the table below. The most important value is the class of a tile, stored in the upper 4 bits of the type_and_height array. The lower 4 bits are used to encode the height and slope data. For a graphical represenation of the tile-layout have a look at <a href="landscape_grid.html">Landscape grid</a> page. +Five arrays are used to encode the information of the contents of each tile. These arrays are referred to as "<span style="font-weight: bold;">map_owner</span>", "<span style="font-weight: bold;">map2</span>", "<span style="font-weight: bold;">map3_lo|_hi</span>", "<span style="font-weight: bold;">map_type_and_height</span>" and "<span style="font-weight: bold;">map5</span>". The known encodings are listed in the table below. The most important value is the class of a tile, stored in the upper 4 bits of the type_and_height array. The lower 4 bits are used to encode the height and slope data. For a graphical represenation of the tile-layout have a look at <a href="landscape_grid.html">Landscape grid</a> page. </p> <p> -<a name="OwnershipInfo">Owner values</a> <tt>00</tt> through <tt>07</tt> are companies (they're indices into the <a href="#_CompanyArray">array of companies</a>), <tt>10</tt> is no owner, <tt>11</tt> appears to be reserved for water, <tt>80</tt> and above are towns (in this case the low 7 bits contain an index into the <a href="#_TownArray">town array</a>). -</p> -<p> -TTD's class-specific periodic tile processing routine is called once every +256 ticks for each tile. +OTTD's class-specific periodic tile processing routine is called once every +256 ticks for each tile. </p> <table border=1 cellpadding=3> @@ -606,13 +603,13 @@ map5 bit 5 set: </td></tr> <tr><td colspan=2> -Classes <tt>B</tt> through <tt>F</tt> are reserved. The presence of a tile in one of the reserved classes will crash TTD. +Classes <tt>B</tt> through <tt>F</tt> are reserved. The presence of a tile in one of the reserved classes will crash OTTD. </td></tr> </table> <hr> -Copyright © 2003 by Marcin Grzegorczyk.<br> +Original Copyright © 2003 by Marcin Grzegorczyk for TTDLX.<br> Transport Tycoon and Transport Tycoon Deluxe are Copyright © by Chris Sawyer. All the other trademarks are the property of their respective owners.<br> </body> diff --git a/docs/landscape_grid.html b/docs/landscape_grid.html index 6703a75d8..df11897c4 100644 --- a/docs/landscape_grid.html +++ b/docs/landscape_grid.html @@ -2,47 +2,57 @@ <html> <head> <meta content="text/html; charset=UTF-8" http-equiv="content-type"> - <title>Transport Tycoon Savegame -Internals - Landscape #2</title> + <meta name="Description" content="Structure of OpenTTD (OTTD) landscape arrays #2"> + <title>OpenTTD Landscape Internals - #2</title> + <style type="text/css"> + .freebits { background-color: rgb(30, 178, 54);} + .abuse { background-color: rgb(255, 58, 31);} + </style> </head> <body style="direction: ltr;"> <h3 style="font-weight: bold;">Landscape</h3> -<span style="font-weight: bold;"></span>Five -arrays are used to encode the information of the contents of the tile. -This can be seen in the <a href="landscape.html">Landscape</a> -document. This page tries to give an overview of used and free bits of -the array so you can quickly see what is used and what is not.<br> +<span style="font-weight: bold;"></span>Five arrays are used to encode the information of the contents of the tile. +This can be seen in the <a href="landscape.html">Landscape</a> document. This page tries to give an overview of used and free bits of +the array so you can quickly see what is used and what is not. <ul> - <li><span style="font-weight: bold;">O</span> -- bit is free</li> - <li><span style="font-weight: bold;">X</span> -- bit is used</li> + <li><span style="font-weight: bold;"><span class="freebits">O</span></span> - bit is free</li> + <li><span style="font-weight: bold;">X</span> - bit is used</li> + <li><span style="font-weight: bold;"><span class="abuse"> </span></span> - bit of _map_* is abused for different purposes</li> </ul> +<p> +<ul> + <li><span style="font-weight: bold;">_map_owner[]</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;">_map2[]</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;">_map3[]</span> - 16 bits in size, which is split up into _map3lo[] and _map3hi[] is used for general storage.</li> + <li><span style="font-weight: bold;">_map_type_and_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;">_map5[]</span> - 8 bits in size, is used for general storage.</li> +</ul> + <table style="text-align: left;" border="1" cellpadding="2" cellspacing="2" width="100%"> <tbody> <tr> - <td style="white-space: nowrap; text-align: left;">type</td> - <td style="white-space: nowrap; text-align: center;">_map_owner[L1]</td> - <td style="white-space: nowrap; text-align: center;">_map2[L2]</td> - <td style="white-space: nowrap; text-align: center;">_map3[lo& hi,L3]</td> - <td style="white-space: nowrap; text-align: center;">_map_type_and_height[L4]</td> - <td style="white-space: nowrap; text-align: center;">_map5[L5]</td> + <th style="white-space: nowrap; text-align: left;">class</th> + <th style="white-space: nowrap; text-align: center;">_map_owner[L1] (8)</th> + <th style="white-space: nowrap; text-align: center;">_map2[L2] (16)</th> + <th style="white-space: nowrap; text-align: center;">_map3[lo& hi,L3] (16)</th> + <th style="white-space: nowrap; text-align: center;">_map_type_and_height[L4] (8)</th> + <th style="white-space: nowrap; text-align: center;">_map5[L5] (8)</th> </tr> <tr> - <td style="white-space: nowrap; text-align: left;">ground</td> + <td style="white-space: nowrap; text-align: left;">(0) ground</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOOO OOOO</span></td> - <td style="white-space: nowrap; text-align: center;">XXXX <span style="background-color: rgb(30, 178, 54);">OOOO OO</span>XX XXXX</td> + <td style="white-space: nowrap; text-align: center;"><span class="freebits">OOOO OOOO OOOO OOOO</span></td> + <td style="white-space: nowrap; text-align: center;">XXXX <span class="freebits">OOOO OO</span>XX XXXX</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;">XXXX X<span style="background-color: rgb(30, 178, 54);">O</span>XX</td> + <td style="white-space: nowrap; text-align: center;">XXXX X<span class="freebits">O</span>XX</td> </tr> <tr> - <td style="white-space: nowrap; text-align: left;">rail</td> - <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;">XXXX XXXX <span style="background-color: rgb(30, 178, 54);">OOOO OOOO</span><br> + <td style="white-space: nowrap; text-align: left;">(1) rail</td> + <td style="white-space: nowrap; text-align: center;"><span class="abuse">XXXX XXXX</span></td> + <td style="white-space: nowrap; text-align: center;">XXXX XXXX <span class="freebits">OOOO OOOO</span><br> </td> - <td style="white-space: nowrap; text-align: center;">XXXX XXXX XXX<span style="background-color: rgb(30, 178, 54);">O OOOO</span><br> + <td style="white-space: nowrap; text-align: center;">XXXX XXXX XXX<span class="freebits">O OOOO</span><br> </td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX<br> @@ -51,105 +61,105 @@ the array so you can quickly see what is used and what is not.<br> <tr> <td> <ul> - <li>depot/checkpoint</li> + <li style="white-space: nowrap; text-align: left;">depot/checkpoint</li> </ul> </td> <td style="text-align: center;">-inherit-</td> - <td style="text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOOO OOOO</span></td> - <td style="text-align: center;">XXXX X<span style="background-color: rgb(30, 178, 54);">OOO</span> XXXX XXXX</td> + <td style="text-align: center;"><span class="freebits">OOOO OOOO OOOO OOOO</span></td> + <td style="text-align: center;">XXXX X<span class="freebits">OOO</span> XXXX XXXX</td> <td style="text-align: center;">-inherit-</td> - <td style="white-space: nowrap; text-align: center;">XXX<span style="background-color: rgb(30, 178, 54);">O OO</span>XX</td> + <td style="white-space: nowrap; text-align: center;">XXX<span class="freebits">O OO</span>XX</td> </tr> <tr> - <td>road</td> + <td style="white-space: nowrap; text-align: left;">(2) road</td> <td style="text-align: center;">XXXX XXXX</td> - <td style="text-align: center;">XXXX XXXX XXXX XXXX</td> - <td style="text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO</span> XXXX XXXX</td> + <td style="text-align: center;"><span class="abuse">XXXX XXXX XXXX XXXX</span></td> + <td style="text-align: center;"><span class="freebits">OOOO OOOO</span> XXXX XXXX</td> <td style="text-align: center;">XXXX XXXX</td> <td style="text-align: center;">XXXX XXXX</td> </tr> <tr> <td> <ul> - <li>level crossing</li> + <li style="white-space: nowrap; text-align: left;">level crossing</li> </ul> </td> <td style="text-align: center;">-inherit-</td> - <td style="text-align: center;">XXXX XXXX XXXX XXXX</td> + <td style="text-align: center;"><span class="abuse">XXXX XXXX XXXX XXXX</span></td> <td style="text-align: center;">XXXX XXXX XXXX XXXX</td> <td style="text-align: center;">-inherit-</td> - <td style="text-align: center;"><span style="background-color: rgb(30, 178, 54);">OO</span>XX XXXX</td> + <td style="text-align: center;"><span class="freebits">OO</span>XX XXXX</td> </tr> <tr> <td> <ul> - <li>road depot</li> + <li style="white-space: nowrap; text-align: left;">road depot</li> </ul> </td> <td style="text-align: center;">-inherit-</td> - <td style="text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOOO OOOO</span></td> - <td style="text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOOO OOO</span>X</td> + <td style="text-align: center;"><span class="freebits">OOOO OOOO OOOO OOOO</span></td> + <td style="text-align: center;"><span class="freebits">OOOO OOOO OOOO OOO</span>X</td> <td style="text-align: center;">-inherit-</td> <td style="text-align: center;">XXXX XXXX</td> </tr> <tr> - <td style="white-space: nowrap; text-align: left;">town</td> - <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> + <td style="white-space: nowrap; text-align: left;">(3) town</td> + <td style="white-space: nowrap; text-align: center;"><span class="abuse">XXXX XXXX</span></td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX XXXX XXXX<br> </td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX XXXX XXXX<br> </td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;">XXXX XXOX</td> + <td style="white-space: nowrap; text-align: center;">XXXX XX<span class="freebits">O</span>X</td> </tr> <tr> - <td style="white-space: nowrap; text-align: left;">trees</td> - <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;">XXXX XX<span style="background-color: rgb(30, 178, 54);">OO OOOO OOOO</span></td> - <td style="white-space: nowrap; text-align: center;">XXXX XXXX OOXX XXXX</td> + <td style="white-space: nowrap; text-align: left;">(4) trees</td> + <td style="white-space: nowrap; text-align: center;"><span class="abuse">XXXX XXXX</span></td> + <td style="white-space: nowrap; text-align: center;">XXXX XX<span class="freebits">OO OOOO OOOO</span></td> + <td style="white-space: nowrap; text-align: center;">XXXX XXXX <span class="freebits">OO</span>XX XXXX</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;">XXX<span style="background-color: rgb(30, 178, 54);">O OO</span>XX</td> + <td style="white-space: nowrap; text-align: center;">XXX<span class="freebits">O OO</span>XX</td> </tr> <tr> - <td style="white-space: nowrap; text-align: left;">station</td> + <td style="white-space: nowrap; text-align: left;">(5) station</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;">XXXX XOOO XXXX XXXX</td> + <td style="white-space: nowrap; text-align: center;">XXXX X<span class="freebits">OOO</span> XXXX XXXX</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> </tr> <tr> - <td style="white-space: nowrap; text-align: left;">water</td> + <td style="white-space: nowrap; text-align: left;">(6) water</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOOO OOOO</span></td> - <td style="white-space: nowrap; text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOOO OOOO</span></td> + <td style="white-space: nowrap; text-align: center;"><span class="freebits">OOOO OOOO OOOO OOOO</span></td> + <td style="white-space: nowrap; text-align: center;"><span class="freebits">OOOO OOOO OOOO OOOO</span></td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> </tr> <tr> - <td style="white-space: nowrap; text-align: left;">industry</td> - <td style="white-space: nowrap; text-align: center;">XXXX X<span style="background-color: rgb(30, 178, 54);">OO</span>X</td> + <td style="white-space: nowrap; text-align: left;">(8) industry</td> + <td style="white-space: nowrap; text-align: center;"><span class="abuse">XXXX X</span><span class="freebits">OO</span><span class="abuse">X</span></td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOOO OOOO</span></td> + <td style="white-space: nowrap; text-align: center;"><span class="freebits">OOOO OOOO OOOO OOOO</span></td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> </tr> <tr> <td> <ul> - <li>bubble/sugar/toffee</li> + <li style="white-space: nowrap; text-align: left;">bubble/sugar/toffee</li> </ul> </td> <td style="text-align: center;">-inherit-</td> <td style="text-align: center;">-inherit-</td> - <td style="text-align: center;">XXXX XXXX <span style="background-color: rgb(30, 178, 54);">OOOO OOOO</span></td> + <td style="text-align: center;">XXXX XXXX <span class="freebits">OOOO OOOO</span></td> <td style="text-align: center;">-inherit-</td> <td style="text-align: center;">-inherit-</td> </tr> <tr> <td> <ul> - <li>toy factory</li> + <li style="white-space: nowrap; text-align: left;">toy factory</li> </ul> </td> <td style="text-align: center;">-inherit-</td> @@ -161,11 +171,10 @@ the array so you can quickly see what is used and what is not.<br> <tr> <td> <ul> - <li>gold/copper/coal</li> + <li style="white-space: nowrap; text-align: left;">gold/copper/coal</li> </ul> </td> - <td style="text-align: center;">XXXX -XXXX</td> + <td style="text-align: center;">XXXX XXXX</td> <td style="text-align: center;">-inherit-</td> <td style="text-align: center;">-inherit-</td> <td style="text-align: center;">-inherit-</td> @@ -174,7 +183,7 @@ XXXX</td> <tr> <td> <ul> - <li>oil wells</li> + <li style="white-space: nowrap; text-align: left;">oil wells</li> </ul> </td> <td style="text-align: center;">-inherit-</td> @@ -186,45 +195,45 @@ XXXX</td> <tr> <td> <ul> - <li>power station</li> + <li style="white-space: nowrap; text-align: left;">power station</li> </ul> </td> - <td style="text-align: center;">XXXX XX<span style="background-color: rgb(30, 178, 54);">O</span>X</td> + <td style="text-align: center;">XXXX XX<span class="freebits">O</span>X</td> <td style="text-align: center;">-inherit-</td> <td style="text-align: center;">-inherit-</td> <td style="text-align: center;">-inherit-</td> <td style="text-align: center;">-inherit-</td> </tr> <tr> - <td style="white-space: nowrap; text-align: left;">tunnel</td> + <td style="white-space: nowrap; text-align: left;">(9) tunnel</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOOO OOOO</span></td> - <td style="white-space: nowrap; text-align: center;">XXXX <span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOO</span>X</td> + <td style="white-space: nowrap; text-align: center;"><span class="freebits">OOOO OOOO OOOO OOOO</span></td> + <td style="white-space: nowrap; text-align: center;">XXXX <span class="freebits">OOOO OOOO OOO</span>X</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> </tr> <tr> <td> <ul> - <li>bridge</li> + <li style="white-space: nowrap; text-align: left;">bridge</li> </ul> </td> <td style="text-align: center;">XXXX XXXX</td> - <td style="text-align: center;">XXXX XXXX <span style="background-color: rgb(30, 178, 54);">OOOO OOOO</span></td> - <td style="text-align: center;">XXXX XXXX <span style="background-color: rgb(30, 178, 54);">OOOO OOO</span>X</td> + <td style="text-align: center;"><span class="abuse">XXXX XXXX</span> <span class="freebits">OOOO OOOO</span></td> + <td style="text-align: center;">XXXX XXXX <span class="freebits">OOOO OOO</span>X</td> <td style="text-align: center;">XXXX XXXX</td> <td style="text-align: center;">XXXX XXXX</td> </tr> <tr> - <td style="white-space: nowrap; text-align: left;">various (HQ)</td> + <td style="white-space: nowrap; text-align: left;">(10) various (HQ)</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> - <td style="white-space: nowrap; text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOOO OOOO</span></td> - <td style="white-space: nowrap; text-align: center;"><span style="background-color: rgb(30, 178, 54);">OOOO OOOO OOOO OOOO</span></td> + <td style="white-space: nowrap; text-align: center;"><span class="freebits">OOOO OOOO OOOO OOOO</span></td> + <td style="white-space: nowrap; text-align: center;"><span class="freebits">OOOO OOOO OOOO OOOO</span></td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> <td style="white-space: nowrap; text-align: center;">XXXX XXXX</td> </tr> </tbody> </table> -<br> + </body> </html> |