src/newgrf_industrytiles.h

   1 /* $Id: newgrf_industrytiles.h 26085 2013-11-24 14:41:19Z 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_industrytiles.h NewGRF handling of industry tiles. */
  11
  12 #ifndef NEWGRF_INDUSTRYTILES_H
  13 #define NEWGRF_INDUSTRYTILES_H
  14
  15 #include "newgrf_animation_type.h"
  16 #include "newgrf_industries.h"
  17 #include "core/random_func.hpp"
  18
  19 /** Resolver for the industry tiles scope. */
  20 struct IndustryTileScopeResolver : public ScopeResolver {
  21         Industry *industry; ///< Industry owning the tiles.
  22         TileIndex tile;     ///< %Tile being resolved.
  23
  24         /**
  25          * Constructor of the scope resolver for the industry tile.
  26          * @param ro Surrounding resolver.
  27          * @param industry %Industry owning the tile.
  28          * @param tile %Tile of the industry.
  29          */
  30         IndustryTileScopeResolver(ResolverObject &ro, Industry *industry, TileIndex tile)
  31                 : ScopeResolver(ro), industry(industry), tile(tile)
  32         {
  33         }
  34
  35         /* virtual */ uint32 GetRandomBits() const;
  36         /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
  37         /* virtual */ uint32 GetTriggers() const;
  38 };
  39
  40 /** Resolver for industry tiles. */
  41 struct IndustryTileResolverObject : public ResolverObject {
  42         IndustryTileScopeResolver indtile_scope; ///< Scope resolver for the industry tile.
  43         IndustriesScopeResolver ind_scope;       ///< Scope resolver for the industry owning the tile.
  44
  45         IndustryTileResolverObject(IndustryGfx gfx, TileIndex tile, Industry *indus,
  46                         CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
  47
  48         /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
  49         {
  50                 switch (scope) {
  51                         case VSG_SCOPE_SELF: return &indtile_scope;
  52                         case VSG_SCOPE_PARENT: return &ind_scope;
  53                         default: return ResolverObject::GetScope(scope, relative);
  54                 }
  55         }
  56 };
  57
  58 bool DrawNewIndustryTile(TileInfo *ti, Industry *i, IndustryGfx gfx, const IndustryTileSpec *inds);
  59 uint16 GetIndustryTileCallback(CallbackID callback, uint32 param1, uint32 param2, IndustryGfx gfx_id, Industry *industry, TileIndex tile);
  60 CommandCost PerformIndustryTileSlopeCheck(TileIndex ind_base_tile, TileIndex ind_tile, const IndustryTileSpec *its, IndustryType type, IndustryGfx gfx, uint itspec_index, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
  61
  62 void AnimateNewIndustryTile(TileIndex tile);
  63 bool StartStopIndustryTileAnimation(TileIndex tile, IndustryAnimationTrigger iat, uint32 random = Random());
  64 bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat);
  65
  66
  67 /** Available industry tile triggers. */
  68 enum IndustryTileTrigger {
  69         INDTILE_TRIGGER_TILE_LOOP       = 0x01, ///< The tile of the industry has been triggered during the tileloop.
  70         INDUSTRY_TRIGGER_INDUSTRY_TICK  = 0x02, ///< The industry has been triggered via its tick.
  71         INDUSTRY_TRIGGER_RECEIVED_CARGO = 0x04, ///< Cargo has been delivered.
  72 };
  73 void TriggerIndustryTile(TileIndex t, IndustryTileTrigger trigger);
  74 void TriggerIndustry(Industry *ind, IndustryTileTrigger trigger);
  75
  76 #endif /* NEWGRF_INDUSTRYTILES_H */