object_base.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 OBJECT_BASE_H
#define OBJECT_BASE_H
 
#include "core/pool_type.hpp"
#include "gfx_type.h"
#include "object_type.h"
#include "tilearea_type.h"
#include "town_type.h"
#include "timer/timer_game_calendar.h"
 
using ObjectPool = Pool<Object, ObjectID, 64>;
extern ObjectPool _object_pool;

struct Object : ObjectPool::PoolItem<&_object_pool> {
  ObjectType type = INVALID_OBJECT_TYPE; 
  Town *town = nullptr; 
  TileArea location{INVALID_TILE, 0, 0}; 
  TimerGameCalendar::Date build_date{}; 
  uint8_t recolour_offset = 0; 
  uint8_t view = 0; 
 
  Object(ObjectID index) : ObjectPool::PoolItem<&_object_pool>(index) {}
  Object(ObjectID index, ObjectType type, Town *town, TileArea location, TimerGameCalendar::Date build_date, uint8_t view) :
    ObjectPool::PoolItem<&_object_pool>(index), type(type), town(town), location(location), build_date(build_date), view(view) {}
  ~Object() {}
 
  static Object *GetByTile(TileIndex tile);

  static inline void IncTypeCount(ObjectType type)
  {
    assert(type < NUM_OBJECTS);
    Object::counts[type]++;
  }

  static inline void DecTypeCount(ObjectType type)
  {
    assert(type < NUM_OBJECTS);
    Object::counts[type]--;
  }

  static inline uint16_t GetTypeCount(ObjectType type)
  {
    assert(type < NUM_OBJECTS);
    return Object::counts[type];
  }

  static inline void ResetTypeCounts()
  {
    Object::counts.fill(0);
  }
 
protected:
  static std::array<uint16_t, NUM_OBJECTS> counts; 
};

struct ClearedObjectArea {
  TileIndex first_tile;  
  TileArea area;         
};
 
ClearedObjectArea *FindClearedObject(TileIndex tile);
extern std::vector<ClearedObjectArea> _cleared_object_areas;
 
#endif /* OBJECT_BASE_H */