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

 
#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; 
  int view; 

  HouseScopeResolver(ResolverObject &ro, HouseID house_id, TileIndex tile, Town *town,
      bool not_yet_constructed, uint8_t initial_random_bits, CargoTypes watched_cargo_triggers, int view)
    : 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), view(view)
  {
  }
 
  uint32_t GetRandomBits() const override;
  uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
  uint32_t GetRandomTriggers() const override;
};

struct HouseResolverObject : public SpecializedResolverObject<HouseRandomTriggers> {
  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 = {}, int view = 0);
 
  ScopeResolver *GetScope(VarSpriteGroupScope scope = VarSpriteGroupScope::Self, uint8_t relative = 0) override
  {
    switch (scope) {
      case VarSpriteGroupScope::Self: return &this->house_scope;
      case VarSpriteGroupScope::Parent: return &this->town_scope;
      default: return ResolverObject::GetScope(scope, relative);
    }
  }
 
  GrfSpecFeature GetFeature() const override;
  uint32_t GetDebugID() const override;
};

struct HouseClassMapping {
  GrfID grfid;     
  uint8_t  class_id;  
};
 
void ResetHouseClassIDs();
HouseClassID AllocateHouseClassID(uint8_t grf_class_id, GrfID grfid);
 
void InitializeBuildingCounts();
void InitializeBuildingCounts(Town *t);
void IncreaseBuildingCount(Town *t, HouseID house_id);
void DecreaseBuildingCount(Town *t, HouseID house_id);
std::span<const uint> GetBuildingHouseIDCounts();
 
void DrawNewHouseTile(TileInfo *ti, HouseID house_id);
void DrawNewHouseTileInGUI(int x, int y, const HouseSpec *spec, HouseID house_id, int view);
void AnimateNewHouseTile(TileIndex tile);
/* see also: void TriggerHouseAnimation_TileLoop(TileIndex tile, uint16_t random_bits) */
void TriggerHouseAnimation_ConstructionStageChanged(TileIndex tile, bool first_call);
void TriggerHouseAnimation_WatchedCargoAccepted(TileIndex tile, CargoTypes trigger_cargoes);
 
uint16_t GetHouseCallback(CallbackID callback, uint32_t param1, uint32_t param2, HouseID house_id, Town *town, TileIndex tile, std::span<int32_t> regs100 = {},
    bool not_yet_constructed = false, uint8_t initial_random_bits = 0, CargoTypes watched_cargo_triggers = {}, int view = 0);
 
bool CanDeleteHouse(TileIndex tile);
 
bool NewHouseTileLoop(TileIndex tile);
 
void TriggerHouseRandomisation(TileIndex t, HouseRandomTrigger trigger);
 
#endif /* NEWGRF_HOUSE_H */