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 "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.Free();

   139

   140

	DisasterVehicleUpdateImage(v);

   141

	VehiclePositionChanged(v);

   142

	BeginVehicleMove(v);

   143

	EndVehicleMove(v);

   144

}

   145

   146

static void DeleteDisasterVeh(Vehicle *v)

   147

{

   148

	DeleteVehicleChain(v);

   149

}

   150

   151

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

   152

{

   153

	Vehicle *u;

   154

   155

	BeginVehicleMove(v);

   156

	v->x_pos = x;

   157

	v->y_pos = y;

   158

	v->z_pos = z;

   159

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

   160

   161

	DisasterVehicleUpdateImage(v);

   162

	VehiclePositionChanged(v);

   163

	EndVehicleMove(v);

   164

   165

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

   166

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

   167

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

   168

		BeginVehicleMove(u);

   169

   170

		u->x_pos = x;

   171

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

   172

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

   173

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

   174

		u->direction = v->direction;

   175

   176

		DisasterVehicleUpdateImage(u);

   177

		VehiclePositionChanged(u);

   178

		EndVehicleMove(u);

   179

   180

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

   181

			BeginVehicleMove(u);

   182

			u->x_pos = x;

   183

			u->y_pos = y;

   184

			u->z_pos = z + 5;

   185

			VehiclePositionChanged(u);

   186

			EndVehicleMove(u);

   187

		}

   188

	}

   189

}

   190

   191

/**

   192

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

   193

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

   194

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

   195

 * 2: Create more smoke and leave debris on ground

   196

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

   197

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

   198

 */

   199

static void DisasterTick_Zeppeliner(Vehicle *v)

   200

{

   201

	Station *st;

   202

	int x, y;

   203

	byte z;

   204

	TileIndex tile;

   205

   206

	v->tick_counter++;

   207

   208

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

   209

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

   210

   211

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   212

   213

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

   214

   215

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

   216

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

   217

				v->current_order.dest = 2;

   218

				v->age = 0;

   219

			}

   220

   221

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

   222

   223

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

   224

			tile = v->tile;

   225

   226

			if (IsValidTile(tile) &&

   227

					IsTileType(tile, MP_STATION) &&

   228

					IsAirport(tile) &&

   229

					IsHumanPlayer(GetTileOwner(tile))) {

   230

				v->current_order.dest = 1;

   231

				v->age = 0;

   232

   233

				SetDParam(0, GetStationIndex(tile));

   234

				AddNewsItem(STR_B000_ZEPPELIN_DISASTER_AT,

   235

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

   236

					v->index,

   237

					0);

   238

			}

   239

		}

   240

   241

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

   242

		return;

   243

	}

   244

   245

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

   246

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

   247

   248

		tile = v->tile;

   249

   250

		if (IsValidTile(tile) &&

   251

				IsTileType(tile, MP_STATION) &&

   252

				IsAirport(tile) &&

   253

				IsHumanPlayer(GetTileOwner(tile))) {

   254

			st = GetStationByTile(tile);

   255

			CLRBITS(st->airport_flags, RUNWAY_IN_block);

   256

		}

   257

   258

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

   259

		DeleteDisasterVeh(v);

   260

		return;

   261

	}

   262

   263

	x = v->x_pos;

   264

	y = v->y_pos;

   265

	z = GetSlopeZ(x,y);

   266

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

   267

	SetDisasterVehiclePos(v, x, y, z);

   268

   269

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

   270

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

   271

		SndPlayVehicleFx(SND_12_EXPLOSION, v);

   272

		v->u.disaster.image_override = SPR_BLIMP_CRASHING;

   273

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

   274

		v->u.disaster.image_override = SPR_BLIMP_CRASHED;

   275

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

   276

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

   277

			uint32 r = Random();

   278

   279

			CreateEffectVehicleRel(v,

   280

				GB(r, 0, 4) - 7,

   281

				GB(r, 4, 4) - 7,

   282

				GB(r, 8, 3) + 5,

   283

				EV_EXPLOSION_SMALL);

   284

		}

   285

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

   286

		v->current_order.dest = 3;

   287

		v->age = 0;

   288

	}

   289

   290

	tile = v->tile;

   291

	if (IsValidTile(tile) &&

   292

			IsTileType(tile, MP_STATION) &&

   293

			IsAirport(tile) &&

   294

			IsHumanPlayer(GetTileOwner(tile))) {

   295

		st = GetStationByTile(tile);

   296

		SETBITS(st->airport_flags, RUNWAY_IN_block);

   297

	}

   298

}

   299

   300

/**

   301

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

   302

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

   303

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

   304

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

   305

 */

   306

static void DisasterTick_Ufo(Vehicle *v)

   307

{

   308

	Vehicle *u;

   309

	uint dist;

   310

	byte z;

   311

   312

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

   313

   314

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

   315

		/* Fly around randomly */

   316

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

   317

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

   318

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

   319

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

   320

			GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   321

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

   322

			return;

   323

		}

   324

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

   325

			v->dest_tile = RandomTile();

   326

			return;

   327

		}

   328

		v->current_order.dest = 1;

   329

   330

		FOR_ALL_VEHICLES(u) {

   331

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

   332

				v->dest_tile = u->index;

   333

				v->age = 0;

   334

				return;

   335

			}

   336

		}

   337

   338

		DeleteDisasterVeh(v);

   339

	} else {

   340

		/* Target a vehicle */

   341

		u = GetVehicle(v->dest_tile);

   342

		if (u->type != VEH_ROAD) {

   343

			DeleteDisasterVeh(v);

   344

			return;

   345

		}

   346

   347

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

   348

   349

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

   350

			u->breakdown_ctr = 3;

   351

			u->breakdown_delay = 140;

   352

		}

   353

   354

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

   355

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   356

   357

		z = v->z_pos;

   358

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

   359

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

   360

   361

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

   362

			v->age++;

   363

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

   364

				u->u.road.crashed_ctr++;

   365

				u->vehstatus |= VS_CRASHED;

   366

   367

				AddNewsItem(STR_B001_ROAD_VEHICLE_DESTROYED,

   368

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

   369

					u->index,

   370

					0);

   371

			}

   372

		}

   373

   374

		/* Destroy? */

   375

		if (v->age > 50) {

   376

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

   377

			SndPlayVehicleFx(SND_12_EXPLOSION, v);

   378

			DeleteDisasterVeh(v);

   379

		}

   380

	}

   381

}

   382

   383

static void DestructIndustry(Industry *i)

   384

{

   385

	TileIndex tile;

   386

   387

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

   388

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

   389

			ResetIndustryConstructionStage(tile);

   390

			MarkTileDirtyByTile(tile);

   391

		}

   392

	}

   393

}

   394

   395

/**

   396

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

   397

 * 0: Fly towards the targetted oil refinery

   398

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

   399

 * 2: Refinery explosions

   400

 * 3: Fly out of the map

   401

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

   402

 */

   403

static void DisasterTick_Airplane(Vehicle *v)

   404

{

   405

	v->tick_counter++;

   406

	v->u.disaster.image_override =

   407

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

   408

   409

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   410

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

   411

   412

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

   413

		DeleteDisasterVeh(v);

   414

		return;

   415

	}

   416

   417

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

   418

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

   419

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

   420

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

   421

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

   422

			uint32 r = Random();

   423

   424

			CreateEffectVehicleAbove(

   425

				GB(r,  0, 6) + x,

   426

				GB(r,  6, 6) + y,

   427

				GB(r, 12, 4),

   428

				EV_EXPLOSION_SMALL);

   429

   430

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

   431

		}

   432

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

   433

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

   434

			Industry *i;

   435

   436

			v->current_order.dest = 2;

   437

			v->age = 0;

   438

   439

			i = GetIndustry(v->dest_tile);

   440

			DestructIndustry(i);

   441

   442

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

   443

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

   444

			SndPlayTileFx(SND_12_EXPLOSION, i->xy);

   445

		}

   446

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

   447

		int x, y;

   448

		TileIndex tile;

   449

		uint ind;

   450

   451

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

   452

		y = v->y_pos;

   453

   454

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

   455

   456

		tile = TileVirtXY(x, y);

   457

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

   458

   459

		ind = GetIndustryIndex(tile);

   460

		v->dest_tile = ind;

   461

   462

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

   463

			v->current_order.dest = 1;

   464

			v->age = 0;

   465

		}

   466

	}

   467

}

   468

   469

/**

   470

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

   471

 * 0: Fly towards the targetted factory

   472

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

   473

 * 2: Factory explosions

   474

 * 3: Fly out of the map

   475

 */

   476

static void DisasterTick_Helicopter(Vehicle *v)

   477

{

   478

	v->tick_counter++;

   479

	v->u.disaster.image_override =

   480

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

   481

   482

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   483

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

   484

   485

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

   486

		DeleteDisasterVeh(v);

   487

		return;

   488

	}

   489

   490

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

   491

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

   492

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

   493

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

   494

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

   495

			uint32 r = Random();

   496

   497