Action0/Vehicles/Ships

From GRFSpecs
Jump to: navigation, search

Introduction

Defining properties of ships.

Properties

Number Size Version Description
08 B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.02.0 Sprite (FF for new graphics)
09 B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.02.0 Refittable (0 no, 1 yes)
0A B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.02.0 Cost factor
0B B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.02.0 Speed in mph*3.2
0C B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.02.0 Cargo type, see CargoTypes

GRFv≤7 For GRF version 7 and below: Type B 'cargo slot'
GRFv≥8 For GRF version 8 and above: Type A '(translated) cargo bit'

0D W Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.02.0 Capacity
0F B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.02.0 Running cost factor
10 B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.02.0 Sound effect type (4=cargo ship, 5=passenger ship)
Supported by OpenTTD 1.6 (r27507)1.6 Not supported by TTDPatch Since OpenTTD r27507 also custom sound effects from Action11 are allowed here.
11 D Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.02.0 GRFv≥1 Bit mask of cargo types available for refitting, see column 2 (bit values) in CargoTypes
12 B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.52.5 GRFv≥6 Callback flags bit mask, see below
13 B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.5 (alpha 30)2.5 Refit cost, using 1/32 of the default refit cost base
14 B Supported by OpenTTD 1.2 (r22639)1.2 Supported by TTDPatch 2.5 (alpha 44)2.5 Ocean speed fraction, sets fraction of top speed available in the ocean; e.g. 00=100%, 80=50%, FF=0.4%
15 B Supported by OpenTTD 1.2 (r22639)1.2 Supported by TTDPatch 2.5 (alpha 44)2.5 Canal speed fraction, same as above but for canals and rivers
16 B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.5 (alpha 44)2.5 Retire vehicle early, this many years before the end of phase 2 (see Action0General)
17 B Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.5 (alpha 55)2.5 Miscellaneous vehicle flags
18 W Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.5 (alpha 55)2.5 Refittable cargo classes, see train prop. 28
19 W Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.5 (alpha 55)2.5 Non-refittable cargo classes, see train prop. 29
1A D Supported by OpenTTD 0.6 (r7191)0.6 Supported by TTDPatch 2.6 (r1210)2.6 Long format introduction date
1B B* Supported by OpenTTD 0.7 (r13831)0.7 Not supported by TTDPatch Sort the purchase list
1C B Supported by OpenTTD 1.1 (r21240)1.1 Not supported by TTDPatch Visual effect
1D W Supported by OpenTTD 1.2 (r22713)1.2 Not supported by TTDPatch Custom cargo ageing period
1E B n*B Supported by OpenTTD 1.2 (r23291)1.2 Not supported by TTDPatch List of always refittable cargo types, see train property 2C
1F B n*B Supported by OpenTTD 1.2 (r23291)1.2 Not supported by TTDPatch List of never refittable cargo types, see train property 2D

Descriptions

Callbacks (12)

For ships, the following callbacks have to be enabled by setting the corresponding bit in property 12 (certain other, not as frequently used callbacks are available without setting a bit here):

Bit Value Variable 0C value Callback
2 4 12 Load amount
3 8 15 Set refitted capacity
5 20 19 show a suffix after the cargo type name
6 40 2D Select color mapping for vehicle
7 80 33 Sound effect callbacks

Bit is the bit you have to set, you do this by adding all the values for all the bits. Variable 0C value is what variable 0C will be set to, for checking it in the VarAction2 for callbacks.

Refit cost (13)

Refit cost, using 1/32 of the default refit cost base. This property can be overridden by callback 15E.

Supported by OpenTTD 1.2 (r23087)1.2 Not supported by TTDPatch If the refit cost factor is set to zero and bit 4 of the miscellaneous flags (17) is set, auto-refitting is allowed.

Miscellaneous flags (17)

This is a bit mask, with the following bits:

Bit Value Meaning
0 1 reserved, do not use
1 2 Uses two company colors
2 4 reserved, do not use
3 8 reserved, do not use
4 10 Supported by OpenTTD 1.2 (r23087)1.2 Not supported by TTDPatch Auto-refitting is enabled for refits where callback 15E allows it or prop 13 specifies zero cost.
5 20 Supported by OpenTTD 1.2 (r23861)1.2 Not supported by TTDPatch Use cargo multiplier for default cargo. See page about vehicle refitting.
6 40 Supported by OpenTTD 1.3 (r24124)1.3 Not supported by TTDPatch Disable breakdown smoke effect.
7 80 Supported by OpenTTD 1.7 (r27668)1.7 Not supported by TTDPatch Compose vehicle from multiple sprites.

Long format introduction date (1A)

Set the vehicle introduction date, in days since the year 0. This takes account of leap years; dividable by 4, but not 100 unless 400. A start date of 1920-01-01 is obtained with a value of 701265 (51 B3 0A 00). This property must be set after property 00 to take effect.

Not supported by OpenTTD Supported by TTDPatch In TTDPatch, dates after 2044 will be limited to 2044.

Sort vehicle list (1B)

See sort vehicle list for trains for details.

Visual effect (1C)

See the equivalent train property for information about the meaning of all bits. There is no default effect for ships, therefore values of 00..0F will show no visual effect. Bit 7 (disable wagon power) currently has no meaning and should be left at 0.

Custom cargo ageing period (1D)

See custom cargo ageing period for trains for details.

Example

To be written