Action3/Canals - Revision history

Planetmaker: /* id */ clarified water ids

2011-12-02T22:04:01Z

id: clarified water ids

Rubidium: Allow replacing the buoy

2011-10-02T20:31:03Z

Allow replacing the buoy

Frosch: ottd defines river gui sprites via action 5 ottd gui sprites

2011-09-30T19:26:06Z

ottd defines river gui sprites via action 5 ottd gui sprites

Planetmaker: /* River slopes (05) */ note on property 0x09, bit 0

2011-09-10T10:52:32Z

River slopes (05): note on property 0x09, bit 0

Frosch: version tags

2011-09-01T17:23:56Z

version tags

Planetmaker: /* Riverbanks (06) */ sprites explained

2011-08-27T18:19:30Z

Riverbanks (06): sprites explained

Planetmaker: Action3 specific to canals/rivers

2011-08-27T17:52:55Z

Action3 specific to canals/rivers

New page

== Introduction ==

Action 3 assigns graphics sets (referenced to by (chains of) [[Action2|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:

<pre> <Sprite-number> * <Length> 03 05 01 <id> 00 <set-ID></pre>

{| class="wikitable"
|-
!'''Element'''
![[GRFActionsDetailed|'''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 [[Features|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 [[Action0/Canals#Graphic flags (09)| prop. 09 Bit 0]] is set'''
|-
|00||Watercliffs||4 slope sprites||1 flat ground sprite followed by 4 slope sprites
|-
|01||Locks||24||undefined
|-
|02||Dikes||12||undefined
|-
|03||Icons||1||undefined
|-
|04||Flat docks||4||undefined
|-
|05||River Slope||4||1 flat ground sprite followed by 4 slope sprites
|-
|06||Riverbanks ||12*5 (Last 4 for slopes)||undefined
|-
|07||River GUI||2||undefined
|}

==== Watercliffs (00) ====
[[File:riversprites_00.png]]

==== Dikes (Canals) (02) ====
[[File:riversprites_02.png]]

==== River slopes (05) ====
[[File:riversprites_05.png]]

==== Riverbanks (06) ====
[[File:riversprites_06.png]]

=== set-ID ===

set-ID (or Action2 ID)

== Example ==

@@ Line 73: / Line 73: @@
 !colspan="2"|'''Sprites when [[Action0/Canals#Graphic flags (09)| prop. 09 Bit 0]] is set'''
 |-
-|00||Watercliffs||{{ottdp|0.6|2.5}}||4 slope sprites||{{ottdp|1.1|2.6|ottdrev=r20352|ttdprev=r1573}}||1 flat ground sprite followed by 4 slope sprites
+|00||Canal water||{{ottdp|0.6|2.5}}||4 slope sprites||{{ottdp|1.1|2.6|ottdrev=r20352|ttdprev=r1573}}||1 flat ground sprite followed by 4 slope sprites
 |-
 |01||Locks||{{ottdp|0.6|2.5}}||24||{{ottdp|no|no}}||undefined
@@ Line 83: / Line 83: @@
 |04||Flat docks||{{ottdp|no|2.5}}||4||{{ottdp|no|no}}||undefined
 |-
-|05||River Slope||{{ottdp|0.6|2.6}}||4||{{ottdp|1.1|2.6|ottdrev=r20352|ttdprev=r1573}}||1 flat ground sprite followed by 4 slope sprites
+|05||River water||{{ottdp|0.6|2.6}}||4 slope sprites||{{ottdp|1.1|2.6|ottdrev=r20352|ttdprev=r1573}}||1 flat ground sprite followed by 4 slope sprites
 |-
 |06||Riverbanks ||{{ottdp|0.6|2.6}}||12*5 (Last 4 for slopes)||{{ottdp|no|no}}||undefined

@@ Line 88: / Line 88: @@
 |-
 |07||River GUI||{{ottdp|no|2.6}}||2||{{ottdp|no|no}}||undefined
 |}
@@ Line 105: / Line 107: @@
 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).
 === set-ID ===

@@ Line 79: / Line 79: @@
 |02||Dikes||{{ottdp|0.6|2.5}}||12||{{ottdp|no|no}}||undefined
 |-
-|03||Icons||{{ottdp|no|2.5}}||1||{{ottdp|no|no}}||undefined
+|03||Canal GUI||{{ottdp|no|2.5}}||1||{{ottdp|no|no}}||undefined
 |-
 |04||Flat docks||{{ottdp|no|2.5}}||4||{{ottdp|no|no}}||undefined
@@ Line 87: / Line 87: @@
 |06||Riverbanks ||{{ottdp|0.6|2.6}}||12*5 (Last 4 for slopes)||{{ottdp|no|no}}||undefined
 |-
-|07||River GUI||{{ottdp|0.6|2.6}}||2||{{ottdp|no|no}}||undefined
+|07||River GUI||{{ottdp|no|2.6}}||2||{{ottdp|no|no}}||undefined
 |}

← Older revision		Revision as of 18:19, 27 August 2011
Line 98:		Line 98:

	==== Riverbanks (06) ====		==== Riverbanks (06) ====
		+
−	[[File:riversprites_06.png]]
		+	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).

	=== set-ID ===		=== set-ID ===

@@ Line 97: / Line 97: @@
 ==== River slopes (05) ====
 [[File:riversprites_05.png]]
 ==== Riverbanks (06) ====

@@ Line 69: / Line 69: @@
 {| |-
-!'''ID'''!!'''Description'''!!'''Sprites'''!!'''Sprites when [[Action0/Canals#Graphic flags (09)| prop. 09 Bit 0]] is set'''
+!'''ID'''!!'''Description'''
 |-
-|00||Watercliffs||4 slope sprites||1 flat ground sprite followed by 4 slope sprites
+|00||Watercliffs||{{ottdp|0.6|2.5}}||4 slope sprites||{{ottdp|1.1|2.6|ottdrev=r20352|ttdprev=r1573}}||1 flat ground sprite followed by 4 slope sprites
 |-
-|01||Locks||24||undefined
+|01||Locks||{{ottdp|0.6|2.5}}||24||{{ottdp|no|no}}||undefined
 |-
-|02||Dikes||12||undefined
+|02||Dikes||{{ottdp|0.6|2.5}}||12||{{ottdp|no|no}}||undefined
 |-
-|03||Icons||1||undefined
+|03||Icons||{{ottdp|no|2.5}}||1||{{ottdp|no|no}}||undefined
 |-
-|04||Flat docks||4||undefined
+|04||Flat docks||{{ottdp|no|2.5}}||4||{{ottdp|no|no}}||undefined
 |-
-|05||River Slope||4||1 flat ground sprite followed by 4 slope sprites
+|05||River Slope||{{ottdp|0.6|2.6}}||4||{{ottdp|1.1|2.6|ottdrev=r20352|ttdprev=r1573}}||1 flat ground sprite followed by 4 slope sprites
 |-
-|06||Riverbanks ||12*5 (Last 4 for slopes)||undefined
+|06||Riverbanks ||{{ottdp|0.6|2.6}}||12*5 (Last 4 for slopes)||{{ottdp|no|no}}||undefined
 |-
-|07||River GUI||2||undefined
+|07||River GUI||{{ottdp|0.6|2.6}}||2||{{ottdp|no|no}}||undefined
 |}