newgrf_airporttiles.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef NEWGRF_AIRPORTTILES_H
#define NEWGRF_AIRPORTTILES_H
 
#include "airport.h"
#include "station_map.h"
#include "newgrf_animation_type.h"
#include "newgrf_badge_type.h"
#include "newgrf_callbacks.h"
#include "newgrf_commons.h"
#include "newgrf_spritegroup.h"
#include "station_base.h"

struct AirportTileScopeResolver : public ScopeResolver {
  struct Station *st;  
  uint8_t airport_id;     
  TileIndex tile;      
  const AirportTileSpec *ats;

  AirportTileScopeResolver(ResolverObject &ro, const AirportTileSpec *ats, TileIndex tile, Station *st)
    : ScopeResolver(ro), st(st), tile(tile), ats(ats)
  {
    assert(st != nullptr);
    this->airport_id = st->airport.type;
  }
 
  uint32_t GetRandomBits() const override;
  uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
};

struct AirportTileResolverObject : public ResolverObject {
  AirportTileScopeResolver tiles_scope; 
  AirportScopeResolver airport_scope;   
 
  AirportTileResolverObject(const AirportTileSpec *ats, TileIndex tile, Station *st,
      CallbackID callback = CBID_NO_CALLBACK, uint32_t callback_param1 = 0, uint32_t callback_param2 = 0);
 
  ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t relative = 0) override
  {
    switch (scope) {
      case VSG_SCOPE_SELF: return &tiles_scope;
      case VSG_SCOPE_PARENT: return &airport_scope;
      default: return ResolverObject::GetScope(scope, relative);
    }
  }
 
  GrfSpecFeature GetFeature() const override;
  uint32_t GetDebugID() const override;
};

struct AirportTileSpec {
  AnimationInfo<AirportAnimationTriggers> animation; 
  StringID name;                        
  AirportTileCallbackMasks callback_mask;                  
  uint8_t animation_special_flags;        
  bool enabled;                         
  SubstituteGRFFileProps grf_prop; 
  std::vector<BadgeID> badges;
 
  static const AirportTileSpec *Get(StationGfx gfx);
  static const AirportTileSpec *GetByTile(TileIndex tile);
 
  static void ResetAirportTiles();
 
private:
  static AirportTileSpec tiles[NUM_AIRPORTTILES];
 
  friend void AirportTileOverrideManager::SetEntitySpec(AirportTileSpec &&airpts);
};
 
void AnimateAirportTile(TileIndex tile);
bool TriggerAirportTileAnimation(Station *st, TileIndex tile, AirportAnimationTrigger trigger);
bool TriggerAirportAnimation(Station *st, AirportAnimationTrigger trigger, CargoType cargo_type = INVALID_CARGO);
bool DrawNewAirportTile(TileInfo *ti, Station *st, const AirportTileSpec *airts);
 
#endif /* NEWGRF_AIRPORTTILES_H */