OpenTTD Source: src/newgrf_animation_type.h Source File

OpenTTD Source 14.0-RC3

newgrf_animation_type.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 #ifndef NEWGRF_ANIMATION_TYPE_H
11 #define NEWGRF_ANIMATION_TYPE_H
12
13 static const uint8_t ANIM_STATUS_NON_LOOPING = 0x00;
14 static const uint8_t ANIM_STATUS_LOOPING = 0x01;
15 static const uint8_t ANIM_STATUS_NO_ANIMATION = 0xFF;
16
18 struct AnimationInfo {
19 uint8_t frames;
20 uint8_t status;
21 uint8_t speed;
22 uint16_t triggers;
23 };
24
26 enum StationAnimationTrigger {
27 SAT_BUILT,
28 SAT_NEW_CARGO,
29 SAT_CARGO_TAKEN,
30 SAT_TRAIN_ARRIVES,
31 SAT_TRAIN_DEPARTS,
32 SAT_TRAIN_LOADS,
33 SAT_250_TICKS,
34 };
35
37 enum IndustryAnimationTrigger {
38 IAT_CONSTRUCTION_STATE_CHANGE,
39 IAT_TILELOOP,
40 IAT_INDUSTRY_TICK,
41 IAT_INDUSTRY_RECEIVED_CARGO,
42 IAT_INDUSTRY_DISTRIBUTES_CARGO,
43 };
44
46 enum AirpAnimationTrigger {
47 AAT_BUILT,
48 AAT_TILELOOP,
49 AAT_STATION_NEW_CARGO,
50 AAT_STATION_CARGO_TAKEN,
51 AAT_STATION_250_TICKS,
52 AAT_STATION_AIRPLANE_LAND,
53 };
54
56 enum ObjectAnimationTrigger {
57 OAT_BUILT,
58 OAT_TILELOOP,
59 OAT_256_TICKS,
60 };
61
62 #endif /* NEWGRF_ANIMATION_TYPE_H */
AAT_STATION_250_TICKS
@ AAT_STATION_250_TICKS
Triggered every 250 ticks (for all tiles at the same time).
Definition: newgrf_animation_type.h:51
OAT_256_TICKS
@ OAT_256_TICKS
Triggered every 256 ticks (for all tiles at the same time).
Definition: newgrf_animation_type.h:59
IAT_TILELOOP
@ IAT_TILELOOP
Trigger in the periodic tile loop.
Definition: newgrf_animation_type.h:39
SAT_250_TICKS
@ SAT_250_TICKS
Trigger station every 250 ticks.
Definition: newgrf_animation_type.h:33
AAT_STATION_NEW_CARGO
@ AAT_STATION_NEW_CARGO
Triggered when new cargo arrives at the station (for all tiles at the same time).
Definition: newgrf_animation_type.h:49
AnimationInfo::triggers
uint16_t triggers
The triggers that trigger animation.
Definition: newgrf_animation_type.h:22
SAT_NEW_CARGO
@ SAT_NEW_CARGO
Trigger station on new cargo arrival.
Definition: newgrf_animation_type.h:28
IAT_INDUSTRY_TICK
@ IAT_INDUSTRY_TICK
Trigger every tick.
Definition: newgrf_animation_type.h:40
SAT_TRAIN_ARRIVES
@ SAT_TRAIN_ARRIVES
Trigger platform when train arrives.
Definition: newgrf_animation_type.h:30
AAT_BUILT
@ AAT_BUILT
Triggered when the airport is built (for all tiles at the same time).
Definition: newgrf_animation_type.h:47
ObjectAnimationTrigger
ObjectAnimationTrigger
Animation triggers for objects.
Definition: newgrf_animation_type.h:56
SAT_CARGO_TAKEN
@ SAT_CARGO_TAKEN
Trigger station when cargo is completely taken.
Definition: newgrf_animation_type.h:29
AAT_STATION_CARGO_TAKEN
@ 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:50
AnimationInfo
Information about animation.
Definition: newgrf_animation_type.h:18
AnimationInfo::frames
uint8_t frames
The number of frames.
Definition: newgrf_animation_type.h:19
IndustryAnimationTrigger
IndustryAnimationTrigger
Animation triggers of the industries.
Definition: newgrf_animation_type.h:37
AAT_TILELOOP
@ AAT_TILELOOP
Triggered in the periodic tile loop.
Definition: newgrf_animation_type.h:48
IAT_INDUSTRY_RECEIVED_CARGO
@ IAT_INDUSTRY_RECEIVED_CARGO
Trigger when cargo is received .
Definition: newgrf_animation_type.h:41
AAT_STATION_AIRPLANE_LAND
@ AAT_STATION_AIRPLANE_LAND
Triggered when an airplane (not a helicopter) touches down at the airport (for single tile).
Definition: newgrf_animation_type.h:52
AnimationInfo::status
uint8_t status
Status; 0: no looping, 1: looping, 0xFF: no animation.
Definition: newgrf_animation_type.h:20
ANIM_STATUS_LOOPING
static const uint8_t ANIM_STATUS_LOOPING
Animation is looping.
Definition: newgrf_animation_type.h:14
AnimationInfo::speed
uint8_t speed
The speed, i.e. the amount of time between frames.
Definition: newgrf_animation_type.h:21
ANIM_STATUS_NO_ANIMATION
static const uint8_t ANIM_STATUS_NO_ANIMATION
There is no animation.
Definition: newgrf_animation_type.h:15
SAT_TRAIN_LOADS
@ SAT_TRAIN_LOADS
Trigger platform when train loads/unloads.
Definition: newgrf_animation_type.h:32
SAT_BUILT
@ SAT_BUILT
Trigger tile when built.
Definition: newgrf_animation_type.h:27
OAT_BUILT
@ OAT_BUILT
Triggered when the object is built (for all tiles at the same time).
Definition: newgrf_animation_type.h:57
OAT_TILELOOP
@ OAT_TILELOOP
Triggered in the periodic tile loop.
Definition: newgrf_animation_type.h:58
SAT_TRAIN_DEPARTS
@ SAT_TRAIN_DEPARTS
Trigger platform when train leaves.
Definition: newgrf_animation_type.h:31
StationAnimationTrigger
StationAnimationTrigger
Animation triggers for station.
Definition: newgrf_animation_type.h:26
ANIM_STATUS_NON_LOOPING
static const uint8_t ANIM_STATUS_NON_LOOPING
Animation is not looping.
Definition: newgrf_animation_type.h:13
IAT_CONSTRUCTION_STATE_CHANGE
@ IAT_CONSTRUCTION_STATE_CHANGE
Trigger whenever the construction state changes.
Definition: newgrf_animation_type.h:38
AirpAnimationTrigger
AirpAnimationTrigger
Animation triggers for airport tiles.
Definition: newgrf_animation_type.h:46
IAT_INDUSTRY_DISTRIBUTES_CARGO
@ IAT_INDUSTRY_DISTRIBUTES_CARGO
Trigger when cargo is distributed.
Definition: newgrf_animation_type.h:42