From 6903e5c9373cdd770f97657ad25f7e6734d0ecf6 Mon Sep 17 00:00:00 2001 From: Jonathan G Rennison Date: Tue, 16 Jan 2024 20:25:54 +0000 Subject: [PATCH] Documentation: Update NewGRF road stops documents --- docs/newgrf-roadstops-nml.html | 55 ++++++------ docs/newgrf-roadstops.html | 147 ++++++++++++++++++--------------- 2 files changed, 108 insertions(+), 94 deletions(-) diff --git a/docs/newgrf-roadstops-nml.html b/docs/newgrf-roadstops-nml.html index a6468aa15d..c0cbf7ee5d 100644 --- a/docs/newgrf-roadstops-nml.html +++ b/docs/newgrf-roadstops-nml.html @@ -2,7 +2,7 @@ - JGR's Patchpack - NewGRF Road Stops Addition to NewGRF Specifications in NML + JGR's Patchpack - Additions to the NewGRF Road Stops Specification in NML -

NewGRF Road Stops Addition to NewGRF Specifications in JGR's Patchpack in NML

-

This document describes the non-standard addition of the NewGRF road stops feature to the Official OpenTTD NML Specifications, as implemented in this patchpack, and the associated NML fork
- This feature does not match OpenTTD PR #7955 in a number of key areas, this feature may not necessarily match implementations of NewGRF road stops in other patches, branches, etc.
- This feature as implemented here MAY also be present in other patchpacks.

+

Additions to the NewGRF Road Stops Specification in JGR's Patchpack in NML

+

This document describes the non-standard additions to the NewGRF road stops feature in the Official OpenTTD NML Specifications, as implemented in this patchpack, and the associated NML fork
+ The additions here are compatible with the specification and OpenTTD 14.0, such that GRFs can run on OpenTTD 14.0 and also optionally use patchpack extensions where available.

+

These additions and the official specification do not match the obsolete OpenTTD PR #7955 which used a different NewGRF interface.

The feature identifier is FEAT_ROADSTOPS, (the PARENT scope for this feature is the road stop's station's town).
There is no permanent storage associated with this feature.

@@ -25,10 +25,9 @@

See the associated non-NML document for more details on the NewGRF road stops feature.

-

This feature will be automatically skipped when loaded into a version of OpenTTD which does not support this feature.
- If this feature is the only significant thing in this GRF, then extended_feature_test("road_stops") 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.
- Otherwise the GRF could silently do nothing instead of the expected functionality, creating confusion for end users.

+

This feature will be automatically skipped when loaded into a version of OpenTTD which does not support this feature (before 14.0).
+ If this feature is the only significant thing in this GRF, then version_openttd(14, 0) || extended_feature_test("road_stops") MAY 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 value is false.

Sections: