Difference between revisions of "Action0"

From GRFSpecs
Jump to navigationJump to search
m (13 revisions)
(fix tables and stuff lost in conversion)
Line 1: Line 1:
  +
==Introduction==
 
'''''Defining new graphics feature properties'''''
 
 
=Action 0=
 
   
 
Defining new graphics feature properties
 
Defining new graphics feature properties
   
  +
Action 0 allows to change the feature properties of 'features', i.e. vehicles, stations, bridges, houses and more.
-=What does it do?=-
 
 
Action 0 is similar to [[TTDAlter]] in that it changes the feature properties of 'features', i.e. vehicles, stations, bridges, houses and more.  That means that you can change properties like:
 
*vehicle introduction date
 
*top speed
 
*wagon capacity
 
 
and many more.
 
   
  +
==Syntax==
-=Format=-
 
   
 
The data for Action 0 looks as follows:
 
The data for Action 0 looks as follows:
   
<pre>-+&lt;Sprite-number&gt; * &lt;Length&gt; 00 &lt;Feature&gt; &lt;Num-props&gt; &lt;Num-info&gt; &lt;Id&gt; (&lt;Property &lt;New-info&gt;)...+-</pre>
+
<Sprite-number> * <Length> 00 <Feature> <Num-props> <Num-info> <Id> (<Property <New-info>)...
   
 
Here is a short overview of what every term means:
 
Here is a short overview of what every term means:
   
  +
{| |-
||'''Element'''|[[GRFActionsDetailed|'''Size''']]|'''Description'''
 
  +
!Element!![[GRFActionsDetailed|Size]]!!Description
 
  +
|-
&lt;-+Sprite-number+-&gt; |dec|A sequential sprite number
 
  +
|<Sprite-number> ||dec||A sequential sprite number
 
  +
|-
&lt;-+Length+-&gt; |dec|The total number of bytes in the action
 
  +
|<Length> ||dec||The total number of bytes in the action
 
  +
|-
-+00+- |B|Action type. &nbsp;In this case, 00
 
  +
|00 ||B||Action type. In this case, 00
 
  +
|-
&lt;-+Feature+-&gt; |B|Which type of feature you would like to change
 
  +
|<Feature> ||B||Which type of feature you would like to change
 
  +
|-
&lt;-+Num-props+-&gt; |B|How many properties you would like to change per vehicle or station
 
  +
|<Num-props> ||B||How many properties you would like to change per vehicle or station
 
  +
|-
&lt;-+Num-info+-&gt; |B|How many vehicles/stations you would like to change
 
  +
|<Num-info> ||B||How many vehicles/stations you would like to change
 
  +
|-
&lt;-+Id+-&gt; |B*|The ID of the first vehicle/station to change
 
  +
|<Id> ||B*||The ID of the first vehicle/station to change
 
  +
|-
&lt;-+Property+-&gt; |B|What property to change for each vehicle/station
 
  +
|<Property> ||B||What property to change for each vehicle/station
 
  +
|-
&lt;-+New-info+-&gt; |V|The new value of the property||
 
  +
|<New-info> ||V||The new value of the property
 
  +
|}
 
You can put an Action 0 anywhere after [[Action8|Action 8]] in the GRF file.
 
You can put an Action 0 anywhere after [[Action8|Action 8]] in the GRF file.
   
The &lt;Id&gt; is an extended byte since 2.0.1 alpha 61, to support the definition of &gt;255 sound effects. In OpenTTD since r13482, extended IDs (up to 65535) can be used for vehicles as well. However there is currently a caveat that articulated parts must be below 128.
+
The <Id> is an extended byte since 2.0.1 alpha 61, to support the definition of >255 sound effects. In OpenTTD since r13482, extended IDs (up to 65535) can be used for vehicles as well. However there is currently a caveat that articulated parts must be below 128.
   
  +
==Descriptions==
-=Filling in the terms=-
 
   
 
===Sprite-number===
 
===Sprite-number===
Line 55: Line 46:
 
===Length===
 
===Length===
   
The total number of bytes in Action 0. &nbsp;Start counting from &lt;-+Action+-&gt;, the bit that sets the pseudo-sprite to act as the specified action.
+
The total number of bytes in Action 0. Start counting from <Action>, the bit that sets the pseudo-sprite to act as the specified action.
   
 
===Action===
 
===Action===
Line 64: Line 55:
   
 
This sets the type of feature that you wish to change. Set it to:
 
This sets the type of feature that you wish to change. Set it to:
  +
{|
 
  +
!Value!!Feature
00 for [[Action0Trains|trains]]
 
  +
|-
 
  +
|00 || [[Action0Trains|trains]]
01 for [[Action0RoadVehicles|road vehicles]]
 
  +
|-
 
  +
|01 || [[Action0RoadVehicles|road vehicles]]
02 for [[Action0Ships|ships]]
 
  +
|-
 
03 for [[Action0Planes|planes]]
+
|02 || [[Action0Ships|ships]]
  +
|-
 
  +
|03 || [[Action0Planes|planes]]
04 for [[Action0Stations|stations]]
 
  +
|-
 
  +
|04 || [[Action0Stations|stations]]
05 for [[Action0Canals|canals]]
 
  +
|-
 
06 for [[Action0Bridges|bridges]]
+
|05 || [[Action0Canals|canals]]
  +
|-
 
  +
|06 || [[Action0Bridges|bridges]]
07 for [[Action0Houses|houses]] (see [[DefaultHouseProps|defaults]])
 
  +
|-
 
  +
|07 || [[Action0Houses|houses]] (see [[DefaultHouseProps|defaults]])
08 for [[Action0GeneralVariables|global variables]]
 
  +
|-
 
  +
|08 || [[Action0GeneralVariables|global variables]]
09 for [[Action0IndustryTiles|industry tiles]] (see [[IndustryTileDefaultProps|defaults]])
 
  +
|-
 
0A for [[Action0Industries|industries]] (see [[IndustryDefaultProps|defaults]])
+
|09 || [[Action0IndustryTiles|industry tiles]] (see [[IndustryTileDefaultProps|defaults]])
  +
|-
 
0B for [[Action0Cargos|cargos]] (see [[CargoDefaultProps|defaults]])
+
|0A || [[Action0Industries|industries]] (see [[IndustryDefaultProps|defaults]])
  +
|-
 
  +
|0B || [[Action0Cargos|cargos]] (see [[CargoDefaultProps|defaults]])
0C for [[Action0SoundEffects|sound effects]]
 
  +
|-
 
  +
|0C || [[Action0SoundEffects|sound effects]]
0D for [[Action0Airports|airports]]
 
  +
|-
 
  +
|0D || [[Action0Airports|airports]]
0E for signals (Action 0 is not valid for this feature)
 
  +
|-
 
  +
|0E || signals (Action 0 is not valid for this feature)
0F for [[Action0Objects|newobjects]]
 
  +
|-
 
  +
|0F || [[Action0Objects|newobjects]]
10 for [[Action0Railtypes|rail types]] (OpenTTD r18969)
 
  +
|-
 
11 for [[Action0AirportTiles|airport tiles]] (OpenTTD r19204)
+
|10 || [[Action0Railtypes|rail types]] (OpenTTD r18969)
  +
|-
  +
|11 || [[Action0AirportTiles|airport tiles]] (OpenTTD r19204)
  +
|}
   
 
Note that the above list is the master list for ''all'' actions where not stated otherwise.
 
Note that the above list is the master list for ''all'' actions where not stated otherwise.
Line 105: Line 99:
 
===Num-props===
 
===Num-props===
   
This is the number of properties that you wish to change per vehicle or station. &nbsp;Note: even if you wish to set the same properties to the same value for different vehicles then you must still repeat the properties and their values for each vehicle.
+
This is the number of properties that you wish to change per vehicle or station. Note: even if you wish to set the same properties to the same value for different vehicles then you must still repeat the properties and their values for each vehicle.
   
 
===Num-info===
 
===Num-info===
Line 112: Line 106:
   
 
===Id===
 
===Id===
  +
The [[VehicleIDs|Vehicle ID]] of the first vehicle or station to change. If num-info is greater than one, this vehicle/station and the following vehicles/stations will be changed.
 
The [[VehicleIDs|Vehicle ID]] of the first vehicle or station to change. &nbsp;If num-info is greater than one, this vehicle/station and the following vehicles/stations will be changed.
 
   
 
===Property===
 
===Property===
   
The number of the property that will be changed. &nbsp;This and the New-info section are repeated as many times as there are properties to set; in total, there are &lt;num-props&gt; property bytes.
+
The number of the property that will be changed. This and the New-info section are repeated as many times as there are properties to set; in total, there are <
  +
num-props> property bytes.
   
 
See relevant sub-section (links at the bottom) for more details.
 
See relevant sub-section (links at the bottom) for more details.
Line 123: Line 117:
 
===New-info===
 
===New-info===
   
The new information that will replace the previous information for the specified property. &nbsp;This is a variable size; dependent upon the property. Each property byte is followed by &lt;num-info&gt; new-info sections.
+
The new information that will replace the previous information for the specified property. This is a variable size; dependent upon the property. Each property byte is followed by <num-info> new-info sections.
  +
The appropriate \b, \w, and \d escape sequences can be quite useful for most <
  +
new-info>s. See [[GRFActionsDetailed#Byte_order|the discussion of escape sequences]] for further information.
   
  +
===Features and properties===
The appropriate \b, \w, and \d escape sequences can be quite useful for most &lt;new-info&gt;s. See [[GRFActionsDetailed#Byte_order|the discussion of escape sequences]] for further information.
 
   
  +
Each feature has its own very specific properties. These are explained in detail in their separate pages.
-=Features and properties=-
 
 
Each feature has its own very specific properties. &nbsp;These are explained in detail in the pages listed below:
 
 
{toc}
 
   
 
You will also find the minimum GRF version (in [[Action8|Action 8]]) that supports this property, or alternatively if the property was introduced between version changes, the patch version number that you can check with [[Action7|Action 7]].
 
You will also find the minimum GRF version (in [[Action8|Action 8]]) that supports this property, or alternatively if the property was introduced between version changes, the patch version number that you can check with [[Action7|Action 7]].
   
-=Example=-
+
==Example==
 
For examples please see the action 0 entries for each feature.
 

Revision as of 04:05, 14 June 2011

Introduction

Defining new graphics feature properties

Action 0 allows to change the feature properties of 'features', i.e. vehicles, stations, bridges, houses and more.

Syntax

The data for Action 0 looks as follows:

<Sprite-number> * <Length> 00 <Feature> <Num-props> <Num-info> <Id> (<Property <New-info>)...

Here is a short overview of what every term means:

Element Size Description
<Sprite-number> dec A sequential sprite number
<Length> dec The total number of bytes in the action
00 B Action type. In this case, 00
<Feature> B Which type of feature you would like to change
<Num-props> B How many properties you would like to change per vehicle or station
<Num-info> B How many vehicles/stations you would like to change
<Id> B* The ID of the first vehicle/station to change
<Property> B What property to change for each vehicle/station
<New-info> V The new value of the property

You can put an Action 0 anywhere after Action 8 in the GRF file.

The <Id> is an extended byte since 2.0.1 alpha 61, to support the definition of >255 sound effects. In OpenTTD since r13482, extended IDs (up to 65535) can be used for vehicles as well. However there is currently a caveat that articulated parts must be below 128.

Descriptions

Sprite-number

Action 0 can appear anywhere in the GRF file, so set it to the sprite number you are currently at.

Length

The total number of bytes in Action 0. Start counting from <Action>, the bit that sets the pseudo-sprite to act as the specified action.

Action

The type of action this pseudo-sprites defines. It should be 00 here because we want this pseudo-sprite to act as Action 0.

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 planes
04 stations
05 canals
06 bridges
07 houses (see defaults)
08 global variables
09 industry tiles (see defaults)
0A industries (see defaults)
0B cargos (see defaults)
0C sound effects
0D airports
0E signals (Action 0 is not valid for this feature)
0F newobjects
10 rail types (OpenTTD r18969)
11 airport tiles (OpenTTD r19204)

Note that the above list is the master list for all actions where not stated otherwise.

Num-props

This is the number of properties that you wish to change per vehicle or station. Note: even if you wish to set the same properties to the same value for different vehicles then you must still repeat the properties and their values for each vehicle.

Num-info

Simply the number of vehicles that you will change using this action 0.

Id

The Vehicle ID of the first vehicle or station to change. If num-info is greater than one, this vehicle/station and the following vehicles/stations will be changed.

Property

The number of the property that will be changed. This and the New-info section are repeated as many times as there are properties to set; in total, there are < num-props> property bytes.

See relevant sub-section (links at the bottom) for more details.

New-info

The new information that will replace the previous information for the specified property. This is a variable size; dependent upon the property. Each property byte is followed by <num-info> new-info sections. The appropriate \b, \w, and \d escape sequences can be quite useful for most < new-info>s. See the discussion of escape sequences for further information.

Features and properties

Each feature has its own very specific properties. These are explained in detail in their separate pages.

You will also find the minimum GRF version (in Action 8) that supports this property, or alternatively if the property was introduced between version changes, the patch version number that you can check with Action 7.

Example