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.

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.

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.

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.

Sections:

• IDs
• Properties
• Variables
• Callbacks
• Animation triggers
• Views/rotations
• Syntax example

Road Stop IDs

Road stop IDs are NewGRF-local and can therefore freely be chosen in the 0..255 range. A road stop is allocated by setting the 'class'-property, which should therefore be set first.

Road Stop Properties

Road Stop Variables

A number of variables are shared between road stops and stations. These are listed on the stations page.

Road Stop Callbacks

Road Stop Animation Triggers

Road stop views/rotations

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;
	}
}