OpenTTD

newgrf_animation_type.h
Go to the documentation of this file.
1 /* $Id: newgrf_animation_type.h 22745 2011-08-14 13:45:36Z frosch $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
9
12 #ifndef NEWGRF_ANIMATION_TYPE_H
13 #define NEWGRF_ANIMATION_TYPE_H
14
15 static const uint8 ANIM_STATUS_NON_LOOPING = 0x00;
16 static const uint8 ANIM_STATUS_LOOPING = 0x01;
17 static const uint8 ANIM_STATUS_NO_ANIMATION = 0xFF;
18
20 struct AnimationInfo {
21 uint8 frames;
22 uint8 status;
23 uint8 speed;
24 uint16 triggers;
25 };
26
28 enum StationAnimationTrigger {
29 SAT_BUILT,
30 SAT_NEW_CARGO,
31 SAT_CARGO_TAKEN,
32 SAT_TRAIN_ARRIVES,
33 SAT_TRAIN_DEPARTS,
34 SAT_TRAIN_LOADS,
35 SAT_250_TICKS,
36 };
37
39 enum IndustryAnimationTrigger {
40 IAT_CONSTRUCTION_STATE_CHANGE,
41 IAT_TILELOOP,
42 IAT_INDUSTRY_TICK,
43 IAT_INDUSTRY_RECEIVED_CARGO,
44 IAT_INDUSTRY_DISTRIBUTES_CARGO,
45 };
46
48 enum AirpAnimationTrigger {
49 AAT_BUILT,
50 AAT_TILELOOP,
51 AAT_STATION_NEW_CARGO,
52 AAT_STATION_CARGO_TAKEN,
53 AAT_STATION_250_TICKS,
54 };
55
57 enum ObjectAnimationTrigger {
58 OAT_BUILT,
59 OAT_TILELOOP,
60 OAT_256_TICKS,
61 };
62
63 #endif /* NEWGRF_ANIMATION_TYPE_H */
IAT_CONSTRUCTION_STATE_CHANGE
Trigger whenever the construction state changes.
Definition: newgrf_animation_type.h:40
IAT_INDUSTRY_DISTRIBUTES_CARGO
Trigger when cargo is distributed.
Definition: newgrf_animation_type.h:44
IndustryAnimationTrigger
IndustryAnimationTrigger
Animation triggers of the industries.
Definition: newgrf_animation_type.h:39
AnimationInfo::triggers
uint16 triggers
The triggers that trigger animation.
Definition: newgrf_animation_type.h:24
IAT_TILELOOP
Trigger in the periodic tile loop.
Definition: newgrf_animation_type.h:41
SAT_TRAIN_ARRIVES
Trigger platform when train arrives.
Definition: newgrf_animation_type.h:32
SAT_BUILT
Trigger tile when built.
Definition: newgrf_animation_type.h:29
AnimationInfo::status
uint8 status
Status; 0: no looping, 1: looping, 0xFF: no animation.
Definition: newgrf_animation_type.h:22
SAT_TRAIN_LOADS
Trigger platform when train loads/unloads.
Definition: newgrf_animation_type.h:34
AAT_TILELOOP
Triggered in the periodic tile loop.
Definition: newgrf_animation_type.h:50
IAT_INDUSTRY_TICK
Trigger every tick.
Definition: newgrf_animation_type.h:42
AAT_STATION_CARGO_TAKEN
Triggered when a cargo type is completely removed from the station (for all tiles at the same time)...
Definition: newgrf_animation_type.h:52
AAT_BUILT
Triggered when the airport is built (for all tiles at the same time).
Definition: newgrf_animation_type.h:49
ANIM_STATUS_NON_LOOPING
static const uint8 ANIM_STATUS_NON_LOOPING
Animation is not looping.
Definition: newgrf_animation_type.h:15
OAT_BUILT
Triggered when the object is built (for all tiles at the same time).
Definition: newgrf_animation_type.h:58
SAT_TRAIN_DEPARTS
Trigger platform when train leaves.
Definition: newgrf_animation_type.h:33
SAT_250_TICKS
Trigger station every 250 ticks.
Definition: newgrf_animation_type.h:35
IAT_INDUSTRY_RECEIVED_CARGO
Trigger when cargo is received .
Definition: newgrf_animation_type.h:43
SAT_NEW_CARGO
Trigger station on new cargo arrival.
Definition: newgrf_animation_type.h:30
ANIM_STATUS_NO_ANIMATION
static const uint8 ANIM_STATUS_NO_ANIMATION
There is no animation.
Definition: newgrf_animation_type.h:17
OAT_256_TICKS
Triggered every 256 ticks (for all tiles at the same time).
Definition: newgrf_animation_type.h:60
StationAnimationTrigger
StationAnimationTrigger
Animation triggers for station.
Definition: newgrf_animation_type.h:28
ObjectAnimationTrigger
ObjectAnimationTrigger
Animation triggers for objects.
Definition: newgrf_animation_type.h:57
AAT_STATION_250_TICKS
Triggered every 250 ticks (for all tiles at the same time).
Definition: newgrf_animation_type.h:53
AnimationInfo
Information about animation.
Definition: newgrf_animation_type.h:20
OAT_TILELOOP
Triggered in the periodic tile loop.
Definition: newgrf_animation_type.h:59
AnimationInfo::speed
uint8 speed
The speed, i.e. the amount of time between frames.
Definition: newgrf_animation_type.h:23
SAT_CARGO_TAKEN
Trigger station when cargo is completely taken.
Definition: newgrf_animation_type.h:31
AAT_STATION_NEW_CARGO
Triggered when new cargo arrives at the station (for all tiles at the same time). ...
Definition: newgrf_animation_type.h:51
ANIM_STATUS_LOOPING
static const uint8 ANIM_STATUS_LOOPING
Animation is looping.
Definition: newgrf_animation_type.h:16
AnimationInfo::frames
uint8 frames
The number of frames.
Definition: newgrf_animation_type.h:21
AirpAnimationTrigger
AirpAnimationTrigger
Animation triggers for airport tiles.
Definition: newgrf_animation_type.h:48