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"

    22

#include "landscape.h"

    24

#include "industry_map.h"

    25

#include "station_map.h"

    26

#include "table/strings.h"

    27

#include "map.h"

    28

#include "vehicle.h"

    29

#include "command_func.h"

    31

#include "news.h"

    32

#include "station.h"

    33

#include "waypoint.h"

    34

#include "town.h"

    35

#include "industry.h"

    36

#include "player.h"

    37

#include "airport.h"

    38

#include "sound.h"

    39

#include "variables.h"

    40

#include "table/sprites.h"

    41

#include "date.h"

    42

#include "strings_func.h"

    43

    44

enum DisasterSubType {

    45

	ST_Zeppeliner,

    46

	ST_Zeppeliner_Shadow,

    47

	ST_Small_Ufo,

    48

	ST_Small_Ufo_Shadow,

    49

	ST_Airplane,

    50

	ST_Airplane_Shadow,

    51

	ST_Helicopter,

    52

	ST_Helicopter_Shadow,

    53

	ST_Helicopter_Rotors,

    54

	ST_Big_Ufo,

    55

	ST_Big_Ufo_Shadow,

    56

	ST_Big_Ufo_Destroyer,

    57

	ST_Big_Ufo_Destroyer_Shadow,

    58

	ST_Small_Submarine,

    59

	ST_Big_Submarine,

    60

};

    61

    62

static void DisasterClearSquare(TileIndex tile)

    63

{

    64

	if (!EnsureNoVehicleOnGround(tile)) return;

    65

    66

	switch (GetTileType(tile)) {

    67

		case MP_RAILWAY:

    68

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

    69

				PlayerID p = _current_player;

    70

				_current_player = OWNER_WATER;

    71

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

    72

				_current_player = p;

    73

			}

    74

			break;

    75

    76

		case MP_HOUSE: {

    77

			PlayerID p = _current_player;

    78

			_current_player = OWNER_NONE;

    79

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

    80

			_current_player = p;

    81

			break;

    82

		}

    83

    84

		case MP_TREES:

    85

		case MP_CLEAR:

    86

			DoClearSquare(tile);

    87

			break;

    88

    89

		default:

    90

			break;

    91

	}

    92

}

    93

    94

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

    95

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

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

   104

static const SpriteID * const _disaster_images[] = {

   105

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

   106

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

   107

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

   108

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

   109

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

   110

	_disaster_images_7, _disaster_images_7,                     ///< skyranger and shadow

   111

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

   112

};

   113

   114

static void DisasterVehicleUpdateImage(Vehicle *v)

   115

{

   116

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

   117

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

   118

	v->cur_image = img;

   119

}

   120

   121

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

   122

 * and owned by nobody */

   123

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

   124

{

   125

	v->x_pos = x;

   126

	v->y_pos = y;

   127

	v->z_pos = z;

   128

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

   129

	v->direction = direction;

   130

	v->subtype = subtype;

   131

	v->UpdateDeltaXY(INVALID_DIR);

   132

	v->owner = OWNER_NONE;

   133

	v->vehstatus = VS_UNCLICKABLE;

   134

	v->u.disaster.image_override = 0;

   135

	v->current_order.Free();

   136

   137

	DisasterVehicleUpdateImage(v);

   138

	VehiclePositionChanged(v);

   139

	BeginVehicleMove(v);

   140

	EndVehicleMove(v);

   141

}

   142

   143

static void DeleteDisasterVeh(Vehicle *v)

   144

{

   145

	DeleteVehicleChain(v);

   146

}

   147

   148

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

   149

{

   150

	Vehicle *u;

   151

   152

	BeginVehicleMove(v);

   153

	v->x_pos = x;

   154

	v->y_pos = y;

   155

	v->z_pos = z;

   156

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

   157

   158

	DisasterVehicleUpdateImage(v);

   159

	VehiclePositionChanged(v);

   160

	EndVehicleMove(v);

   161

   162

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

   163

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

   164

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

   165

		BeginVehicleMove(u);

   166

   167

		u->x_pos = x;

   168

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

   169

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

   170

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

   171

		u->direction = v->direction;

   172

   173

		DisasterVehicleUpdateImage(u);

   174

		VehiclePositionChanged(u);

   175

		EndVehicleMove(u);

   176

   177

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

   178

			BeginVehicleMove(u);

   179

			u->x_pos = x;

   180

			u->y_pos = y;

   181

			u->z_pos = z + 5;

   182

			VehiclePositionChanged(u);

   183

			EndVehicleMove(u);

   184

		}

   185

	}

   186

}

   187

   188

/**

   189

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

   190

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

   191

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

   192

 * 2: Create more smoke and leave debris on ground

   193

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

   194

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

   195

 */

   196

static void DisasterTick_Zeppeliner(Vehicle *v)

   197

{

   198

	Station *st;

   199

	int x, y;

   200

	byte z;

   201

	TileIndex tile;

   202

   203

	v->tick_counter++;

   204

   205

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

   206

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

   207

   208

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   209

   210

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

   211

   212

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

   213

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

   214

				v->current_order.dest = 2;

   215

				v->age = 0;

   216

			}

   217

   218

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

   219

   220

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

   221

			tile = v->tile;

   222

   223

			if (IsValidTile(tile) &&

   224

					IsTileType(tile, MP_STATION) &&

   225

					IsAirport(tile) &&

   226

					IsHumanPlayer(GetTileOwner(tile))) {

   227

				v->current_order.dest = 1;

   228

				v->age = 0;

   229

   230

				SetDParam(0, GetStationIndex(tile));

   231

				AddNewsItem(STR_B000_ZEPPELIN_DISASTER_AT,

   232

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

   233

					v->index,

   234

					0);

   235

			}

   236

		}

   237

   238

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

   239

		return;

   240

	}

   241

   242

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

   243

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

   244

   245

		tile = v->tile;

   246

   247

		if (IsValidTile(tile) &&

   248

				IsTileType(tile, MP_STATION) &&

   249

				IsAirport(tile) &&

   250

				IsHumanPlayer(GetTileOwner(tile))) {

   251

			st = GetStationByTile(tile);

   252

			CLRBITS(st->airport_flags, RUNWAY_IN_block);

   253

		}

   254

   255

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

   256

		DeleteDisasterVeh(v);

   257

		return;

   258

	}

   259

   260

	x = v->x_pos;

   261

	y = v->y_pos;

   262

	z = GetSlopeZ(x, y);

   263

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

   264

	SetDisasterVehiclePos(v, x, y, z);

   265

   266

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

   267

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

   268

		SndPlayVehicleFx(SND_12_EXPLOSION, v);

   269

		v->u.disaster.image_override = SPR_BLIMP_CRASHING;

   270

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

   271

		v->u.disaster.image_override = SPR_BLIMP_CRASHED;

   272

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

   273

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

   274

			uint32 r = Random();

   275

   276

			CreateEffectVehicleRel(v,

   277

				GB(r, 0, 4) - 7,

   278

				GB(r, 4, 4) - 7,

   279

				GB(r, 8, 3) + 5,

   280

				EV_EXPLOSION_SMALL);

   281

		}

   282

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

   283

		v->current_order.dest = 3;

   284

		v->age = 0;

   285

	}

   286

   287

	tile = v->tile;

   288

	if (IsValidTile(tile) &&

   289

			IsTileType(tile, MP_STATION) &&

   290

			IsAirport(tile) &&

   291

			IsHumanPlayer(GetTileOwner(tile))) {

   292

		st = GetStationByTile(tile);

   293

		SETBITS(st->airport_flags, RUNWAY_IN_block);

   294

	}

   295

}

   296

   297

/**

   298

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

   299

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

   300

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

   301

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

   302

 */

   303

static void DisasterTick_Ufo(Vehicle *v)

   304

{

   305

	Vehicle *u;

   306

	uint dist;

   307

	byte z;

   308

   309

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

   310

   311

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

   312

		/* Fly around randomly */

   313

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

   314

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

   315

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

   316

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

   317

			GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   318

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

   319

			return;

   320

		}

   321

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

   322

			v->dest_tile = RandomTile();

   323

			return;

   324

		}

   325

		v->current_order.dest = 1;

   326

   327

		FOR_ALL_VEHICLES(u) {

   328

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

   329

				v->dest_tile = u->index;

   330

				v->age = 0;

   331

				return;

   332

			}

   333

		}

   334

   335

		DeleteDisasterVeh(v);

   336

	} else {

   337

		/* Target a vehicle */

   338

		u = GetVehicle(v->dest_tile);

   339

		if (u->type != VEH_ROAD) {

   340

			DeleteDisasterVeh(v);

   341

			return;

   342

		}

   343

   344

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

   345

   346

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

   347

			u->breakdown_ctr = 3;

   348

			u->breakdown_delay = 140;

   349

		}

   350

   351

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

   352

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   353

   354

		z = v->z_pos;

   355

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

   356

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

   357

   358

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

   359

			v->age++;

   360

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

   361

				u->u.road.crashed_ctr++;

   362

				u->vehstatus |= VS_CRASHED;

   363

   364

				AddNewsItem(STR_B001_ROAD_VEHICLE_DESTROYED,

   365

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

   366

					u->index,

   367

					0);

   368

			}

   369

		}

   370

   371

		/* Destroy? */

   372

		if (v->age > 50) {

   373

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

   374

			SndPlayVehicleFx(SND_12_EXPLOSION, v);

   375

			DeleteDisasterVeh(v);

   376

		}

   377

	}

   378

}

   379

   380

static void DestructIndustry(Industry *i)

   381

{

   382

	TileIndex tile;

   383

   384

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

   385

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

   386

			ResetIndustryConstructionStage(tile);

   387

			MarkTileDirtyByTile(tile);

   388

		}

   389

	}

   390

}

   391

   392

/**

   393

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

   394

 * 0: Fly towards the targetted oil refinery

   395

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

   396

 * 2: Refinery explosions

   397

 * 3: Fly out of the map

   398

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

   399

 */

   400

static void DisasterTick_Airplane(Vehicle *v)

   401

{

   402

	v->tick_counter++;

   403

	v->u.disaster.image_override =

   404

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

   405

   406

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   407

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

   408

   409

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

   410

		DeleteDisasterVeh(v);

   411

		return;

   412

	}

   413

   414

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

   415

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

   416

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

   417

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

   418

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

   419

			uint32 r = Random();

   420

   421

			CreateEffectVehicleAbove(

   422

				GB(r,  0, 6) + x,

   423

				GB(r,  6, 6) + y,

   424

				GB(r, 12, 4),

   425

				EV_EXPLOSION_SMALL);

   426

   427

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

   428

		}

   429

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

   430

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

   431

			Industry *i;

   432

   433

			v->current_order.dest = 2;

   434

			v->age = 0;

   435

   436

			i = GetIndustry(v->dest_tile);

   437

			DestructIndustry(i);

   438

   439

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

   440

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

   441

			SndPlayTileFx(SND_12_EXPLOSION, i->xy);

   442

		}

   443

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

   444

		int x, y;

   445

		TileIndex tile;

   446

		uint ind;

   447

   448

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

   449

		y = v->y_pos;

   450

   451

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

   452

   453

		tile = TileVirtXY(x, y);

   454

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

   455

   456

		ind = GetIndustryIndex(tile);

   457

		v->dest_tile = ind;

   458

   459

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

   460

			v->current_order.dest = 1;

   461

			v->age = 0;

   462

		}

   463

	}

   464

}

   465

   466

/**

   467

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

   468

 * 0: Fly towards the targetted factory

   469

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

   470

 * 2: Factory explosions

   471

 * 3: Fly out of the map

   472

 */

   473

static void DisasterTick_Helicopter(Vehicle *v)

   474

{

   475

	v->tick_counter++;

   476

	v->u.disaster.image_override =

   477

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

   478

   479

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   480

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

   481

   482

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

   483

		DeleteDisasterVeh(v);

   484

		return;

   485

	}

   486

   487

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

   488

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

   489

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

   490

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

   491

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

   492

			uint32 r = Random();

   493

   494

			CreateEffectVehicleAbove(

   495

				GB(r,  0, 6) + x,