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

#include "water.h"

    29

    30

#include "table/sprites.h"

    31

#include "table/strings.h"

    32

    33

/**

    34

 * Based on newhouses equivalent, but adapted for newindustries

    35

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

    36

 * @param tile TileIndex from which the callback was initiated

    37

 * @param index of the industry been queried for

    38

 * @return a construction of bits obeying the newgrf format

    39

 */

    40

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

    41

{

    42

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

    43

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

    44

    45

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

    46

}

    47

    48

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

    49

 * Format: 00yxYYXX

    50

 * Variable  Content

    51

 * x         the x offset from the northernmost tile

    52

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

    53

 * y         the y offset from the northernmost tile

    54

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

    55

 * @param tile TileIndex of the tile to evaluate

    56

 * @param ind_tile northernmost tile of the industry

    57

 */

    58

static uint32 GetRelativePosition(TileIndex tile, TileIndex ind_tile)

    59

{

    60

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

    61

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

    62

    63

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

    64

}

    65

    66

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

    67

{

    68

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

    69

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

    70

    71

	if (object->scope == VSG_SCOPE_PARENT) {

    72

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

    73

	}

    74

    75

	switch (variable) {

    76

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

    77

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

    78

    79

		case 0x41 : return GetTerrainType(tile);

    80

    81

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

    82

		case 0x42 : return GetTownRadiusGroup(ClosestTownFromTile(tile, UINT_MAX), tile);

    83

    84

		/* Relative position */

    85

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

    86

    87

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

    88

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

    89

    90

		/* Land info of nearby tiles */

    91

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

    92

    93

		/* Animation stage of nearby tiles */

    94

		case 0x61 : {

    95

			tile = GetNearbyTile(parameter, tile);

    96

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

    97

				return GetIndustryAnimationState(tile);

    98

			}

    99

			return 0xFFFFFFFF;

   100

		}

   101

   102

		/* Get industry tile ID at offset */

   103

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

   104

	}

   105

   106

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

   107

   108

	*available = false;

   109

	return (uint32)-1;

   110

}

   111

   112

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

   113

{

   114

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

   115

	return NULL;

   116

}

   117

   118

static uint32 IndustryTileGetRandomBits(const ResolverObject *object)

   119

{

   120

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

   121

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

   122

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

   123

}

   124

   125

static uint32 IndustryTileGetTriggers(const ResolverObject *object)

   126

{

   127

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

   128

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

   129

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

   130

}

   131

   132

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

   133

{

   134

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

   135

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

   136

   137

	if (object->scope == VSG_SCOPE_SELF) {

   138

		SetIndustryTriggers(tile, triggers);

   139

	} else {

   140

		GetIndustryByTile(tile)->random_triggers = triggers;

   141

	}

   142

}

   143

   144

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

   145

{

   146

	res->GetRandomBits = IndustryTileGetRandomBits;

   147

	res->GetTriggers   = IndustryTileGetTriggers;

   148

	res->SetTriggers   = IndustryTileSetTriggers;

   149

	res->GetVariable   = IndustryTileGetVariable;

   150

	res->ResolveReal   = IndustryTileResolveReal;

   151

   152

	res->psa             = &indus->psa;

   153

	res->u.industry.tile = tile;

   154

	res->u.industry.ind  = indus;

   155

	res->u.industry.gfx  = gfx;

   156

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

   157

   158

	res->callback        = CBID_NO_CALLBACK;

   159

	res->callback_param1 = 0;

   160

	res->callback_param2 = 0;

   161

	res->last_value      = 0;

   162

	res->trigger         = 0;

   163

	res->reseed          = 0;

   164

	res->count           = 0;

   165

   166

	const IndustryTileSpec *its = GetIndustryTileSpec(gfx);

   167

	res->grffile         = (its != NULL ? its->grf_prop.grffile : NULL);

   168

}

   169

   170

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

   171

{

   172

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

   173

	const DrawTileSeqStruct *dtss;

   174

   175

	SpriteID image = dts->ground.sprite;

   176

	SpriteID pal   = dts->ground.pal;

   177

   178

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

   179

   180

	if (GB(image, 0, SPRITE_WIDTH) != 0) {

   181

		/* If the ground sprite is the default flat water sprite, draw also canal/river borders

   182

		 * Do not do this if the tile's WaterClass is 'land'. */

   183

		if (image == SPR_FLAT_WATER_TILE && IsIndustryTileOnWater(ti->tile)) {

   184

			DrawWaterClassGround(ti);

   185

		} else {

   186

			DrawGroundSprite(image, pal);

   187

		}

   188

	}

   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_TRANSPARENT) || 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

			/* For industries and houses delta_x and delta_y are unsigned */

   219

			AddChildSpriteScreen(image, pal, (byte)dtss->delta_x, (byte)dtss->delta_y, !HasBit(image, SPRITE_MODIFIER_OPAQUE) && IsTransparencySet(TO_INDUSTRIES));

   220

		}

   221

	}

   222

}

   223

   224

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

   225

{

   226

	ResolverObject object;

   227

	const SpriteGroup *group;

   228

   229

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

   230

	object.callback = callback;

   231

	object.callback_param1 = param1;

   232

	object.callback_param2 = param2;

   233

   234

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

   235

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

   236

   237

	return group->g.callback.result;

   238

}

   239

   240

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

   241

{

   242

	const SpriteGroup *group;

   243

	ResolverObject object;

   244

   245

	if (ti->tileh != SLOPE_FLAT) {

   246

		bool draw_old_one = true;

   247

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

   248

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

   249

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

   250

			draw_old_one = callback_res != 0;

   251

		}

   252

   253

		if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);

   254

	}

   255

   256

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

   257

   258

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

   259

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

   260

		return false;

   261

	} else {

   262

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

   263

		byte stage = GetIndustryConstructionStage(ti->tile);

   264

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

   265

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

   266

		return true;

   267

	}

   268

}

   269

   270

extern bool IsSlopeRefused(Slope current, Slope refused);

   271

   272

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

   273

{

   274

	Industry ind;

   275

	ind.index = INVALID_INDUSTRY;

   276

	ind.xy = ind_base_tile;

   277

	ind.width = 0;

   278

	ind.type = type;

   279

   280

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

   281

	if (callback_res == CALLBACK_FAILED) {

   282

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

   283

	}

   284

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

   285

		return callback_res != 0;

   286

	}

   288

   289

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

   290

	SwitchToErrorRefStack();

   291

	PrepareTextRefStackUsage(4);

   292

	SwitchToNormalRefStack();

   293

   294

	switch (callback_res) {

   295

		case 0x401: _error_message = STR_0239_SITE_UNSUITABLE;                 return false;

   296

		case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; return false;

   297

		case 0x403: _error_message = STR_0318_CAN_ONLY_BE_BUILT_IN_DESERT;     return false;

   298

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

   299

	}

   300

}

   301

   302

void AnimateNewIndustryTile(TileIndex tile)

   303

{

   304

	Industry *ind = GetIndustryByTile(tile);

   305

	IndustryGfx gfx = GetIndustryGfx(tile);

   306

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   307

	byte animation_speed = itspec->animation_speed;

   308

   309

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

   310

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

   311

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

   312

	}

   313

   314

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

   315

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

   316

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

   317

	 * maximum, corresponding to around 33 minutes. */

   318

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

   319

   320

	bool frame_set_by_callback = false;

   321

	byte frame = GetIndustryAnimationState(tile);

   322

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

   323

   324

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

   325

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

   326

   327

		if (callback_res != CALLBACK_FAILED) {

   328

			frame_set_by_callback = true;

   329

   330

			switch (callback_res & 0xFF) {

   331

				case 0xFF:

   332

					DeleteAnimatedTile(tile);

   333

					break;

   334

				case 0xFE:

   335

					/* Carry on as normal. */

   336

					frame_set_by_callback = false;

   337

					break;

   338

				default:

   339

					frame = callback_res & 0xFF;

   340

					break;

   341

			}

   342

   343

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

   344

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

   345

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

   346

		}

   347

	}

   348

   349

	if (!frame_set_by_callback) {

   350

		if (frame < num_frames) {

   351

			frame++;

   352

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

   353

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

   354

			frame = 0;

   355

		} else {

   356

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

   357

			DeleteAnimatedTile(tile);

   358

		}

   359

	}

   360

   361

	SetIndustryAnimationState(tile, frame);

   362

	MarkTileDirtyByTile(tile);

   363

}

   364

   365

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

   366

{

   367

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

   368

	if (callback_res == CALLBACK_FAILED) return;

   369

   370

	switch (callback_res & 0xFF) {

   371

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

   372

		case 0xFE: AddAnimatedTile(tile);    break;

   373

		case 0xFF: DeleteAnimatedTile(tile); break;

   374

		default:

   375

			SetIndustryAnimationState(tile, callback_res & 0xFF);

   376

			AddAnimatedTile(tile);

   377

			break;

   378

	}

   379

   380

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

   381

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

   382

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

   383

}

   384

   385

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

   386

{

   387

	IndustryGfx gfx = GetIndustryGfx(tile);

   388

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   389

   390

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

   391

   392

	Industry *ind = GetIndustryByTile(tile);

   393

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

   394

	return true;

   395

}

   396

   397

bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat)

   398

{

   399

	bool ret = true;

   400

	uint32 random = Random();

   401

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

   402

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

   403

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

   404

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

   405

			} else {

   406

				ret = false;

   407

			}

   408

		}

   409

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

   410

   411

	return ret;

   412

}

   413

   414

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

   415

{

   416

	ResolverObject object;

   417

   418

	IndustryGfx gfx = GetIndustryGfx(tile);

   419

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   420

   421

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

   422

   423

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

   424

   425

	object.callback = CBID_RANDOM_TRIGGER;

   426

	object.trigger = trigger;

   427

   428

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

   429

	if (group == NULL) return;

   430

   431

	byte new_random_bits = Random();

   432

	byte random_bits = GetIndustryRandomBits(tile);

   433

	random_bits &= ~object.reseed;

   434

	random_bits |= new_random_bits & object.reseed;

   435

	SetIndustryRandomBits(tile, random_bits);

   436

}

   437

   438

void TriggerIndustryTile(TileIndex tile, IndustryTileTrigger trigger)

   439

{

   440

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

   441

}

   442

   443

void TriggerIndustry(Industry *ind, IndustryTileTrigger trigger)

   444

{

   445

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

   446

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

   447

			DoTriggerIndustryTile(tile, trigger, ind);

   448

		}

   449

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

   450

}