1

/* $Id$ */

     2

     3

/** @file disaster_cmd.cpp

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

    23

#include "industry_map.h"

    24

#include "station_map.h"

    25

#include "table/strings.h"

    26

#include "map.h"

    27

#include "tile.h"

    28

#include "vehicle.h"

    29

#include "command.h"

    30

#include "news.h"

    31

#include "station.h"

    32

#include "waypoint.h"

    33

#include "town.h"

    34

#include "industry.h"

    35

#include "player.h"

    36

#include "airport.h"

    37

#include "sound.h"

    38

#include "variables.h"

    39

#include "table/sprites.h"

    40

#include "date.h"

    41

    42

enum DisasterSubType {

    43

	ST_Zeppeliner,

    44

	ST_Zeppeliner_Shadow,

    45

	ST_Small_Ufo,

    46

	ST_Small_Ufo_Shadow,

    47

	ST_Airplane,

    48

	ST_Airplane_Shadow,

    49

	ST_Helicopter,

    50

	ST_Helicopter_Shadow,

    51

	ST_Helicopter_Rotors,

    52

	ST_Big_Ufo,

    53

	ST_Big_Ufo_Shadow,

    54

	ST_Big_Ufo_Destroyer,

    55

	ST_Big_Ufo_Destroyer_Shadow,

    56

	ST_Small_Submarine,

    57

	ST_Big_Submarine,

    58

};

    59

    60

static void DisasterClearSquare(TileIndex tile)

    61

{

    62

	if (!EnsureNoVehicle(tile)) return;

    63

    64

	switch (GetTileType(tile)) {

    65

		case MP_RAILWAY:

    66

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

    67

				PlayerID p = _current_player;

    68

				_current_player = OWNER_WATER;

    69

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

    70

				_current_player = p;

    71

			}

    72

			break;

    73

    74

		case MP_HOUSE: {

    75

			PlayerID p = _current_player;

    76

			_current_player = OWNER_NONE;

    77

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

    78

			_current_player = p;

    79

			break;

    80

		}

    81

    82

		case MP_TREES:

    83

		case MP_CLEAR:

    84

			DoClearSquare(tile);

    85

			break;

    86

    87

		default:

    88

			break;

    89

	}

    90

}

    91

    92

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

    93

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};

    94

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};

    95

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};

    96

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};

    97

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};

    98

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};

    99

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};

   100

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};

   101

   102

static const SpriteID * const _disaster_images[] = {

   103

	_disaster_images_1, _disaster_images_1,                     ///< zeppeliner and zeppeliner shadow

   104

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

   105

	_disaster_images_3, _disaster_images_3,                     ///< combat aircraft and shadow

   106

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

   107

	_disaster_images_6, _disaster_images_6,                     ///< big ufo and shadow

   108

	_disaster_images_7, _disaster_images_7,                     ///< skyranger and shadow

   109

	_disaster_images_4, _disaster_images_5,                     ///< small and big submarine sprites

   110

};

   111

   112

static void DisasterVehicleUpdateImage(Vehicle *v)

   113

{

   114

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

   115

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

   116

	v->cur_image = img;

   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 = new (v) DisasterVehicle();

   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->UpdateDeltaXY(INVALID_DIR);

   131

	v->owner = OWNER_NONE;

   132

	v->vehstatus = VS_UNCLICKABLE;

   133

	v->u.disaster.image_override = 0;

   134

	v->current_order.Free();

   135

   136

	DisasterVehicleUpdateImage(v);

   137

	VehiclePositionChanged(v);

   138

	BeginVehicleMove(v);

   139

	EndVehicleMove(v);

   140

}

   141

   142

static void DeleteDisasterVeh(Vehicle *v)

   143

{

   144

	DeleteVehicleChain(v);

   145

}

   146

   147

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

   148

{

   149

	Vehicle *u;

   150

   151

	BeginVehicleMove(v);

   152

	v->x_pos = x;

   153

	v->y_pos = y;

   154

	v->z_pos = z;

   155

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

   156

   157

	DisasterVehicleUpdateImage(v);

   158

	VehiclePositionChanged(v);

   159

	EndVehicleMove(v);

   160

   161

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

   162

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

   163

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

   164

		BeginVehicleMove(u);

   165

   166

		u->x_pos = x;

   167

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

   168

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

   169

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

   170

		u->direction = v->direction;

   171

   172

		DisasterVehicleUpdateImage(u);

   173

		VehiclePositionChanged(u);

   174

		EndVehicleMove(u);

   175

   176

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

   177

			BeginVehicleMove(u);

   178

			u->x_pos = x;

   179

			u->y_pos = y;

   180

			u->z_pos = z + 5;

   181

			VehiclePositionChanged(u);

   182

			EndVehicleMove(u);

   183

		}

   184

	}

   185

}

   186

   187

/**

   188

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

   189

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

   190

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

   191

 * 2: Create more smoke and leave debris on ground

   192

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

   193

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

   194

 */

   195

static void DisasterTick_Zeppeliner(Vehicle *v)

   196

{

   197

	Station *st;

   198

	int x, y;

   199

	byte z;

   200

	TileIndex tile;

   201

   202

	v->tick_counter++;

   203

   204

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

   205

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

   206

   207

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   208

   209

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

   210

   211

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

   212

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

   213

				v->current_order.dest = 2;

   214

				v->age = 0;

   215

			}

   216

   217

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

   218

   219

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

   220

			tile = v->tile;

   221

   222

			if (IsValidTile(tile) &&

   223

					IsTileType(tile, MP_STATION) &&

   224

					IsAirport(tile) &&

   225

					IsHumanPlayer(GetTileOwner(tile))) {

   226

				v->current_order.dest = 1;

   227

				v->age = 0;

   228

   229

				SetDParam(0, GetStationIndex(tile));

   230

				AddNewsItem(STR_B000_ZEPPELIN_DISASTER_AT,

   231

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

   232

					v->index,

   233

					0);

   234

			}

   235

		}

   236

   237

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

   238

		return;

   239

	}

   240

   241

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

   242

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

   243

   244

		tile = v->tile;

   245

   246

		if (IsValidTile(tile) &&

   247

				IsTileType(tile, MP_STATION) &&

   248

				IsAirport(tile) &&

   249

				IsHumanPlayer(GetTileOwner(tile))) {

   250

			st = GetStationByTile(tile);

   251

			CLRBITS(st->airport_flags, RUNWAY_IN_block);

   252

		}

   253

   254

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

   255

		DeleteDisasterVeh(v);

   256

		return;

   257

	}

   258

   259

	x = v->x_pos;

   260

	y = v->y_pos;

   261

	z = GetSlopeZ(x, y);

   262

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

   263

	SetDisasterVehiclePos(v, x, y, z);

   264

   265

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

   266

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

   267

		SndPlayVehicleFx(SND_12_EXPLOSION, v);

   268

		v->u.disaster.image_override = SPR_BLIMP_CRASHING;

   269

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

   270

		v->u.disaster.image_override = SPR_BLIMP_CRASHED;

   271

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

   272

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

   273

			uint32 r = Random();

   274

   275

			CreateEffectVehicleRel(v,

   276

				GB(r, 0, 4) - 7,

   277

				GB(r, 4, 4) - 7,

   278

				GB(r, 8, 3) + 5,

   279

				EV_EXPLOSION_SMALL);

   280

		}

   281

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

   282

		v->current_order.dest = 3;

   283

		v->age = 0;

   284

	}

   285

   286

	tile = v->tile;

   287

	if (IsValidTile(tile) &&

   288

			IsTileType(tile, MP_STATION) &&

   289

			IsAirport(tile) &&

   290

			IsHumanPlayer(GetTileOwner(tile))) {

   291

		st = GetStationByTile(tile);

   292

		SETBITS(st->airport_flags, RUNWAY_IN_block);

   293

	}

   294

}

   295

   296

/**

   297

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

   298

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

   299

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

   300

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

   301

 */

   302

static void DisasterTick_Ufo(Vehicle *v)

   303

{

   304

	Vehicle *u;

   305

	uint dist;

   306

	byte z;

   307

   308

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

   309

   310

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

   311

		/* Fly around randomly */

   312

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

   313

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

   314

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

   315

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

   316

			GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   317

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

   318

			return;

   319

		}

   320

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

   321

			v->dest_tile = RandomTile();

   322

			return;

   323

		}

   324

		v->current_order.dest = 1;

   325

   326

		FOR_ALL_VEHICLES(u) {

   327

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

   328

				v->dest_tile = u->index;

   329

				v->age = 0;

   330

				return;

   331

			}

   332

		}

   333

   334

		DeleteDisasterVeh(v);

   335

	} else {

   336

		/* Target a vehicle */

   337

		u = GetVehicle(v->dest_tile);

   338

		if (u->type != VEH_ROAD) {

   339

			DeleteDisasterVeh(v);

   340

			return;

   341

		}

   342

   343

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

   344

   345

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

   346

			u->breakdown_ctr = 3;

   347

			u->breakdown_delay = 140;

   348

		}

   349

   350

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

   351

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   352

   353

		z = v->z_pos;

   354

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

   355

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

   356

   357

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

   358

			v->age++;

   359

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

   360

				u->u.road.crashed_ctr++;

   361

				u->vehstatus |= VS_CRASHED;

   362

   363

				AddNewsItem(STR_B001_ROAD_VEHICLE_DESTROYED,

   364

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

   365

					u->index,

   366

					0);

   367

			}

   368

		}

   369

   370

		/* Destroy? */

   371

		if (v->age > 50) {

   372

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

   373

			SndPlayVehicleFx(SND_12_EXPLOSION, v);

   374

			DeleteDisasterVeh(v);

   375

		}

   376

	}

   377

}

   378

   379

static void DestructIndustry(Industry *i)

   380

{

   381

	TileIndex tile;

   382

   383

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

   384

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

   385

			ResetIndustryConstructionStage(tile);

   386

			MarkTileDirtyByTile(tile);

   387

		}

   388

	}

   389

}

   390

   391

/**

   392

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

   393

 * 0: Fly towards the targetted oil refinery

   394

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

   395

 * 2: Refinery explosions

   396

 * 3: Fly out of the map

   397

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

   398

 */

   399

static void DisasterTick_Airplane(Vehicle *v)

   400

{

   401

	v->tick_counter++;

   402

	v->u.disaster.image_override =

   403

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

   404

   405

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   406

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

   407

   408

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

   409

		DeleteDisasterVeh(v);

   410

		return;

   411

	}

   412

   413

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

   414

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

   415

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

   416

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

   417

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

   418

			uint32 r = Random();

   419

   420

			CreateEffectVehicleAbove(

   421

				GB(r,  0, 6) + x,

   422

				GB(r,  6, 6) + y,

   423

				GB(r, 12, 4),

   424

				EV_EXPLOSION_SMALL);

   425

   426

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

   427

		}

   428

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

   429

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

   430

			Industry *i;

   431

   432

			v->current_order.dest = 2;

   433

			v->age = 0;

   434

   435

			i = GetIndustry(v->dest_tile);

   436

			DestructIndustry(i);

   437

   438

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

   439

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

   440

			SndPlayTileFx(SND_12_EXPLOSION, i->xy);

   441

		}

   442

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

   443

		int x, y;

   444

		TileIndex tile;

   445

		uint ind;

   446

   447

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

   448

		y = v->y_pos;

   449

   450

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

   451

   452

		tile = TileVirtXY(x, y);

   453

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

   454

   455

		ind = GetIndustryIndex(tile);

   456

		v->dest_tile = ind;

   457

   458

		if (GetIndustrySpec(GetIndustry(ind)->type)->behaviour & INDUSTRYBEH_AIRPLANE_ATTACKS) {

   459

			v->current_order.dest = 1;

   460

			v->age = 0;

   461

		}

   462

	}

   463

}

   464

   465

/**

   466

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

   467

 * 0: Fly towards the targetted factory

   468

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

   469

 * 2: Factory explosions

   470

 * 3: Fly out of the map

   471

 */

   472

static void DisasterTick_Helicopter(Vehicle *v)

   473

{

   474

	v->tick_counter++;

   475

	v->u.disaster.image_override =

   476

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

   477

   478

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   479

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

   480

   481

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

   482

		DeleteDisasterVeh(v);

   483

		return;

   484

	}

   485

   486

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

   487

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

   488

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

   489

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

   490

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

   491

			uint32 r = Random();

   492

   493

			CreateEffectVehicleAbove(

   494

				GB(r,  0, 6) + x,

   495

				GB(r,  6, 6) + y,

   496