newgrf_house.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_HOUSE_H
#define NEWGRF_HOUSE_H
 
#include "newgrf_callbacks.h"
#include "tile_cmd.h"
#include "house_type.h"
#include "newgrf_spritegroup.h"
#include "newgrf_town.h"
 
struct HouseScopeResolver : public ScopeResolver {
  HouseID house_id;              
  TileIndex tile;                
  Town *town;                    
  bool not_yet_constructed;      
  uint16_t initial_random_bits;    
  CargoTypes watched_cargo_triggers; 
 
  HouseScopeResolver(ResolverObject &ro, HouseID house_id, TileIndex tile, Town *town,
      bool not_yet_constructed, uint8_t initial_random_bits, CargoTypes watched_cargo_triggers)
    : ScopeResolver(ro), house_id(house_id), tile(tile), town(town), not_yet_constructed(not_yet_constructed),
    initial_random_bits(initial_random_bits), watched_cargo_triggers(watched_cargo_triggers)
  {
  }
 
  uint32_t GetRandomBits() const override;
  uint32_t GetVariable(byte variable, [[maybe_unused]] uint32_t parameter, bool *available) const override;
  uint32_t GetTriggers() const override;
};
 
struct HouseResolverObject : public ResolverObject {
  HouseScopeResolver house_scope;
  TownScopeResolver  town_scope;
 
  HouseResolverObject(HouseID house_id, TileIndex tile, Town *town,
      CallbackID callback = CBID_NO_CALLBACK, uint32_t param1 = 0, uint32_t param2 = 0,
      bool not_yet_constructed = false, uint8_t initial_random_bits = 0, CargoTypes watched_cargo_triggers = 0);
 
  ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0) override
  {
    switch (scope) {
      case VSG_SCOPE_SELF:   return &this->house_scope;
      case VSG_SCOPE_PARENT: return &this->town_scope;
      default: return ResolverObject::GetScope(scope, relative);
    }
  }
 
  GrfSpecFeature GetFeature() const override;
  uint32_t GetDebugID() const override;
};
 
struct HouseClassMapping {
  uint32_t grfid;     
  uint8_t  class_id;  
};
 
void ResetHouseClassIDs();
HouseClassID AllocateHouseClassID(byte grf_class_id, uint32_t grfid);
 
void InitializeBuildingCounts();
void IncreaseBuildingCount(Town *t, HouseID house_id);
void DecreaseBuildingCount(Town *t, HouseID house_id);
 
void DrawNewHouseTile(TileInfo *ti, HouseID house_id);
void AnimateNewHouseTile(TileIndex tile);
void AnimateNewHouseConstruction(TileIndex tile);
 
uint16_t GetHouseCallback(CallbackID callback, uint32_t param1, uint32_t param2, HouseID house_id, Town *town, TileIndex tile,
    bool not_yet_constructed = false, uint8_t initial_random_bits = 0, CargoTypes watched_cargo_triggers = 0);
void WatchedCargoCallback(TileIndex tile, CargoTypes trigger_cargoes);
 
bool CanDeleteHouse(TileIndex tile);
 
bool NewHouseTileLoop(TileIndex tile);
 
enum HouseTrigger {
  /* The tile of the house has been triggered during the tileloop. */
  HOUSE_TRIGGER_TILE_LOOP     = 0x01,
  /*
   * The top tile of a (multitile) building has been triggered during and all
   * the tileloop other tiles of the same building get the same random value.
   */
  HOUSE_TRIGGER_TILE_LOOP_TOP = 0x02,
};
void TriggerHouse(TileIndex t, HouseTrigger trigger);
 
#endif /* NEWGRF_HOUSE_H */