Difference between revisions of "Action2"

From GRFSpecs
Jump to navigationJump to search
m (13 revisions)
m (Add road stops to feature table)
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
  +
== Introduction ==
−  
−
'''''Define graphics set IDs'''''
  
−  
−
=Action 2=
  
   
 
Defining graphics set IDs.
  
Defining graphics set IDs.
   
  +
Action2 is used to group sets of sprites from the previous [[Action1]] together, and make them accessible by a [[VariationalAction2|variational]] or [[RandomAction2|random action 2]] (chain) or an [[Action3]].
−
-=Introduction=-
  
   
  +
Do not skip an Action2 using [[Action9]] (unless it skips the whole file). Action2 must not be skipped by Action9 or TTDPatch will most likely crash. Skip or modify [[Action3]] instead. Skipping an Action2 with an [[Action7]] has no effect.
−
Action 2 is used to group sets of sprites from the previous [[Action1|action 1]] together, and make them accessible by a variational or random action2 (chain) or an action3.
  
   
  +
== Syntax ==
−
-=Format=-
  
   
−
In general, the data looks as follows:
 +
In general, the data looks as follows. Some features use a different syntax though (see table below).
   
−
<pre> -+&lt;Sprite-number&gt; * &lt;Length&gt; 02 &lt;feature&gt; &lt;set-id&gt; &lt;num-ent1&gt; &lt;num-ent2&gt; &lt;entries...&gt;+-</pre>
 +
<Sprite-number> * <Length> 02 <feature> <set-id> <num-ent1> <num-ent2> <entries...>
   
  +
{|
−
||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''
  
  +
!Element!![[GRFActionsDetailed|Size]]!!Description
  +
|-
  +
|<Sprite-number>||dec||A sequential sprite number
  +
|-
  +
|<length>||dec||The total number of bytes used in this action
  +
|-
  +
|02||B||Defines action 02
  +
|-
  +
|<feature>||B||For what type of feature should the following sprites be used?
  +
|-
  +
|<set-id>||B||What set-ID this action 2 defines
  +
|-
  +
|<num-ent1>||B||First number of entries, depends on feature
  +
|-
  +
|<num-ent2>||B||Second number of entries, depends on feature
  +
|-
  +
|<entries...>||W||Entry numbers, depends on the feature
  +
|}
   
  +
== Descriptions ==
−
&lt;Sprite-number&gt;|dec|A sequential sprite number
  
   
  +
=== Sprite-number ===
−
&lt;length&gt;|dec|The total number of bytes used in this action
  
−  
−
02|B|Defines action 02
  
−  
−
&lt;feature&gt;|B|For what type of feature should the following sprites be used?
  
−  
−
&lt;set-id&gt;|B|What set-ID this action 2 defines
  
−  
−
&lt;num-ent1&gt;|B|First number of entries, depends on feature
  
−  
−
&lt;num-ent2&gt;|B|Second number of entries, depends on feature
  
−  
−
&lt;entries...&gt;|W|Entry numbers, depends on the feature||
  
−  
−
-=Filling in the terms=-
  
−  
−
===Sprite-number===
  
   
 
This is just the number you are at.
  
This is just the number you are at.
   
−
===Length===
 +
=== Length ===
   
 
Count the number of bytes in this action.
  
Count the number of bytes in this action.
   
−
===feature===
 +
=== Feature ===
   
−
This sets the type of feature that you wish to change. Set it to:
 +
This sets the type of [[Features|feature]] that you wish to change. Set it to:
   
  +
{|- |
−
00 for trains
  
  +
!Value!![[Features|Feature]]
  +
|-
  +
|00||[[Action2/Vehicles | Trains]]
  +
|-
  +
|01||[[Action2/Vehicles | Road Vehicles]]
  +
|-
  +
|02||[[Action2/Vehicles | Ships]]
  +
|-
  +
|03||[[Action2/Vehicles | Aircraft]]
  +
|-
  +
|04||[[Action2/Stations | Stations]]
  +
|-
  +
|05||[[Action2/Single_Set | Canals/Rivers]]
  +
|-
  +
|07||[[Action2/Sprite_Layout | Houses]] (special Sprite Layout format)
  +
|-
  +
|09||[[Action2/Sprite_Layout | Industry Tiles]] (special Sprite Layout format)
  +
|-
  +
|0A||[[Action2/Industries | Industries]] (special Production Callback format)
  +
|-
  +
|0B||[[Action2/Single_Set | Cargos]]
  +
|-
  +
|0C||[[Action2/Only_Callback_Failure | Sound Effects]] (callback failure only)
  +
|-
  +
|0D||[[Action2/Single_Set | Airports]]
  +
|-
  +
|0E||[[Action2/Only_Callback_Failure | Signals]] (callback failure only)
  +
|-
  +
|0F||[[Action2/Sprite_Layout | Objects]] (special Sprite Layout format)
  +
|-
  +
|10||[[Action2/Single_Set | Railtypes]]
  +
|-
  +
|11||[[Action2/Sprite_Layout | Airport Tiles]] (special Sprite Layout format)
  +
|-
  +
|12||[[Action2/Single_Set | Roadtypes]]
  +
|-
  +
|13||[[Action2/Single_Set | Tramtypes]]
  +
|-
  +
|14||[[Action2/Sprite_Layout | Road Stops]] (special Sprite Layout format)
  +
|}
   
  +
=== set-id ===
−
01 for road vehicles
  
   
  +
This defines the ID of the current action 2. This ID will later be referred to by [[Action3|action 3]], or a variational/random action 2.
−
02 for ships
  
−  
−
03 for planes
  
−  
−
04 for stations
  
−  
−
05 for canals/rivers
  
−  
−
06 for bridges
  
−  
−
07 for houses
  
−  
−
09 for industry tiles
  
−  
−
0A for industries
  
−  
−
0B for cargos
  
−  
−
0F for objects
  
−  
−
10 for rail types (since OpenTTD r19056)
  
−  
−
==set-id==
  
−  
−
This defines the ID of the current action 2. &nbsp;This ID will later be referred to by [[Action3|action 3]], or a variational/random action 2.
  
   
 
You can reuse action 2 IDs, and there's no restriction on the order in which they are defined.
  
You can reuse action 2 IDs, and there's no restriction on the order in which they are defined.
   
−
==num-ent1, num-ent2==
 +
=== num-ent1, num-ent2 ===
   
 
Each feature has two different graphics ranges, but their exact meaning differs from feature to feature. For example, for vehicles, the first set is used while moving, and the second while loading/unloading in a station.
  
Each feature has two different graphics ranges, but their exact meaning differs from feature to feature. For example, for vehicles, the first set is used while moving, and the second while loading/unloading in a station.
   
−
==entries==
 +
=== entries ===
   
 
This is the list of action 1 sets to use, first num-ent1 for the first range, then num-ent2 entries for the second range.
  
This is the list of action 1 sets to use, first num-ent1 for the first range, then num-ent2 entries for the second range.
   
  +
==Example==
−
-=Notes=-
  
−  
−
Do not skip an action 2 using [[Action9|action 9]] (unless it skips the whole file). Action 2 must not be skipped by action 9 or the patch will most likely crash. Skip or modify [[Action3|action 3]] instead. Skipping an action 2 with an [[Action7|action 7]] has no effect.
  
−  
−
-=Feature specific formats=-
  
−  
−
Some features and/or num-ent1 values have a special format. These are detailed on the pages listed below.
  
−  
−
{toc}
  
−  
−
-=Example=-
  
−  
−
<span style='color:#808080'>Something to go here</span>
  

Latest revision as of 09:52, 11 June 2023

Introduction

Defining graphics set IDs.

Action2 is used to group sets of sprites from the previous Action1 together, and make them accessible by a variational or random action 2 (chain) or an Action3.

Do not skip an Action2 using Action9 (unless it skips the whole file). Action2 must not be skipped by Action9 or TTDPatch will most likely crash. Skip or modify Action3 instead. Skipping an Action2 with an Action7 has no effect.

Syntax

In general, the data looks as follows. Some features use a different syntax though (see table below). 

<Sprite-number> * <Length> 02 <feature> <set-id> <num-ent1> <num-ent2> <entries...>
Element Size Description
<Sprite-number> dec A sequential sprite number
<length> dec The total number of bytes used in this action
02 B Defines action 02
<feature> B For what type of feature should the following sprites be used?
<set-id> B What set-ID this action 2 defines
<num-ent1> B First number of entries, depends on feature
<num-ent2> B Second number of entries, depends on feature
<entries...> W Entry numbers, depends on the feature

Descriptions

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 (special Sprite Layout format)
09 Industry Tiles (special Sprite Layout format)
0A Industries (special Production Callback format)
0B Cargos
0C Sound Effects (callback failure only)
0D Airports
0E Signals (callback failure only)
0F Objects (special Sprite Layout format)
10 Railtypes
11 Airport Tiles (special Sprite Layout format)
12 Roadtypes
13 Tramtypes
14 Road Stops (special Sprite Layout format)

set-id

This defines the ID of the current action 2. This ID will later be referred to by action 3, or a variational/random action 2.

You can reuse action 2 IDs, and there's no restriction on the order in which they are defined.

num-ent1, num-ent2

Each feature has two different graphics ranges, but their exact meaning differs from feature to feature. For example, for vehicles, the first set is used while moving, and the second while loading/unloading in a station.

entries

This is the list of action 1 sets to use, first num-ent1 for the first range, then num-ent2 entries for the second range.

Example

Retrieved from ‘https://newgrf-specs.tt-wiki.net/index.php?title=Action2&oldid=4461’