dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: Spelling/minor adjustments to NewGRF additions

Browse Source
This commit is contained in:
Jonathan G Rennison
2018-08-09 08:40:34 +01:00
parent 15d818facc
commit b653c55d34
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/newgrf-additions.html
View File

@@ -18,7 +18,7 @@
<body> <body>
<h2>Additions to NewGRF Specifications in JGR's Patchpack</h2> <h2>Additions to NewGRF Specifications in JGR's Patchpack</h2>
<p>This document describes non-standard additions to the <a href="https://newgrf-specs.tt-wiki.net/wiki/Main_Page">Official OpenTTD NewGRF Specifications</a> which are present in this patchpack. <p>This document describes non-standard additions to the <a href="https://newgrf-specs.tt-wiki.net/wiki/Main_Page">Official OpenTTD NewGRF Specifications</a> which are present in this patchpack.
<p>This additions MAY also be present in other patchpacks. They MAY be removed or moved in future, if necessary.</p> <p>These additions MAY also be present in other patchpacks. They MAY be removed or moved in future, if necessary.</p>
<p>NewGRFs which use any of these features SHOULD use the <a href="#feature-test">feature testing</a> mechanism described below to check whether individual added features are supported.</p> <p>NewGRFs which use any of these features SHOULD use the <a href="#feature-test">feature testing</a> mechanism described below to check whether individual added features are supported.</p>
<h3 id="feature-test">Action 14 - Feature Tests</h3> <h3 id="feature-test">Action 14 - Feature Tests</h3>
@@ -27,7 +27,7 @@
<p>Each FTST chunk (type C) describes an individual feature test.<br /> <p>Each FTST chunk (type C) describes an individual feature test.<br />
Sub-chunks with each FTST chunk may appear in any order, however each sub-chunk SHOULD only appear ONCE within an individual FTST chunk.</p> Sub-chunks with each FTST chunk may appear in any order, however each sub-chunk SHOULD only appear ONCE within an individual FTST chunk.</p>
<p>Feature tests can be safely used on implementations which do not implement the described feature test mechanism because unknown Action 14 blocks are ignored, <p>Feature tests can be safely used on implementations which do not implement the described feature test mechanism because unknown Action 14 blocks are ignored,
and the obserable result (in global variable 0x9D) is equivalent to the case where all feature tests have failed, indicating that the feature is not present.</p> and the observable result (in global variable 0x9D) is equivalent to the case where all feature tests have failed, indicating that the feature is not present.</p>
<h4>Feature Name: C "FTST" -> T "NAME"</h4> <h4>Feature Name: C "FTST" -> T "NAME"</h4>
<p>Within an FTST chunk, the NAME text (type T) field contains the name of the feature to test for. The value of the language ID byte is ignored.<br /> <p>Within an FTST chunk, the NAME text (type T) field contains the name of the feature to test for. The value of the language ID byte is ignored.<br />
If the named feature is not present, or if this field is omitted, the version is 0.<br /> If the named feature is not present, or if this field is omitted, the version is 0.<br />
@@ -48,7 +48,7 @@
If this field is omitted, no bit is set or cleared, and the test is not observable. If this field is omitted, no bit is set or cleared, and the test is not observable.
</p> </p>
<br /> <br />
<h4>Example:</h4> <h4>Example NFO:</h4>
<pre> <pre>
// Set bit 4 of global variable 0x9D if sample_feature_1 is present with a version of at least 4 // Set bit 4 of global variable 0x9D if sample_feature_1 is present with a version of at least 4
// Set bit 5 of global variable 0x9D if sample_feature_2 is present with a version of at least 5 and at most 6 // Set bit 5 of global variable 0x9D if sample_feature_2 is present with a version of at least 5 and at most 6
@@ -70,15 +70,15 @@
// Skip 1 sprite if bit 4 of global variable 0x9D is not set (indicating that sample_feature_1 with a version of at least 4 is NOT present) // Skip 1 sprite if bit 4 of global variable 0x9D is not set (indicating that sample_feature_1 with a version of at least 4 is NOT present)
-1 * -1 07 9D 01 \70 04 01 -1 * -1 07 9D 01 \70 04 01
</pre> </pre>
<h2><a href="https://newgrf-specs.tt-wiki.net/wiki/Action0/Stations">Action 0 - Stations</a></h2> <h3><a href="https://newgrf-specs.tt-wiki.net/wiki/Action0/Stations">Action 0 - Stations</a></h3>
<h4><a href="https://newgrf-specs.tt-wiki.net/wiki/Action0/Stations#Minimum_bridge_height_.281B.29">Minimum bridge height (1B)</a></h4> <h4><a href="https://newgrf-specs.tt-wiki.net/wiki/Action0/Stations#Minimum_bridge_height_.281B.29">Minimum bridge height (1B)</a></h4>
<p>This is indicated by the feature name: <font face="monospace">action0_station_prop1B</font>, version 1</p> <p>This is indicated by the feature name: <font face="monospace">action0_station_prop1B</font>, version 1</p>
<h2><a href="https://newgrf-specs.tt-wiki.net/wiki/Action0/Bridges">Action 0 - Bridges</a></h2> <h3><a href="https://newgrf-specs.tt-wiki.net/wiki/Action0/Bridges">Action 0 - Bridges</a></h3>
<h4>Menu icons (14)</h4> <h4>Menu icons (14)</h4>
<p>This is indicated by the feature name: <font face="monospace">action0_bridge_prop14</font>, version 1</p> <p>This is indicated by the feature name: <font face="monospace">action0_bridge_prop14</font>, version 1</p>
<h4>More bridges (16 instead of 13)</h4> <h4>More bridges (16 instead of 13)</h4>
<p>This is indicated by the feature name: <font face="monospace">more_bridge_types</font>, version 1</p> <p>This is indicated by the feature name: <font face="monospace">more_bridge_types</font>, version 1</p>
<h2><a href="https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Stations">Variational Action 2 - Stations</a></h2> <h3><a href="https://newgrf-specs.tt-wiki.net/wiki/VariationalAction2/Stations">Variational Action 2 - Stations</a></h3>
<h4>Track type in purchase list (42)</h4> <h4>Track type in purchase list (42)</h4>
<p>This is indicated by the feature name: <font face="monospace">varaction2_station_var42</font>, version 1</p> <p>This is indicated by the feature name: <font face="monospace">varaction2_station_var42</font>, version 1</p>
</body> </body>