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 "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"

    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 (!EnsureNoVehicleOnGround(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->x_pos = x;

   124

	v->y_pos = y;

   125

	v->z_pos = z;

   126

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

   127

	v->direction = direction;

   128

	v->subtype = subtype;

   129

	v->UpdateDeltaXY(INVALID_DIR);

   130

	v->owner = OWNER_NONE;

   131

	v->vehstatus = VS_UNCLICKABLE;

   132

	v->u.disaster.image_override = 0;

   133

	v->current_order.Free();

   134

   135

	DisasterVehicleUpdateImage(v);

   136

	VehiclePositionChanged(v);

   137

	BeginVehicleMove(v);

   138

	EndVehicleMove(v);

   139

}

   140

   141

static void DeleteDisasterVeh(Vehicle *v)

   142

{

   143

	DeleteVehicleChain(v);

   144

}

   145

   146

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

   147

{

   148

	Vehicle *u;

   149

   150

	BeginVehicleMove(v);

   151

	v->x_pos = x;

   152

	v->y_pos = y;

   153

	v->z_pos = z;

   154

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

   155

   156

	DisasterVehicleUpdateImage(v);

   157

	VehiclePositionChanged(v);

   158

	EndVehicleMove(v);

   159

   160

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

   161

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

   162

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

   163

		BeginVehicleMove(u);

   164

   165

		u->x_pos = x;

   166

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

   167

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

   168

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

   169

		u->direction = v->direction;

   170

   171

		DisasterVehicleUpdateImage(u);

   172

		VehiclePositionChanged(u);

   173

		EndVehicleMove(u);

   174

   175

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

   176

			BeginVehicleMove(u);

   177

			u->x_pos = x;

   178

			u->y_pos = y;

   179

			u->z_pos = z + 5;

   180

			VehiclePositionChanged(u);

   181

			EndVehicleMove(u);

   182

		}

   183

	}

   184

}

   185

   186

/**

   187

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

   188

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

   189

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

   190

 * 2: Create more smoke and leave debris on ground

   191

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

   192

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

   193

 */

   194

static void DisasterTick_Zeppeliner(Vehicle *v)

   195

{

   196

	Station *st;

   197

	int x, y;

   198

	byte z;

   199

	TileIndex tile;

   200

   201

	v->tick_counter++;

   202

   203

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

   204

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

   205

   206

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   207

   208

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

   209

   210

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

   211

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

   212

				v->current_order.dest = 2;

   213

				v->age = 0;

   214

			}

   215

   216

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

   217

   218

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

   219

			tile = v->tile;

   220

   221

			if (IsValidTile(tile) &&

   222

					IsTileType(tile, MP_STATION) &&

   223

					IsAirport(tile) &&

   224

					IsHumanPlayer(GetTileOwner(tile))) {

   225

				v->current_order.dest = 1;

   226

				v->age = 0;

   227

   228

				SetDParam(0, GetStationIndex(tile));

   229

				AddNewsItem(STR_B000_ZEPPELIN_DISASTER_AT,

   230

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

   231

					v->index,

   232

					0);

   233

			}

   234

		}

   235

   236

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

   237

		return;

   238

	}

   239

   240

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

   241

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

   242

   243

		tile = v->tile;

   244

   245

		if (IsValidTile(tile) &&

   246

				IsTileType(tile, MP_STATION) &&

   247

				IsAirport(tile) &&

   248

				IsHumanPlayer(GetTileOwner(tile))) {

   249

			st = GetStationByTile(tile);

   250

			CLRBITS(st->airport_flags, RUNWAY_IN_block);

   251

		}

   252

   253

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

   254

		DeleteDisasterVeh(v);

   255

		return;

   256

	}

   257

   258

	x = v->x_pos;

   259

	y = v->y_pos;

   260

	z = GetSlopeZ(x, y);

   261

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

   262

	SetDisasterVehiclePos(v, x, y, z);

   263

   264

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

   265

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

   266

		SndPlayVehicleFx(SND_12_EXPLOSION, v);

   267

		v->u.disaster.image_override = SPR_BLIMP_CRASHING;

   268

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

   269

		v->u.disaster.image_override = SPR_BLIMP_CRASHED;

   270

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

   271

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

   272

			uint32 r = Random();

   273

   274

			CreateEffectVehicleRel(v,

   275

				GB(r, 0, 4) - 7,

   276

				GB(r, 4, 4) - 7,

   277

				GB(r, 8, 3) + 5,

   278

				EV_EXPLOSION_SMALL);

   279

		}

   280

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

   281

		v->current_order.dest = 3;

   282

		v->age = 0;

   283

	}

   284

   285

	tile = v->tile;

   286

	if (IsValidTile(tile) &&

   287

			IsTileType(tile, MP_STATION) &&

   288

			IsAirport(tile) &&

   289

			IsHumanPlayer(GetTileOwner(tile))) {

   290

		st = GetStationByTile(tile);

   291

		SETBITS(st->airport_flags, RUNWAY_IN_block);

   292

	}

   293

}

   294

   295

/**

   296

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

   297

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

   298

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

   299

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

   300

 */

   301

static void DisasterTick_Ufo(Vehicle *v)

   302

{

   303

	Vehicle *u;

   304

	uint dist;

   305

	byte z;

   306

   307

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

   308

   309

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

   310

		/* Fly around randomly */

   311

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

   312

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

   313

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

   314

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

   315

			GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   316

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

   317

			return;

   318

		}

   319

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

   320

			v->dest_tile = RandomTile();

   321

			return;

   322

		}

   323

		v->current_order.dest = 1;

   324

   325

		FOR_ALL_VEHICLES(u) {

   326

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

   327

				v->dest_tile = u->index;

   328

				v->age = 0;

   329

				return;

   330

			}

   331

		}

   332

   333

		DeleteDisasterVeh(v);

   334

	} else {

   335

		/* Target a vehicle */

   336

		u = GetVehicle(v->dest_tile);

   337

		if (u->type != VEH_ROAD) {

   338

			DeleteDisasterVeh(v);

   339

			return;

   340

		}

   341

   342

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

   343

   344

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

   345

			u->breakdown_ctr = 3;

   346

			u->breakdown_delay = 140;

   347

		}

   348

   349

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

   350

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   351

   352

		z = v->z_pos;

   353

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

   354

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

   355

   356

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

   357

			v->age++;

   358

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

   359

				u->u.road.crashed_ctr++;

   360

				u->vehstatus |= VS_CRASHED;

   361

   362

				AddNewsItem(STR_B001_ROAD_VEHICLE_DESTROYED,

   363

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

   364

					u->index,

   365

					0);

   366

			}

   367

		}

   368

   369

		/* Destroy? */

   370

		if (v->age > 50) {

   371

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

   372

			SndPlayVehicleFx(SND_12_EXPLOSION, v);

   373

			DeleteDisasterVeh(v);

   374

		}

   375

	}

   376

}

   377

   378

static void DestructIndustry(Industry *i)

   379

{

   380

	TileIndex tile;

   381

   382

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

   383

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

   384

			ResetIndustryConstructionStage(tile);

   385

			MarkTileDirtyByTile(tile);

   386

		}

   387

	}

   388

}

   389

   390

/**

   391

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

   392

 * 0: Fly towards the targetted oil refinery

   393

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

   394

 * 2: Refinery explosions

   395

 * 3: Fly out of the map

   396

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

   397

 */

   398

static void DisasterTick_Airplane(Vehicle *v)

   399

{

   400

	v->tick_counter++;

   401

	v->u.disaster.image_override =

   402

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

   403

   404

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   405

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

   406

   407

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

   408

		DeleteDisasterVeh(v);

   409

		return;

   410

	}

   411

   412

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

   413

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

   414

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

   415

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

   416

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

   417

			uint32 r = Random();

   418

   419

			CreateEffectVehicleAbove(

   420

				GB(r,  0, 6) + x,

   421

				GB(r,  6, 6) + y,

   422

				GB(r, 12, 4),

   423

				EV_EXPLOSION_SMALL);

   424

   425

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

   426

		}

   427

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

   428

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

   429

			Industry *i;

   430

   431

			v->current_order.dest = 2;

   432

			v->age = 0;

   433

   434

			i = GetIndustry(v->dest_tile);

   435

			DestructIndustry(i);

   436

   437

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

   438

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

   439

			SndPlayTileFx(SND_12_EXPLOSION, i->xy);

   440

		}

   441

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

   442

		int x, y;

   443

		TileIndex tile;

   444

		uint ind;

   445

   446

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

   447

		y = v->y_pos;

   448

   449

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

   450

   451

		tile = TileVirtXY(x, y);

   452

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

   453

   454

		ind = GetIndustryIndex(tile);

   455

		v->dest_tile = ind;

   456

   457

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

   458

			v->current_order.dest = 1;

   459

			v->age = 0;

   460

		}

   461

	}

   462

}

   463

   464

/**

   465

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

   466

 * 0: Fly towards the targetted factory

   467

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

   468

 * 2: Factory explosions

   469

 * 3: Fly out of the map

   470

 */

   471

static void DisasterTick_Helicopter(Vehicle *v)

   472

{

   473

	v->tick_counter++;

   474

	v->u.disaster.image_override =

   475

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

   476

   477

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   478

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

   479

   480

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

   481

		DeleteDisasterVeh(v);

   482

		return;

   483

	}

   484

   485

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

   486

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

   487

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

   488

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

   489

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

   490

			uint32 r = Random();

   491

   492

			CreateEffectVehicleAbove(

   493

				GB(r,  0, 6) + x,

   494

				GB(r,  6, 6) + y,

   495

				GB(r, 12, 4),

   496