1

/* $Id$ */

     2

     3

/** @file newgrf_industrytiles.cpp NewGRF handling of industry tiles. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "debug.h"

     9

#include "viewport_func.h"

    10

#include "landscape.h"

    11

#include "newgrf.h"

    12

#include "industry.h"

    13

#include "newgrf_commons.h"

    14

#include "newgrf_spritegroup.h"

    15

#include "newgrf_callbacks.h"

    16

#include "newgrf_industries.h"

    17

#include "newgrf_industrytiles.h"

    18

#include "newgrf_sound.h"

    19

#include "newgrf_text.h"

    20

#include "industry_map.h"

    21

#include "clear_map.h"

    22

#include "sprite.h"

    23

#include "transparency.h"

    24

#include "functions.h"

    25

#include "town.h"

    26

#include "command_func.h"

    27

#include "animated_tile_func.h"

    28

    29

#include "table/sprites.h"

    30

#include "table/strings.h"

    31

    32

static uint32 GetGRFParameter(IndustryGfx indtile_id, byte parameter)

    33

{

    34

	const IndustryTileSpec *indtspec = GetIndustryTileSpec(indtile_id);

    35

	const GRFFile *file = indtspec->grf_prop.grffile;

    36

    37

	if (parameter >= file->param_end) return 0;

    38

	return file->param[parameter];

    39

}

    40

    41

/**

    42

 * Based on newhouses equivalent, but adapted for newindustries

    43

 * @param parameter from callback.  It's in fact a pair of coordinates

    44

 * @param tile TileIndex from which the callback was initiated

    45

 * @param index of the industry been queried for

    46

 * @return a construction of bits obeying the newgrf format

    47

 */

    48

uint32 GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index)

    49

{

    50

	if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required

    51

	bool is_same_industry = (IsTileType(tile, MP_INDUSTRY) && GetIndustryIndex(tile) == index);

    52

    53

	return GetNearbyTileInformation(tile) | (is_same_industry ? 1 : 0) << 8;

    54

}

    55

    56

/** This is the position of the tile relative to the northernmost tile of the industry.

    57

 * Format: 00yxYYXX

    58

 * Variable  Content

    59

 * x         the x offset from the northernmost tile

    60

 * XX        same, but stored in a byte instead of a nibble

    61

 * y         the y offset from the northernmost tile

    62

 * YY        same, but stored in a byte instead of a nibble

    63

 * @param tile TileIndex of the tile to evaluate

    64

 * @param ind_tile northernmost tile of the industry

    65

 */

    66

static uint32 GetRelativePosition(TileIndex tile, TileIndex ind_tile)

    67

{

    68

	byte x = TileX(tile) - TileX(ind_tile);

    69

	byte y = TileY(tile) - TileY(ind_tile);

    70

    71

	return ((y & 0xF) << 20) | ((x & 0xF) << 16) | (y << 8) | x;

    72

}

    73

    74

static uint32 IndustryTileGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)

    75

{

    76

	const Industry *inds = object->u.industry.ind;

    77

	TileIndex tile       = object->u.industry.tile;

    78

    79

	if (object->scope == VSG_SCOPE_PARENT) {

    80

		return IndustryGetVariable(object, variable, parameter, available);

    81

	}

    82

    83

	switch (variable) {

    84

		 /* Construction state of the tile: a value between 0 and 3 */

    85

		case 0x40 : return (IsTileType(tile, MP_INDUSTRY)) ? GetIndustryConstructionStage(tile) : 0;

    86

    87

		case 0x41 : return GetTerrainType(tile);

    88

    89

		/* Current town zone of the tile in the nearest town */

    90

		case 0x42 : return GetTownRadiusGroup(ClosestTownFromTile(tile, (uint)-1), tile);

    91

    92

		/* Relative position */

    93

		case 0x43 : return GetRelativePosition(tile, inds->xy);

    94

    95

		/* Animation frame. Like house variable 46 but can contain anything 0..FF. */

    96

		case 0x44 : return (IsTileType(tile, MP_INDUSTRY)) ? GetIndustryAnimationState(tile) : 0;

    97

    98

		/* Land info of nearby tiles */

    99

		case 0x60 : return GetNearbyIndustryTileInformation(parameter, tile, inds == NULL ? (IndustryID)INVALID_INDUSTRY : inds->index);

   100

   101

		/* Animation stage of nearby tiles */

   102

		case 0x61 : {

   103

			tile = GetNearbyTile(parameter, tile);

   104

			if (IsTileType(tile, MP_INDUSTRY) && GetIndustryByTile(tile) == inds) {

   105

				return GetIndustryAnimationState(tile);

   106

			}

   107

			return 0xFFFFFFFF;

   108

		}

   109

   110

		/* Get industry tile ID at offset */

   111

		case 0x62 : return GetIndustryIDAtOffset(GetNearbyTile(parameter, tile), inds);

   112

   113

		/* Read GRF parameter */

   114

		case 0x7F: return GetGRFParameter(GetIndustryGfx(tile), parameter);

   115

	}

   116

   117

	DEBUG(grf, 1, "Unhandled industry tile property 0x%X", variable);

   118

   119

	*available = false;

   120

	return (uint32)-1;

   121

}

   122

   123

static const SpriteGroup *IndustryTileResolveReal(const ResolverObject *object, const SpriteGroup *group)

   124

{

   125

	/* IndustryTile do not have 'real' groups.  Or do they?? */

   126

	return NULL;

   127

}

   128

   129

static uint32 IndustryTileGetRandomBits(const ResolverObject *object)

   130

{

   131

	const TileIndex tile = object->u.industry.tile;

   132

	if (tile == INVALID_TILE || !IsTileType(tile, MP_INDUSTRY)) return 0;

   133

	return (object->scope == VSG_SCOPE_SELF) ? GetIndustryRandomBits(tile) : GetIndustryByTile(tile)->random;

   134

}

   135

   136

static uint32 IndustryTileGetTriggers(const ResolverObject *object)

   137

{

   138

	const TileIndex tile = object->u.industry.tile;

   139

	if (tile == INVALID_TILE || !IsTileType(tile, MP_INDUSTRY)) return 0;

   140

	return (object->scope == VSG_SCOPE_SELF) ? GetIndustryTriggers(tile) : GetIndustryByTile(tile)->random_triggers;

   141

}

   142

   143

static void IndustryTileSetTriggers(const ResolverObject *object, int triggers)

   144

{

   145

	const TileIndex tile = object->u.industry.tile;

   146

	if (tile == INVALID_TILE || !IsTileType(tile, MP_INDUSTRY)) return;

   147

   148

	if (object->scope == VSG_SCOPE_SELF) {

   149

		SetIndustryTriggers(tile, triggers);

   150

	} else {

   151

		GetIndustryByTile(tile)->random_triggers = triggers;

   152

	}

   153

}

   154

   155

static void NewIndustryTileResolver(ResolverObject *res, IndustryGfx gfx, TileIndex tile, Industry *indus)

   156

{

   157

	res->GetRandomBits = IndustryTileGetRandomBits;

   158

	res->GetTriggers   = IndustryTileGetTriggers;

   159

	res->SetTriggers   = IndustryTileSetTriggers;

   160

	res->GetVariable   = IndustryTileGetVariable;

   161

	res->ResolveReal   = IndustryTileResolveReal;

   162

   163

	res->psa             = &indus->psa;

   164

	res->u.industry.tile = tile;

   165

	res->u.industry.ind  = indus;

   166

	res->u.industry.gfx  = gfx;

   167

	res->u.industry.type = indus->type;

   168

   169

	res->callback        = CBID_NO_CALLBACK;

   170

	res->callback_param1 = 0;

   171

	res->callback_param2 = 0;

   172

	res->last_value      = 0;

   173

	res->trigger         = 0;

   174

	res->reseed          = 0;

   175

	res->count           = 0;

   176

}

   177

   178

void IndustryDrawTileLayout(const TileInfo *ti, const SpriteGroup *group, byte rnd_color, byte stage, IndustryGfx gfx)

   179

{

   180

	const DrawTileSprites *dts = group->g.layout.dts;

   181

	const DrawTileSeqStruct *dtss;

   182

   183

	SpriteID image = dts->ground.sprite;

   184

	SpriteID pal   = dts->ground.pal;

   185

   186

	if (IS_CUSTOM_SPRITE(image)) image += stage;

   187

   188

	if (GB(image, 0, SPRITE_WIDTH) != 0) DrawGroundSprite(image, pal);

   189

   190

	foreach_draw_tile_seq(dtss, dts->seq) {

   191

		if (GB(dtss->image.sprite, 0, SPRITE_WIDTH) == 0) continue;

   192

   193

		image = dtss->image.sprite;

   194

		pal   = dtss->image.pal;

   195

   196

		/* Stop drawing sprite sequence once we meet a sprite that doesn't have to be opaque */

   197

		if (IsInvisibilitySet(TO_INDUSTRIES) && !HasBit(image, SPRITE_MODIFIER_OPAQUE)) return;

   198

   199

		if (IS_CUSTOM_SPRITE(image)) image += stage;

   200

   201

		if (HasBit(image, PALETTE_MODIFIER_COLOR)) {

   202

			if (pal == 0) {

   203

				pal = GENERAL_SPRITE_COLOR(rnd_color);

   204

			}

   205

		} else {

   206

			pal = PAL_NONE;

   207

		}

   208

   209

		if ((byte)dtss->delta_z != 0x80) {

   210

			AddSortableSpriteToDraw(

   211

				image, pal,

   212

				ti->x + dtss->delta_x, ti->y + dtss->delta_y,

   213

				dtss->size_x, dtss->size_y,

   214

				dtss->size_z, ti->z + dtss->delta_z,

   215

				!HasBit(image, SPRITE_MODIFIER_OPAQUE) && IsTransparencySet(TO_INDUSTRIES)

   216

			);

   217

		} else {

   218

			AddChildSpriteScreen(image, pal, (byte)dtss->delta_x, (byte)dtss->delta_y, IsTransparencySet(TO_INDUSTRIES));

   219

		}

   220

	}

   221

}

   222

   223

uint16 GetIndustryTileCallback(CallbackID callback, uint32 param1, uint32 param2, IndustryGfx gfx_id, Industry *industry, TileIndex tile)

   224

{

   225

	ResolverObject object;

   226

	const SpriteGroup *group;

   227

   228

	NewIndustryTileResolver(&object, gfx_id, tile, industry);

   229

	object.callback = callback;

   230

	object.callback_param1 = param1;

   231

	object.callback_param2 = param2;

   232

   233

	group = Resolve(GetIndustryTileSpec(gfx_id)->grf_prop.spritegroup, &object);

   234

	if (group == NULL || group->type != SGT_CALLBACK) return CALLBACK_FAILED;

   235

   236

	return group->g.callback.result;

   237

}

   238

   239

bool DrawNewIndustryTile(TileInfo *ti, Industry *i, IndustryGfx gfx, const IndustryTileSpec *inds)

   240

{

   241

	const SpriteGroup *group;

   242

	ResolverObject object;

   243

   244

	if (ti->tileh != SLOPE_FLAT) {

   245

		bool draw_old_one = true;

   246

		if (HasBit(inds->callback_flags, CBM_INDT_DRAW_FOUNDATIONS)) {

   247

			/* Called to determine the type (if any) of foundation to draw for industry tile */

   248

			uint32 callback_res = GetIndustryTileCallback(CBID_INDUSTRY_DRAW_FOUNDATIONS, 0, 0, gfx, i, ti->tile);

   249

			draw_old_one = callback_res != 0;

   250

		}

   251

   252

		if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);

   253

	}

   254

   255

	NewIndustryTileResolver(&object, gfx, ti->tile, i);

   256

   257

	group = Resolve(inds->grf_prop.spritegroup, &object);

   258

	if (group == NULL || group->type != SGT_TILELAYOUT) {

   259

		return false;

   260

	} else {

   261

		/* Limit the building stage to the number of stages supplied. */

   262

		byte stage = GetIndustryConstructionStage(ti->tile);

   263

		stage = Clamp(stage - 4 + group->g.layout.num_sprites, 0, group->g.layout.num_sprites - 1);

   264

		IndustryDrawTileLayout(ti, group, i->random_color, stage, gfx);

   265

		return true;

   266

	}

   267

}

   268

   269

extern bool IsSlopeRefused(Slope current, Slope refused);

   270

   271

bool PerformIndustryTileSlopeCheck(TileIndex ind_base_tile, TileIndex ind_tile, const IndustryTileSpec *its, IndustryType type, IndustryGfx gfx, uint itspec_index)

   272

{

   273

	Industry ind;

   274

	ind.index = INVALID_INDUSTRY;

   275

	ind.xy = ind_base_tile;

   276

	ind.width = 0;

   277

	ind.type = type;

   278

   279

	uint16 callback_res = GetIndustryTileCallback(CBID_INDTILE_SHAPE_CHECK, 0, itspec_index, gfx, &ind, ind_tile);

   280

	if (callback_res == CALLBACK_FAILED) {

   281

		return !IsSlopeRefused(GetTileSlope(ind_tile, NULL), its->slopes_refused);

   282

	}

   283

	if (its->grf_prop.grffile->grf_version < 7) {

   284

		return callback_res != 0;

   285

	}

   286

   287

	/* Copy some parameters from the registers to the error message text ref. stack */

   288

	SwitchToErrorRefStack();

   289

	PrepareTextRefStackUsage(4);

   290

	SwitchToNormalRefStack();

   291

   292

	switch (callback_res) {

   293

		case 0x400: return true;

   294

		case 0x401: _error_message = STR_0239_SITE_UNSUITABLE;                 return false;

   295

		case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; return false;

   296

		case 0x403: _error_message = STR_0318_CAN_ONLY_BE_BUILT_IN_DESERT;     return false;

   297

		default: _error_message = GetGRFStringID(its->grf_prop.grffile->grfid, 0xD000 + callback_res); return false;

   298

	}

   299

}

   300

   301

void AnimateNewIndustryTile(TileIndex tile)

   302

{

   303

	Industry *ind = GetIndustryByTile(tile);

   304

	IndustryGfx gfx = GetIndustryGfx(tile);

   305

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   306

	byte animation_speed = itspec->animation_speed;

   307

   308

	if (HasBit(itspec->callback_flags, CBM_INDT_ANIM_SPEED)) {

   309

		uint16 callback_res = GetIndustryTileCallback(CBID_INDTILE_ANIMATION_SPEED, 0, 0, gfx, ind, tile);

   310

		if (callback_res != CALLBACK_FAILED) animation_speed = Clamp(callback_res & 0xFF, 0, 16);

   311

	}

   312

   313

	/* An animation speed of 2 means the animation frame changes 4 ticks, and

   314

	 * increasing this value by one doubles the wait. 0 is the minimum value

   315

	 * allowed for animation_speed, which corresponds to 30ms, and 16 is the

   316

	 * maximum, corresponding to around 33 minutes. */

   317

	if ((_tick_counter % (1 << animation_speed)) != 0) return;

   318

   319

	bool frame_set_by_callback = false;

   320

	byte frame = GetIndustryAnimationState(tile);

   321

	uint16 num_frames = GB(itspec->animation_info, 0, 8);

   322

   323

	if (HasBit(itspec->callback_flags, CBM_INDT_ANIM_NEXT_FRAME)) {

   324

		uint16 callback_res = GetIndustryTileCallback(CBID_INDTILE_ANIM_NEXT_FRAME, HasBit(itspec->animation_special_flags, 0) ? Random() : 0, 0, gfx, ind, tile);

   325

   326

		if (callback_res != CALLBACK_FAILED) {

   327

			frame_set_by_callback = true;

   328

   329

			switch (callback_res & 0xFF) {

   330

				case 0xFF:

   331

					DeleteAnimatedTile(tile);

   332

					break;

   333

				case 0xFE:

   334

					/* Carry on as normal. */

   335

					frame_set_by_callback = false;

   336

					break;

   337

				default:

   338

					frame = callback_res & 0xFF;

   339

					break;

   340

			}

   341

   342

			/* If the lower 7 bits of the upper byte of the callback

   343

			 * result are not empty, it is a sound effect. */

   344

			if (GB(callback_res, 8, 7) != 0) PlayTileSound(itspec->grf_prop.grffile, GB(callback_res, 8, 7), tile);

   345

		}

   346

	}

   347

   348

	if (!frame_set_by_callback) {

   349

		if (frame < num_frames) {

   350

			frame++;

   351

		} else if (frame == num_frames && GB(itspec->animation_info, 8, 8) == 1) {

   352

			/* This animation loops, so start again from the beginning */

   353

			frame = 0;

   354

		} else {

   355

			/* This animation doesn't loop, so stay here */

   356

			DeleteAnimatedTile(tile);

   357

		}

   358

	}

   359

   360

	SetIndustryAnimationState(tile, frame);

   361

	MarkTileDirtyByTile(tile);

   362

}

   363

   364

static void ChangeIndustryTileAnimationFrame(const IndustryTileSpec *itspec, TileIndex tile, IndustryAnimationTrigger iat, uint32 random_bits, IndustryGfx gfx, Industry *ind)

   365

{

   366

	uint16 callback_res = GetIndustryTileCallback(CBID_INDTILE_ANIM_START_STOP, random_bits, iat, gfx, ind, tile);

   367

	if (callback_res == CALLBACK_FAILED) return;

   368

   369

	switch (callback_res & 0xFF) {

   370

		case 0xFD: /* Do nothing. */         break;

   371

		case 0xFE: AddAnimatedTile(tile);    break;

   372

		case 0xFF: DeleteAnimatedTile(tile); break;

   373

		default:

   374

			SetIndustryAnimationState(tile, callback_res & 0xFF);

   375

			AddAnimatedTile(tile);

   376

			break;

   377

	}

   378

   379

	/* If the lower 7 bits of the upper byte of the callback

   380

	 * result are not empty, it is a sound effect. */

   381

	if (GB(callback_res, 8, 7) != 0) PlayTileSound(itspec->grf_prop.grffile, GB(callback_res, 8, 7), tile);

   382

}

   383

   384

bool StartStopIndustryTileAnimation(TileIndex tile, IndustryAnimationTrigger iat, uint32 random)

   385

{

   386

	IndustryGfx gfx = GetIndustryGfx(tile);

   387

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   388

   389

	if (!HasBit(itspec->animation_triggers, iat)) return false;

   390

   391

	Industry *ind = GetIndustryByTile(tile);

   392

	ChangeIndustryTileAnimationFrame(itspec, tile, iat, random, gfx, ind);

   393

	return true;

   394

}

   395

   396

bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat)

   397

{

   398

	bool ret = true;

   399

	uint32 random = Random();

   400

	BEGIN_TILE_LOOP(tile, ind->width, ind->height, ind->xy)

   401

		if (IsTileType(tile, MP_INDUSTRY) && GetIndustryIndex(tile) == ind->index) {

   402

			if (StartStopIndustryTileAnimation(tile, iat, random)) {

   403

				SB(random, 0, 16, Random());

   404

			} else {

   405

				ret = false;

   406

			}

   407

		}

   408

	END_TILE_LOOP(tile, ind->width, ind->height, ind->xy)

   409

   410

	return ret;

   411

}

   412

   413

static void DoTriggerIndustryTile(TileIndex tile, IndustryTileTrigger trigger, Industry *ind)

   414

{

   415

	ResolverObject object;

   416

   417

	IndustryGfx gfx = GetIndustryGfx(tile);

   418

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   419

   420

	if (itspec->grf_prop.spritegroup == NULL) return;

   421

   422

	NewIndustryTileResolver(&object, gfx, tile, ind);

   423

   424

	object.callback = CBID_RANDOM_TRIGGER;

   425

	object.trigger = trigger;

   426

   427

	const SpriteGroup *group = Resolve(itspec->grf_prop.spritegroup, &object);

   428

	if (group == NULL) return;

   429

   430

	byte new_random_bits = Random();

   431

	byte random_bits = GetIndustryRandomBits(tile);

   432

	random_bits &= ~object.reseed;

   433

	random_bits |= new_random_bits & object.reseed;

   434

	SetIndustryRandomBits(tile, random_bits);

   435

}

   436

   437

void TriggerIndustryTile(TileIndex tile, IndustryTileTrigger trigger)

   438

{

   439

	DoTriggerIndustryTile(tile, trigger, GetIndustryByTile(tile));

   440

}

   441

   442

void TriggerIndustry(Industry *ind, IndustryTileTrigger trigger)

   443

{

   444

	BEGIN_TILE_LOOP(tile, ind->width, ind->height, ind->xy)

   445

		if (IsTileType(tile, MP_INDUSTRY) && GetIndustryIndex(tile) == ind->index) {

   446

			DoTriggerIndustryTile(tile, trigger, ind);

   447

		}

   448

	END_TILE_LOOP(tile, ind->width, ind->height, ind->xy)

   449

}