Add GRF feature: New Landscape
Custom graphics using actions 1/2/3. Currently only for rock tiles
This commit is contained in:
Jonathan G Rennison
@@ -29,6 +29,7 @@
|
||||
<h3>Features with separate pages</h3>
|
||||
<ul>
|
||||
<li><a href="newgrf-roadstops-nml.html">Road stops (FEAT_ROADSTOPS)</a></li>
|
||||
<li><a href="newgrf-newlandscape-nml.html">New landscape (FEAT_NEWLANDSCAPE)</a></li>
|
||||
</ul>
|
||||
|
||||
<h3><a href="https://newgrf-specs.tt-wiki.net/wiki/NML:Builtin_functions">Builtin functions</a></h3>
|
||||
|
||||
@@ -29,6 +29,7 @@
|
||||
<h3 id="separate_features">Features with separate pages</h3>
|
||||
<ul>
|
||||
<li><a href="newgrf-roadstops.html">Road stops</a></li>
|
||||
<li><a href="newgrf-newlandscape.html">New landscape (custom graphics)</a></li>
|
||||
</ul>
|
||||
|
||||
<br />
|
||||
@@ -740,6 +741,7 @@
|
||||
<table>
|
||||
<tr><th>Feature name</th><th>Description</th></tr>
|
||||
<tr><td><font face="monospace">road_stops</font></td><td><a href="newgrf-roadstops.html">Custom road stops (bus stops, lorry stops and road waypoints)</a></d></tr>
|
||||
<tr><td><font face="monospace">new_landscape</font></td><td><a href="newgrf-newlandscape.html">Custom landscape graphics (currently rocky tiles only)</a></d></tr>
|
||||
</table>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
126
docs/newgrf-newlandscape-nml.html
Normal file
126
docs/newgrf-newlandscape-nml.html
Normal file
@@ -0,0 +1,126 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
<title>JGR's Patchpack - NewGRF New Landscape Addition to NewGRF Specifications in NML</title>
|
||||
<style type="text/css">
|
||||
td li { white-space: nowrap; text-align: left; }
|
||||
th { white-space: nowrap; text-align: center; }
|
||||
td, th { border: 1px solid #CCCCCC; padding: 0px 5px; }
|
||||
table { border-collapse: collapse; empty-cells: show; }
|
||||
.code { white-space: pre; font-family: "Courier New", Courier, mono; }
|
||||
.indent { margin-left: 2em; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h2>NewGRF New Landscape Addition to NewGRF Specifications in JGR's Patchpack in NML</h2>
|
||||
<p>This document describes the non-standard addition of the NewGRF new landscape feature to the <a href="https://newgrf-specs.tt-wiki.net/wiki/NML:Main">Official OpenTTD NML Specifications</a>, as implemented in this patchpack, and the associated <a href="https://github.com/JGRennison/nml">NML fork</a></p>
|
||||
<p>This feature allows NewGRF custom graphics using switches and spritesets for landscape tiles. Currently this includes: rock tiles.</p>
|
||||
<p>This feature may not necessarily match implementations of additional landscape graphics features in other patches, branches, etc.<br />
|
||||
This feature as implemented here MAY also be present in other patchpacks.</p>
|
||||
|
||||
<p>The feature identifier is <span class="code">FEAT_NEWLANDSCAPE</span>.<br />
|
||||
There is no permanent storage associated with this feature.</p>
|
||||
|
||||
<p>See the <a href="newgrf-additions-nml.html">NewGRF additions (NML)</a> document for background information on additions to NML.</p>
|
||||
|
||||
<p>See the associated <a href="newgrf-newlandscape.html">non-NML document</a> for more details on the NewGRF new landscape feature.</p>
|
||||
|
||||
<p>This feature will be automatically skipped when loaded into a version of OpenTTD which does not support this feature.<br />
|
||||
If this feature is the only significant thing in this GRF, then <span class="code">extended_feature_test("new_landscape")</span> SHOULD be called and some message, error or other form of
|
||||
signalling to the user used to inform the user that this version of OpenTTD does not support the feature, if the return value is false.<br />
|
||||
Otherwise the GRF could silently do nothing instead of the expected functionality, creating confusion for end users.</p>
|
||||
|
||||
<p><b>Sections:</b>
|
||||
<ul>
|
||||
<li><a href="#newlandscape_ids">IDs</a></li>
|
||||
<li><a href="#newlandscape_properties">Properties</a></li>
|
||||
<li><a href="#newlandscape_variables">Variables</a></li>
|
||||
<li><a href="#newlandscape_example">Syntax example</a></li>
|
||||
</ul></p>
|
||||
|
||||
<h3 id="newlandscape_ids">New Landscape IDs</h3>
|
||||
<p>
|
||||
The ID field for an item must be set to one of the IDs in the table below (further IDs may be allocated for other purposes in future).
|
||||
<table>
|
||||
<tr><th>ID</th><th>Landscape type</th></tr>
|
||||
<tr><td>NEW_LANDSCAPE_ID_ROCKS</td><td>Rocky tiles</td></tr>
|
||||
</table>
|
||||
</p>
|
||||
</p>
|
||||
|
||||
<h3 id="newlandscape_properties">New Landscape Properties</h3>
|
||||
|
||||
<table>
|
||||
<tr><th>Property</th><th>Value range</th><th>Comment</th></tr>
|
||||
<tr><td>enable_recolour</td><td>0 or 1</td>
|
||||
<td>
|
||||
Enable recolouring of graphics.<br />
|
||||
When enabled, in addition to returning a sprite, register 0x100 may be set to the following using STORE_TEMP:
|
||||
<table>
|
||||
<tr><th>Bits</th><th>Meaning</th></tr>
|
||||
<tr><td>0 - 23</td><td>Recolour sprite to use. Set to 0 for no recolouring.</td></tr>
|
||||
<tr><td>24 - 31</td><td>Reserved, set to zero.</td></tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h3 id="newlandscape_variables">New Landscape Variables</h3>
|
||||
|
||||
<p>A number of variables are shared between new landscape and stations. These are listed on the <a href="https://newgrf-specs.tt-wiki.net/wiki/NML:Stations#Base_station_variables">stations</a> page.</p>
|
||||
|
||||
<table>
|
||||
<tr><th>Name</th><th>Value range</th><th>Comment</th></tr>
|
||||
<tr><td>terrain_type</td><td>TILETYPE_XXX</td><td>XXX = NORMAL | DESERT | RAIN_FOREST | SNOW</td></tr>
|
||||
<tr><td>tile_slope</td><td>SLOPE_XXX</td><td>See <a href="https://newgrf-specs.tt-wiki.net/wiki/NML:List_of_tile_slopes">tile slopes</a> for an overview of possible values</td></tr>
|
||||
<tr><td>tile_height</td><td>0..255</td><td>Height of the lowest corner of the tile</td></tr>
|
||||
<tr><td>tile_hash</td><td>0..4294967295</td><td>Hash value derived from the coordinates of the tile, suitable for pseudo-randomising graphics</td></tr>
|
||||
<tr><td>landscape_type</td><td>NEW_LANDSCAPE_TYPE_XXX</td><td>Landscape type<br />XXX = ROCKS</td></tr>
|
||||
</table>
|
||||
<br />
|
||||
Variables that require one or more parameters:
|
||||
<table>
|
||||
<tr><th>Name</th><th>Arguments</th><th>Value range</th><th>Comment</th></tr>
|
||||
<tr><td>nearby_tile_slope</td><td>x, y offset (-8..7)</td><td>SLOPE_XXX</td><td>Slope of a nearby tile</td></tr>
|
||||
<tr><td>nearby_tile_is_same_type</td><td>x, y offset (-8..7)</td><td>0 | 1</td><td>Is nearby tile the same landscape type as this one?</td></tr>
|
||||
<tr><td>nearby_tile_is_water</td><td>x, y offset (-8..7)</td><td>0 | 1</td><td>Is nearby tile a water tile?</td></tr>
|
||||
<tr><td>nearby_tile_terrain_type</td><td>x, y offset (-8..7)</td><td></td><td>See terrain_type</td></tr>
|
||||
<tr><td>nearby_tile_water_class</td><td>x, y offset (-8..7)</td><td>WATER_CLASS_XXX</td><td>XXX = [NONE | SEA | CANAL | RIVER]<br />Note that tiles for which nearby_tile_is_water is 0 may still have a water class, e.g. industry tiles with water beneath them. </td></tr>
|
||||
<tr><td>nearby_tile_height</td><td>x, y offset (-8..7)</td><td></td><td>The minimum height of the given tile in height level units</td></tr>
|
||||
<tr><td>nearby_tile_class</td><td>x, y offset (-8..7)</td><td><a href="https://newgrf-specs.tt-wiki.net/wiki/NML:List_of_tile_classes">tile class</a></td><td></td></tr>
|
||||
<tr><td>nearby_tile_info</td><td>x, y offset (-8..7)</td><td></td><td>Above nearby tile variables in one variable (all of variable 0x60)</td></tr>
|
||||
</table>
|
||||
|
||||
<h3 id="newlandscape_example">Syntax example</h3>
|
||||
<p>
|
||||
<pre class="code">
|
||||
grf {
|
||||
...
|
||||
}
|
||||
|
||||
if (!extended_feature_test("new_landscape")) {
|
||||
error(FATAL, string(STR_UNSUPPORTED_VERSION));
|
||||
}
|
||||
|
||||
|
||||
spriteset spriteset_rocks {
|
||||
/* 19 tile sprites in the standard order */
|
||||
}
|
||||
|
||||
switch (FEAT_NEWLANDSCAPE, SELF, switch_rocks, ...) {
|
||||
...
|
||||
}
|
||||
|
||||
item (FEAT_NEWLANDSCAPE, item_rocks, NEW_LANDSCAPE_ID_ROCKS) {
|
||||
property {
|
||||
enable_recolour: 0;
|
||||
}
|
||||
graphics {
|
||||
default: switch_rocks;
|
||||
}
|
||||
}
|
||||
</pre>
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
124
docs/newgrf-newlandscape.html
Normal file
124
docs/newgrf-newlandscape.html
Normal file
@@ -0,0 +1,124 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
<title>JGR's Patchpack - NewGRF New Landscape Addition to NewGRF Specifications</title>
|
||||
<style type="text/css">
|
||||
td li { white-space: nowrap; text-align: left; }
|
||||
th { white-space: nowrap; text-align: center; }
|
||||
td, th { border: 1px solid #CCCCCC; padding: 0px 5px; }
|
||||
table { border-collapse: collapse; empty-cells: show; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<h2>NewGRF New Landscape Addition to NewGRF Specifications in JGR's Patchpack</h2>
|
||||
<p>This document describes the non-standard addition of the NewGRF new landscape feature to the <a href="https://newgrf-specs.tt-wiki.net/wiki/Main_Page">Official OpenTTD NewGRF Specifications</a>, as implemented in this patchpack.</p>
|
||||
<p>This feature allows NewGRF custom graphics using Action 1/2/3 for landscape tiles. Currently this includes: rock tiles.</p>
|
||||
<p>This feature may not necessarily match implementations of additional landscape graphics features in other patches, branches, etc.<br />
|
||||
This feature as implemented here MAY also be present in other patchpacks.</p>
|
||||
<p>See the <a href="newgrf-additions.html">NewGRF additions</a> document for background information on additions to the NewGRF specifications.</p>
|
||||
<p>The functionality listed below is also supported in a fork of NML, see the associated <a href="newgrf-newlandscape-nml.html">NML new landscape</a> and <a href="newgrf-additions-nml.html">NML additions</a> documents for more details.</p>
|
||||
<p>NewGRFs which use this feature SHOULD use the <a href="newgrf-additions.html#feature-test">feature testing</a> mechanism to check whether the new landscape feature and/or feature ID mapping is supported.</p>
|
||||
<p>NewGRFs which use this feature MUST use the <a href="newgrf-additions.html#feature-id-mapping">feature ID mapping</a> mechanism to map the non-standard NewGRF road stop feature to a local feature ID.</p>
|
||||
<p>This feature is indicated by the feature name: <font face="monospace">new_landscape</font>, version 1.<br />
|
||||
The feature name to use for feature ID mapping is <font face="monospace">new_landscape</font>.<br />
|
||||
Features/properties/variables which require a higher version will indicate the required version. Unless indicated otherwise these will fall back to doing nothing on versions which do not support them.</p>
|
||||
|
||||
<p><h3 id="ids">IDs:</h3>
|
||||
The ID field for Actions 0 and 3 must be set to one of the IDs in the table below (further IDs may be allocated for other purposes in future).
|
||||
<table>
|
||||
<tr><th>ID</th><th>Landscape type</th></tr>
|
||||
<tr><td>0</td><td>Rocky tiles</td></tr>
|
||||
</table>
|
||||
</p>
|
||||
|
||||
<p><h3 id="actions">Actions:</h3>
|
||||
<ul>
|
||||
<li><a href="#a0roadstops">Action 0</a></li>
|
||||
<li><a href="#a2roadstops">Action 2</a></li>
|
||||
<li><a href="#varaction2roadstops">Variational Action 2</a></li>
|
||||
<li><a href="#a3roadstops">Action 3</a></li>
|
||||
</ul></p>
|
||||
|
||||
<h3 id="a0roadstops">Action 0 - New Landscape</h3>
|
||||
|
||||
<p>See the <a href="https://newgrf-specs.tt-wiki.net/wiki/Action0">Action 0 Specification</a> for background information.</p>
|
||||
|
||||
<b>Properties:</b>
|
||||
<table>
|
||||
<tr><th>Mappable name</th><th>Size in bytes</th><th>Description</th></tr>
|
||||
<tr><td><a href="#newlandscape_enable_recolour">newlandscape_enable_recolour</a></td><td>1</td><td>Enable recolour</td></tr>
|
||||
</table>
|
||||
|
||||
<h4 id="newlandscape_enable_recolour">Enable recolouring for new landscape graphics (mappable property: newlandscape_enable_recolour)</h4>
|
||||
<p>When enabled, in addition to returning a sprite, register 0x100 may be set to the following:
|
||||
<table>
|
||||
<tr><th>Bits</th><th>Meaning</th></tr>
|
||||
<tr><td>0 - 23</td><td>Recolour sprite to use. Set to 0 for no recolouring.</td></tr>
|
||||
<tr><td>24 - 31</td><td>Reserved, set to zero. </td></tr>
|
||||
</table></p>
|
||||
<p>The property length is 1 byte. 0 is disabled (default). 1 is enabled.</p>
|
||||
|
||||
<h3 id="a2roadstops">Action 2 - New Landscape</h3>
|
||||
|
||||
<p>See the <a href="https://newgrf-specs.tt-wiki.net/wiki/Action2">Action 2 Specification</a> for background information.</p>
|
||||
|
||||
<p>New landscape <b>does not</b> use the special sprite layout format.</p>
|
||||
<br />
|
||||
|
||||
<h3 id="varaction2roadstops">Variational Action 2 - New Landscape</h3>
|
||||
|
||||
<p>See the <a href="https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2">Variational Action 2 Specification</a> for background information.</p>
|
||||
|
||||
<b>Variables:</b>
|
||||
<table>
|
||||
<tr><th>Number</th><th>Mappable name</th><th>Description</th></tr>
|
||||
<tr><td><a href="#newlandscape_terrain_type">40</a></td><td><a href="#newlandscape_terrain_type">newlandscape_terrain_type</a></td><td>Terrain type</td></tr>
|
||||
<tr><td><a href="#newlandscape_tile_slope">41</a></td><td><a href="#newlandscape_tile_slope">newlandscape_tile_slope</a></td><td>Tile Slope</td></tr>
|
||||
<tr><td><a href="#newlandscape_tile_height">42</a></td><td><a href="#newlandscape_tile_height">newlandscape_tile_height</a></td><td>Tile Height</td></tr>
|
||||
<tr><td><a href="#newlandscape_tile_hash">43</a></td><td><a href="#newlandscape_tile_hash">newlandscape_tile_hash</a></td><td>Tile Hash</td></tr>
|
||||
<tr><td><a href="#newlandscape_landscape_type">44</a></td><td><a href="#newlandscape_landscape_type">newlandscape_landscape_type</a></td><td>Landscape Type</td></tr>
|
||||
<tr><td><a href="#newlandscape_land_info_nearby_tiles">60</a></td><td><a href="#newlandscape_land_info_nearby_tiles">newlandscape_land_info_nearby_tiles</a></td><td>Land info of nearby tiles</td></tr>
|
||||
</table>
|
||||
|
||||
<h4 id="newlandscape_terrain_type">Tile terrain type (40, or mappable variable: newlandscape_terrain_type)</h4>
|
||||
<p>This has the same value as bits 0 - 7 of <a href="https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Objects#Tile_information_.2841.29">object (feature F) variable 41</a>.
|
||||
<table>
|
||||
<tr><th>Value</th><th>Meaning</th></tr>
|
||||
<tr><td>0</td><td>Normal</td></tr>
|
||||
<tr><td>1</td><td>Desert</td></tr>
|
||||
<tr><td>2</td><td>Rainforest</td></tr>
|
||||
<tr><td>4</td><td>On or above snowline</td></tr>
|
||||
</table>
|
||||
</p>
|
||||
|
||||
<h4 id="newlandscape_tile_slope">Tile slope (41, or mappable variable: newlandscape_tile_slope)</h4>
|
||||
<p>This has the same value as bits 0 - 7 of <a href="https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Industry_Tiles#Land_info_of_nearby_tiles_.2860.29">industry tile (feature 9) variable 60</a> for this tile.</p>
|
||||
|
||||
<h4 id="newlandscape_tile_height">Tile height (42, or mappable variable: newlandscape_tile_height)</h4>
|
||||
<p>The height of the lowest corner of the tile (in units of 1).</p>
|
||||
|
||||
<h4 id="newlandscape_tile_hash">Tile hash (43, or mappable variable: newlandscape_tile_hash)</h4>
|
||||
<p>Hash value derived from the coordinates of the tile, suitable for pseudo-randomising graphics.</p>
|
||||
|
||||
<h4 id="roadstop_land_info_nearby_tiles">Land info of nearby tile (60, or mappable variable: newlandscape_land_info_nearby_tiles)</h4>
|
||||
<p>This has the same value as <a href="https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Industry_Tiles#Land_info_of_nearby_tiles_.2860.29">industry tile (feature 9) variable 60</a>.</p>
|
||||
|
||||
<br />
|
||||
|
||||
<h3 id="a3roadstops">Action 3 - New Landscape</h3>
|
||||
|
||||
<p>See the <a href="https://newgrf-specs.tt-wiki.net/wiki/Action3">Action 3 Specification</a> for background information.</p>
|
||||
|
||||
<p>Note that this is not a generic callback, the sprite group must be assigned to an ID in the <a href="#ids">IDs table</a>.
|
||||
<table>
|
||||
<tr><th>Action 3 ID</th><th>Expected number of sprites</th><th>Landscape type</th></tr>
|
||||
<tr><td>0</td><td>19</td><td>Rocky tiles</td></tr>
|
||||
</table>
|
||||
Cargo type definitions are not used. Only the default set ID is used.
|
||||
</p>
|
||||
<p>This is indicated by the feature name: <font face="monospace">new_landscape</font>, version 1</p>
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user