src/newgrf_animation_type.h

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