Files
@ r15173:a59afd6301a6
Branch filter:
Location: cpp/openttd-patchpack/source/src/newgrf_airporttiles.cpp
r15173:a59afd6301a6
13.8 KiB
text/x-c
(svn r19812) -Codechange: give some unnamed enums a name or, in case they consisted of unrelated values use static const (u)int
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 | /* $Id$ */
/*
* 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 newgrf_airporttiles.cpp NewGRF handling of airport tiles. */
#include "stdafx.h"
#include "debug.h"
#include "airport.h"
#include "newgrf.h"
#include "newgrf_airporttiles.h"
#include "newgrf_spritegroup.h"
#include "newgrf_sound.h"
#include "animated_tile_func.h"
#include "station_base.h"
#include "water.h"
#include "viewport_func.h"
#include "landscape.h"
#include "company_base.h"
#include "town.h"
#include "variables.h"
#include "functions.h"
#include "core/random_func.hpp"
#include "table/strings.h"
#include "table/airporttiles.h"
AirportTileSpec AirportTileSpec::tiles[NUM_AIRPORTTILES];
AirportTileOverrideManager _airporttile_mngr(NEW_AIRPORTTILE_OFFSET, NUM_AIRPORTTILES, INVALID_AIRPORTTILE);
/**
* Retrieve airport tile spec for the given airport tile
* @param gfx index of airport tile
* @return A pointer to the corresponding AirportTileSpec
*/
/* static */ const AirportTileSpec *AirportTileSpec::Get(StationGfx gfx)
{
/* should be assert(gfx < lengthof(tiles)), but that gives compiler warnings
* since it's always true if the following holds: */
assert_compile(MAX_UVALUE(StationGfx) + 1 == lengthof(tiles));
return &AirportTileSpec::tiles[gfx];
}
/**
* This function initializes the tile array of AirportTileSpec
*/
void AirportTileSpec::ResetAirportTiles()
{
memset(&AirportTileSpec::tiles, 0, sizeof(AirportTileSpec::tiles));
memcpy(&AirportTileSpec::tiles, &_origin_airporttile_specs, sizeof(_origin_airporttile_specs));
/* Reset any overrides that have been set. */
_airporttile_mngr.ResetOverride();
}
void AirportTileOverrideManager::SetEntitySpec(const AirportTileSpec *airpts)
{
StationGfx airpt_id = this->AddEntityID(airpts->grf_prop.local_id, airpts->grf_prop.grffile->grfid, airpts->grf_prop.subst_id);
if (airpt_id == invalid_ID) {
grfmsg(1, "AirportTile.SetEntitySpec: Too many airport tiles allocated. Ignoring.");
return;
}
memcpy(&AirportTileSpec::tiles[airpt_id], airpts, sizeof(*airpts));
/* Now add the overrides. */
for (int i = 0; i < max_offset; i++) {
AirportTileSpec *overridden_airpts = &AirportTileSpec::tiles[i];
if (entity_overrides[i] != airpts->grf_prop.local_id || grfid_overrides[i] != airpts->grf_prop.grffile->grfid) continue;
overridden_airpts->grf_prop.override = airpt_id;
overridden_airpts->enabled = false;
entity_overrides[i] = invalid_ID;
grfid_overrides[i] = 0;
}
}
/**
* Do airporttile gfx ID translation for NewGRFs.
* @param gfx the type to get the override for.
* @return the gfx to actually work with.
*/
StationGfx GetTranslatedAirportTileID(StationGfx gfx)
{
const AirportTileSpec *it = AirportTileSpec::Get(gfx);
return it->grf_prop.override == INVALID_AIRPORTTILE ? gfx : it->grf_prop.override;
}
static const SpriteGroup *AirportTileResolveReal(const ResolverObject *object, const RealSpriteGroup *group)
{
/* AirportTile do not have 'real' groups. */
return NULL;
}
/**
* Based on newhouses/newindustries equivalent, but adapted for airports.
* @param parameter from callback. It's in fact a pair of coordinates
* @param tile TileIndex from which the callback was initiated
* @param index of the industry been queried for
* @return a construction of bits obeying the newgrf format
*/
uint32 GetNearbyAirportTileInformation(byte parameter, TileIndex tile, StationID index)
{
if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required
bool is_same_airport = (IsTileType(tile, MP_STATION) && IsAirport(tile) && GetStationIndex(tile) == index);
return GetNearbyTileInformation(tile) | (is_same_airport ? 1 : 0) << 8;
}
/**
* Make an analysis of a tile and check whether it belongs to the same
* airport, and/or the same grf file
* @param tile TileIndex of the tile to query
* @param st Station to which to compare the tile to
* @param cur_grfid GRFID of the current callback
* @return value encoded as per NFO specs
*/
static uint32 GetAirportTileIDAtOffset(TileIndex tile, const Station *st, uint32 cur_grfid)
{
if (!st->TileBelongsToAirport(tile)) {
return 0xFFFF;
}
StationGfx gfx = GetAirportGfx(tile);
const AirportTileSpec *ats = AirportTileSpec::Get(gfx);
if (gfx < NEW_AIRPORTTILE_OFFSET) { // Does it belongs to an old type?
/* It is an old tile. We have to see if it's been overriden */
if (ats->grf_prop.override == INVALID_AIRPORTTILE) { // has it been overridden?
return 0xFF << 8 | gfx; // no. Tag FF + the gfx id of that tile
}
/* Overriden */
const AirportTileSpec *tile_ovr = AirportTileSpec::Get(ats->grf_prop.override);
if (tile_ovr->grf_prop.grffile->grfid == cur_grfid) {
return tile_ovr->grf_prop.local_id; // same grf file
} else {
return 0xFFFE; // not the same grf file
}
}
/* Not an 'old type' tile */
if (ats->grf_prop.spritegroup != NULL) { // tile has a spritegroup ?
if (ats->grf_prop.grffile->grfid == cur_grfid) { // same airport, same grf ?
return ats->grf_prop.local_id;
} else {
return 0xFFFE; // Defined in another grf file
}
}
/* The tile has no spritegroup */
return 0xFF << 8 | ats->grf_prop.subst_id; // so just give him the substitute
}
static uint32 AirportTileGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)
{
const Station *st = object->u.airport.st;
TileIndex tile = object->u.airport.tile;
assert(st != NULL);
if (object->scope == VSG_SCOPE_PARENT) {
DEBUG(grf, 1, "Parent scope for airport tiles unavailable");
*available = false;
return UINT_MAX;
}
extern uint32 GetRelativePosition(TileIndex tile, TileIndex ind_tile);
switch (variable) {
/* Terrain type */
case 0x41: return GetTerrainType(tile);
/* Current town zone of the tile in the nearest town */
case 0x42: return GetTownRadiusGroup(ClosestTownFromTile(tile, UINT_MAX), tile);
/* Position relative to most northern airport tile. */
case 0x43: return GetRelativePosition(tile, st->airport.tile);
/* Animation frame of tile */
case 0x44: return GetStationAnimationFrame(tile);
/* Land info of nearby tiles */
case 0x60: return GetNearbyAirportTileInformation(parameter, tile, st->index);
/* Animation stage of nearby tiles */
case 0x61:
tile = GetNearbyTile(parameter, tile);
if (st->TileBelongsToAirport(tile)) {
return GetStationAnimationFrame(tile);
}
return UINT_MAX;
/* Get airport tile ID at offset */
case 0x62: return GetAirportTileIDAtOffset(GetNearbyTile(parameter, tile), st, object->grffile->grfid);
}
DEBUG(grf, 1, "Unhandled airport tile property 0x%X", variable);
*available = false;
return UINT_MAX;
}
static uint32 AirportTileGetRandomBits(const ResolverObject *object)
{
const Station *st = object->u.airport.st;
const TileIndex tile = object->u.airport.tile;
return (st == NULL ? 0 : st->random_bits) | (tile == INVALID_TILE ? 0 : GetStationTileRandomBits(tile) << 16);
}
static void AirportTileResolver(ResolverObject *res, StationGfx gfx, TileIndex tile, Station *st)
{
res->GetRandomBits = AirportTileGetRandomBits;
res->GetTriggers = NULL;
res->SetTriggers = NULL;
res->GetVariable = AirportTileGetVariable;
res->ResolveReal = AirportTileResolveReal;
assert(st != NULL);
res->psa = NULL;
res->u.airport.airport_id = st->airport.type;
res->u.airport.st = st;
res->u.airport.tile = tile;
res->callback = CBID_NO_CALLBACK;
res->callback_param1 = 0;
res->callback_param2 = 0;
res->last_value = 0;
res->trigger = 0;
res->reseed = 0;
res->count = 0;
const AirportTileSpec *ats = AirportTileSpec::Get(gfx);
res->grffile = ats->grf_prop.grffile;
}
uint16 GetAirportTileCallback(CallbackID callback, uint32 param1, uint32 param2, StationGfx gfx_id, Station *st, TileIndex tile)
{
ResolverObject object;
const SpriteGroup *group;
AirportTileResolver(&object, gfx_id, tile, st);
object.callback = callback;
object.callback_param1 = param1;
object.callback_param2 = param2;
group = SpriteGroup::Resolve(AirportTileSpec::Get(gfx_id)->grf_prop.spritegroup, &object);
if (group == NULL) return CALLBACK_FAILED;
return group->GetCallbackResult();
}
static void AirportDrawTileLayout(const TileInfo *ti, const TileLayoutSpriteGroup *group, byte colour, StationGfx gfx)
{
const DrawTileSprites *dts = group->dts;
SpriteID image = dts->ground.sprite;
SpriteID pal = dts->ground.pal;
if (GB(image, 0, SPRITE_WIDTH) != 0) {
if (image == SPR_FLAT_WATER_TILE && GetWaterClass(ti->tile) != WATER_CLASS_INVALID) {
DrawWaterClassGround(ti);
} else {
DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, GENERAL_SPRITE_COLOUR(colour)));
}
}
DrawNewGRFTileSeq(ti, dts, TO_BUILDINGS, 0, GENERAL_SPRITE_COLOUR(colour));
}
bool DrawNewAirportTile(TileInfo *ti, Station *st, StationGfx gfx, const AirportTileSpec *airts)
{
const SpriteGroup *group;
ResolverObject object;
if (ti->tileh != SLOPE_FLAT) {
bool draw_old_one = true;
if (HasBit(airts->callback_flags, CBM_AIRT_DRAW_FOUNDATIONS)) {
/* Called to determine the type (if any) of foundation to draw */
uint32 callback_res = GetAirportTileCallback(CBID_AIRPTILE_DRAW_FOUNDATIONS, 0, 0, gfx, st, ti->tile);
draw_old_one = (callback_res != 0);
}
if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);
}
AirportTileResolver(&object, gfx, ti->tile, st);
group = SpriteGroup::Resolve(airts->grf_prop.spritegroup, &object);
if (group == NULL || group->type != SGT_TILELAYOUT) {
return false;
}
const TileLayoutSpriteGroup *tlgroup = (const TileLayoutSpriteGroup *)group;
AirportDrawTileLayout(ti, tlgroup, Company::Get(st->owner)->colour, gfx);
return true;
}
void AnimateAirportTile(TileIndex tile)
{
Station *st = Station::GetByTile(tile);
StationGfx gfx = GetAirportGfx(tile);
const AirportTileSpec *ats = AirportTileSpec::Get(gfx);
uint8 animation_speed = ats->animation_speed;
if (HasBit(ats->callback_flags, CBM_AIRT_ANIM_SPEED)) {
uint16 callback_res = GetAirportTileCallback(CBID_AIRPTILE_ANIMATION_SPEED, 0, 0, gfx, st, tile);
if (callback_res != CALLBACK_FAILED) animation_speed = Clamp(callback_res & 0xFF, 0, 16);
}
/* An animation speed of 2 means the animation frame changes 4 ticks, and
* increasing this value by one doubles the wait. 0 is the minimum value
* allowed for animation_speed, which corresponds to 30ms, and 16 is the
* maximum, corresponding to around 33 minutes. */
if ((_tick_counter % (1 << animation_speed)) != 0) return;
bool frame_set_by_callback = false;
uint8 frame = GetStationAnimationFrame(tile);
uint16 num_frames = GB(ats->animation_info, 0, 8);
if (HasBit(ats->callback_flags, CBM_AIRT_ANIM_NEXT_FRAME)) {
uint16 callback_res = GetAirportTileCallback(CBID_AIRPTILE_ANIM_NEXT_FRAME, HasBit(ats->animation_special_flags, 0) ? Random() : 0, 0, gfx, st, tile);
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. */
if (GB(callback_res, 8, 7) != 0) PlayTileSound(ats->grf_prop.grffile, GB(callback_res, 8, 7), tile);
}
}
if (!frame_set_by_callback) {
if (frame < num_frames) {
frame++;
} else if (frame == num_frames && GB(ats->animation_info, 8, 8) == 1) {
/* This animation loops, so start again from the beginning */
frame = 0;
} else {
/* This animation doesn't loop, so stay here */
DeleteAnimatedTile(tile);
}
}
SetStationAnimationFrame(tile, frame);
MarkTileDirtyByTile(tile);
}
static void ChangeAirportTileAnimationFrame(const AirportTileSpec *ats, TileIndex tile, AirpAnimationTrigger trigger, StationGfx gfx, Station *st)
{
uint16 callback_res = GetAirportTileCallback(CBID_AIRPTILE_ANIM_START_STOP, Random(), trigger, gfx, st, tile);
if (callback_res == CALLBACK_FAILED) return;
switch (callback_res & 0xFF) {
case 0xFD: /* Do nothing. */ break;
case 0xFE: AddAnimatedTile(tile); break;
case 0xFF: DeleteAnimatedTile(tile); break;
default:
SetStationAnimationFrame(tile, callback_res & 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. */
if (GB(callback_res, 8, 7) != 0) PlayTileSound(ats->grf_prop.grffile, GB(callback_res, 8, 7), tile);
}
void AirportTileAnimationTrigger(Station *st, TileIndex tile, AirpAnimationTrigger trigger, CargoID cargo_type)
{
StationGfx gfx = GetAirportGfx(tile);
const AirportTileSpec *ats = AirportTileSpec::Get(gfx);
if (!HasBit(ats->animation_triggers, trigger)) return;
ChangeAirportTileAnimationFrame(ats, tile, trigger, gfx, st);
return;
}
void AirportAnimationTrigger(Station *st, AirpAnimationTrigger trigger, CargoID cargo_type)
{
if (st->airport.tile == INVALID_TILE) return;
TILE_AREA_LOOP(tile, st->airport) {
if (st->TileBelongsToAirport(tile)) AirportTileAnimationTrigger(st, tile, trigger, cargo_type);
}
}
/**
* Resolve an airport tile's spec and such so we can get a variable.
* @param ro The resolver object to fill.
* @param index The airport tile to get the data from.
*/
void GetAirportTileTypeResolver(ResolverObject *ro, uint index)
{
AirportTileResolver(ro, GetAirportGfx(index), index, Station::GetByTile(index));
}
|