Standardized Roadtype Scheme

From GRFSpecs
Revision as of 18:15, 17 September 2023 by Brickblock1 (talk | contribs)
Jump to navigationJump to search

Not in a useable state do not use

There is currently not enough clarification on how the standard is meant to be used

Surface / Type [X***]

Describes the road surface / rail type and thus the vehicle type.

Roadtype:

Letter Meaning (Road) Powered Roadtypes Recomended vehicle set fallbacks
R Public Road / Rail RI(S)
P Passenger-only RPI(S) R
G Guided busway RPG P then R
I Industrial Site (ISR) I R
B Bicycle Lane RB(Z) R
W Waterway W
A Amphibious on road (hidden) RPI(S)W R
S Snowy or Iced Track S
a Amphibious on snow (hidden) SW S
Z Pedestrian Zone Z
E Eyecandy
p Pump/Pipeline RIZ I then R
X Crossing (Multiple/universal roadtypes) n/a NOTE: It is suggested to make the second letter the primary roadtype's first letter in a crossing between roadtypes (e.g. "XRBN" for a road and pipeline crossing). Please understand that as of this writing, the standardized roadtype scheme cannot yet account for more than two crossing roadtypes with the same primary roadtype. Finally, as of this writing, only some combination of a road, a pipeline, eyecandy or (potentially) a system not yet given a label can justify use of the "X" label.

Tramtype:

Letter Meaning (Tram) Powered Tramtypes Recomended vehicle set fallbacks
R Public Rail RI(M)
P Passenger-only RPI(M) R
I Industrial Site (ISR) I R
B Bicycle Lane (R)B
S Suspended Monorail S
M Metro M(RP)
O Trackless trams O
E Eyecandy/Electrical infrastructure
X Junction/Crossover (Multiple/universal railtypes) n/a NOTE: It is suggested to make the second letter the primary tramtype's first letter in a junction tramtype (e.g. "XRBN" for light rail with bike lanes). Please understand that as of this writing, the standardized roadtype scheme cannot yet account for more than two crossing tramtypes with the same primary tramtype. If there is no primary tramtype (such as a "universal" tramtype or a tramtype with more than two systems in the junction) then it is recommended to use a lowercase x as the second letter.

It is the vehicle set's responsibility to implement fallbacks to other appropriate surfaces. It is also up to the author to decide if they want to do it or not.

It is up to the track set to implement all recommended roadtypes in the powered_roadtype_list (NML). The same goes for tramtypes: powered_tramtype_list (NML). It is further advised to implement support for the roadtypes/tramtypes in brackets, if applicable.

Hidden roadtypes for compatibility should be implemented by road sets. It is up to the author to decide if they want to implement it as a hidden roadtype or not.

Speed / Feature [*X**]

Any character may be used for roads, but at least one road must have "A". It is suggested that roadtype and tramtype speeds use capital letters (A-Z) and roadtypes and tramtypes with specific features use lowercase letters (a-z). Vehicles should use "A".

Terrain / Stability [**X*]

Describes the roughness of the road surface / trackbed stability, and thus the vehicle tier.

Letter Meaning Powered Roadtypes
a Very slow / rough / light aA
A Slow / rough / light aAB
B Regular ABC
C Fast / stable BCc
c Very fast / stable Cc
Letter Meaning Powered Roadtypes
b Eyecandy and other features (ONLY use if you wish for vehicles to not be able to travel on the roadtype/tramtype) n/a

If all classes aren't defined by the road set, the other ones should be in the alternative_roadtype_list (NML). The same goes for tramtypes: alternative_tramtype_list (NML).

Road vehicle sets should not implement fallbacks for terrain / stability.

Classes "a" and "c" are entirely optional for road/tramtype sets and should under no circumstances be used by vehicles.

Energy [***X]

Describes the energy source of the track / vehicle.

Generic classes:

Letter Meaning (Road) Meaning (Tram)
N None None
i Invisible Invisible, Illumination (Road Lighting), Infrastructure, or Irrelevant

For eyecandy and for underground infrastructure with compatibility toward certain vehicle sets, you should use EABX, EABS, EABG and EABE in the powered_roadtype_list or powered_tramtype_list for this road/tramtype

E Overhead electrified (Catenary) Overhead electrified (Catenary)
G Ground electrified Ground electrified
Z Ground and overhead electrified Ground and overhead electrified

Specialized classes:

Letter Meaning (Road) Meaning (Tram) Vehicle set fallback
3 n/a Third Rail G
4 n/a Fourth Rail 3 then G
C n/a Cable G
M n/a Suspended Monorail n/a
P Pump/Pipeline Power Line/Mains (with no lighting) X, then S, then i, then G, then E
S Smart infrastructure Smart infrastructure n/a
X Crossover (Multiple/universal powered types) Crossover (Multiple/universal powered types) Z, then E, then i, then N

A road or track set that only uses specialized types, should map the generic types to the most suitable specialized type in the set.

The default labels (ROAD, ELRL)

It is up to the road set author to decide what labels should replace these, but it is recommended to choose RABN / RABE.

Vehicle set authors might need to add the default labels as a fallback. If not implemented, their vehicles won't show up on the default roads and/or tracks.