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"

    27

    28

#include "table/sprites.h"

    29

#include "table/strings.h"

    30

    31

static uint32 GetGRFParameter(IndustryGfx indtile_id, byte parameter)

    32

{

    33

	const IndustryTileSpec *indtspec = GetIndustryTileSpec(indtile_id);

    34

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

    35

    36

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

    37

	return file->param[parameter];

    38

}

    39

    40

/**

    41

 * Based on newhouses equivalent, but adapted for newindustries

    42

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

    43

 * @param tile TileIndex from which the callback was initiated

    44

 * @param index of the industry been queried for

    45

 * @return a construction of bits obeying the newgrf format

    46

 */

    47

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

    48

{

    49

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

    50

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

    51

    52

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

    53

}

    54

    55

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

    56

 * Format: 00yxYYXX

    57

 * Variable  Content

    58

 * x         the x offset from the northernmost tile

    59

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

    60

 * y         the y offset from the northernmost tile

    61

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

    62

 * @param tile TileIndex of the tile to evaluate

    63

 * @param ind_tile northernmost tile of the industry

    64

 */

    65

static uint32 GetRelativePosition(TileIndex tile, TileIndex ind_tile)

    66

{

    67

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

    68

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

    69

    70

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

    71

}

    72

    73

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

    74

{

    75

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

    76

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

    77

    78

	if (object->scope == VSG_SCOPE_PARENT) {

    79

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

    80

	}

    81

    82

	switch (variable) {

    83

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

    84

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

    85

    86

		case 0x41 : return GetTerrainType(tile);

    87

    88

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

    89

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

    90

    91

		/* Relative position */

    92

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

    93

    94

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

    95

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

    96

    97

		/* Land info of nearby tiles */

    98

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

    99

   100

		/* Animation stage of nearby tiles */

   101

		case 0x61 : {

   102

			tile = GetNearbyTile(parameter, tile);

   103

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

   104

				return GetIndustryAnimationState(tile);

   105

			}

   106

			return 0xFFFFFFFF;

   107

		}

   108

   109

		/* Get industry tile ID at offset */

   110

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

   111

   112

		/* Read GRF parameter */

   113

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

   114

	}

   115

   116

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

   117

   118

	*available = false;

   119

	return (uint32)-1;

   120

}

   121

   122

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

   123

{

   124

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

   125

	return NULL;

   126

}

   127

   128

static uint32 IndustryTileGetRandomBits(const ResolverObject *object)

   129

{

   130

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

   131

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

   132

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

   133

}

   134

   135

static uint32 IndustryTileGetTriggers(const ResolverObject *object)

   136

{

   137

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

   138

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

   139

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

   140

}

   141

   142

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

   143

{

   144

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

   145

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

   146

   147

	if (object->scope == VSG_SCOPE_SELF) {

   148

		SetIndustryTriggers(tile, triggers);

   149

	} else {

   150

		GetIndustryByTile(tile)->random_triggers = triggers;

   151

	}

   152

}

   153

   154

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

   155

{

   156

	res->GetRandomBits = IndustryTileGetRandomBits;

   157

	res->GetTriggers   = IndustryTileGetTriggers;

   158

	res->SetTriggers   = IndustryTileSetTriggers;

   159

	res->GetVariable   = IndustryTileGetVariable;

   160

	res->ResolveReal   = IndustryTileResolveReal;

   161

   162

	res->psa             = &indus->psa;

   163

	res->u.industry.tile = tile;

   164

	res->u.industry.ind  = indus;

   165

	res->u.industry.gfx  = gfx;

   166

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

   167

   168

	res->callback        = CBID_NO_CALLBACK;

   169

	res->callback_param1 = 0;

   170

	res->callback_param2 = 0;

   171

	res->last_value      = 0;

   172

	res->trigger         = 0;

   173

	res->reseed          = 0;

   174

	res->count           = 0;

   175

}

   176

   177

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

   178

{

   179

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

   180

	const DrawTileSeqStruct *dtss;

   181

   182

	SpriteID image = dts->ground.sprite;

   183

	SpriteID pal   = dts->ground.pal;

   184

   185

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

   186

   187

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

   188

   189

	/* End now if industries are invisible */

   190

	if (IsInvisibilitySet(TO_INDUSTRIES)) return;

   191

   192

	foreach_draw_tile_seq(dtss, dts->seq) {

   193

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

   194

   195

		image = dtss->image.sprite;

   196

		pal   = dtss->image.pal;

   197

   198

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

   199

   200

		if (HasBit(image, PALETTE_MODIFIER_COLOR)) {

   201

			if (pal == 0) {

   202

				pal = GENERAL_SPRITE_COLOR(rnd_color);

   203

			}

   204

		} else {

   205

			pal = PAL_NONE;

   206

		}

   207

   208

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

   209

			AddSortableSpriteToDraw(

   210

				image, pal,

   211

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

   212

				dtss->size_x, dtss->size_y,

   213

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

   214

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

   215

			);

   216

		} else {

   217

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

   218

		}

   219

	}

   220

}

   221

   222

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

   223

{

   224

	ResolverObject object;

   225

	const SpriteGroup *group;

   226

   227

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

   228

	object.callback = callback;

   229

	object.callback_param1 = param1;

   230

	object.callback_param2 = param2;

   231

   232

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

   233

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

   234

   235

	return group->g.callback.result;

   236

}

   237

   238

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

   239

{

   240

	const SpriteGroup *group;

   241

	ResolverObject object;

   242

   243

	if (ti->tileh != SLOPE_FLAT) {

   244

		bool draw_old_one = true;

   245

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

   246

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

   247

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

   248

			draw_old_one = callback_res != 0;

   249

		}

   250

   251

		if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);

   252

	}

   253

   254

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

   255

   256

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

   257

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

   258

		return false;

   259

	} else {

   260

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

   261

		byte stage = GetIndustryConstructionStage(ti->tile);

   262

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

   263

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

   264

		return true;

   265

	}

   266

}

   267

   268

extern bool IsSlopeRefused(Slope current, Slope refused);

   269

   270

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

   271

{

   272

	Industry ind;

   273

	ind.index = INVALID_INDUSTRY;

   274

	ind.xy = ind_base_tile;

   275

	ind.width = 0;

   276

	ind.type = type;

   277

   278

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

   279

	if (callback_res == CALLBACK_FAILED) {

   280

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

   281

	}

   282

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

   283

		return callback_res != 0;

   284

	}

   285

   286

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

   287

	SwitchToErrorRefStack();

   288

	PrepareTextRefStackUsage(4);

   289

	SwitchToNormalRefStack();

   290

   291

	switch (callback_res) {

   292

		case 0x400: return true;

   293

		case 0x401: _error_message = STR_0239_SITE_UNSUITABLE;                 return false;

   294

		case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; return false;

   295

		case 0x403: _error_message = STR_0318_CAN_ONLY_BE_BUILT_IN_DESERT;     return false;

   296

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

   297

	}

   298

}

   299

   300

void AnimateNewIndustryTile(TileIndex tile)

   301

{

   302

	Industry *ind = GetIndustryByTile(tile);

   303

	IndustryGfx gfx = GetIndustryGfx(tile);

   304

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   305

	byte animation_speed = itspec->animation_speed;

   306

   307

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

   308

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

   309

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

   310

	}

   311

   312

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

   313

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

   314

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

   315

	 * maximum, corresponding to around 33 minutes. */

   316

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

   317

   318

	bool frame_set_by_callback = false;

   319

	byte frame = GetIndustryAnimationState(tile);

   320

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

   321

   322

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

   323

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

   324

   325

		if (callback_res != CALLBACK_FAILED) {

   326

			frame_set_by_callback = true;

   327

   328

			switch (callback_res & 0xFF) {

   329

				case 0xFF:

   330

					DeleteAnimatedTile(tile);

   331

					break;

   332

				case 0xFE:

   333

					/* Carry on as normal. */

   334

					frame_set_by_callback = false;

   335

					break;

   336

				default:

   337

					frame = callback_res & 0xFF;

   338

					break;

   339

			}

   340

		}

   341

	}

   342

   343

	if (!frame_set_by_callback) {

   344

		if (frame < num_frames) {

   345

			frame++;

   346

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

   347

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

   348

			frame = 0;

   349

		} else {

   350

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

   351

			DeleteAnimatedTile(tile);

   352

		}

   353

	}

   354

   355

	SetIndustryAnimationState(tile, frame);

   356

	MarkTileDirtyByTile(tile);

   357

}

   358

   359

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

   360

{

   361

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

   362

	if (callback_res == CALLBACK_FAILED) return;

   363

   364

	switch (callback_res & 0xFF) {

   365

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

   366

		case 0xFE: AddAnimatedTile(tile);    break;

   367

		case 0xFF: DeleteAnimatedTile(tile); break;

   368

		default:

   369

			SetIndustryAnimationState(tile, callback_res & 0xFF);

   370

			AddAnimatedTile(tile);

   371

			break;

   372

	}

   373

}

   374

   375

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

   376

{

   377

	IndustryGfx gfx = GetIndustryGfx(tile);

   378

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   379

   380

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

   381

   382

	Industry *ind = GetIndustryByTile(tile);

   383

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

   384

	return true;

   385

}

   386

   387

bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat)

   388

{

   389

	bool ret = true;

   390

	uint32 random = Random();

   391

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

   392

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

   393

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

   394

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

   395

			} else {

   396

				ret = false;

   397

			}

   398

		}

   399

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

   400

   401

	return ret;

   402

}

   403

   404

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

   405

{

   406

	ResolverObject object;

   407

   408

	IndustryGfx gfx = GetIndustryGfx(tile);

   409

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   410

   411

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

   412

   413

	object.callback = CBID_RANDOM_TRIGGER;

   414

	object.trigger = trigger;

   415

   416

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

   417

	if (group == NULL) return;

   418

   419

	byte new_random_bits = Random();

   420

	byte random_bits = GetIndustryRandomBits(tile);

   421

	random_bits &= ~object.reseed;

   422

	random_bits |= new_random_bits & object.reseed;

   423

	SetIndustryRandomBits(tile, random_bits);

   424

}

   425

   426

void TriggerIndustryTile(TileIndex tile, IndustryTileTrigger trigger)

   427

{

   428

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

   429

}

   430

   431

void TriggerIndustry(Industry *ind, IndustryTileTrigger trigger)

   432

{

   433

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

   434

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

   435

			DoTriggerIndustryTile(tile, trigger, ind);

   436

		}

   437

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

   438

}