1

/* $Id$ */

     2

     3

/** @file newgrf_industrytiles.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "variables.h"

     9

#include "debug.h"

    10

#include "viewport.h"

    11

#include "landscape.h"

    12

#include "newgrf.h"

    13

#include "industry.h"

    14

#include "newgrf_commons.h"

    15

#include "newgrf_spritegroup.h"

    16

#include "newgrf_callbacks.h"

    17

#include "newgrf_industries.h"

    18

#include "newgrf_industrytiles.h"

    19

#include "newgrf_text.h"

    20

#include "industry_map.h"

    21

#include "clear_map.h"

    22

#include "table/sprites.h"

    23

#include "table/strings.h"

    24

#include "sprite.h"

    25

    26

/**

    27

 * Based on newhouses equivalent, but adapted for newindustries

    28

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

    29

 * @param tile TileIndex from which the callback was initiated

    30

 * @param index of the industry been queried for

    31

 * @return a construction of bits obeying the newgrf format

    32

 */

    33

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

    34

{

    35

	byte tile_type;

    36

	bool is_same_industry;

    37

    38

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

    39

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

    40

	tile_type = GetTerrainType(tile) << 2 | (IsTileType(tile, MP_WATER) ? 1 : 0) << 1 | (is_same_industry ? 1 : 0);

    41

    42

	uint z;

    43

	Slope tileh = GetTileSlope(tile, &z);

    44

	return GetTileType(tile) << 24 | z << 16 | tile_type << 8 | tileh;

    45

}

    46

    47

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

    48

 * Format: 00yxYYXX

    49

 * Variable  Content

    50

 * x         the x offset from the northernmost tile

    51

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

    52

 * y         the y offset from the northernmost tile

    53

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

    54

 * @param tile TileIndex of the tile to evaluate

    55

 * @param ind_tile northernmost tile of the industry

    56

 */

    57

static uint32 GetRelativePosition(TileIndex tile, TileIndex ind_tile)

    58

{

    59

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

    60

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

    61

    62

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

    63

}

    64

    65

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

    66

{

    67

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

    68

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

    69

    70

	if (object->scope == VSG_SCOPE_PARENT) {

    71

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

    72

	}

    73

    74

	switch (variable) {

    75

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

    76

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

    77

    78

		case 0x41 : return GetTerrainType(tile);

    79

    80

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

    81

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

    82

    83

		/* Relative position */

    84

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

    85

    86

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

    87

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

    88

    89

		/* Land info of nearby tiles */

    90

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

    91

    92

		/* Animation stage of nearby tiles */

    93

		case 0x61 : {

    94

			tile = GetNearbyTile(parameter, tile);

    95

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

    96

				return GetIndustryAnimationState(tile);

    97

			}

    98

			return 0xFFFFFFFF;

    99

		}

   100

   101

		/* Get industry tile ID at offset */

   102

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

   103

	}

   104

   105

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

   106

   107

	*available = false;

   108

	return (uint32)-1;

   109

}

   110

   111

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

   112

{

   113

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

   114

	return NULL;

   115

}

   116

   117

uint32 IndustryTileGetRandomBits(const ResolverObject *object)

   118

{

   119

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

   120

	return (tile == INVALID_TILE || !IsTileType(tile, MP_INDUSTRY)) ? 0 : GetIndustryRandomBits(tile);

   121

}

   122

   123

uint32 IndustryTileGetTriggers(const ResolverObject *object)

   124

{

   125

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

   126

	return (tile == INVALID_TILE || !IsTileType(tile, MP_INDUSTRY)) ? 0 : GetIndustryTriggers(tile);

   127

}

   128

   129

void IndustryTileSetTriggers(const ResolverObject *object, int triggers)

   130

{

   131

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

   132

	if (IsTileType(tile, MP_INDUSTRY)) SetIndustryTriggers(tile, triggers);

   133

}

   134

   135

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

   136

{

   137

	res->GetRandomBits = IndustryTileGetRandomBits;

   138

	res->GetTriggers   = IndustryTileGetTriggers;

   139

	res->SetTriggers   = IndustryTileSetTriggers;

   140

	res->GetVariable   = IndustryTileGetVariable;

   141

	res->ResolveReal   = IndustryTileResolveReal;

   142

   143

	res->u.industry.tile = tile;

   144

	res->u.industry.ind  = indus;

   145

	res->u.industry.gfx  = gfx;

   146

   147

	res->callback        = CBID_NO_CALLBACK;

   148

	res->callback_param1 = 0;

   149

	res->callback_param2 = 0;

   150

	res->last_value      = 0;

   151

	res->trigger         = 0;

   152

	res->reseed          = 0;

   153

}

   154

   155

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

   156

{

   157

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

   158

	const DrawTileSeqStruct *dtss;

   159

   160

	SpriteID image = dts->ground_sprite;

   161

	SpriteID pal   = dts->ground_pal;

   162

   163

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

   164

   165

	foreach_draw_tile_seq(dtss, dts->seq) {

   166

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

   167

   168

		image = dtss->image + stage;

   169

		pal   = dtss->pal;

   170

   171

		if (HASBIT(image, PALETTE_MODIFIER_COLOR)) {

   172

			pal = GENERAL_SPRITE_COLOR(rnd_color);

   173

		} else {

   174

			pal = PAL_NONE;

   175

		}

   176

   177

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

   178

			AddSortableSpriteToDraw(

   179

				image, pal,

   180

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

   181

				dtss->size_x, dtss->size_y,

   182

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

   183

				!HASBIT(image, SPRITE_MODIFIER_OPAQUE) && HASBIT(_transparent_opt, TO_INDUSTRIES)

   184

			);

   185

		} else {

   186

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

   187

		}

   188

	}

   189

}

   190

   191

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

   192

{

   193

	ResolverObject object;

   194

	const SpriteGroup *group;

   195

   196

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

   197

	object.callback = callback;

   198

	object.callback_param1 = param1;

   199

	object.callback_param2 = param2;

   200

   201

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

   202

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

   203

   204

	return group->g.callback.result;

   205

}

   206

   207

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

   208

{

   209

	const SpriteGroup *group;

   210

	ResolverObject object;

   211

   212

	if (ti->tileh != SLOPE_FLAT) {

   213

		bool draw_old_one = true;

   214

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

   215

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

   216

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

   217

			draw_old_one = callback_res != 0;

   218

		}

   219

   220

		if (draw_old_one) DrawFoundation(ti, FOUNDATION_LEVELED);

   221

	}

   222

   223

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

   224

   225

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

   226

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

   227

		return false;

   228

	} else {

   229

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

   230

		byte stage = GetIndustryConstructionStage(ti->tile);

   231

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

   232

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

   233

		return true;

   234

	}

   235

}

   236

   237

bool PerformIndustryTileSlopeCheck(TileIndex tile, const IndustryTileSpec *its, IndustryType type, IndustryGfx gfx)

   238

{

   239

	Industry ind;

   240

	ind.xy = 0;

   241

	ind.width = 0;

   242

	ind.type = type;

   243

   244

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

   245

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

   246

		return callback_res != 0;

   247

	}

   248

	if (callback_res == CALLBACK_FAILED) return false;

   249

   250

	switch (callback_res) {

   251

		case 0x400: return true;

   252

		case 0x401: _error_message = STR_0239_SITE_UNSUITABLE;                 return false;

   253

		case 0x402: _error_message = STR_0317_CAN_ONLY_BE_BUILT_IN_RAINFOREST; return false;

   254

		case 0x403: _error_message = STR_0318_CAN_ONLY_BE_BUILT_IN_DESERT;     return false;

   255

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

   256

	}

   257

}

   258

   259

void AnimateNewIndustryTile(TileIndex tile)

   260

{

   261

	Industry *ind = GetIndustryByTile(tile);

   262

	IndustryGfx gfx = GetIndustryGfx(tile);

   263

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   264

	byte animation_speed = itspec->animation_speed;

   265

   266

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

   267

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

   268

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

   269

	}

   270

   271

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

   272

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

   273

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

   274

	 * maximum, corresponding to around 33 minutes. */

   275

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

   276

   277

	bool frame_set_by_callback = false;

   278

	byte frame = GetIndustryAnimationState(tile);

   279

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

   280

   281

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

   282

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

   283

   284

		if (callback_res != CALLBACK_FAILED) {

   285

			frame_set_by_callback = true;

   286

   287

			switch (callback_res & 0xFF) {

   288

				case 0xFF:

   289

					DeleteAnimatedTile(tile);

   290

					break;

   291

				case 0xFE:

   292

					/* Carry on as normal. */

   293

					frame_set_by_callback = false;

   294

					break;

   295

				default:

   296

					frame = callback_res & 0xFF;

   297

					break;

   298

			}

   299

		}

   300

	}

   301

   302

	if (!frame_set_by_callback) {

   303

		if (frame < num_frames) {

   304

			frame++;

   305

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

   306

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

   307

			frame = 0;

   308

		} else {

   309

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

   310

			DeleteAnimatedTile(tile);

   311

		}

   312

	}

   313

   314

	SetIndustryAnimationState(tile, frame);

   315

	MarkTileDirtyByTile(tile);

   316

}

   317

   318

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

   319

{

   320

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

   321

	if (callback_res == CALLBACK_FAILED) return;

   322

   323

	switch (callback_res & 0xFF) {

   324

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

   325

		case 0xFE: AddAnimatedTile(tile);    break;

   326

		case 0xFF: DeleteAnimatedTile(tile); break;

   327

		default:

   328

			SetIndustryAnimationState(tile, callback_res & 0xFF);

   329

			AddAnimatedTile(tile);

   330

			break;

   331

	}

   332

}

   333

   334

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

   335

{

   336

	IndustryGfx gfx = GetIndustryGfx(tile);

   337

	const IndustryTileSpec *itspec = GetIndustryTileSpec(gfx);

   338

   339

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

   340

   341

	Industry *ind = GetIndustryByTile(tile);

   342

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

   343

	return true;

   344

}

   345

   346

bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat)

   347

{

   348

	bool ret = true;

   349

	uint32 random = Random();

   350

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

   351

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

   352

			ret &= StartStopIndustryTileAnimation(tile, iat, random);

   353

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

   354

		}

   355

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

   356

   357

	return ret;

   358

}