File diff r27165:ea28ecab6159 → r27166:64e04a3ef9b1
src/object_base.h
Show inline comments
 
/*
 
 * 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/>.
 
 */
 

	
 
/** @file object_base.h Base for all objects. */
 

	
 
#ifndef OBJECT_BASE_H
 
#define OBJECT_BASE_H
 

	
 
#include "core/pool_type.hpp"
 
#include "object_type.h"
 
#include "tilearea_type.h"
 
#include "town_type.h"
 
#include "date_type.h"
 
#include "timer/timer_game_calendar.h"
 

	
 
typedef Pool<Object, ObjectID, 64, 0xFF0000> ObjectPool;
 
extern ObjectPool _object_pool;
 

	
 
/** An object, such as transmitter, on the map. */
 
struct Object : ObjectPool::PoolItem<&_object_pool> {
 
	ObjectType type;    ///< Type of the object
 
	Town *town;         ///< Town the object is built in
 
	TileArea location;  ///< Location of the object
 
	Date build_date;    ///< Date of construction
 
	TimerGameCalendar::Date build_date; ///< Date of construction
 
	byte colour;        ///< Colour of the object, for display purpose
 
	byte view;          ///< The view setting for this object
 

	
 
	/** Make sure the object isn't zeroed. */
 
	Object() {}
 
	/** Make sure the right destructor is called as well! */
 
	~Object() {}
 

	
 
	static Object *GetByTile(TileIndex tile);
 

	
 
	/**
 
	 * Increment the count of objects for this type.
 
	 * @param type ObjectType to increment
 
	 * @pre type < NUM_OBJECTS
 
	 */
 
	static inline void IncTypeCount(ObjectType type)
 
	{
 
		assert(type < NUM_OBJECTS);
 
		counts[type]++;
 
	}
 

	
 
	/**
 
	 * Decrement the count of objects for this type.
 
	 * @param type ObjectType to decrement