Action3/Roadtypes - Revision history

Michi cc: /* cargo-type */ 03 tunnel

2022-12-26T23:00:27Z

cargo-type: 03 tunnel

← Older revision		Revision as of 23:00, 26 December 2022
Line 107:		Line 107:
	\|19		\|19
	\|11 roadbit combinations, 4 slopes, and 4 dead ends. These sprites are required.		\|11 roadbit combinations, 4 slopes, and 4 dead ends. These sprites are required.
	<!--
	\|-		\|-
	\|03		\|03
	\|Tunnel<ref name=leftout />		\|Tunnel<ref name=leftout />
	\|4		\|4
	\|1 sprite for each direction. Sprite is overlay for ~~track~~ in existing tunnel graphics. The original ground sprite is drawn, then the overlay, then possibly a ~~train~~ and the original tunnel head is drawn over the top. This keeps compatibility with different landscape types. Sprite order: SW, NW, NE, SE~~. {{ottd\|1.2\|r23952}} If type 0A is defined as well, this sprite is used slightly different, see [[#Tunnel portal overlay (0A)\|Tunnel portal overlay (0A)]]~~.		\|{{ottd\|13\|}} 1 sprite for each direction. Sprite is overlay for road in existing tunnel graphics. The original ground sprite is drawn, then the overlay, then possibly a RV and the original tunnel head is drawn over the top. This keeps compatibility with different landscape types. Sprite order: SW, NW, NE, SE.
	-->
	\|-		\|-
	\|04		\|04

Flherne: /* cargo-type */ add another OTTD 13 tag

2022-12-26T21:11:53Z

cargo-type: add another OTTD 13 tag

← Older revision		Revision as of 21:11, 26 December 2022
Line 209:		Line 209:
	==== One-way road arrows (0B) ====		==== One-way road arrows (0B) ====

			Since {{ottd\|13\|}}.
	[[File:Nrt_oneway.png]]		[[File:Nrt_oneway.png]]

Flherne: /* cargo-type */ add example oneway spritesheet

2022-12-26T21:10:00Z

cargo-type: add example oneway spritesheet

← Older revision		Revision as of 21:10, 26 December 2022
Line 150:		Line 150:
	\|One-way road arrows		\|One-way road arrows
	\|18		\|18
	\|{{ottd\|13\|}}Overlays for one-way roads: repeat (arrow facing SW, arrow NE, impassable NE-SW, arrow NW, arrow SE, impassable NW-SE) for flat, N corner raised, S corner raised.		\|{{ottd\|13\|}} Overlays for one-way roads: repeat (arrow facing SW, arrow NE, impassable NE-SW, arrow NW, arrow SE, impassable NW-SE) for flat, N corner raised, S corner raised.
	\|}		\|}

Line 206:		Line 206:

	[[File:Nrt_drivein.png]]		[[File:Nrt_drivein.png]]

			==== One-way road arrows (0B) ====

			[[File:Nrt_oneway.png]]

	<!--		<!--
	==== Tunnel portal overlay (0A) ====		==== Tunnel portal overlay (0A) ====

Flherne: /* cargo-type */ Add 0B one-way road arrows to table

2022-12-26T21:04:53Z

cargo-type: Add 0B one-way road arrows to table

← Older revision		Revision as of 21:04, 26 December 2022
Line 146:		Line 146:
	\|4		\|4
	\|Overlays for drive-in road stops		\|Overlays for drive-in road stops
			\|-
			\|0B
			\|One-way road arrows
			\|18
			\|{{ottd\|13\|}}Overlays for one-way roads: repeat (arrow facing SW, arrow NE, impassable NE-SW, arrow NW, arrow SE, impassable NW-SE) for flat, N corner raised, S corner raised.
	\|}		\|}

Andythenorth: /* cargo-type */

2020-02-21T18:49:54Z

cargo-type

← Older revision		Revision as of 18:49, 21 February 2020
Line 142:		Line 142:
	-->		-->
	\|-		\|-
	\|0A?		\|0A
	\|Road stops		\|Road stops
	\|4		\|4
Line 198:		Line 198:
	[[File:Nrt_bridge.png]]		[[File:Nrt_bridge.png]]

	==== Road stops (0A?)====		==== Road stops (0A) ====

	[[File:Nrt_drivein.png]]		[[File:Nrt_drivein.png]]

Andrew350: corrected the feature byte

2019-12-28T12:03:55Z

corrected the feature byte

← Older revision		Revision as of 12:03, 28 December 2019
Line 9:		Line 9:
	The format of the data is feature-dependent. For roadtypes it looks like		The format of the data is feature-dependent. For roadtypes it looks like

	<pre> <Sprite-number> * <Length> 03 10 <n-id> <ids...> <num-cid> <cargo-type> <set-ID>... <default set-ID></pre>		<pre> <Sprite-number> * <Length> 03 12 <n-id> <ids...> <num-cid> <cargo-type> <set-ID>... <default set-ID></pre>

	{\| class="wikitable"		{\| class="wikitable"

Andrew350: initial creation

2019-12-28T12:03:00Z

initial creation

New page

== Introduction ==

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

{{ottdp|1.10}} Roadtypes are available only in OpenTTD > 1.10

== Format ==

The format of the data is feature-dependent. For roadtypes it looks like

<pre> <Sprite-number> * <Length> 03 10 <n-id> <ids...> <num-cid> <cargo-type> <set-ID>... <default 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
|-
|12
|B
|The feature byte for roadtypes
|-
|<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.

=== 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 [[Action3LiveryOverride|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.

=== num-cid ===

Number of "cargo" type definitions that follow.

=== cargo-type ===

Roadtypes re-uses in its Action3 the 'cargo'-type definition in order to assign the type of graphics defined by the associated set-ID:

{| class="wikitable"
|-
!'Cargo' Type
!Sprite Type
!#Sprites
!Useage
|-
|00
|Icons and cursors
|12
|4 road directions, autoroad, depot, tunnel and convert road. First all icons, then all cursors.
|-
|01
|Track overlays<ref name=leftout>Either all or none of these sprites should be provided.</ref>
|19
|11 roadbit combinations, 4 slopes, and 4 dead ends. These sprites are optional for roadtypes.
|-
|02
|Underlay<ref name=leftout />
|19
|11 roadbit combinations, 4 slopes, and 4 dead ends. These sprites are required.

|-
|04
|Catenary front
|29
|11 roadbit combinations, 4 slopes, 4 dead ends, 4 tunnels, 2 bridge middle, 4 bridge ramps
|-
|05
|Catenary back
|29
|11 roadbit combinations, 4 slopes, 4 dead ends, 4 tunnels (unused), 2 bridge middle, 4 bridge ramps
|-
|06
|Bridge surfaces<ref name=leftout />
|6
|2 bridge middle, 4 bridge ramps
|-
|08
|Depots
|6
|Follows the original layout for depot sprites. If not present, the default depot sprites (depending on catenary flag) plus track overlay are drawn. If present, the depot sprites are expected to include track overlay graphics.

|-
|0A?
|Road stops
|4
|Overlays for drive-in road stops
|}

<references />

==== GUI sprites (00) ====

[[File:Nrt_gui.png]]

==== Road underlay (02) ====

[[File:Nrt_underlay.png]]

==== Catenary front (04)====

[[File:Nrt_catenary_front.png]]

==== Catenary back (05) ====

[[File:Nrt_catenary_back.png]]

==== Depot sprites (08) ====

[[File:Nrt_depot.png]]

{| class="wikitable
|-
!Sprite Number
!Usage
|-
|0
|    NE wall for SE-entry depot.
|-
|1
|    Depot building for SE-entry depot.
|-
|2
|    NW wall for SW-entry depot.
|-
|3
|    Depot building for SW-entry depot.
|-
|4
|    Depot building for NE-entry depot.
|-
|5
|    Depot building for NW-entry depot.
|}

==== Bridge surfaces (06) ====

[[File:Nrt_bridge.png]]

==== Road stops (0A?)====

[[File:Nrt_drivein.png]]


=== default set-ID ===

The default set-ID would be used for roadtype callbacks. However, since there are currently no callbacks for roadtypes it should always result in a [[Action2/Only_Callback_Failure|callback-failure]].

== Example ==