2007-03-19 11:27:30 +00:00
|
|
|
/* $Id$ */
|
|
|
|
|
2009-08-21 20:21:05 +00:00
|
|
|
/*
|
|
|
|
* 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/>.
|
|
|
|
*/
|
|
|
|
|
2008-05-06 15:11:33 +00:00
|
|
|
/** @file newgrf_house.cpp Implementation of NewGRF houses. */
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
#include "stdafx.h"
|
|
|
|
#include "openttd.h"
|
|
|
|
#include "variables.h"
|
|
|
|
#include "debug.h"
|
2008-01-09 09:57:48 +00:00
|
|
|
#include "viewport_func.h"
|
2007-03-20 13:47:00 +00:00
|
|
|
#include "landscape.h"
|
2007-03-19 11:27:30 +00:00
|
|
|
#include "sprite.h"
|
|
|
|
#include "newgrf.h"
|
|
|
|
#include "newgrf_house.h"
|
|
|
|
#include "newgrf_spritegroup.h"
|
|
|
|
#include "newgrf_town.h"
|
|
|
|
#include "newgrf_sound.h"
|
2007-05-15 21:36:58 +00:00
|
|
|
#include "newgrf_commons.h"
|
2007-11-10 01:17:15 +00:00
|
|
|
#include "transparency.h"
|
2007-12-25 11:26:07 +00:00
|
|
|
#include "functions.h"
|
2008-09-30 20:51:04 +00:00
|
|
|
#include "company_func.h"
|
2008-04-20 08:22:59 +00:00
|
|
|
#include "animated_tile_func.h"
|
2008-09-30 20:51:04 +00:00
|
|
|
#include "company_base.h"
|
2009-06-26 13:44:14 +00:00
|
|
|
#include "town.h"
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2009-03-17 19:40:10 +00:00
|
|
|
static BuildingCounts<uint32> _building_counts;
|
2007-03-19 11:27:30 +00:00
|
|
|
static HouseClassMapping _class_mapping[HOUSE_CLASS_MAX];
|
|
|
|
|
2007-05-15 21:36:58 +00:00
|
|
|
HouseOverrideManager _house_mngr(NEW_HOUSE_OFFSET, HOUSE_MAX, INVALID_HOUSE_ID);
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
HouseClassID AllocateHouseClassID(byte grf_class_id, uint32 grfid)
|
|
|
|
{
|
|
|
|
/* Start from 1 because 0 means that no class has been assigned. */
|
|
|
|
for (int i = 1; i != lengthof(_class_mapping); i++) {
|
|
|
|
HouseClassMapping *map = &_class_mapping[i];
|
|
|
|
|
|
|
|
if (map->class_id == grf_class_id && map->grfid == grfid) return (HouseClassID)i;
|
|
|
|
|
|
|
|
if (map->class_id == 0 && map->grfid == 0) {
|
|
|
|
map->class_id = grf_class_id;
|
|
|
|
map->grfid = grfid;
|
|
|
|
return (HouseClassID)i;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return HOUSE_NO_CLASS;
|
|
|
|
}
|
|
|
|
|
|
|
|
void InitializeBuildingCounts()
|
|
|
|
{
|
|
|
|
memset(&_building_counts, 0, sizeof(_building_counts));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* IncreaseBuildingCount()
|
|
|
|
* Increase the count of a building when it has been added by a town.
|
|
|
|
* @param t The town that the building is being built in
|
|
|
|
* @param house_id The id of the house being added
|
|
|
|
*/
|
|
|
|
void IncreaseBuildingCount(Town *t, HouseID house_id)
|
|
|
|
{
|
2009-06-26 14:02:27 +00:00
|
|
|
HouseClassID class_id = HouseSpec::Get(house_id)->class_id;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2007-06-15 23:55:52 +00:00
|
|
|
if (!_loaded_newgrf_features.has_newhouses) return;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
t->building_counts.id_count[house_id]++;
|
2009-03-17 19:40:10 +00:00
|
|
|
_building_counts.id_count[house_id]++;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2009-03-17 19:40:10 +00:00
|
|
|
if (class_id == HOUSE_NO_CLASS) return;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
t->building_counts.class_count[class_id]++;
|
2009-03-17 19:40:10 +00:00
|
|
|
_building_counts.class_count[class_id]++;
|
2007-03-19 11:27:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* DecreaseBuildingCount()
|
|
|
|
* Decrease the number of a building when it is deleted.
|
|
|
|
* @param t The town that the building was built in
|
|
|
|
* @param house_id The id of the house being removed
|
|
|
|
*/
|
|
|
|
void DecreaseBuildingCount(Town *t, HouseID house_id)
|
|
|
|
{
|
2009-06-26 14:02:27 +00:00
|
|
|
HouseClassID class_id = HouseSpec::Get(house_id)->class_id;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2007-06-15 23:55:52 +00:00
|
|
|
if (!_loaded_newgrf_features.has_newhouses) return;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
if (t->building_counts.id_count[house_id] > 0) t->building_counts.id_count[house_id]--;
|
|
|
|
if (_building_counts.id_count[house_id] > 0) _building_counts.id_count[house_id]--;
|
|
|
|
|
|
|
|
if (class_id == HOUSE_NO_CLASS) return;
|
|
|
|
|
|
|
|
if (t->building_counts.class_count[class_id] > 0) t->building_counts.class_count[class_id]--;
|
|
|
|
if (_building_counts.class_count[class_id] > 0) _building_counts.class_count[class_id]--;
|
|
|
|
}
|
|
|
|
|
|
|
|
static uint32 HouseGetRandomBits(const ResolverObject *object)
|
|
|
|
{
|
|
|
|
const TileIndex tile = object->u.house.tile;
|
|
|
|
return (tile == INVALID_TILE || !IsTileType(tile, MP_HOUSE)) ? 0 : GetHouseRandomBits(tile);
|
|
|
|
}
|
|
|
|
|
|
|
|
static uint32 HouseGetTriggers(const ResolverObject *object)
|
|
|
|
{
|
|
|
|
const TileIndex tile = object->u.house.tile;
|
|
|
|
return (tile == INVALID_TILE || !IsTileType(tile, MP_HOUSE)) ? 0 : GetHouseTriggers(tile);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void HouseSetTriggers(const ResolverObject *object, int triggers)
|
|
|
|
{
|
|
|
|
const TileIndex tile = object->u.house.tile;
|
|
|
|
if (IsTileType(tile, MP_HOUSE)) SetHouseTriggers(tile, triggers);
|
|
|
|
}
|
|
|
|
|
|
|
|
static uint32 GetNumHouses(HouseID house_id, const Town *town)
|
|
|
|
{
|
|
|
|
uint8 map_id_count, town_id_count, map_class_count, town_class_count;
|
2009-06-26 14:02:27 +00:00
|
|
|
HouseClassID class_id = HouseSpec::Get(house_id)->class_id;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2009-03-17 19:40:10 +00:00
|
|
|
map_id_count = ClampU(_building_counts.id_count[house_id], 0, 255);
|
|
|
|
map_class_count = ClampU(_building_counts.class_count[class_id], 0, 255);
|
|
|
|
town_id_count = ClampU(town->building_counts.id_count[house_id], 0, 255);
|
|
|
|
town_class_count = ClampU(town->building_counts.class_count[class_id], 0, 255);
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
return map_class_count << 24 | town_class_count << 16 | map_id_count << 8 | town_id_count;
|
|
|
|
}
|
|
|
|
|
2007-06-08 17:54:18 +00:00
|
|
|
uint32 GetNearbyTileInformation(byte parameter, TileIndex tile)
|
|
|
|
{
|
|
|
|
tile = GetNearbyTile(parameter, tile);
|
2008-01-31 17:46:08 +00:00
|
|
|
return GetNearbyTileInformation(tile);
|
2007-06-08 17:54:18 +00:00
|
|
|
}
|
|
|
|
|
2008-06-25 20:04:27 +00:00
|
|
|
/** Structure with user-data for SearchNearbyHouseXXX - functions */
|
|
|
|
typedef struct {
|
|
|
|
const HouseSpec *hs; ///< Specs of the house, that startet the search
|
|
|
|
TileIndex north_tile; ///< Northern tile of the house.
|
|
|
|
} SearchNearbyHouseData;
|
|
|
|
|
2008-06-21 23:59:38 +00:00
|
|
|
/** Callback function to search a house by its HouseID
|
|
|
|
* @param tile TileIndex to be examined
|
2008-06-25 20:04:27 +00:00
|
|
|
* @param user_data SearchNearbyHouseData
|
2008-06-21 23:59:38 +00:00
|
|
|
* @return true or false, if found or not
|
|
|
|
*/
|
2008-06-25 18:46:05 +00:00
|
|
|
static bool SearchNearbyHouseID(TileIndex tile, void *user_data)
|
2008-06-21 23:59:38 +00:00
|
|
|
{
|
|
|
|
if (IsTileType(tile, MP_HOUSE)) {
|
2008-06-25 20:04:27 +00:00
|
|
|
HouseID house = GetHouseType(tile); // tile been examined
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(house);
|
2008-06-21 23:59:38 +00:00
|
|
|
if (hs->grffile != NULL) { // must be one from a grf file
|
2008-06-25 20:04:27 +00:00
|
|
|
SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;
|
|
|
|
|
|
|
|
TileIndex north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!
|
|
|
|
if (north_tile == nbhd->north_tile) return false; // Always ignore origin house
|
|
|
|
|
|
|
|
return hs->local_id == nbhd->hs->local_id && // same local id as the one requested
|
|
|
|
hs->grffile->grfid == nbhd->hs->grffile->grfid; // from the same grf
|
2008-06-21 23:59:38 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/** Callback function to search a house by its classID
|
|
|
|
* @param tile TileIndex to be examined
|
2008-06-25 20:04:27 +00:00
|
|
|
* @param user_data SearchNearbyHouseData
|
2008-06-21 23:59:38 +00:00
|
|
|
* @return true or false, if found or not
|
|
|
|
*/
|
2008-06-25 18:46:05 +00:00
|
|
|
static bool SearchNearbyHouseClass(TileIndex tile, void *user_data)
|
2008-06-21 23:59:38 +00:00
|
|
|
{
|
|
|
|
if (IsTileType(tile, MP_HOUSE)) {
|
2008-06-25 20:04:27 +00:00
|
|
|
HouseID house = GetHouseType(tile); // tile been examined
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(house);
|
2008-06-21 23:59:38 +00:00
|
|
|
if (hs->grffile != NULL) { // must be one from a grf file
|
2008-06-25 20:04:27 +00:00
|
|
|
SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;
|
|
|
|
|
|
|
|
TileIndex north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!
|
|
|
|
if (north_tile == nbhd->north_tile) return false; // Always ignore origin house
|
|
|
|
|
|
|
|
return hs->class_id == nbhd->hs->class_id && // same classid as the one requested
|
|
|
|
hs->grffile->grfid == nbhd->hs->grffile->grfid; // from the same grf
|
2008-06-21 23:59:38 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/** Callback function to search a house by its grfID
|
|
|
|
* @param tile TileIndex to be examined
|
2008-06-25 20:04:27 +00:00
|
|
|
* @param user_data SearchNearbyHouseData
|
2008-06-21 23:59:38 +00:00
|
|
|
* @return true or false, if found or not
|
|
|
|
*/
|
2008-06-25 18:46:05 +00:00
|
|
|
static bool SearchNearbyHouseGRFID(TileIndex tile, void *user_data)
|
2008-06-21 23:59:38 +00:00
|
|
|
{
|
|
|
|
if (IsTileType(tile, MP_HOUSE)) {
|
2008-06-25 20:04:27 +00:00
|
|
|
HouseID house = GetHouseType(tile); // tile been examined
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(house);
|
2008-06-21 23:59:38 +00:00
|
|
|
if (hs->grffile != NULL) { // must be one from a grf file
|
2008-06-25 20:04:27 +00:00
|
|
|
SearchNearbyHouseData *nbhd = (SearchNearbyHouseData *)user_data;
|
|
|
|
|
|
|
|
TileIndex north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!
|
|
|
|
if (north_tile == nbhd->north_tile) return false; // Always ignore origin house
|
|
|
|
|
|
|
|
return hs->grffile->grfid == nbhd->hs->grffile->grfid; // from the same grf
|
2008-06-21 23:59:38 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/** This function will activate a search around a central tile, looking for some houses
|
|
|
|
* that fit the requested characteristics
|
|
|
|
* @param parameter that is given by the callback.
|
|
|
|
* bits 0..6 radius of the search
|
|
|
|
* bits 7..8 search type i.e.: 0 = houseID/ 1 = classID/ 2 = grfID
|
|
|
|
* @param tile TileIndex from which to start the search
|
2008-06-25 18:46:05 +00:00
|
|
|
* @param house the HouseID that is associated to the house, the callback is called for
|
|
|
|
* @return the Manhattan distance from the center tile, if any, and 0 if failure
|
|
|
|
*/
|
|
|
|
static uint32 GetDistanceFromNearbyHouse(uint8 parameter, TileIndex tile, HouseID house)
|
2008-06-21 23:59:38 +00:00
|
|
|
{
|
|
|
|
static TestTileOnSearchProc * const search_procs[3] = {
|
|
|
|
SearchNearbyHouseID,
|
|
|
|
SearchNearbyHouseClass,
|
|
|
|
SearchNearbyHouseGRFID,
|
|
|
|
};
|
|
|
|
TileIndex found_tile = tile;
|
|
|
|
uint8 searchtype = GB(parameter, 6, 2);
|
|
|
|
uint8 searchradius = GB(parameter, 0, 6);
|
|
|
|
if (searchtype >= lengthof(search_procs)) return 0; // do not run on ill-defined code
|
2008-06-25 17:30:53 +00:00
|
|
|
if (searchradius < 1) return 0; // do not use a too low radius
|
2008-06-21 23:59:38 +00:00
|
|
|
|
2008-06-25 20:04:27 +00:00
|
|
|
SearchNearbyHouseData nbhd;
|
2009-06-26 14:02:27 +00:00
|
|
|
nbhd.hs = HouseSpec::Get(house);
|
2008-06-25 20:04:27 +00:00
|
|
|
nbhd.north_tile = tile + GetHouseNorthPart(house); // modifies 'house'!
|
|
|
|
|
2008-06-21 23:59:38 +00:00
|
|
|
/* Use a pointer for the tile to start the search. Will be required for calculating the distance*/
|
2008-06-25 20:04:27 +00:00
|
|
|
if (CircularTileSearch(&found_tile, 2 * searchradius + 1, search_procs[searchtype], &nbhd)) {
|
2008-06-21 23:59:38 +00:00
|
|
|
return DistanceManhattan(found_tile, tile);
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2007-03-19 11:27:30 +00:00
|
|
|
/**
|
|
|
|
* HouseGetVariable():
|
|
|
|
*
|
|
|
|
* Used by the resolver to get values for feature 07 deterministic spritegroups.
|
|
|
|
*/
|
|
|
|
static uint32 HouseGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)
|
|
|
|
{
|
|
|
|
const Town *town = object->u.house.town;
|
|
|
|
TileIndex tile = object->u.house.tile;
|
|
|
|
HouseID house_id = object->u.house.house_id;
|
|
|
|
|
|
|
|
if (object->scope == VSG_SCOPE_PARENT) {
|
|
|
|
return TownGetVariable(variable, parameter, available, town);
|
|
|
|
}
|
|
|
|
|
|
|
|
switch (variable) {
|
|
|
|
/* Construction stage. */
|
2008-03-31 15:10:24 +00:00
|
|
|
case 0x40: return (IsTileType(tile, MP_HOUSE) ? GetHouseBuildingStage(tile) : 0) | TileHash2Bit(TileX(tile), TileY(tile)) << 2;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
/* Building age. */
|
2009-05-15 22:45:31 +00:00
|
|
|
case 0x41: return IsTileType(tile, MP_HOUSE) ? GetHouseAge(tile) : 0;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
/* Town zone */
|
|
|
|
case 0x42: return GetTownRadiusGroup(town, tile);
|
|
|
|
|
|
|
|
/* Terrain type */
|
|
|
|
case 0x43: return GetTerrainType(tile);
|
|
|
|
|
|
|
|
/* Number of this type of building on the map. */
|
|
|
|
case 0x44: return GetNumHouses(house_id, town);
|
|
|
|
|
|
|
|
/* Whether the town is being created or just expanded. */
|
|
|
|
case 0x45: return _generating_world ? 1 : 0;
|
|
|
|
|
|
|
|
/* Current animation frame. */
|
|
|
|
case 0x46: return IsTileType(tile, MP_HOUSE) ? GetHouseAnimationFrame(tile) : 0;
|
|
|
|
|
2008-09-12 17:02:22 +00:00
|
|
|
/* Position of the house */
|
2008-09-12 17:05:23 +00:00
|
|
|
case 0x47: return TileY(tile) << 16 | TileX(tile);
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
/* Building counts for old houses with id = parameter. */
|
|
|
|
case 0x60: return GetNumHouses(parameter, town);
|
|
|
|
|
|
|
|
/* Building counts for new houses with id = parameter. */
|
|
|
|
case 0x61: {
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(house_id);
|
2007-03-19 11:27:30 +00:00
|
|
|
if (hs->grffile == NULL) return 0;
|
|
|
|
|
2007-05-15 21:36:58 +00:00
|
|
|
HouseID new_house = _house_mngr.GetID(parameter, hs->grffile->grfid);
|
2007-03-19 11:27:30 +00:00
|
|
|
return new_house == INVALID_HOUSE_ID ? 0 : GetNumHouses(new_house, town);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Land info for nearby tiles. */
|
2007-06-08 17:54:18 +00:00
|
|
|
case 0x62: return GetNearbyTileInformation(parameter, tile);
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2008-06-15 02:48:25 +00:00
|
|
|
/* Current animation frame of nearby house tiles */
|
|
|
|
case 0x63: {
|
|
|
|
TileIndex testtile = GetNearbyTile(parameter, tile);
|
|
|
|
return IsTileType(testtile, MP_HOUSE) ? GetHouseAnimationFrame(testtile) : 0;
|
|
|
|
}
|
|
|
|
|
2008-06-21 23:59:38 +00:00
|
|
|
/* Cargo acceptance history of nearby stations */
|
|
|
|
/*case 0x64: not implemented yet */
|
|
|
|
|
|
|
|
/* Distance test for some house types */
|
|
|
|
case 0x65: return GetDistanceFromNearbyHouse(parameter, tile, object->u.house.house_id);
|
2007-03-19 11:27:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
DEBUG(grf, 1, "Unhandled house property 0x%X", variable);
|
|
|
|
|
|
|
|
*available = false;
|
|
|
|
return UINT_MAX;
|
|
|
|
}
|
|
|
|
|
2009-05-23 12:13:42 +00:00
|
|
|
static const SpriteGroup *HouseResolveReal(const ResolverObject *object, const RealSpriteGroup *group)
|
2007-03-19 11:27:30 +00:00
|
|
|
{
|
|
|
|
/* Houses do not have 'real' groups */
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* NewHouseResolver():
|
|
|
|
*
|
|
|
|
* Returns a resolver object to be used with feature 07 spritegroups.
|
|
|
|
*/
|
|
|
|
static void NewHouseResolver(ResolverObject *res, HouseID house_id, TileIndex tile, Town *town)
|
|
|
|
{
|
|
|
|
res->GetRandomBits = HouseGetRandomBits;
|
|
|
|
res->GetTriggers = HouseGetTriggers;
|
|
|
|
res->SetTriggers = HouseSetTriggers;
|
|
|
|
res->GetVariable = HouseGetVariable;
|
|
|
|
res->ResolveReal = HouseResolveReal;
|
|
|
|
|
|
|
|
res->u.house.tile = tile;
|
|
|
|
res->u.house.town = town;
|
|
|
|
res->u.house.house_id = house_id;
|
|
|
|
|
2007-07-25 19:06:29 +00:00
|
|
|
res->callback = CBID_NO_CALLBACK;
|
2007-03-19 11:27:30 +00:00
|
|
|
res->callback_param1 = 0;
|
|
|
|
res->callback_param2 = 0;
|
|
|
|
res->last_value = 0;
|
|
|
|
res->trigger = 0;
|
|
|
|
res->reseed = 0;
|
2008-03-27 21:36:16 +00:00
|
|
|
res->count = 0;
|
2008-07-30 18:23:12 +00:00
|
|
|
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(house_id);
|
2008-07-30 18:23:12 +00:00
|
|
|
res->grffile = (hs != NULL ? hs->grffile : NULL);
|
2007-03-19 11:27:30 +00:00
|
|
|
}
|
|
|
|
|
2007-07-25 19:06:29 +00:00
|
|
|
uint16 GetHouseCallback(CallbackID callback, uint32 param1, uint32 param2, HouseID house_id, Town *town, TileIndex tile)
|
2007-03-19 11:27:30 +00:00
|
|
|
{
|
|
|
|
ResolverObject object;
|
|
|
|
const SpriteGroup *group;
|
|
|
|
|
|
|
|
NewHouseResolver(&object, house_id, tile, town);
|
|
|
|
object.callback = callback;
|
|
|
|
object.callback_param1 = param1;
|
2007-05-19 09:13:08 +00:00
|
|
|
object.callback_param2 = param2;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2009-06-26 14:02:27 +00:00
|
|
|
group = SpriteGroup::Resolve(HouseSpec::Get(house_id)->spritegroup, &object);
|
2009-05-23 12:13:42 +00:00
|
|
|
if (group == NULL) return CALLBACK_FAILED;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2009-05-23 12:13:42 +00:00
|
|
|
return group->GetCallbackResult();
|
2007-03-19 11:27:30 +00:00
|
|
|
}
|
|
|
|
|
2009-05-23 12:13:42 +00:00
|
|
|
static void DrawTileLayout(const TileInfo *ti, const TileLayoutSpriteGroup *group, byte stage, HouseID house_id)
|
2007-03-19 11:27:30 +00:00
|
|
|
{
|
2009-05-23 12:13:42 +00:00
|
|
|
const DrawTileSprites *dts = group->dts;
|
2007-03-19 11:27:30 +00:00
|
|
|
const DrawTileSeqStruct *dtss;
|
|
|
|
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(house_id);
|
2009-02-09 02:57:15 +00:00
|
|
|
SpriteID palette = hs->random_colour[TileHash2Bit(ti->x, ti->y)] + PALETTE_RECOLOUR_START;
|
2008-11-22 16:04:11 +00:00
|
|
|
if (HasBit(hs->callback_mask, CBM_HOUSE_COLOUR)) {
|
2009-06-26 13:46:23 +00:00
|
|
|
uint16 callback = GetHouseCallback(CBID_HOUSE_COLOUR, 0, 0, house_id, Town::GetByTile(ti->tile), ti->tile);
|
2008-11-22 16:04:11 +00:00
|
|
|
if (callback != CALLBACK_FAILED) {
|
|
|
|
/* If bit 14 is set, we should use a 2cc colour map, else use the callback value. */
|
|
|
|
palette = HasBit(callback, 14) ? GB(callback, 0, 8) + SPR_2CCMAP_BASE : callback;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2008-02-15 18:40:42 +00:00
|
|
|
SpriteID image = dts->ground.sprite;
|
|
|
|
SpriteID pal = dts->ground.pal;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2007-09-23 10:54:11 +00:00
|
|
|
if (IS_CUSTOM_SPRITE(image)) image += stage;
|
|
|
|
|
2008-11-22 16:04:11 +00:00
|
|
|
if (GB(image, 0, SPRITE_WIDTH) != 0) {
|
|
|
|
DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
|
|
|
|
}
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
foreach_draw_tile_seq(dtss, dts->seq) {
|
2008-02-15 18:34:26 +00:00
|
|
|
if (GB(dtss->image.sprite, 0, SPRITE_WIDTH) == 0) continue;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2008-02-15 18:34:26 +00:00
|
|
|
image = dtss->image.sprite;
|
|
|
|
pal = dtss->image.pal;
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2008-06-18 16:48:58 +00:00
|
|
|
/* Stop drawing sprite sequence once we meet a sprite that doesn't have to be opaque */
|
|
|
|
if (IsInvisibilitySet(TO_HOUSES) && !HasBit(image, SPRITE_MODIFIER_OPAQUE)) return;
|
|
|
|
|
2007-09-23 10:54:11 +00:00
|
|
|
if (IS_CUSTOM_SPRITE(image)) image += stage;
|
|
|
|
|
2008-11-22 16:04:11 +00:00
|
|
|
pal = SpriteLayoutPaletteTransform(image, pal, palette);
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
if ((byte)dtss->delta_z != 0x80) {
|
|
|
|
AddSortableSpriteToDraw(
|
|
|
|
image, pal,
|
|
|
|
ti->x + dtss->delta_x, ti->y + dtss->delta_y,
|
|
|
|
dtss->size_x, dtss->size_y,
|
2007-07-26 14:07:11 +00:00
|
|
|
dtss->size_z, ti->z + dtss->delta_z,
|
2008-10-18 17:21:56 +00:00
|
|
|
!HasBit(image, SPRITE_MODIFIER_OPAQUE) && IsTransparencySet(TO_HOUSES)
|
2007-03-19 11:27:30 +00:00
|
|
|
);
|
|
|
|
} else {
|
2008-10-18 17:21:56 +00:00
|
|
|
/* For industries and houses delta_x and delta_y are unsigned */
|
|
|
|
AddChildSpriteScreen(image, pal, (byte)dtss->delta_x, (byte)dtss->delta_y, !HasBit(image, SPRITE_MODIFIER_OPAQUE) && IsTransparencySet(TO_HOUSES));
|
2007-03-19 11:27:30 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void DrawNewHouseTile(TileInfo *ti, HouseID house_id)
|
|
|
|
{
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(house_id);
|
2007-03-19 11:27:30 +00:00
|
|
|
const SpriteGroup *group;
|
|
|
|
ResolverObject object;
|
|
|
|
|
2009-09-16 19:10:50 +00:00
|
|
|
if (ti->tileh != SLOPE_FLAT) {
|
|
|
|
bool draw_old_one = true;
|
|
|
|
if (HasBit(hs->callback_mask, CBM_HOUSE_DRAW_FOUNDATIONS)) {
|
|
|
|
/* Called to determine the type (if any) of foundation to draw for the house tile */
|
|
|
|
uint32 callback_res = GetHouseCallback(CBID_HOUSE_DRAW_FOUNDATIONS, 0, 0, house_id, Town::GetByTile(ti->tile), ti->tile);
|
|
|
|
draw_old_one = (callback_res != 0);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);
|
|
|
|
}
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2009-06-26 13:46:23 +00:00
|
|
|
NewHouseResolver(&object, house_id, ti->tile, Town::GetByTile(ti->tile));
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2009-05-23 15:25:52 +00:00
|
|
|
group = SpriteGroup::Resolve(hs->spritegroup, &object);
|
2009-12-16 11:35:05 +00:00
|
|
|
const TileLayoutSpriteGroup *tlgroup = (const TileLayoutSpriteGroup *)group;
|
|
|
|
if (group == NULL || group->type != SGT_TILELAYOUT || tlgroup->num_building_stages == 0) {
|
|
|
|
return;
|
2007-03-19 11:27:30 +00:00
|
|
|
} else {
|
|
|
|
/* Limit the building stage to the number of stages supplied. */
|
|
|
|
byte stage = GetHouseBuildingStage(ti->tile);
|
2009-12-16 11:35:05 +00:00
|
|
|
stage = Clamp(stage - 4 + tlgroup->num_building_stages, 0, tlgroup->num_building_stages - 1);
|
2009-05-23 12:13:42 +00:00
|
|
|
DrawTileLayout(ti, tlgroup, stage, house_id);
|
2007-03-19 11:27:30 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void AnimateNewHouseTile(TileIndex tile)
|
|
|
|
{
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
|
2007-03-19 11:27:30 +00:00
|
|
|
byte animation_speed = hs->animation_speed;
|
|
|
|
bool frame_set_by_callback = false;
|
|
|
|
|
2007-11-19 21:02:30 +00:00
|
|
|
if (HasBit(hs->callback_mask, CBM_HOUSE_ANIMATION_SPEED)) {
|
2009-06-26 13:46:23 +00:00
|
|
|
uint16 callback_res = GetHouseCallback(CBID_HOUSE_ANIMATION_SPEED, 0, 0, GetHouseType(tile), Town::GetByTile(tile), tile);
|
2007-11-19 18:38:10 +00:00
|
|
|
if (callback_res != CALLBACK_FAILED) animation_speed = Clamp(callback_res & 0xFF, 2, 16);
|
2007-03-19 11:27:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/* An animation speed of 2 means the animation frame changes 4 ticks, and
|
|
|
|
* increasing this value by one doubles the wait. 2 is the minimum value
|
|
|
|
* allowed for animation_speed, which corresponds to 120ms, and 16 is the
|
|
|
|
* maximum, corresponding to around 33 minutes. */
|
|
|
|
if (_tick_counter % (1 << animation_speed) != 0) return;
|
|
|
|
|
|
|
|
byte frame = GetHouseAnimationFrame(tile);
|
|
|
|
byte num_frames = GB(hs->animation_frames, 0, 7);
|
|
|
|
|
2007-11-19 21:02:30 +00:00
|
|
|
if (HasBit(hs->callback_mask, CBM_HOUSE_ANIMATION_NEXT_FRAME)) {
|
2007-03-19 11:27:30 +00:00
|
|
|
uint32 param = (hs->extra_flags & CALLBACK_1A_RANDOM_BITS) ? Random() : 0;
|
2009-06-26 13:46:23 +00:00
|
|
|
uint16 callback_res = GetHouseCallback(CBID_HOUSE_ANIMATION_NEXT_FRAME, param, 0, GetHouseType(tile), Town::GetByTile(tile), tile);
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
if (callback_res != CALLBACK_FAILED) {
|
|
|
|
frame_set_by_callback = true;
|
|
|
|
|
|
|
|
switch (callback_res & 0xFF) {
|
|
|
|
case 0xFF:
|
|
|
|
DeleteAnimatedTile(tile);
|
|
|
|
break;
|
|
|
|
case 0xFE:
|
|
|
|
/* Carry on as normal. */
|
|
|
|
frame_set_by_callback = false;
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
frame = callback_res & 0xFF;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* If the lower 7 bits of the upper byte of the callback
|
|
|
|
* result are not empty, it is a sound effect. */
|
2008-04-21 11:29:01 +00:00
|
|
|
if (GB(callback_res, 8, 7) != 0) PlayTileSound(hs->grffile, GB(callback_res, 8, 7), tile);
|
2007-03-19 11:27:30 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!frame_set_by_callback) {
|
|
|
|
if (frame < num_frames) {
|
|
|
|
frame++;
|
2007-11-19 21:02:30 +00:00
|
|
|
} else if (frame == num_frames && HasBit(hs->animation_frames, 7)) {
|
2007-03-19 11:27:30 +00:00
|
|
|
/* This animation loops, so start again from the beginning */
|
|
|
|
frame = 0;
|
|
|
|
} else {
|
|
|
|
/* This animation doesn't loop, so stay here */
|
|
|
|
DeleteAnimatedTile(tile);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
SetHouseAnimationFrame(tile, frame);
|
|
|
|
MarkTileDirtyByTile(tile);
|
|
|
|
}
|
|
|
|
|
2008-04-21 11:29:01 +00:00
|
|
|
void ChangeHouseAnimationFrame(const GRFFile *file, TileIndex tile, uint16 callback_result)
|
2007-03-19 11:27:30 +00:00
|
|
|
{
|
|
|
|
switch (callback_result & 0xFF) {
|
|
|
|
case 0xFD: /* Do nothing. */ break;
|
|
|
|
case 0xFE: AddAnimatedTile(tile); break;
|
|
|
|
case 0xFF: DeleteAnimatedTile(tile); break;
|
|
|
|
default:
|
|
|
|
SetHouseAnimationFrame(tile, callback_result & 0xFF);
|
|
|
|
AddAnimatedTile(tile);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
/* If the lower 7 bits of the upper byte of the callback
|
|
|
|
* result are not empty, it is a sound effect. */
|
2008-04-21 11:29:01 +00:00
|
|
|
if (GB(callback_result, 8, 7) != 0) PlayTileSound(file, GB(callback_result, 8, 7), tile);
|
2007-03-19 11:27:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
bool CanDeleteHouse(TileIndex tile)
|
|
|
|
{
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2008-09-30 20:39:50 +00:00
|
|
|
/* Humans are always allowed to remove buildings, as is water and
|
2007-03-19 11:27:30 +00:00
|
|
|
* anyone using the scenario editor. */
|
2009-06-10 22:05:01 +00:00
|
|
|
if (Company::IsValidHumanID(_current_company) || _current_company == OWNER_WATER || _current_company == OWNER_NONE) {
|
|
|
|
return true;
|
|
|
|
}
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2007-11-19 21:02:30 +00:00
|
|
|
if (HasBit(hs->callback_mask, CBM_HOUSE_DENY_DESTRUCTION)) {
|
2009-06-26 13:46:23 +00:00
|
|
|
uint16 callback_res = GetHouseCallback(CBID_HOUSE_DENY_DESTRUCTION, 0, 0, GetHouseType(tile), Town::GetByTile(tile), tile);
|
2007-03-19 11:27:30 +00:00
|
|
|
return (callback_res == CALLBACK_FAILED || callback_res == 0);
|
|
|
|
} else {
|
|
|
|
return !(hs->extra_flags & BUILDING_IS_PROTECTED);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static void AnimationControl(TileIndex tile, uint16 random_bits)
|
|
|
|
{
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2007-11-19 21:02:30 +00:00
|
|
|
if (HasBit(hs->callback_mask, CBM_HOUSE_ANIMATION_START_STOP)) {
|
2007-03-19 11:27:30 +00:00
|
|
|
uint32 param = (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) ? (GB(Random(), 0, 16) | random_bits << 16) : Random();
|
2009-06-26 13:46:23 +00:00
|
|
|
uint16 callback_res = GetHouseCallback(CBID_HOUSE_ANIMATION_START_STOP, param, 0, GetHouseType(tile), Town::GetByTile(tile), tile);
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2008-04-21 11:29:01 +00:00
|
|
|
if (callback_res != CALLBACK_FAILED) ChangeHouseAnimationFrame(hs->grffile, tile, callback_res);
|
2007-03-19 11:27:30 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
bool NewHouseTileLoop(TileIndex tile)
|
|
|
|
{
|
2009-06-26 14:02:27 +00:00
|
|
|
const HouseSpec *hs = HouseSpec::Get(GetHouseType(tile));
|
2007-03-19 11:27:30 +00:00
|
|
|
|
|
|
|
if (GetHouseProcessingTime(tile) > 0) {
|
|
|
|
DecHouseProcessingTime(tile);
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2007-11-11 17:58:05 +00:00
|
|
|
TriggerHouse(tile, HOUSE_TRIGGER_TILE_LOOP);
|
2009-08-02 19:48:51 +00:00
|
|
|
if (hs->building_flags & BUILDING_HAS_1_TILE) TriggerHouse(tile, HOUSE_TRIGGER_TILE_LOOP_TOP);
|
2007-03-19 11:27:30 +00:00
|
|
|
|
2007-11-19 21:02:30 +00:00
|
|
|
if (HasBit(hs->callback_mask, CBM_HOUSE_ANIMATION_START_STOP)) {
|
2007-03-19 11:27:30 +00:00
|
|
|
/* If this house is marked as having a synchronised callback, all the
|
|
|
|
* tiles will have the callback called at once, rather than when the
|
|
|
|
* tile loop reaches them. This should only be enabled for the northern
|
|
|
|
* tile, or strange things will happen (here, and in TTDPatch). */
|
|
|
|
if (hs->extra_flags & SYNCHRONISED_CALLBACK_1B) {
|
|
|
|
uint16 random = GB(Random(), 0, 16);
|
|
|
|
|
|
|
|
if (hs->building_flags & BUILDING_HAS_1_TILE) AnimationControl(tile, random);
|
|
|
|
if (hs->building_flags & BUILDING_2_TILES_Y) AnimationControl(TILE_ADDXY(tile, 0, 1), random);
|
|
|
|
if (hs->building_flags & BUILDING_2_TILES_X) AnimationControl(TILE_ADDXY(tile, 1, 0), random);
|
|
|
|
if (hs->building_flags & BUILDING_HAS_4_TILES) AnimationControl(TILE_ADDXY(tile, 1, 1), random);
|
|
|
|
} else {
|
|
|
|
AnimationControl(tile, 0);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Check callback 21, which determines if a house should be destroyed. */
|
2007-11-19 21:02:30 +00:00
|
|
|
if (HasBit(hs->callback_mask, CBM_HOUSE_DESTRUCTION)) {
|
2009-06-26 13:46:23 +00:00
|
|
|
uint16 callback_res = GetHouseCallback(CBID_HOUSE_DESTRUCTION, 0, 0, GetHouseType(tile), Town::GetByTile(tile), tile);
|
2008-04-21 14:33:33 +00:00
|
|
|
if (callback_res != CALLBACK_FAILED && GB(callback_res, 0, 8) > 0) {
|
2009-06-26 13:46:23 +00:00
|
|
|
ClearTownHouse(Town::GetByTile(tile), tile);
|
2007-03-19 11:27:30 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
SetHouseProcessingTime(tile, hs->processing_time);
|
2009-08-02 19:49:22 +00:00
|
|
|
MarkTileDirtyByTile(tile);
|
2007-03-19 11:27:30 +00:00
|
|
|
return true;
|
|
|
|
}
|
2007-11-11 17:58:05 +00:00
|
|
|
|
|
|
|
static void DoTriggerHouse(TileIndex tile, HouseTrigger trigger, byte base_random, bool first)
|
|
|
|
{
|
|
|
|
ResolverObject object;
|
|
|
|
|
|
|
|
/* We can't trigger a non-existent building... */
|
|
|
|
assert(IsTileType(tile, MP_HOUSE));
|
|
|
|
|
|
|
|
HouseID hid = GetHouseType(tile);
|
2009-06-26 14:02:27 +00:00
|
|
|
HouseSpec *hs = HouseSpec::Get(hid);
|
2007-11-11 17:58:05 +00:00
|
|
|
|
2008-04-23 00:14:49 +00:00
|
|
|
if (hs->spritegroup == NULL) return;
|
|
|
|
|
2009-06-26 13:46:23 +00:00
|
|
|
NewHouseResolver(&object, hid, tile, Town::GetByTile(tile));
|
2007-11-11 17:58:05 +00:00
|
|
|
|
|
|
|
object.callback = CBID_RANDOM_TRIGGER;
|
|
|
|
object.trigger = trigger;
|
|
|
|
|
2009-05-23 15:25:52 +00:00
|
|
|
const SpriteGroup *group = SpriteGroup::Resolve(hs->spritegroup, &object);
|
2007-11-11 17:58:05 +00:00
|
|
|
if (group == NULL) return;
|
|
|
|
|
|
|
|
byte new_random_bits = Random();
|
|
|
|
byte random_bits = GetHouseRandomBits(tile);
|
|
|
|
random_bits &= ~object.reseed;
|
|
|
|
random_bits |= (first ? new_random_bits : base_random) & object.reseed;
|
|
|
|
SetHouseRandomBits(tile, random_bits);
|
|
|
|
|
|
|
|
switch (trigger) {
|
|
|
|
case HOUSE_TRIGGER_TILE_LOOP:
|
|
|
|
/* Random value already set. */
|
|
|
|
break;
|
|
|
|
|
|
|
|
case HOUSE_TRIGGER_TILE_LOOP_TOP:
|
2009-08-02 19:49:22 +00:00
|
|
|
if (!first) {
|
|
|
|
/* The top tile is marked dirty by the usual TileLoop */
|
|
|
|
MarkTileDirtyByTile(tile);
|
|
|
|
break;
|
|
|
|
}
|
2007-11-11 17:58:05 +00:00
|
|
|
/* Random value of first tile already set. */
|
2007-11-12 01:05:35 +00:00
|
|
|
if (hs->building_flags & BUILDING_2_TILES_Y) DoTriggerHouse(TILE_ADDXY(tile, 0, 1), trigger, random_bits, false);
|
|
|
|
if (hs->building_flags & BUILDING_2_TILES_X) DoTriggerHouse(TILE_ADDXY(tile, 1, 0), trigger, random_bits, false);
|
|
|
|
if (hs->building_flags & BUILDING_HAS_4_TILES) DoTriggerHouse(TILE_ADDXY(tile, 1, 1), trigger, random_bits, false);
|
2007-11-11 17:58:05 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
void TriggerHouse(TileIndex t, HouseTrigger trigger)
|
|
|
|
{
|
2007-11-12 01:38:32 +00:00
|
|
|
DoTriggerHouse(t, trigger, 0, true);
|
2007-11-11 17:58:05 +00:00
|
|
|
}
|