Action3

Introduction

Action 3 assigns graphics sets (referenced to by (chains of) action 2(s) to feature IDs (vehicles, stations, houses, industries, ...).

Format

The format of the data is feature-dependent.

The data is:

 <Sprite-number> * <Length> 03 <feature> <n-id> <ids...> <num-cid> (<cargo-type> <set-ID>)... <default set-ID>

Element	Size	Description
<Sprite-number>	dec	A sequential sprite number
<length>	dec	The total number of bytes used in this action
03	B	Defines action 03
<feature>	B	What type of feature the IDs refer to
<n-id>	B	Number of IDs this action 3 associates graphics with
<ids...>	B/B*	IDs of the current feature this action 3 associates graphics with. There must be as many IDs as <n-id> specifies
<num-cid>	B	Number of different cargo types to support
<cargo-type>	B	Cargo type for which to use the following set-ID
<set-ID>	W	Set-ID (from action 2 or from a varaction2 chain) to use for this cargo type
<default set-ID>	W	Default set-ID to use if none of the above matches

Description

Sprite-number

This is just the number you are at.

Length

Count the number of bytes in this action.

Feature

This sets the type of feature that you wish to change. Set it to:

Value	Feature
00	Trains
01	Road Vehicles
02	Ships
03	Aircraft
04	Stations
05	Canals/Rivers
07	Houses
09	Industry Tiles
0A	Industries
0B	Cargos
0C	Sound Effects (generic callback only)
0D	Airports
0E	Signals (generic callback only)
0F	Objects
10	Railtypes
11	Airport Tiles
12	Roadtypes
13	Tramtypes
14	Road Stops

n-id

How many items of the current feature this action 3 defines new graphics for. If this is more than one, all items listed will get the same graphics. If this value has bit 7 set (i.e. 80 added), it is a wagon override. See Action 3 - Livery Override for more info on this feature.

You can make a definition with n-id equal to zero (and thus no ids that follow).  This creates a generic feature-specific definition not associated with any particular item.  At the moment, this is used for generic callbacks, but might be extended to other functions eventually.

ids

Feature IDs to use this action 3 for. All IDs are counted from the first of their class, i.e. the first road vehicle has 00, as does the first plane, the first ship, and the first train vehicle.

In OpenTTD since r13482, each ID is an extended byte for vehicles, otherwise the ID is a regular byte.

Since OpenTTD 14.0, each ID is an extended byte for all features.

For canals and rivers the id has a special meaning, see its own Action 3 page

For town buildings, the IDs are the house IDs, and specifying a house ID that haven't been defined before (by setting its property 08) doesn't do anything, but doesn't cause an error, either. Note that you don't necessarily have to assign a set-ID to a house ID, the old TTD sprite of the substitute type will be used if you don't do so.  Industry tile IDs work in the same manner.

num-cid

Number of cargo type definitions that follow. Can be zero if only the default follows.

For features 05 (canals/rivers), 07 (houses), 09 (industry tiles), 0A (industries), and 0B (cargoes) this must always be zero.

cargo-type

Feature	cids
00..03 vehicles	00..FE: cargo-type (index in cargo translation table; cargobit if no table present) FF: purchase list default: used if none of the listed cids apply
04 stations	00..FD: cargo-type (index in cargo translation table; cargobit if no table present) waiting at the station. The waiting amount of this cargo is used in Action2 to decide the spriteset. FE: used if none of the listed cids apply. Action2 will assume "zero waiting cargo". FF: purchase list default: used if none of the listed cids apply. Action2 will use "sum of all waiting cargos".
05 canals	default only
07 houses	default only
09 industry tiles	default only
0A industries	default only
0B cargos	default only
0C sound effects	default only
0D airports	default only
0E signals	default only
0F objects	FF: purchase list default: used if none of the listed cids apply
10 rail types	special cids, see here
11 airport tiles	default only
12 road types	special cids, see here
13 tram types	special cids, see here
14 road stops	00..FD: cargo-type (index in cargo translation table; cargobit if no table present) waiting at the road stop. FE: used if none of the listed cids apply. FF: purchase list default: used if none of the listed cids apply.

default set-ID

Default set-ID if no entry from the cargo-type list above matches, or if there are no special cargo-types listed at all.

Example

Below is an example of what a real action 3 pseudo-sprite could look like for a train engine.

 13 * 7   03 00 01 02 00 00 00

Byte	Meaning
13	<sprite-number>
7	<length> of the action in bytes; start counting at 03 (<action>)
03	<action>: sets this pseudo-sprite to function as action 3
00	<feature>: 00 for trains
01	<n-id>: One ID to change in this case
02	<ids...>: vehicle ID (02 - Ploddyphut Choo-Choo)
00	<num-cid>: this engine doesn't have cargo-specific graphics
00 00	<default set-ID>: Use action 2 ID 00, because it is a word value you add 00