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

    22

    23

#include "industry_map.h"

    24

#include "station_map.h"

    25

#include "command_func.h"

    26

#include "tile_cmd.h"

    27

#include "news.h"

    28

#include "station.h"

    29

#include "waypoint.h"

    30

#include "town.h"

    31

#include "industry.h"

    32

#include "player_func.h"

    33

#include "airport.h"

    34

#include "variables.h"

    35

#include "strings_func.h"

    36

#include "date_func.h"

    37

#include "functions.h"

    38

#include "vehicle_func.h"

    39

#include "vehicle_base.h"

    40

#include "sound_func.h"

    41

    45

enum DisasterSubType {

    46

	ST_Zeppeliner,

    47

	ST_Zeppeliner_Shadow,

    48

	ST_Small_Ufo,

    49

	ST_Small_Ufo_Shadow,

    50

	ST_Airplane,

    51

	ST_Airplane_Shadow,

    52

	ST_Helicopter,

    53

	ST_Helicopter_Shadow,

    54

	ST_Helicopter_Rotors,

    55

	ST_Big_Ufo,

    56

	ST_Big_Ufo_Shadow,

    57

	ST_Big_Ufo_Destroyer,

    58

	ST_Big_Ufo_Destroyer_Shadow,

    59

	ST_Small_Submarine,

    60

	ST_Big_Submarine,

    61

};

    62

    63

static void DisasterClearSquare(TileIndex tile)

    64

{

    65

	if (!EnsureNoVehicleOnGround(tile)) return;

    66

    67

	switch (GetTileType(tile)) {

    68

		case MP_RAILWAY:

    69

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

    70

				PlayerID p = _current_player;

    71

				_current_player = OWNER_WATER;

    72

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

    73

				_current_player = p;

    74

			}

    75

			break;

    76

    77

		case MP_HOUSE: {

    78

			PlayerID p = _current_player;

    79

			_current_player = OWNER_NONE;

    80

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

    81

			_current_player = p;

    82

			break;

    83

		}

    84

    85

		case MP_TREES:

    86

		case MP_CLEAR:

    87

			DoClearSquare(tile);

    88

			break;

    89

    90

		default:

    91

			break;

    92

	}

    93

}

    94

    95

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

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

   105

static const SpriteID * const _disaster_images[] = {

   106

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

   107

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

   108

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

   109

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

   110

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

   111

	_disaster_images_7, _disaster_images_7,                     ///< skyranger and shadow

   112

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

   113

};

   114

   115

static void DisasterVehicleUpdateImage(Vehicle *v)

   116

{

   117

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

   118

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

   119

	v->cur_image = img;

   120

}

   121

   122

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

   123

 * and owned by nobody */

   124

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

   125

{

   126

	v->x_pos = x;

   127

	v->y_pos = y;

   128

	v->z_pos = z;

   129

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

   130

	v->direction = direction;

   131

	v->subtype = subtype;

   132

	v->UpdateDeltaXY(INVALID_DIR);

   133

	v->owner = OWNER_NONE;

   134

	v->vehstatus = VS_UNCLICKABLE;

   135

	v->u.disaster.image_override = 0;

   136

	v->current_order.Free();

   137

   138

	DisasterVehicleUpdateImage(v);

   139

	VehiclePositionChanged(v);

   140

	BeginVehicleMove(v);

   141

	EndVehicleMove(v);

   142

}

   143

   144

static void DeleteDisasterVeh(Vehicle *v)

   145

{

   146

	DeleteVehicleChain(v);

   147

}

   148

   149

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

   150

{

   151

	Vehicle *u;

   152

   153

	BeginVehicleMove(v);

   154

	v->x_pos = x;

   155

	v->y_pos = y;

   156

	v->z_pos = z;

   157

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

   158

   159

	DisasterVehicleUpdateImage(v);

   160

	VehiclePositionChanged(v);

   161

	EndVehicleMove(v);

   162

   163

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

   164

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

   165

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

   166

		BeginVehicleMove(u);

   167

   168

		u->x_pos = x;

   169

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

   170

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

   171

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

   172

		u->direction = v->direction;

   173

   174

		DisasterVehicleUpdateImage(u);

   175

		VehiclePositionChanged(u);

   176

		EndVehicleMove(u);

   177

   178

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

   179

			BeginVehicleMove(u);

   180

			u->x_pos = x;

   181

			u->y_pos = y;

   182

			u->z_pos = z + 5;

   183

			VehiclePositionChanged(u);

   184

			EndVehicleMove(u);

   185

		}

   186

	}

   187

}

   188

   189

/**

   190

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

   191

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

   192

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

   193

 * 2: Create more smoke and leave debris on ground

   194

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

   195

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

   196

 */

   197

static void DisasterTick_Zeppeliner(Vehicle *v)

   198

{

   199

	Station *st;

   200

	int x, y;

   201

	byte z;

   202

	TileIndex tile;

   203

   204

	v->tick_counter++;

   205

   206

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

   207

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

   208

   209

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   210

   211

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

   212

   213

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

   214

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

   215

				v->current_order.dest = 2;

   216

				v->age = 0;

   217

			}

   218

   219

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

   220

   221

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

   222

			tile = v->tile;

   223

   224

			if (IsValidTile(tile) &&

   225

					IsTileType(tile, MP_STATION) &&

   226

					IsAirport(tile) &&

   227

					IsHumanPlayer(GetTileOwner(tile))) {

   228

				v->current_order.dest = 1;

   229

				v->age = 0;

   230

   231

				SetDParam(0, GetStationIndex(tile));

   232

				AddNewsItem(STR_B000_ZEPPELIN_DISASTER_AT,

   233

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

   234

					v->index,

   235

					0);

   236

			}

   237

		}

   238

   239

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

   240

		return;

   241

	}

   242

   243

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

   244

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

   245

   246

		tile = v->tile;

   247

   248

		if (IsValidTile(tile) &&

   249

				IsTileType(tile, MP_STATION) &&

   250

				IsAirport(tile) &&

   251

				IsHumanPlayer(GetTileOwner(tile))) {

   252

			st = GetStationByTile(tile);

   253

			CLRBITS(st->airport_flags, RUNWAY_IN_block);

   254

		}

   255

   256

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

   257

		DeleteDisasterVeh(v);

   258

		return;

   259

	}

   260

   261

	x = v->x_pos;

   262

	y = v->y_pos;

   263

	z = GetSlopeZ(x, y);

   264

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

   265

	SetDisasterVehiclePos(v, x, y, z);

   266

   267

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

   268

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

   269

		SndPlayVehicleFx(SND_12_EXPLOSION, v);

   270

		v->u.disaster.image_override = SPR_BLIMP_CRASHING;

   271

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

   272

		v->u.disaster.image_override = SPR_BLIMP_CRASHED;

   273

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

   274

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

   275

			uint32 r = Random();

   276

   277

			CreateEffectVehicleRel(v,

   278

				GB(r, 0, 4) - 7,

   279

				GB(r, 4, 4) - 7,

   280

				GB(r, 8, 3) + 5,

   281

				EV_EXPLOSION_SMALL);

   282

		}

   283

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

   284

		v->current_order.dest = 3;

   285

		v->age = 0;

   286

	}

   287

   288

	tile = v->tile;

   289

	if (IsValidTile(tile) &&

   290

			IsTileType(tile, MP_STATION) &&

   291

			IsAirport(tile) &&

   292

			IsHumanPlayer(GetTileOwner(tile))) {

   293

		st = GetStationByTile(tile);

   294

		SETBITS(st->airport_flags, RUNWAY_IN_block);

   295

	}

   296

}

   297

   298

/**

   299

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

   300

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

   301

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

   302

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

   303

 */

   304

static void DisasterTick_Ufo(Vehicle *v)

   305

{

   306

	Vehicle *u;

   307

	uint dist;

   308

	byte z;

   309

   310

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

   311

   312

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

   313

		/* Fly around randomly */

   314

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

   315

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

   316

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

   317

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

   318

			GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   319

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

   320

			return;

   321

		}

   322

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

   323

			v->dest_tile = RandomTile();

   324

			return;

   325

		}

   326

		v->current_order.dest = 1;

   327

   328

		FOR_ALL_VEHICLES(u) {

   329

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

   330

				v->dest_tile = u->index;

   331

				v->age = 0;

   332

				return;

   333

			}

   334

		}

   335

   336

		DeleteDisasterVeh(v);

   337

	} else {

   338

		/* Target a vehicle */

   339

		u = GetVehicle(v->dest_tile);

   340

		if (u->type != VEH_ROAD) {

   341

			DeleteDisasterVeh(v);

   342

			return;

   343

		}

   344

   345

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

   346

   347

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

   348

			u->breakdown_ctr = 3;

   349

			u->breakdown_delay = 140;

   350

		}

   351

   352

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

   353

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   354

   355

		z = v->z_pos;

   356

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

   357

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

   358

   359

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

   360

			v->age++;

   361

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

   362

				u->u.road.crashed_ctr++;

   363

				u->vehstatus |= VS_CRASHED;

   364

   365

				AddNewsItem(STR_B001_ROAD_VEHICLE_DESTROYED,

   366

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

   367

					u->index,

   368

					0);

   369

			}

   370

		}

   371

   372

		/* Destroy? */

   373

		if (v->age > 50) {

   374

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

   375

			SndPlayVehicleFx(SND_12_EXPLOSION, v);

   376

			DeleteDisasterVeh(v);

   377

		}

   378

	}

   379

}

   380

   381

static void DestructIndustry(Industry *i)

   382

{

   383

	TileIndex tile;

   384

   385

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

   386

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

   387

			ResetIndustryConstructionStage(tile);

   388

			MarkTileDirtyByTile(tile);

   389

		}

   390

	}

   391

}

   392

   393

/**

   394

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

   395

 * 0: Fly towards the targetted oil refinery

   396

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

   397

 * 2: Refinery explosions

   398

 * 3: Fly out of the map

   399

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

   400

 */

   401

static void DisasterTick_Airplane(Vehicle *v)

   402

{

   403

	v->tick_counter++;

   404

	v->u.disaster.image_override =

   405

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

   406

   407

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   408

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

   409

   410

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

   411

		DeleteDisasterVeh(v);

   412

		return;

   413

	}

   414

   415

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

   416

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

   417

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

   418

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

   419

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

   420

			uint32 r = Random();

   421

   422

			CreateEffectVehicleAbove(

   423

				GB(r,  0, 6) + x,

   424

				GB(r,  6, 6) + y,

   425

				GB(r, 12, 4),

   426

				EV_EXPLOSION_SMALL);

   427

   428

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

   429

		}

   430

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

   431

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

   432

			Industry *i;

   433

   434

			v->current_order.dest = 2;

   435

			v->age = 0;

   436

   437

			i = GetIndustry(v->dest_tile);

   438

			DestructIndustry(i);

   439

   440

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

   441

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

   442

			SndPlayTileFx(SND_12_EXPLOSION, i->xy);

   443

		}

   444

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

   445

		int x, y;

   446

		TileIndex tile;

   447

		uint ind;

   448

   449

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

   450

		y = v->y_pos;

   451

   452

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

   453

   454

		tile = TileVirtXY(x, y);

   455

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

   456

   457

		ind = GetIndustryIndex(tile);

   458

		v->dest_tile = ind;

   459

   460

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

   461

			v->current_order.dest = 1;

   462

			v->age = 0;

   463

		}

   464

	}

   465

}

   466

   467

/**

   468

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

   469

 * 0: Fly towards the targetted factory

   470

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

   471

 * 2: Factory explosions

   472

 * 3: Fly out of the map

   473

 */

   474

static void DisasterTick_Helicopter(Vehicle *v)

   475

{

   476

	v->tick_counter++;

   477

	v->u.disaster.image_override =

   478

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

   479

   480

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   481

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

   482

   483

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

   484

		DeleteDisasterVeh(v);

   485

		return;

   486

	}

   487

   488

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

   489

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

   490

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

   491

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

   492

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

   493

			uint32 r = Random();

   494

   495

			CreateEffectVehicleAbove(