Action0/Vehicles/Planes

From GRFSpecs

Contents 1 Introduction 2 Properties 3 Descriptions 3.1 Primary (0F) and secondary (11) caego capacity 3.2 Sound effect (12) 3.3 Callbacks (14) 3.4 Refit cost (15) 3.5 Miscellaneous flags (17) 3.6 Long format introduction date (1A) 3.7 Sort vehicle list (1B) 3.8 Custom cargo ageing period (1C) 4 Example

Introduction

Defining properties of planes.

Properties

Number	Size	Version	Description
08	B	0.6 2.0	Sprite (FF for new graphics)
09	B	0.6 2.0	Is helicopter? 2=no, 0=yes
0A	B	0.6 2.0	Is large? 0=no, 1=yes (i.e. can't safely land on small airports)
0B	B	0.6 2.0	Cost factor
0C	B	0.6 2.0	Speed in mph*8
0D	B	0.6 2.0	Acceleration
0E	B	0.6 2.0	Running cost factor
0F	W	0.6 2.0	Primary cargo capacity (passenger or refitted cargo)
11	B	0.6 2.0	Secondary cargo capacity (mail)
12	B	0.6 2.0	Sound effect
13	D	0.6 2.5 GRFv≥6	Bit mask of cargo types available for refitting, see column 2 (Bit Value) in CargoTypes
14	B	0.6 2.5 GRFv≥6	Callback flags bit mask, see below
15	B	0.6 2.5	Refit cost, using 1/32 of the default refit cost base
16	B	0.6 2.5	Retire vehicle early, this many years before the end of phase 2 (see Action0General)
17	B	0.6 2.5	Miscellaneous vehicle flags
18	W	0.6 2.5	Refittable cargo classes, see train prop. 28
19	W	0.6 2.5	Non-refittable cargo classes, see train prop. 29
1A	D	0.6 2.5	Long format introduction date
1B	B*	0.7	Sort the purchase list
1C	W	1.2	Custom cargo ageing period
1D	B n*B	1.2	List of always refittable cargo types, see train property 2C
1E	B n*B	1.2	List of never refittable cargo types, see train property 2D
1F	W	1.2	Aircraft range in tiles. Distance is euclidean, a value of 0 means range is unlimited

Descriptions

Primary (0F) and secondary (11) caego capacity

Aircraft can transport up to two cargo types. The first (primary) cargo type can be changed when refitting the aircraft.

The secondary cargo type is always mail, and is only present when the primary cargo type is part of the passenger cargo class.

See also the page about vehicle refitting.

Sound effect (12)

The following sound effects are used by planes (note, the setting is ignored for helicopters):

Number	Sound
06	Propeller sound 1
07	Jet sound 1
3B	Supersonic
3D	Jet sound 2
45	Propeller sound 2
46	Jet sound 3

Callbacks (14)

For planes, the following callbacks have to be enabled by setting the corresponding bit in property 14 (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 (15)

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

1.2  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	1.2  Auto-refitting is enabled for refits where callback 15E allows it or prop 15 specifies zero cost.
5	20	1.2  Use cargo multiplier for default cargo. See page about vehicle refitting.
6	40	1.3  Disable breakdown smoke effect.

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.

  In TTDPatch, dates after 2044 will be limited to 2044.

Sort vehicle list (1B)

See sort vehicle list for trains for details.

Custom cargo ageing period (1C)

See custom cargo ageing period for trains for details.

Example

To be written