newgrf_callbacks.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef NEWGRF_CALLBACKS_H
#define NEWGRF_CALLBACKS_H
 
#include "core/enum_type.hpp"
 
enum CallbackID : uint16_t {
  CBID_NO_CALLBACK                     = 0x00,
 
  CBID_RANDOM_TRIGGER                  = 0x01,
 
  /* There are no callbacks 0x02 - 0x0F. */
 
  CBID_VEHICLE_VISUAL_EFFECT           = 0x10, // 8 bit callback
 
  CBID_VEHICLE_LENGTH                  = 0x11,
 
  CBID_VEHICLE_LOAD_AMOUNT             = 0x12, // 8 bit callback
 
  CBID_STATION_AVAILABILITY            = 0x13, // 8 bit callback
 
  CBID_STATION_DRAW_TILE_LAYOUT        = 0x14,
 
  CBID_VEHICLE_REFIT_CAPACITY          = 0x15, // 15 bit callback
 
  CBID_VEHICLE_ARTIC_ENGINE            = 0x16, // 8 bit callback for grf version < 8
 
  CBID_HOUSE_ALLOW_CONSTRUCTION        = 0x17, // 8 bit callback
 
  CBID_GENERIC_AI_PURCHASE_SELECTION   = 0x18, // 8 bit callback, implemented for stations only
 
  CBID_VEHICLE_CARGO_SUFFIX            = 0x19,
 
  CBID_HOUSE_ANIMATION_NEXT_FRAME      = 0x1A, // 15 bit callback
 
  CBID_HOUSE_ANIMATION_START_STOP      = 0x1B, // 15 bit callback
 
  CBID_HOUSE_CONSTRUCTION_STATE_CHANGE = 0x1C, // 15 bit callback
 
  CBID_TRAIN_ALLOW_WAGON_ATTACH        = 0x1D,
 
  CBID_HOUSE_COLOUR                    = 0x1E, // 15 bit callback
 
  CBID_HOUSE_CARGO_ACCEPTANCE          = 0x1F, // 15 bit callback
 
  CBID_HOUSE_ANIMATION_SPEED           = 0x20, // 8 bit callback
 
  CBID_HOUSE_DESTRUCTION               = 0x21, // 8 bit callback
 
  CBID_INDUSTRY_PROBABILITY            = 0x22, // 15 bit callback
 
  CBID_VEHICLE_ADDITIONAL_TEXT         = 0x23,
 
  CBID_STATION_BUILD_TILE_LAYOUT       = 0x24, // 15 bit callback
 
  CBID_INDTILE_ANIM_START_STOP         = 0x25, // 15 bit callback
 
  CBID_INDTILE_ANIM_NEXT_FRAME         = 0x26, // 15 bit callback
 
  CBID_INDTILE_ANIMATION_SPEED         = 0x27, // 8 bit callback
 
  CBID_INDUSTRY_LOCATION               = 0x28, // 15 bit callback
 
  CBID_INDUSTRY_PRODUCTION_CHANGE      = 0x29, // 15 bit callback
 
  CBID_HOUSE_ACCEPT_CARGO              = 0x2A, // 15 bit callback
 
  CBID_INDTILE_CARGO_ACCEPTANCE        = 0x2B, // 15 bit callback
 
  CBID_INDTILE_ACCEPT_CARGO            = 0x2C, // 15 bit callback
 
  CBID_VEHICLE_COLOUR_MAPPING          = 0x2D, // 15 bit callback
 
  CBID_HOUSE_PRODUCE_CARGO             = 0x2E, // 15 bit callback
 
  CBID_INDTILE_SHAPE_CHECK             = 0x2F, // 15 bit callback
 
  CBID_INDTILE_DRAW_FOUNDATIONS        = 0x30, // 15 bit callback
 
  CBID_VEHICLE_START_STOP_CHECK        = 0x31, // 15 bit callback, but 0xFF test is done with 8 bit
 
  CBID_VEHICLE_32DAY_CALLBACK          = 0x32, // 2 bit callback
 
  CBID_VEHICLE_SOUND_EFFECT            = 0x33, // 15 bit callback
 
  CBID_VEHICLE_AUTOREPLACE_SELECTION   = 0x34, // 15 bit callback, not implemented
 
  CBID_INDUSTRY_MONTHLYPROD_CHANGE     = 0x35, // 15 bit callback
 
  CBID_VEHICLE_MODIFY_PROPERTY         = 0x36, // 8/15 bit depends on queried property
 
  CBID_INDUSTRY_CARGO_SUFFIX           = 0x37, // 15 bit callback, but 0xFF test is done with 8 bit
 
  CBID_INDUSTRY_FUND_MORE_TEXT         = 0x38, // 15 bit callback
 
  CBID_CARGO_PROFIT_CALC               = 0x39, // 15 bit callback
 
  CBID_INDUSTRY_WINDOW_MORE_TEXT       = 0x3A, // 15 bit callback
 
  CBID_INDUSTRY_SPECIAL_EFFECT         = 0x3B, // 15 bit callback
 
  CBID_INDTILE_AUTOSLOPE               = 0x3C, // 15 bit callback
 
  CBID_INDUSTRY_REFUSE_CARGO           = 0x3D, // 15 bit callback
 
  /* There are no callbacks 0x3E - 0x13F */
 
  CBID_STATION_ANIM_START_STOP         = 0x140, // 15 bit callback
 
  CBID_STATION_ANIM_NEXT_FRAME         = 0x141, // 15 bit callback
 
  CBID_STATION_ANIMATION_SPEED         = 0x142, // 8 bit callback
 
  CBID_HOUSE_DENY_DESTRUCTION          = 0x143, // 15 bit callback
 
  CBID_SOUNDS_AMBIENT_EFFECT           = 0x144, // 15 bit callback
 
  CBID_CARGO_STATION_RATING_CALC       = 0x145, // 15 bit callback
 
  CBID_NEW_SIGNALS_SPRITE_DRAW         = 0x146, // 15 bit callback, not implemented
 
  CBID_CANALS_SPRITE_OFFSET            = 0x147, // 15 bit callback
 
  CBID_HOUSE_WATCHED_CARGO_ACCEPTED    = 0x148, // 15 bit callback
 
  CBID_STATION_LAND_SLOPE_CHECK        = 0x149, // 15 bit callback
 
  CBID_INDUSTRY_DECIDE_COLOUR          = 0x14A, // 4 bit callback
 
  CBID_INDUSTRY_INPUT_CARGO_TYPES      = 0x14B, // 8 bit callback
 
  CBID_INDUSTRY_OUTPUT_CARGO_TYPES     = 0x14C, // 8 bit callback
 
  CBID_HOUSE_CUSTOM_NAME               = 0x14D, // 15 bit callback
 
  CBID_HOUSE_DRAW_FOUNDATIONS          = 0x14E, // 15 bit callback
 
  CBID_HOUSE_AUTOSLOPE                 = 0x14F, // 15 bit callback
 
  CBID_AIRPTILE_DRAW_FOUNDATIONS       = 0x150, // 15 bit callback
 
  CBID_AIRPTILE_ANIM_START_STOP        = 0x152, // 15 bit callback
 
  CBID_AIRPTILE_ANIM_NEXT_FRAME        = 0x153, // 15 bit callback
 
  CBID_AIRPTILE_ANIMATION_SPEED        = 0x154, // 8 bit callback
 
  CBID_AIRPORT_ADDITIONAL_TEXT         = 0x155, // 15 bit callback
 
  CBID_AIRPORT_LAYOUT_NAME             = 0x156, // 15 bit callback
 
  CBID_OBJECT_LAND_SLOPE_CHECK         = 0x157, // 15 bit callback
 
  CBID_OBJECT_ANIMATION_NEXT_FRAME     = 0x158, // 15 bit callback
 
  CBID_OBJECT_ANIMATION_START_STOP     = 0x159, // 15 bit callback
 
  CBID_OBJECT_ANIMATION_SPEED          = 0x15A, // 8 bit callback
 
  CBID_OBJECT_COLOUR                   = 0x15B, // 15 bit callback
 
  CBID_OBJECT_FUND_MORE_TEXT           = 0x15C, // 15 bit callback
 
  CBID_OBJECT_AUTOSLOPE                = 0x15D, // 15 bit callback
 
  CBID_VEHICLE_REFIT_COST              = 0x15E, // 15 bit callback
 
  CBID_INDUSTRY_PROD_CHANGE_BUILD      = 0x15F, // 15 bit callback
 
  CBID_VEHICLE_SPAWN_VISUAL_EFFECT     = 0x160, // 15 bit callback
 
  CBID_VEHICLE_NAME                    = 0x161, // 15 bit callback
 
  CBID_VEHICLE_BUILD_PROBABILITY       = 0x162, // 15 bit callback
 
  CBID_VEHICLE_CUSTOM_REFIT            = 0x0163, // 15 bit callback
};
 
enum class VehicleCallbackMask : uint8_t {
  VisualEffect  = 0, 
  Length        = 1, 
  LoadAmount    = 2, 
  RefitCapacity = 3, 
  ArticEngine   = 4, 
  CargoSuffix   = 5, 
  ColourRemap   = 6, 
  SoundEffect   = 7, 
  Name          = 8, 
  CustomRefit   = 9, 
};
using VehicleCallbackMasks = EnumBitSet<VehicleCallbackMask, uint16_t>;
 
enum class StationCallbackMask : uint8_t {
  Avail              = 0, 
  DrawTileLayout     = 1, 
  AnimationNextFrame = 2, 
  AnimationSpeed     = 3, 
  SlopeCheck         = 4, 
};
using StationCallbackMasks = EnumBitSet<StationCallbackMask, uint16_t>;
 
enum class RoadStopCallbackMask : uint8_t {
  Avail              = 0, 
  AnimationNextFrame = 1, 
  AnimationSpeed     = 2, 
};
using RoadStopCallbackMasks = EnumBitSet<RoadStopCallbackMask, uint8_t>;
 
enum class HouseCallbackMask : uint8_t {
  AllowConstruction       =  0, 
  AnimationNextFrame      =  1, 
  AnimationStartStop      =  2, 
  ConstructionStateChange =  3, 
  Colour                  =  4, 
  CargoAcceptance         =  5, 
  AnimationSpeed          =  6, 
  Destruction             =  7, 
  AcceptCargo             =  8, 
  ProduceCargo            =  9, 
  DenyDestruction         = 10, 
  DrawFoundations         = 11, 
  Autoslope               = 12, 
};
using HouseCallbackMasks = EnumBitSet<HouseCallbackMask, uint16_t>;
 
enum class CanalCallbackMask : uint8_t {
  SpriteOffset       = 0, 
};
using CanalCallbackMasks = EnumBitSet<CanalCallbackMask, uint8_t>;
 
enum class CargoCallbackMask : uint8_t {
  ProfitCalc        = 0, 
  StationRatingCalc = 1, 
};
using CargoCallbackMasks = EnumBitSet<CargoCallbackMask, uint8_t>;
 
enum class IndustryCallbackMask : uint8_t {
  Probability            =  0, 
  ProductionCargoArrival =  1, 
  Production256Ticks     =  2, 
  Location               =  3, 
  ProductionChange       =  4, 
  MonthlyProdChange      =  5, 
  CargoSuffix            =  6, 
  FundMoreText           =  7, 
  WindowMoreText         =  8, 
  SpecialEffect          =  9, 
  RefuseCargo            = 10, 
  DecideColour           = 11, 
  InputCargoTypes        = 12, 
  OutputCargoTypes       = 13, 
  ProdChangeBuild        = 14, 
};
using IndustryCallbackMasks = EnumBitSet<IndustryCallbackMask, uint16_t>;
 
enum class IndustryTileCallbackMask : uint8_t {
  AnimationNextFrame = 0, 
  AnimationSpeed     = 1, 
  CargoAcceptance    = 2, 
  AcceptCargo        = 3, 
  ShapeCheck         = 4, 
  DrawFoundations    = 5, 
  Autoslope          = 6, 
};
using IndustryTileCallbackMasks = EnumBitSet<IndustryTileCallbackMask, uint8_t>;
 
enum class ObjectCallbackMask : uint8_t {
  SlopeCheck         =  0, 
  AnimationNextFrame =  1, 
  AnimationSpeed     =  2, 
  Colour             =  3, 
  FundMoreText       =  4, 
  Autoslope          =  5, 
};
using ObjectCallbackMasks = EnumBitSet<ObjectCallbackMask, uint8_t>;
 
enum class AirportTileCallbackMask : uint8_t {
  AnimationNextFrame = 0, 
  AnimationSpeed     = 1, 
  ShapeCheck         = 4, 
  DrawFoundations    = 5, 
  Autoslope          = 6, 
};
using AirportTileCallbackMasks = EnumBitSet<AirportTileCallbackMask, uint8_t>;
 
static const uint CALLBACK_FAILED              = 0xFFFF; 
static const uint CALLBACK_HOUSEPRODCARGO_END  = 0x20FF; 
 
#endif /* NEWGRF_CALLBACKS_H */