1

/* $Id$ */

     2

     3

/** @file newgrf_industrytiles.cpp */

     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_text.h"

    19

#include "industry_map.h"

    20

#include "clear_map.h"

    21

#include "sprite.h"

    22

#include "transparency.h"

    23

#include "functions.h"

    24

#include "town.h"

    25

#include "command_func.h"

    26

    27

#include "table/sprites.h"

    28

#include "table/strings.h"

    29

    30

static uint32 GetGRFParameter(IndustryGfx indtile_id, byte parameter)

    31

{

    32

	const IndustryTileSpec *indtspec = GetIndustryTileSpec(indtile_id);

    33

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

    34

    35

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

    36

	return file->param[parameter];

    37

}

    38

    39

/**

    40

 * Based on newhouses equivalent, but adapted for newindustries

    41

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

    42

 * @param tile TileIndex from which the callback was initiated

    43

 * @param index of the industry been queried for

    44

 * @return a construction of bits obeying the newgrf format

    45

 */

    46

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

    47

{

    48

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

    49

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

    50

    51

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

    52

}

    53

    54

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

    55

 * Format: 00yxYYXX

    56

 * Variable  Content

    57

 * x         the x offset from the northernmost tile

    58

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

    59

 * y         the y offset from the northernmost tile

    60

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

    61

 * @param tile TileIndex of the tile to evaluate

    62

 * @param ind_tile northernmost tile of the industry

    63

 */

    64

static uint32 GetRelativePosition(TileIndex tile, TileIndex ind_tile)

    65

{

    66

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

    67

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

    68

    69

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

    70

}

    71

    72

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

    73

{

    74

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

    75

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

    76

    77

	if (object->scope == VSG_SCOPE_PARENT) {

    78

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

    79

	}

    80

    81

	switch (variable) {

    82

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

    83

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

    84

    85

		case 0x41 : return GetTerrainType(tile);

    86

    87

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

    88

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

    89

    90

		/* Relative position */

    91

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

    92

    93

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

    94

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

    95

    96

		/* Land info of nearby tiles */

    97

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

    98

    99

		/* Animation stage of nearby tiles */

   100

		case 0x61 : {

   101

			tile = GetNearbyTile(parameter, tile);

   102

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

   103

				return GetIndustryAnimationState(tile);

   104

			}

   105

			return 0xFFFFFFFF;

   106

		}

   107

   108

		/* Get industry tile ID at offset */

   109

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

   110

   111

		/* Read GRF parameter */

   112

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

   113

	}

   114

   115

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

   116

   117

	*available = false;

   118

	return (uint32)-1;

   119

}

   120

   121

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

   122

{

   123

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

   124

	return NULL;

   125

}

   126

   127

static uint32 IndustryTileGetRandomBits(const ResolverObject *object)

   128

{

   129

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

   130

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

   131

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

   132

}

   133

   134

static uint32 IndustryTileGetTriggers(const ResolverObject *object)

   135

{

   136

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

   137

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

   138

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

   139

}

   140

   141

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

   142

{

   143

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

   144

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

   145

   146

	if (object->scope == VSG_SCOPE_SELF) {

   147

		SetIndustryTriggers(tile, triggers);

   148

	} else {

   149

		GetIndustryByTile(tile)->random_triggers = triggers;

   150

	}

   151

}

   152

   153

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

   154

{

   155

	res->GetRandomBits = IndustryTileGetRandomBits;

   156

	res->GetTriggers   = IndustryTileGetTriggers;

   157

	res->SetTriggers   = IndustryTileSetTriggers;

   158

	res->GetVariable   = IndustryTileGetVariable;

   159

	res->ResolveReal   = IndustryTileResolveReal;

   160

   161

	res->psa             = &indus->psa;

   162

	res->u.industry.tile = tile;

   163

	res->u.industry.ind  = indus;

   164

	res->u.industry.gfx  = gfx;

   165

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

   166

   167

	res->callback        = CBID_NO_CALLBACK;

   168

	res->callback_param1 = 0;

   169

	res->callback_param2 = 0;

   170

	res->last_value      = 0;

   171

	res->trigger         = 0;

   172

	res->reseed          = 0;

   173

	res->count           = 0;

   174

}

   175

   176

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

   177

{

   178

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

   179

	const DrawTileSeqStruct *dtss;

   180

   181

	SpriteID image = dts->ground.sprite;

   182

	SpriteID pal   = dts->ground.pal;

   183

   184

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

   185

   186

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

   187

   188

	/* End now if industries are invisible */

   189

	if (IsInvisibilitySet(TO_INDUSTRIES)) return;

   190

   191

	foreach_draw_tile_seq(dtss, dts->seq) {

   192

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

   193

   194

		image = dtss->image.sprite;

   195

		pal   = dtss->image.pal;

   196

   197

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

   198

   199

		if (HasBit(image, PALETTE_MODIFIER_COLOR)) {

   200

			if (pal == 0) {

   201

				pal = GENERAL_SPRITE_COLOR(rnd_color);

   202

			}

   203

		} else {

   204

			pal = PAL_NONE;

   205

		}

   206

   207

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

   208

			AddSortableSpriteToDraw(

   209

				image, pal,

   210

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

   211

				dtss->size_x, dtss->size_y,

   212

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

   213

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

   214

			);

   215

		} else {

   216

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

   217

		}

   218

	}

   219

}

   220

   221

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

   222

{

   223

	ResolverObject object;

   224

	const SpriteGroup *group;

   225

   226

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

   227

	object.callback = callback;

   228

	object.callback_param1 = param1;

   229

	object.callback_param2 = param2;

   230

   231

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

   232

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

   233

   234

	return group->g.callback.result;

   235

}

   236

   237

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

   238

{

   239

	const SpriteGroup *group;

   240

	ResolverObject object;

   241

   242

	if (ti->tileh != SLOPE_FLAT) {

   243

		bool draw_old_one = true;

   244

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

   245

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

   246

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

   247

			draw_old_one = callback_res != 0;

   248

		}

   249

   250

		if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);

   251

	}

   252

   253

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

   254

   255

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

   256

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

   257

		return false;

   258

	} else {

   259

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

   260

		byte stage = GetIndustryConstructionStage(ti->tile);

   261

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

   262

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

   263

		return true;

   264

	}

   265

}

   266

   267

extern bool IsSlopeRefused(Slope current, Slope refused);

   268

   269

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

   270

{

   271

	Industry ind;

   272

	ind.index = INVALID_INDUSTRY;

   273

	ind.xy = ind_base_tile;

   274

	ind.width = 0;

   275

	ind.type = type;

   276

   277

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

   278

	if (callback_res == CALLBACK_FAILED) {

   279

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

   280

	}

   281

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

   282

		return (callback_res & 0xFF) != 0; // mask to 8 bit callback result

   283

	}

   284

   285

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

   286

	SwitchToErrorRefStack();

   287

	PrepareTextRefStackUsage(4);

   288

	SwitchToNormalRefStack();

   289

   290

	switch (callback_res) {

   291

		case 0x400: return true;

   292

		case 0x401: _error_message = STR_0239_SITE_UNSUITABLE;                 return false;

   293

		case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; return false;

   294

		case 0x403: _error_message = STR_0318_CAN_ONLY_BE_BUILT_IN_DESERT;     return false;

   295

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

   296

	}

   297

}

   298

   299

void AnimateNewIndustryTile(TileIndex tile)

   300

{

   301

	Industry *ind = GetIndustryByTile(tile);

   302

	IndustryGfx gfx = GetIndustryGfx(tile);

   303

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   304

	byte animation_speed = itspec->animation_speed;

   305

   306

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

   307

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

   308

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

   309

	}

   310

   311

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

   312

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

   313

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

   314

	 * maximum, corresponding to around 33 minutes. */

   315

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

   316

   317

	bool frame_set_by_callback = false;

   318

	byte frame = GetIndustryAnimationState(tile);

   319

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

   320

   321

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

   322

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

   323

   324

		if (callback_res != CALLBACK_FAILED) {

   325

			frame_set_by_callback = true;

   326

   327

			switch (callback_res & 0xFF) {

   328

				case 0xFF:

   329

					DeleteAnimatedTile(tile);

   330

					break;

   331

				case 0xFE:

   332

					/* Carry on as normal. */

   333

					frame_set_by_callback = false;

   334

					break;

   335

				default:

   336

					frame = callback_res & 0xFF;

   337

					break;

   338

			}

   339

		}

   340

	}

   341

   342

	if (!frame_set_by_callback) {

   343

		if (frame < num_frames) {

   344

			frame++;

   345

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

   346

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

   347

			frame = 0;

   348

		} else {

   349

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

   350

			DeleteAnimatedTile(tile);

   351

		}

   352

	}

   353

   354

	SetIndustryAnimationState(tile, frame);

   355

	MarkTileDirtyByTile(tile);

   356

}

   357

   358

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

   359

{

   360

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

   361

	if (callback_res == CALLBACK_FAILED) return;

   362

   363

	switch (callback_res & 0xFF) {

   364

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

   365

		case 0xFE: AddAnimatedTile(tile);    break;

   366

		case 0xFF: DeleteAnimatedTile(tile); break;

   367

		default:

   368

			SetIndustryAnimationState(tile, callback_res & 0xFF);

   369

			AddAnimatedTile(tile);

   370

			break;

   371

	}

   372

}

   373

   374

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

   375

{

   376

	IndustryGfx gfx = GetIndustryGfx(tile);

   377

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   378

   379

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

   380

   381

	Industry *ind = GetIndustryByTile(tile);

   382

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

   383

	return true;

   384

}

   385

   386

bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat)

   387

{

   388

	bool ret = true;

   389

	uint32 random = Random();

   390

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

   391

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

   392

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

   393

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

   394

			} else {

   395

				ret = false;

   396

			}

   397

		}

   398

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

   399

   400

	return ret;

   401

}

   402

   403

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

   404

{

   405

	ResolverObject object;

   406

   407

	IndustryGfx gfx = GetIndustryGfx(tile);

   408

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   409

   410

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

   411

   412

	object.callback = CBID_RANDOM_TRIGGER;

   413

	object.trigger = trigger;

   414

   415

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

   416

	if (group == NULL) return;

   417

   418

	byte new_random_bits = Random();

   419

	byte random_bits = GetIndustryRandomBits(tile);

   420

	random_bits &= ~object.reseed;

   421

	random_bits |= new_random_bits & object.reseed;

   422

	SetIndustryRandomBits(tile, random_bits);

   423

}

   424

   425

void TriggerIndustryTile(TileIndex tile, IndustryTileTrigger trigger)

   426

{

   427

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

   428

}

   429

   430

void TriggerIndustry(Industry *ind, IndustryTileTrigger trigger)

   431

{

   432

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

   433

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

   434

			DoTriggerIndustryTile(tile, trigger, ind);

   435

		}

   436

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

   437

}