From 13f93ee678df19c8a1b3aac31af1ba839ec526d6 Mon Sep 17 00:00:00 2001 From: Jonathan G Rennison Date: Fri, 25 Feb 2022 20:35:25 +0000 Subject: [PATCH] Documentation: Add syntax example for road stops NML --- docs/newgrf-roadstops-nml.html | 43 ++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/docs/newgrf-roadstops-nml.html b/docs/newgrf-roadstops-nml.html index 9418d264f9..4fb76fe494 100644 --- a/docs/newgrf-roadstops-nml.html +++ b/docs/newgrf-roadstops-nml.html @@ -17,6 +17,9 @@

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.

+ +

The feature identifier is FEAT_ROADSTOPS.

+

See the NewGRF additions (NML) document for background information on additions to NML.

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

@@ -34,6 +37,7 @@
  • Callbacks
  • Animation triggers
  • Views/rotations
    • +
  • Syntax example

    • Road Stop IDs

    @@ -195,5 +199,44 @@ RST_VIEW_DRIVE_THROUGH_X4Drive-throughX-axis: north-east to south-west RST_VIEW_DRIVE_THROUGH_Y5Drive-throughY-axis: north-west to south-east + +

    Syntax example

    +

    + 

    +grf {
+	...
+}
+
+if (!extended_feature_test("road_stops")) {
+	error(FATAL, string(STR_UNSUPPORTED_VERSION));
+}
+
+
+spritelayout spritelayout_roadstop {
+	ground {
+		...
+	}
+	building {
+		...
+	}
+}
+
+switch (FEAT_ROADSTOPS, SELF, switch_roadstop, ...) {
+	...
+}
+
+item (FEAT_ROADSTOPS, item_roadstop)  {
+	property {
+		class: "TEST";
+		availability_type: RST_AVAILABILITY_TYPE_PASSENGER;
+		name: string(STR_ROADSTOP_NAME);
+		classname: string(STR_ROADSTOP_TEST_CLASS_NAME);
+	}
+	graphics {
+		default: switch_roadstop;
+	}
+}
+
    +