src/newgrf_generic.h

   1 /* $Id$ */
   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_generic.h Functions related to generic callbacks. */
  11
  12 #ifndef NEWGRF_GENERIC_H
  13 #define NEWGRF_GENERIC_H
  14
  15 #include "map/coord.h"
  16 #include "industry_type.h"
  17 #include "newgrf.h"
  18
  19 struct SpriteGroup;
  20
  21 /** AI events for asking the NewGRF for information. */
  22 enum AIConstructionEvent {
  23         AICE_TRAIN_CHECK_RAIL_ENGINE     = 0x00, ///< Check if we should build an engine
  24         AICE_TRAIN_CHECK_ELRAIL_ENGINE   = 0x01, ///< Check if we should build an engine
  25         AICE_TRAIN_CHECK_MONORAIL_ENGINE = 0x02, ///< Check if we should build an engine
  26         AICE_TRAIN_CHECK_MAGLEV_ENGINE   = 0x03, ///< Check if we should build an engine
  27         AICE_TRAIN_GET_RAIL_WAGON        = 0x08, ///< Check if we should build an engine
  28         AICE_TRAIN_GET_ELRAIL_WAGON      = 0x09, ///< Check if we should build an engine
  29         AICE_TRAIN_GET_MONORAIL_WAGON    = 0x0A, ///< Check if we should build an engine
  30         AICE_TRAIN_GET_MAGLEV_WAGON      = 0x0B, ///< Check if we should build an engine
  31         AICE_TRAIN_GET_RAILTYPE          = 0x0F, ///< Check if we should build a railtype
  32
  33         AICE_ROAD_CHECK_ENGINE           = 0x00, ///< Check if we should build an engine
  34         AICE_ROAD_GET_FIRST_ENGINE       = 0x01, ///< Unused, we check all
  35         AICE_ROAD_GET_NUMBER_ENGINES     = 0x02, ///< Unused, we check all
  36
  37         AICE_SHIP_CHECK_ENGINE           = 0x00, ///< Check if we should build an engine
  38         AICE_SHIP_GET_FIRST_ENGINE       = 0x01, ///< Unused, we check all
  39         AICE_SHIP_GET_NUMBER_ENGINES     = 0x02, ///< Unused, we check all
  40
  41         AICE_AIRCRAFT_CHECK_ENGINE       = 0x00, ///< Check if we should build an engine
  42
  43         AICE_STATION_GET_STATION_ID      = 0x00, ///< Get a station ID to build
  44 };
  45
  46 static const IndustryType IT_AI_UNKNOWN = 0xFE; ///< The AI has no specific industry in mind.
  47 static const IndustryType IT_AI_TOWN    = 0xFF; ///< The AI actually wants to transport to/from a town, not an industry.
  48
  49 void ResetGenericCallbacks();
  50 void AddGenericCallback(uint8 feature, const GRFFile *file, const SpriteGroup *group);
  51
  52 uint16 GetAiPurchaseCallbackResult(uint8 feature, CargoID cargo_type, uint8 default_selection, IndustryType src_industry, IndustryType dst_industry, uint8 distance, AIConstructionEvent event, uint8 count, uint8 station_size, const GRFFile **file);
  53
  54 /** Play an ambient sound effect for an empty tile. */
  55 static inline void AmbientSoundEffect(TileIndex tile)
  56 {
  57         /* Only run callback if enabled. */
  58         if (!HasGrfMiscBit(GMB_AMBIENT_SOUND_CALLBACK)) return;
  59
  60         extern void AmbientSoundEffectCallback(TileIndex tile);
  61         AmbientSoundEffectCallback(tile);
  62 }
  63
  64 #endif /* NEWGRF_GENERIC_H */