Action0/Railtypes

2011-06-14T13:03:23Z

Jvassie: Updated table syntax

'''''Action 0 properties for rail types'''''

=Action 0 - Properties for rail types=

Defining properties of rail types.

Note: This feature is only available in OpenTTD > r18969

{maketoc}

==Properties==

{| class="wikitable"
|-
!'''Number'''
!'''Version'''
!'''Size'''
!'''Description'''
|-
|08
|
|4*B
|Rail type label
|-
|09
|
|W
|StringID: Build rail toolbar caption
|-
|0A
|
|W
|StringID: Rail construction dropdown text
|-
|0B
|
|W
|StringID: Build vehicle window caption
|-
|0C
|
|W
|StringID: Autoreplace text
|-
|0D
|
|W
|StringID: New engine text
|-
|0E
|
|B n*D
|Compatible rail type list
|-
|0F
|
|B n*D
|Powered rail type list
|-
|10
|
|B
|Rail type flags
|-
|11
|
|B
|Curve speed advantage multiplier
|-
|12
|
|B
|Station (and depot) graphics
|-
|13
|
|W (a)
|Construction costs
|-
|14
|
|W
|Speed limit
|-
|15
|
|B
|Acceleration model
|-
|16
|r19307
|B
|Minimap colour
|-
|17
|r21842
|D
|Introduction date
|-
|18
|r21842
|B n*D
|Introduction required rail type list
|-
|19
|r21841
|B n*D
|Introduced rail type list
|-
|1A
|r21866
|B
|Sort order
|}

(a) In r18969 to 19306 this property was byte-sized.

In NFO, rail type IDs will be GRF local, with an ID to label mapping. Therefore to modify an existing rail type, specify its label in property 08. To create a new rail type, again just specify its label in property 08. This way there is no need for complex GRM mechanisms to allocate IDs. If a label 'clashes' with another GRF, then one GRF will end up modifying the properties instead of creating a new rail type.

When a new rail type is created, it is populated with the information from the first rail type, except that the compatible and powered list contain only the rail type being created. However, no default values should be assumed, as the first rail type may have been modified.

==Comments==

==Rail type label (08)==

These are globally unique four-letter identifiers for specific rail types (analoguous to [[Action0Cargos#Cargo_label_17_|cargo labels]]), used to make various rail types accessible from train vehicle grfs. Reserved labels for default rail types are:

{| class="wikitable
|-
!'''Label'''
!'''Rail Type'''
|-
|RAIL
| Normal Rail
|-
|ELRL
| Electrified Rail
|-
|MONO
| Mono Rail
|-
|MGLV
| Maglev Rail
|}

Rail type sets may use up to 16 railtypes and have to specify their own [[RailtypeLabels|labels]].

See also [[Action0GeneralVariables#Rail_type_translation_table_12_| Rail Type Translation Table]] for further info.

==Build rail toolbar caption (09)==

String ID of the name of the rail type as shown in the toolbar caption.

OpenTTD before r20342 and 1.0.3 require the string to start with the white control code. Later versions of OpenTTD will automatically default to white.

==Rail construction dropdown text (0A)==

String ID for text in the dropdown of all rail types.

This string must never start with a colour control code.

==Build vehicle window caption (0B)==

String ID for build vehicle window caption.

OpenTTD before r20342 and 1.0.3 require the string to start with the white control code. Later versions of OpenTTD will automatically default to white.

==Autoreplace text (0C)==

String ID for rail type shown in autoreplace window.

==New engines (0D)==

StringID to use for showing texts of the type "We have invented a new <rail type> engine".

==Compatible rail type list (0E)==

List of rail types on which trains of this rail type can run, even though they might not be powered. E.g. wagons/engines of "eletrified rail"-type are also compatible to "normal rail" and "third rail" type, but they are not powered (there need to be an other powered engine in the consist to move the train).

The format is:

<pre>0E <nvar> (<rail type label>){n}</pre>

That is you give the number of compatible rail types in a single byte followed by a list of that length of rail type labels. A rail type is automatically compatible (and powered) with itself, so you don't need to list the current rail type.

Note that these properties apply to trains of this rail type, not the track. If you want trains of other rail types to be able to run on your rail types, you must set the compatible rail types property for each rail type. Setting these properties behaves always incremental, so you only need to the set additional bits for each other rail type, you cannot remove compatibility/poweredness once it is set (by some other grf).

==Powered rail type list (0F)==

List of rail types on which trains of this rail type are powered. E.g. engines of "normal rail"-type are powered on "electrified rail"- and "third-rail"-type as well.

Same format as for property 0E above.

==Rail type flags (10)==

Flags to define properties related to the rail type:

{| class="wikitable"
|-
!'''Bit'''
!'''Value'''
!'''Meaning'''
|-
|0
|1
|Draw catenary for this rail
|-
|1
|2
|Disallow level crossings for this rail (OpenTTD since r20049)
|}

==Curve Speed advantage multiplier (11)==

This property sets the multiplier to the curve speed advantage which all trains running on this track type get. The base curve speed advantage is given by the multiplication of the value of this property with the base speed advantage - which depends on the curve length in wagons:

{| class="wikitable"
|-
!'''Curve Length'''
!'''Base Speed Adv.'''
|-
|0 (90° turn)
|30
|-
|1 (2x45° turn)
|44
|-
|2
| 55
|-
|3
| 66
|-
|4
| 75
|-
|5
| 84
|-
|6
| 91
|-
|7
| 98
|-
|8
| 103
|-
|9
| 108
|-
|10
| 111
|-
|11
| 114
|-
|12+
| 115
|}

"Curve length" is the average number of wagons of the train between turns. However, very sharp turns (values 0 and 1) are not averaged out in longer trains.

The maximum speed for a train in a curve is defined by "base speed advantage" * (2 + "property 11"). Tilting trains get an additional bonus of 20% to this value.

For the default rail types this property is 0 for normal rail and electrified rail, 1 for monorail, and 2 for maglev.

==Station (and depot) graphics (12)==

This property defines the default graphics for the stations. If no depot sprites are defined, this also defines at the same time the depot sprites to be used. There are three kind of default stations (and depots), usually associated with rail, monorail and maglev tracks. Valid values are:

{| class="wikitable"
|-
!'''Value'''
!'''Meaning'''
|-
|0
|Normal Rail
|-
|1
|Monorail
|-
|2
|Maglev
|}

==Speed limit (14)==

Speed limit in mph*1.6 (approx. km/h). Set to "0" for no limit at all.

==Acceleration model (15)==

This property defines the acceleration model used. Valid values range from 0 to 2:

{| class="wikitable"
|-
!'''Value'''
!'''Meaning'''
|-
|0
|Normal Rail
|-
|1
|Monorail
|-
|2
|Maglev
|}

There is currently no difference between normal rail and monorail.

==Map colour (16)==

This property defines the colour this track type is drawn in the minimap view. The byte value specifies the colour entry in the [[PalettesAndCoordinates| DOS palette]].

==Introduction date (17)==

This property defines the long date formatted introduction date of this rail type. With this property set the rail type will be introduced at (or after) this date when all of the introduction required rail types are available to the company of the player, or whenever a vehicle using this rail type gets introduced whichever is first.

==Introduction required rail type list (18)==

List of rail types on that need to be available to the company of the player for this rail type to be introduced at (or after) the introduction date. This limit does not apply when the rail type is introduced by the introduction of a vehicle.

Same format as for property 0E above.

This can, for example, be used to introduce a third rail with catenary track type when both third rail and catenary rail types are available.

==Introduced rail type list (19)==

List of rail types that get introduced when this rail type is introduced. For example, to make sure that when a fast rail type is introduced the slow variant exists.

Same format as for property 0E above.

==Sort order (1A)==

Property for influencing the sort order of the drop down lists with rail types. Default values are as follows:

{| class="wikitable"
|-
!'''Value'''
!'''Meaning'''
|-
|07
|Normal Rail
|-
|17
|Electrified Rail
|-
|27
|Monorail
|-
|37
|Maglev
|-
|n7
|Railtype #n
|}

Thus the rail type that (internally) gets index 8 will get a default value of 87. These defaults are to keep the ordering when this property is not supported as they were.

=Example=

To be written

GRFSpecs:Todo

2011-06-14T12:47:03Z

Jvassie: Added an item todo

GRFSpecs:Todo

2011-06-14T12:44:58Z

Jvassie: Added an item todo

2011-06-13T12:10:32Z

Jvassie: Created page

=To-Do List=

This page contains a list of 'jobs' that remain to be completed, please follow the example listing when adding/editing information in the table.

*'''Item''' - name of a page and what needs doing to it.
*'''Status''' - Available (no one working on it), In Progress (someone working on it, include name in parentheses ()), Complete (item has been finished)
*'''Date Added''' - DD/MM/YYYY format
*'''Last Updated''' - DD/MM/YYYY format

{| class="wikitable"
|-
! Item
! Status
! Date Added
! Last Updated
|-
| ''Example Item''
| ''Available''
| ''13/06/2011''
| ''13/06/2011''
|-
| ''Example Item''
| ''Available''
| ''13/06/2011''
| ''13/06/2011''
|}

Main Page

2011-06-13T10:51:53Z

Jvassie: Changed text of Action0Bridge to match others

= Sprite types =
*;[[Action0]] - Defines new graphics feature properties
** [[Action0General]] - Action 0 properties common to all vehicle types
** [[Action0Trains]] - Action 0 properties for trains
** [[Action0RoadVehicles]] - Action 0 properties for road vehicles
** [[Action0Ships]] - Action 0 properties for ships
** [[Action0Planes]] - Action 0 properties for planes
** [[Action0Stations]] - Action 0 properties for new stations
** [[Action0Canals]] - Action 0 - Properties for canals / rivers
** [[Action0Bridges]] - Action 0 properties of bridges
** [[Action0Houses]] - Action 0 properties of houses
** [[Action0GeneralVariables| Action0GlobalVariables]] - Action 0 properties for global variables
** [[Action0IndustryTiles]] - Action 0 properties for industry tiles
** [[Action0Industries]] - Action 0 properties for industries
** [[Action0Cargos]] - Action 0 properties for cargo types
** [[Action0SoundEffects]] - Action 0 properties for new sound effects
** [[Action0Objects]] - Action 0 properties for new objects
** [[Action0Railtypes]] - Action 0 properties for rail types
** [[Action0AirportTiles]] - Action 0 properties for airport tiles
** [[Action0Airports]] - Action 0 properties for airports
*;[[Action1]] - Defines a set of real sprites
*;[[Action2]] - Defines graphics set IDs
** [[Action2Vehicles]] - Defining set-IDs for vehicles
** [[Action2Stations]] - Defining station set-IDs
** [[Action2Canals]] - Defining an action2 for canals
** [[Action2HousesIndustryTiles]] - Defining an action 2 for houses, industry tiles and object
** [[Action2Industries]] - Defining the industry production callback
** [[Action2Cargos]] - Defining set-IDs for cargos
** [[Action2Objects]] - Action2 for Objects
** [[Action2Railtypes]] - Action2 for Railtypes
** [[VariationalAction2]] - Variational Action 2
*** [[VarAction2Advanced]] - Advanced features of Variational Action 2
*** [[VarAction2Vehicles]] - Variational Action 2 Variables for Vehicles
*** [[VarAction2Stations]] - Variational Action 2 Variables for Stations
*** [[VarAction2Cities]] - Variational Action 2 Variables for Cities
*** [[VarAction2Canals]] - Variational Action 2 Variables for Canals
*** [[VarAction2Bridges]] - Variational Action 2 Variables for Bridges
*** [[VarAction2Houses]] - Variational Action 2 Variables for Houses
*** [[VarAction2IndustryTiles]] - Variational Action 2 Variables for Industry and Airport Tiles
*** [[VarAction2Industries]] - Variational Action 2 Variables for Industries
*** [[VarAction2Cargos]] - Variational Action 2 Variables for cargos
*** [[VarAction2NewSignals]] - Variational Action 2 Variables for New Signals
*** [[VarAction2Objects]] - Variational Action 2 Variables for Objects
*** [[VarAction2Railtypes]] - Variational Action 2 for Railtypes
*** [[VarAction2IndustryTiles| VarAction2AirportTiles]] - Variational Action 2 Variables for Industry and Airport Tiles
** [[RandomAction2]] - Randomized Action 2
** [[Callbacks]] - List of available callbacks
*;[[Action3]] - Associates vehicles with graphics set IDs
** [[Action3LiveryOverride]] - Change wagon livery to match the engine
*;[[Action4]] - Defines text strings
*;[[Action5]] - Defines specific base graphics sets
*;[[Action6]] - Modifies the contents of the following sprite
*;[[Action7]] - Conditionally skips sprites or jumps to a label
** [[TTDPatchFlags| GameConfigFlags]] - Configuration flags for Action 7/9 Variable 85
*;[[Action8]] - Defines GRF ID, Name and Description
*;[[Action9]] - (see action 7 above)
*;[[ActionA]] - Modifies TTD base set sprites
*;[[ActionB]] - Generates an error message
*;[[ActionC]] - Does nothing.
*;[[ActionD]] - Assigns parameters and calculates results
** [[ReadingOtherGRFParameters]] - Reading another GRF file's parameters
** [[ReadingPatchVariables| ReadingGameSettings]] - Reading game configuration settings
** [[GRFResourceManagement]] - Preventing conflicts with limited resources
*;[[ActionE]] - Deactivates a NewGRF file
*;[[ActionF]] - Defines new town name styles
*;[[Action10]] - Defines GOTO label for action 7/9
*;[[Action11]] - Defines new sound data
*;[[Action12]] - Load font glyphs
*;[[Action13]] - Translates GRF-specific strings (TTDPatch only)
*;[[Action14]] - Static NewGRF Information (OpenTTD only)
*;[[RealSprites]] - Sprites that actually get drawn on the screen
*;[[RecolorSprites]] - Changing how other sprites are drawn

= Graphics properties =
* [[PalettesAndCoordinates#Palettes | Palettes]] - Palettes used by the game
* [[PalettesAndCoordinates#Coordinates | Coordinates]] - Coordinates used for sprite alignement

= TTD defaults =
* [[DefaultHouseProps]] - Default property values for TTD's houses
* [[IndustryTileDefaultProps]] - Default property values for TTD's industry tiles
* [[IndustryDefaultProps]] - Default properties values for TTD's industries
* [[CargoDefaultProps]] - Default property values for TTD's cargo types

= NewGRF commons =
* [[Action0Cargos#Cargo_classes | Cargo classes]] - Commonly used cargo classes
* [[CargoTypes | Cargo labels]] - Commonly used cargo labels
* [[ObjectLabels | Object classes]] - Commonly used object clases
* [[RailtypeLabels | Railtype labels]] - Commonly used railtype labels

= Misc =
* [[BaseCosts | Base Costs]]
* [[VehicleRefitting | Vehicle Refitting]]

Main Page

2011-06-12T23:03:04Z

Jvassie: /* Sprite types */

= Sprite types =
*;[[Action0]] - Defines new graphics feature properties
** [[Action0General]] - Action 0 properties common to all vehicle types
** [[Action0Trains]] - Action 0 properties for trains
** [[Action0RoadVehicles]] - Action 0 properties for road vehicles
** [[Action0Ships]] - Action 0 properties for ships
** [[Action0Planes]] - Action 0 properties for planes
** [[Action0Stations]] - Action 0 properties for new stations
** [[Action0Canals]] - Action 0 - Properties for canals / rivers
** [[Action0Bridges]] - Defining properties of bridges
** [[Action0Houses]] - Action 0 properties of houses
** [[Action0GeneralVariables| Action0GlobalVariables]] - Action 0 properties for global variables
** [[Action0IndustryTiles]] - Action 0 properties for industry tiles
** [[Action0Industries]] - Action 0 properties for industries
** [[Action0Cargos]] - Action 0 properties for cargo types
** [[Action0SoundEffects]] - Action 0 properties for new sound effects
** [[Action0Objects]] - Action 0 properties for new objects
** [[Action0Railtypes]] - Action 0 properties for rail types
** [[Action0AirportTiles]] - Action 0 properties for airport tiles
** [[Action0Airports]] - Action 0 properties for airports
*;[[Action1]] - Defines a set of real sprites
*;[[Action2]] - Defines graphics set IDs
** [[Action2Vehicles]] - Defining set-IDs for vehicles
** [[Action2Stations]] - Defining station set-IDs
** [[Action2Canals]] - Defining an action2 for canals
** [[Action2HousesIndustryTiles]] - Defining an action 2 for houses, industry tiles and object
** [[Action2Industries]] - Defining the industry production callback
** [[Action2Cargos]] - Defining set-IDs for cargos
** [[Action2Objects]] - Action2 for Objects
** [[Action2Railtypes]] - Action2 for Railtypes
** [[VariationalAction2]] - Variational Action 2
*** [[VarAction2Advanced]] - Advanced features of Variational Action 2
*** [[VarAction2Vehicles]] - Variational Action 2 Variables for Vehicles
*** [[VarAction2Stations]] - Variational Action 2 Variables for Stations
*** [[VarAction2Cities]] - Variational Action 2 Variables for Cities
*** [[VarAction2Canals]] - Variational Action 2 Variables for Canals
*** [[VarAction2Bridges]] - Variational Action 2 Variables for Bridges
*** [[VarAction2Houses]] - Variational Action 2 Variables for Houses
*** [[VarAction2IndustryTiles]] - Variational Action 2 Variables for Industry and Airport Tiles
*** [[VarAction2Industries]] - Variational Action 2 Variables for Industries
*** [[VarAction2Cargos]] - Variational Action 2 Variables for cargos
*** [[VarAction2NewSignals]] - Variational Action 2 Variables for New Signals
*** [[VarAction2Objects]] - Variational Action 2 Variables for Objects
*** [[VarAction2Railtypes]] - Variational Action 2 for Railtypes
*** [[VarAction2IndustryTiles| VarAction2AirportTiles]] - Variational Action 2 Variables for Industry and Airport Tiles
** [[RandomAction2]] - Randomized Action 2
** [[Callbacks]] - List of available callbacks
*;[[Action3]] - Associates vehicles with graphics set IDs
** [[Action3LiveryOverride]] - Change wagon livery to match the engine
*;[[Action4]] - Defines text strings
*;[[Action5]] - Defines specific base graphics sets
*;[[Action6]] - Modifies the contents of the following sprite
*;[[Action7]] - Conditionally skips sprites or jumps to a label
** [[TTDPatchFlags| GameConfigFlags]] - Configuration flags for Action 7/9 Variable 85
*;[[Action8]] - Defines GRF ID, Name and Description
*;[[Action9]] - (see action 7 above)
*;[[ActionA]] - Modifies TTD base set sprites
*;[[ActionB]] - Generates an error message
*;[[ActionC]] - Does nothing.
*;[[ActionD]] - Assigns parameters and calculates results
** [[ReadingOtherGRFParameters]] - Reading another GRF file's parameters
** [[ReadingPatchVariables| ReadingGameSettings]] - Reading game configuration settings
** [[GRFResourceManagement]] - Preventing conflicts with limited resources
*;[[ActionE]] - Deactivates a NewGRF file
*;[[ActionF]] - Defines new town name styles
*;[[Action10]] - Defines GOTO label for action 7/9
*;[[Action11]] - Defines new sound data
*;[[Action12]] - Load font glyphs
*;[[Action13]] - Translates GRF-specific strings (TTDPatch only)
*;[[Action14]] - Static NewGRF Information (OpenTTD only)
*;[[RealSprites]] - Sprites that actually get drawn on the screen
*;[[RecolorSprites]] - Changing how other sprites are drawn

= Graphics properties =
* [[PalettesAndCoordinates#Palettes | Palettes]] - Palettes used by the game
* [[PalettesAndCoordinates#Coordinates | Coordinates]] - Coordinates used for sprite alignement

= TTD defaults =
* [[DefaultHouseProps]] - Default property values for TTD's houses
* [[IndustryTileDefaultProps]] - Default property values for TTD's industry tiles
* [[IndustryDefaultProps]] - Default properties values for TTD's industries
* [[CargoDefaultProps]] - Default property values for TTD's cargo types

= NewGRF commons =
* [[Action0Cargos#Cargo_classes | Cargo classes]] - Commonly used cargo classes
* [[CargoTypes | Cargo labels]] - Commonly used cargo labels
* [[ObjectLabels | Object classes]] - Commonly used object clases
* [[RailtypeLabels | Railtype labels]] - Commonly used railtype labels

= Misc =
* [[BaseCosts | Base Costs]]
* [[VehicleRefitting | Vehicle Refitting]]