1

/* $Id$ */

     2

     3

/** @file

     4

 * All disaster/easter egg vehicles are handled here.

     5

 * The general flow of control for the disaster vehicles is as follows:

     6

 * <ol>

     7

 * <li>Initialize the disaster in a disaster specific way (eg start position,

     8

 *     possible target, etc.) Disaster_XXX_Init() function

     9

 * <li>Add a subtype to a disaster, which is an index into the function array

    10

 *     that handles the vehicle's ticks.

    11

 * <li>Run the disaster vehicles each tick until their target has been reached,

    12

 *     this happens in the DisasterTick_XXX() functions. In here, a vehicle's

    13

 *     state is kept by v->current_order.dest variable. Each achieved sub-target

    14

 *     will increase this value, and the last one will remove the disaster itself

    15

 * </ol>

    16

 */

    17

    18

    19

#include "stdafx.h"

    20

#include "openttd.h"

    21

#include "functions.h"

    22

#include "industry_map.h"

    23

#include "station_map.h"

    24

#include "table/strings.h"

    25

#include "map.h"

    26

#include "tile.h"

    27

#include "vehicle.h"

    28

#include "command.h"

    29

#include "news.h"

    30

#include "station.h"

    31

#include "waypoint.h"

    32

#include "town.h"

    33

#include "industry.h"

    34

#include "player.h"

    35

#include "airport.h"

    36

#include "sound.h"

    37

#include "variables.h"

    38

#include "table/sprites.h"

    39

#include "date.h"

    40

    41

enum DisasterSubType {

    42

	ST_Zeppeliner,

    43

	ST_Zeppeliner_Shadow,

    44

	ST_Small_Ufo,

    45

	ST_Small_Ufo_Shadow,

    46

	ST_Airplane,

    47

	ST_Airplane_Shadow,

    48

	ST_Helicopter,

    49

	ST_Helicopter_Shadow,

    50

	ST_Helicopter_Rotors,

    51

	ST_Big_Ufo,

    52

	ST_Big_Ufo_Shadow,

    53

	ST_Big_Ufo_Destroyer,

    54

	ST_Big_Ufo_Destroyer_Shadow,

    55

	ST_Small_Submarine,

    56

	ST_Big_Submarine,

    57

};

    58

    59

static void DisasterClearSquare(TileIndex tile)

    60

{

    61

	if (!EnsureNoVehicle(tile)) return;

    62

    63

	switch (GetTileType(tile)) {

    64

		case MP_RAILWAY:

    65

			if (IsHumanPlayer(GetTileOwner(tile)) && !IsRailWaypoint(tile)) {

    66

				PlayerID p = _current_player;

    67

				_current_player = OWNER_WATER;

    68

				DoCommand(tile, 0, 0, DC_EXEC, CMD_LANDSCAPE_CLEAR);

    69

				_current_player = p;

    70

			}

    71

			break;

    72

    73

		case MP_HOUSE: {

    74

			PlayerID p = _current_player;

    75

			_current_player = OWNER_NONE;

    76

			DoCommand(tile, 0, 0, DC_EXEC, CMD_LANDSCAPE_CLEAR);

    77

			_current_player = p;

    78

			break;

    79

		}

    80

    81

		case MP_TREES:

    82

		case MP_CLEAR:

    83

			DoClearSquare(tile);

    84

			break;

    85

    86

		default:

    87

			break;

    88

	}

    89

}

    90

    91

static const SpriteID _disaster_images_1[] = {SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP};

    92

static const SpriteID _disaster_images_2[] = {SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT};

    93

static const SpriteID _disaster_images_3[] = {SPR_F_15, SPR_F_15, SPR_F_15, SPR_F_15, SPR_F_15, SPR_F_15, SPR_F_15, SPR_F_15};

    94

static const SpriteID _disaster_images_4[] = {SPR_SUB_SMALL_NE, SPR_SUB_SMALL_NE, SPR_SUB_SMALL_SE, SPR_SUB_SMALL_SE, SPR_SUB_SMALL_SW, SPR_SUB_SMALL_SW, SPR_SUB_SMALL_NW, SPR_SUB_SMALL_NW};

    95

static const SpriteID _disaster_images_5[] = {SPR_SUB_LARGE_NE, SPR_SUB_LARGE_NE, SPR_SUB_LARGE_SE, SPR_SUB_LARGE_SE, SPR_SUB_LARGE_SW, SPR_SUB_LARGE_SW, SPR_SUB_LARGE_NW, SPR_SUB_LARGE_NW};

    96

static const SpriteID _disaster_images_6[] = {SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER};

    97

static const SpriteID _disaster_images_7[] = {SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER};

    98

static const SpriteID _disaster_images_8[] = {SPR_AH_64A, SPR_AH_64A, SPR_AH_64A, SPR_AH_64A, SPR_AH_64A, SPR_AH_64A, SPR_AH_64A, SPR_AH_64A};

    99

static const SpriteID _disaster_images_9[] = {SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1};

   100

   101

static const SpriteID * const _disaster_images[] = {

   102

	_disaster_images_1, _disaster_images_1,                     // zeppeliner and zeppeliner shadow

   103

	_disaster_images_2, _disaster_images_2,                     // small ufo and small ufo shadow

   104

	_disaster_images_3, _disaster_images_3,                     // combat aircraft and shadow

   105

	_disaster_images_8, _disaster_images_8, _disaster_images_9, // combat helicopter, shadow and rotor

   106

	_disaster_images_6, _disaster_images_6,                     // big ufo and shadow

   107

	_disaster_images_7, _disaster_images_7,                     // skyranger and shadow

   108

	_disaster_images_4, _disaster_images_5,                     // small and big submarine sprites

   109

};

   110

   111

static void DisasterVehicleUpdateImage(Vehicle *v)

   112

{

   113

	SpriteID img = v->u.disaster.image_override;

   114

	if (img == 0) img = _disaster_images[v->subtype][v->direction];

   115

	v->cur_image = img;

   116

}

   117

   118

   119

/** Initialize a disaster vehicle. These vehicles are of type VEH_Disaster, are unclickable

   120

 * and owned by nobody */

   121

static void InitializeDisasterVehicle(Vehicle *v, int x, int y, byte z, Direction direction, byte subtype)

   122

{

   123

	v->type = VEH_Disaster;

   124

	v->x_pos = x;

   125

	v->y_pos = y;

   126

	v->z_pos = z;

   127

	v->tile = TileVirtXY(x, y);

   128

	v->direction = direction;

   129

	v->subtype = subtype;

   130

	v->x_offs = -1;

   131

	v->y_offs = -1;

   132

	v->sprite_width = 2;

   133

	v->sprite_height = 2;

   134

	v->z_height = 5;

   135

	v->owner = OWNER_NONE;

   136

	v->vehstatus = VS_UNCLICKABLE;

   137

	v->u.disaster.image_override = 0;

   138

	v->current_order.type = OT_NOTHING;

   139

	v->current_order.flags = 0;

   140

	v->current_order.dest = 0;

   141

   142

	DisasterVehicleUpdateImage(v);

   143

	VehiclePositionChanged(v);

   144

	BeginVehicleMove(v);

   145

	EndVehicleMove(v);

   146

}

   147

   148

static void DeleteDisasterVeh(Vehicle *v)

   149

{

   150

	DeleteVehicleChain(v);

   151

}

   152

   153

static void SetDisasterVehiclePos(Vehicle *v, int x, int y, byte z)

   154

{

   155

	Vehicle *u;

   156

   157

	BeginVehicleMove(v);

   158

	v->x_pos = x;

   159

	v->y_pos = y;

   160

	v->z_pos = z;

   161

	v->tile = TileVirtXY(x, y);

   162

   163

	DisasterVehicleUpdateImage(v);

   164

	VehiclePositionChanged(v);

   165

	EndVehicleMove(v);

   166

   167

	if ((u = v->next) != NULL) {

   168

		int safe_x = clamp(x, 0, MapMaxX() * TILE_SIZE);

   169

		int safe_y = clamp(y - 1, 0, MapMaxY() * TILE_SIZE);

   170

		BeginVehicleMove(u);

   171

   172

		u->x_pos = x;

   173

		u->y_pos = y - 1 - (max(z - GetSlopeZ(safe_x, safe_y), 0U) >> 3);

   174

		safe_y = clamp(u->y_pos, 0, MapMaxY() * TILE_SIZE);

   175

		u->z_pos = GetSlopeZ(safe_x, safe_y);

   176

		u->direction = v->direction;

   177

   178

		DisasterVehicleUpdateImage(u);

   179

		VehiclePositionChanged(u);

   180

		EndVehicleMove(u);

   181

   182

		if ((u = u->next) != NULL) {

   183

			BeginVehicleMove(u);

   184

			u->x_pos = x;

   185

			u->y_pos = y;

   186

			u->z_pos = z + 5;

   187

			VehiclePositionChanged(u);

   188

			EndVehicleMove(u);

   189

		}

   190

	}

   191

}

   192

   193

/**

   194

 * Zeppeliner handling, v->current_order.dest states:

   195

 * 0: Zeppeliner initialization has found a small airport, go there and crash

   196

 * 1: Create crash and animate falling down for extra dramatic effect

   197

 * 2: Create more smoke and leave debris on ground

   198

 * 2: Clear the runway after some time and remove crashed zeppeliner

   199

 * If not airport was found, only state 0 is reached until zeppeliner leaves map

   200

 */

   201

static void DisasterTick_Zeppeliner(Vehicle *v)

   202

{

   203

	GetNewVehiclePosResult gp;

   204

	Station *st;

   205

	int x, y;

   206

	byte z;

   207

	TileIndex tile;

   208

   209

	v->tick_counter++;

   210

   211

	if (v->current_order.dest < 2) {

   212

		if (HASBIT(v->tick_counter, 0)) return;

   213

   214

		GetNewVehiclePos(v, &gp);

   215

   216

		SetDisasterVehiclePos(v, gp.x, gp.y, v->z_pos);

   217

   218

		if (v->current_order.dest == 1) {

   219

			if (++v->age == 38) {

   220

				v->current_order.dest = 2;

   221

				v->age = 0;

   222

			}

   223

   224

			if (GB(v->tick_counter, 0, 3) == 0) CreateEffectVehicleRel(v, 0, -17, 2, EV_SMOKE);

   225

   226

		} else if (v->current_order.dest == 0) {

   227

			tile = v->tile;

   228

   229

			if (IsValidTile(tile) &&

   230

					IsTileType(tile, MP_STATION) &&

   231

					IsAirport(tile) &&

   232

					IsHumanPlayer(GetTileOwner(tile))) {

   233

				v->current_order.dest = 1;

   234

				v->age = 0;

   235

   236

				SetDParam(0, GetStationIndex(tile));

   237

				AddNewsItem(STR_B000_ZEPPELIN_DISASTER_AT,

   238

					NEWS_FLAGS(NM_THIN, NF_VIEWPORT|NF_VEHICLE, NT_ACCIDENT, 0),

   239

					v->index,

   240

					0);

   241

			}

   242

		}

   243

   244

		if (v->y_pos >= ((int)MapSizeY() + 9) * TILE_SIZE - 1) DeleteDisasterVeh(v);

   245

		return;

   246

	}

   247

   248

	if (v->current_order.dest > 2) {

   249

		if (++v->age <= 13320) return;

   250

   251

		tile = v->tile;

   252

   253

		if (IsValidTile(tile) &&

   254

				IsTileType(tile, MP_STATION) &&

   255

				IsAirport(tile) &&

   256

				IsHumanPlayer(GetTileOwner(tile))) {

   257

			st = GetStationByTile(tile);

   258

			CLRBITS(st->airport_flags, RUNWAY_IN_block);

   259

		}

   260

   261

		SetDisasterVehiclePos(v, v->x_pos, v->y_pos, v->z_pos);

   262

		DeleteDisasterVeh(v);

   263

		return;

   264

	}

   265

   266

	x = v->x_pos;

   267

	y = v->y_pos;

   268

	z = GetSlopeZ(x,y);

   269

	if (z < v->z_pos) z = v->z_pos - 1;

   270

	SetDisasterVehiclePos(v, x, y, z);

   271

   272

	if (++v->age == 1) {

   273

		CreateEffectVehicleRel(v, 0, 7, 8, EV_EXPLOSION_LARGE);

   274

		SndPlayVehicleFx(SND_12_EXPLOSION, v);

   275

		v->u.disaster.image_override = SPR_BLIMP_CRASHING;

   276

	} else if (v->age == 70) {

   277

		v->u.disaster.image_override = SPR_BLIMP_CRASHED;

   278

	} else if (v->age <= 300) {

   279

		if (GB(v->tick_counter, 0, 3) == 0) {

   280

			uint32 r = Random();

   281

   282

			CreateEffectVehicleRel(v,

   283

				GB(r, 0, 4) - 7,

   284

				GB(r, 4, 4) - 7,

   285

				GB(r, 8, 3) + 5,

   286

				EV_EXPLOSION_SMALL);

   287

		}

   288

	} else if (v->age == 350) {

   289

		v->current_order.dest = 3;

   290

		v->age = 0;

   291

	}

   292

   293

	tile = v->tile;

   294

	if (IsValidTile(tile) &&

   295

			IsTileType(tile, MP_STATION) &&

   296

			IsAirport(tile) &&

   297

			IsHumanPlayer(GetTileOwner(tile))) {

   298

		st = GetStationByTile(tile);

   299

		SETBITS(st->airport_flags, RUNWAY_IN_block);

   300

	}

   301

}

   302

   303

/**

   304

 * (Small) Ufo handling, v->current_order.dest states:

   305

 * 0: Fly around to the middle of the map, then randomly, after a while target a road vehicle

   306

 * 1: Home in on a road vehicle and crash it >:)

   307

 * If not road vehicle was found, only state 0 is used and Ufo disappears after a while

   308

 */

   309

static void DisasterTick_Ufo(Vehicle *v)

   310

{

   311

	GetNewVehiclePosResult gp;

   312

	Vehicle *u;

   313

	uint dist;

   314

	byte z;

   315

   316

	v->u.disaster.image_override = (HASBIT(++v->tick_counter, 3)) ? SPR_UFO_SMALL_SCOUT_DARKER : SPR_UFO_SMALL_SCOUT;

   317

   318

	if (v->current_order.dest == 0) {

   319

		/* Fly around randomly */

   320

		int x = TileX(v->dest_tile) * TILE_SIZE;

   321

		int y = TileY(v->dest_tile) * TILE_SIZE;

   322

		if (delta(x, v->x_pos) + delta(y, v->y_pos) >= TILE_SIZE) {

   323

			v->direction = GetDirectionTowards(v, x, y);

   324

			GetNewVehiclePos(v, &gp);

   325

			SetDisasterVehiclePos(v, gp.x, gp.y, v->z_pos);

   326

			return;

   327

		}

   328

		if (++v->age < 6) {

   329

			v->dest_tile = RandomTile();

   330

			return;

   331

		}

   332

		v->current_order.dest = 1;

   333

   334

		FOR_ALL_VEHICLES(u) {

   335

			if (u->type == VEH_Road && IsHumanPlayer(u->owner)) {

   336

				v->dest_tile = u->index;

   337

				v->age = 0;

   338

				return;

   339

			}

   340

		}

   341

   342

		DeleteDisasterVeh(v);

   343

	} else {

   344

		/* Target a vehicle */

   345

		u = GetVehicle(v->dest_tile);

   346

		if (u->type != VEH_Road) {

   347

			DeleteDisasterVeh(v);

   348

			return;

   349

		}

   350

   351

		dist = delta(v->x_pos, u->x_pos) + delta(v->y_pos, u->y_pos);

   352

   353

		if (dist < TILE_SIZE && !(u->vehstatus & VS_HIDDEN) && u->breakdown_ctr == 0) {

   354

			u->breakdown_ctr = 3;

   355

			u->breakdown_delay = 140;

   356

		}

   357

   358

		v->direction = GetDirectionTowards(v, u->x_pos, u->y_pos);

   359

		GetNewVehiclePos(v, &gp);

   360

   361

		z = v->z_pos;

   362

		if (dist <= TILE_SIZE && z > u->z_pos) z--;

   363

		SetDisasterVehiclePos(v, gp.x, gp.y, z);

   364

   365

		if (z <= u->z_pos && (u->vehstatus & VS_HIDDEN)==0) {

   366

			v->age++;

   367

			if (u->u.road.crashed_ctr == 0) {

   368

				u->u.road.crashed_ctr++;

   369

				u->vehstatus |= VS_CRASHED;

   370

   371

				AddNewsItem(STR_B001_ROAD_VEHICLE_DESTROYED,

   372

					NEWS_FLAGS(NM_THIN, NF_VIEWPORT|NF_VEHICLE, NT_ACCIDENT, 0),

   373

					u->index,

   374

					0);

   375

			}

   376

		}

   377

   378

		/* Destroy? */

   379

		if (v->age > 50) {

   380

			CreateEffectVehicleRel(v, 0, 7, 8, EV_EXPLOSION_LARGE);

   381

			SndPlayVehicleFx(SND_12_EXPLOSION, v);

   382

			DeleteDisasterVeh(v);

   383

		}

   384

	}

   385

}

   386

   387

static void DestructIndustry(Industry *i)

   388

{

   389

	TileIndex tile;

   390

   391

	for (tile = 0; tile != MapSize(); tile++) {

   392

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

   393

			ResetIndustryConstructionStage(tile);

   394

			MarkTileDirtyByTile(tile);

   395

		}

   396

	}

   397

}

   398

   399

/**

   400

 * Airplane handling, v->current_order.dest states:

   401

 * 0: Fly towards the targetted oil refinery

   402

 * 1: If within 15 tiles, fire away rockets and destroy industry

   403

 * 2: Refinery explosions

   404

 * 3: Fly out of the map

   405

 * If the industry was removed in the meantime just fly to the end of the map

   406

 */

   407

static void DisasterTick_Airplane(Vehicle *v)

   408

{

   409

	GetNewVehiclePosResult gp;

   410

   411

	v->tick_counter++;

   412

	v->u.disaster.image_override =

   413

		(v->current_order.dest == 1 && HASBIT(v->tick_counter, 2)) ? SPR_F_15_FIRING : 0;

   414

   415

	GetNewVehiclePos(v, &gp);

   416

	SetDisasterVehiclePos(v, gp.x, gp.y, v->z_pos);

   417

   418

	if (gp.x < (-10 * TILE_SIZE)) {

   419

		DeleteDisasterVeh(v);

   420

		return;

   421

	}

   422

   423

	if (v->current_order.dest == 2) {

   424

		if (GB(v->tick_counter, 0, 2) == 0) {

   425

			Industry *i = GetIndustry(v->dest_tile);

   426

			int x = TileX(i->xy) * TILE_SIZE;

   427

			int y = TileY(i->xy) * TILE_SIZE;

   428

			uint32 r = Random();

   429

   430

			CreateEffectVehicleAbove(

   431

				GB(r,  0, 6) + x,

   432

				GB(r,  6, 6) + y,

   433

				GB(r, 12, 4),

   434

				EV_EXPLOSION_SMALL);

   435

   436

			if (++v->age >= 55) v->current_order.dest = 3;

   437

		}

   438

	} else if (v->current_order.dest == 1) {

   439

		if (++v->age == 112) {

   440

			Industry *i;

   441

   442

			v->current_order.dest = 2;

   443

			v->age = 0;

   444

   445

			i = GetIndustry(v->dest_tile);

   446

			DestructIndustry(i);

   447

   448

			SetDParam(0, i->town->index);

   449

			AddNewsItem(STR_B002_OIL_REFINERY_EXPLOSION, NEWS_FLAGS(NM_THIN,NF_VIEWPORT|NF_TILE,NT_ACCIDENT,0), i->xy, 0);

   450

			SndPlayTileFx(SND_12_EXPLOSION, i->xy);

   451

		}

   452

	} else if (v->current_order.dest == 0) {

   453

		int x, y;

   454

		TileIndex tile;

   455

		uint ind;

   456

   457

		x = v->x_pos - (15 * TILE_SIZE);

   458

		y = v->y_pos;

   459

   460

		if ( (uint)x > MapMaxX() * TILE_SIZE - 1) return;

   461

   462

		tile = TileVirtXY(x, y);

   463

		if (!IsTileType(tile, MP_INDUSTRY)) return;

   464

   465

		ind = GetIndustryIndex(tile);

   466

		v->dest_tile = ind;

   467

   468

		if (GetIndustry(ind)->type == IT_OIL_REFINERY) {

   469

			v->current_order.dest = 1;

   470

			v->age = 0;

   471

		}

   472

	}

   473

}

   474

   475

/**

   476

 * Helicopter handling, v->current_order.dest states:

   477

 * 0: Fly towards the targetted factory

   478

 * 1: If within 15 tiles, fire away rockets and destroy industry

   479

 * 2: Factory explosions

   480

 * 3: Fly out of the map

   481

 */

   482

static void DisasterTick_Helicopter(Vehicle *v)

   483

{

   484

	GetNewVehiclePosResult gp;

   485

   486

	v->tick_counter++;

   487

	v->u.disaster.image_override =

   488

		(v->current_order.dest == 1 && HASBIT(v->tick_counter, 2)) ? SPR_AH_64A_FIRING : 0;

   489

   490

	GetNewVehiclePos(v, &gp);

   491

	SetDisasterVehiclePos(v, gp.x, gp.y, v->z_pos);

   492

   493

	if (gp.x > (int)MapSizeX() * TILE_SIZE + 9 * TILE_SIZE - 1) {

   494

		DeleteDisasterVeh(v);

   495

		return;

   496

	}

   497

   498

	if (v->current_order.dest == 2) {