Documentation: Update NewGRF road stop docs

pull/484/head
Jonathan G Rennison 1 year ago
parent 1272bec13b
commit 9951c0dbd5

@ -110,6 +110,7 @@
<span class="indent">Pillar along entire north-west edge</span></p>
</td></tr>
<tr><td>cost_multipliers</td><td>[build_cost, clear_cost]</td><td>Build and clear cost multipliers, 16 is the same as a non-NewGRF road stop</td></tr>
<tr><td>height</td><td>0..255</td><td>Road stop height (in the build window), in height level units (1 level == 8px), see also: <a href="https://newgrf-specs.tt-wiki.net/wiki/NML:Objects#Object_properties">object height property</a>.</td></tr>
</table>
<h3 id="roadstop_variables">Road Stop Variables</h3>

@ -24,13 +24,14 @@
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><b>Actions:</b>
<p><b>Sections:</b>
<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="#randomaction2roadstops">Random Action 2</a></li>
<li><a href="#a3roadstops">Action 3</a></li>
<li><a href="#erata">Erata</a></li>
</ul></p>
<h3 id="a0roadstops">Action 0 - Road Stops</h3>
@ -53,6 +54,8 @@
<tr><td><a href="#roadstop_general_flags">12</a></td><td><a href="#roadstop_general_flags">roadstop_general_flags</a></td><td>4</td><td>General flags</td></tr>
<tr><td><a href="#roadstop_min_bridge_height">13</a></td><td><a href="#roadstop_min_bridge_height">roadstop_min_bridge_height</a></td><td>6</td><td>Minimum bridge heights</td></tr>
<tr><td><a href="#roadstop_disallowed_bridge_pillars">14</a></td><td><a href="#roadstop_disallowed_bridge_pillars">roadstop_disallowed_bridge_pillars</a></td><td>6</td><td>Disallowed bridge pillars</td></tr>
<tr><td><a href="#roadstop_cost_multipliers">15</a></td><td><a href="#roadstop_cost_multipliers">roadstop_cost_multipliers</a></td><td>2</td><td>Cost multipliers</td></tr>
<tr><td><a href="#roadstop_height">16</a></td><td><a href="#roadstop_height">roadstop_height</a></td><td>1</td><td>Height (for build window)</td></tr>
</table>
<h4 id="roadstop_class_id">Road stop class ID (08, or mappable property: roadstop_class_id)</h4>
@ -176,6 +179,12 @@
The total property length is 2 bytes.<br />
A value of 16 produces a build or removal cost the same as non-NewGRF road stops.</a>.
</p>
<h4 id="roadstop_height">Road stop height (in the build window) (16, or mappable property: roadstop_height)</h4>
<p>This property sets the height used to size the road stop build window previews.<br />
The nominal height for the road stop preview is set to at least: 32 + "value of this property" * 8.<br />
This similar to <a href="https://newgrf-specs.tt-wiki.net/wiki/Action0/Objects#Building_height_.2816.29">Object variable 16</a>.<br />
The total property length is 1 byte.</a>.
</p>
<p style="padding-top: 0.25em;">
<div id="roadstop_views">The 6 road stop views/rotations are described below.</div>
@ -406,6 +415,10 @@
<p>Road stops have the same Action 3 cargo-type values as feature 4 (station).</p>
<h3 id="erata">Erata</h3>
<p>In feature name <font face="monospace">road_stops</font> versions 1 to 5 (inclusive), mapped Action 0 properties which are unknown and should be ignored, instead generate an error on use.</p>
</body>
</html>

Loading…
Cancel
Save