Action3/Canals

From GRFSpecs
Jump to: navigation, search

Introduction

Action 3 assigns graphics sets (referenced to by (chains of) action 2(s) to feature IDs.

Format

The format of the data is feature-dependent, canals use specific ids which define the graphics being provided.

The data is:

 <Sprite-number> * <Length> 03 05 01 <id> 00 <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
05 B Feature 05 "Canals"
01 B Canals and rivers can only provide one "ID" at a time
<id> B/B* IDs of the current feature this action 3 associates graphics with. There must be as many IDs as <n-id> specifies
00 B Canals support no cargo types
<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, 05 for canals in this case

id

In the case of canals or rivers this differs by the type of sprites provided in the real sprite:

ID Description Sprites Sprites when prop. 09 Bit 0 is set
00 Canal water Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.52.5 4 slope sprites Supported by OpenTTD 1.1 (r20352)1.1 Supported by TTDPatch 2.6 (r1573)2.6 1 flat ground sprite followed by 4 slope sprites
01 Locks Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.52.5 24 Not supported by OpenTTD Not supported by TTDPatch undefined
02 Dikes Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.52.5 12 Not supported by OpenTTD Not supported by TTDPatch undefined
03 Canal GUI Not supported by OpenTTD Supported by TTDPatch 2.52.5 1 Not supported by OpenTTD Not supported by TTDPatch undefined
04 Flat docks Not supported by OpenTTD Supported by TTDPatch 2.52.5 4 Not supported by OpenTTD Not supported by TTDPatch undefined
05 River water Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.62.6 4 slope sprites Supported by OpenTTD 1.1 (r20352)1.1 Supported by TTDPatch 2.6 (r1573)2.6 1 flat ground sprite followed by 4 slope sprites
06 Riverbanks Supported by OpenTTD 0.60.6 Supported by TTDPatch 2.62.6 12*5 (Last 4 for slopes) Not supported by OpenTTD Not supported by TTDPatch undefined
07 River GUI Not supported by OpenTTD Supported by TTDPatch 2.62.6 2 Not supported by OpenTTD Not supported by TTDPatch undefined
08 Buoy Supported by OpenTTD 1.2 (r22973)1.2 Not supported by TTDPatch 1 Not supported by OpenTTD Not supported by TTDPatch undefined

Watercliffs (00)

File:Riversprites 00.png

Dikes (Canals) (02)

Riversprites 02.png

River slopes (05)

When property 09, bit 0 is NOT set, the required sprites are Riversprites 05.png

if the bit is set, the sprites are preceeded by a flat water tile which then represents the water used exclusively for rivers.

Riverbanks (06)

This contains 5 times sprites as shown for id2 (dikes). The first 12 sprites are for level land, the following ones are for sloped rivers where slopes follow the same order as for id5 (river slopes).

Buoy (08)

This contains the buoy sprite without water to be shown on the map. This will be overlaid on the appropriate water for the tile.

set-ID

set-ID (or Action2 ID)

Example