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"

    36

#include "strings_func.h"

    37

#include "date_func.h"

    38

#include "functions.h"

    39

#include "vehicle_func.h"

    40

#include "vehicle_base.h"

    41

#include "sound_func.h"

    42

    43

#include "table/strings.h"

    44

#include "table/sprites.h"

    45

    46

enum DisasterSubType {

    47

	ST_Zeppeliner,

    48

	ST_Zeppeliner_Shadow,

    49

	ST_Small_Ufo,

    50

	ST_Small_Ufo_Shadow,

    51

	ST_Airplane,

    52

	ST_Airplane_Shadow,

    53

	ST_Helicopter,

    54

	ST_Helicopter_Shadow,

    55

	ST_Helicopter_Rotors,

    56

	ST_Big_Ufo,

    57

	ST_Big_Ufo_Shadow,

    58

	ST_Big_Ufo_Destroyer,

    59

	ST_Big_Ufo_Destroyer_Shadow,

    60

	ST_Small_Submarine,

    61

	ST_Big_Submarine,

    62

};

    63

    64

static void DisasterClearSquare(TileIndex tile)

    65

{

    66

	if (!EnsureNoVehicleOnGround(tile)) return;

    67

    68

	switch (GetTileType(tile)) {

    69

		case MP_RAILWAY:

    70

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

    71

				PlayerID p = _current_player;

    72

				_current_player = OWNER_WATER;

    73

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

    74

				_current_player = p;

    75

			}

    76

			break;

    77

    78

		case MP_HOUSE: {

    79

			PlayerID p = _current_player;

    80

			_current_player = OWNER_NONE;

    81

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

    82

			_current_player = p;

    83

			break;

    84

		}

    85

    86

		case MP_TREES:

    87

		case MP_CLEAR:

    88

			DoClearSquare(tile);

    89

			break;

    90

    91

		default:

    92

			break;

    93

	}

    94

}

    95

    96

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

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

   106

static const SpriteID * const _disaster_images[] = {

   107

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

   108

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

   109

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

   110

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

   111

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

   112

	_disaster_images_7, _disaster_images_7,                     ///< skyranger and shadow

   113

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

   114

};

   115

   116

static void DisasterVehicleUpdateImage(Vehicle *v)

   117

{

   118

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

   119

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

   120

	v->cur_image = img;

   121

}

   122

   123

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

   124

 * and owned by nobody */

   125

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

   126

{

   127

	v->x_pos = x;

   128

	v->y_pos = y;

   129

	v->z_pos = z;

   130

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

   131

	v->direction = direction;

   132

	v->subtype = subtype;

   133

	v->UpdateDeltaXY(INVALID_DIR);

   134

	v->owner = OWNER_NONE;

   135

	v->vehstatus = VS_UNCLICKABLE;

   136

	v->u.disaster.image_override = 0;

   137

	v->current_order.Free();

   138

   139

	DisasterVehicleUpdateImage(v);

   140

	VehiclePositionChanged(v);

   141

	BeginVehicleMove(v);

   142

	EndVehicleMove(v);

   143

}

   144

   145

static void DeleteDisasterVeh(Vehicle *v)

   146

{

   147

	DeleteVehicleChain(v);

   148

}

   149

   150

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

   151

{

   152

	Vehicle *u;

   153

   154

	BeginVehicleMove(v);

   155

	v->x_pos = x;

   156

	v->y_pos = y;

   157

	v->z_pos = z;

   158

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

   159

   160

	DisasterVehicleUpdateImage(v);

   161

	VehiclePositionChanged(v);

   162

	EndVehicleMove(v);

   163

   164

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

   165

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

   166

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

   167

		BeginVehicleMove(u);

   168

   169

		u->x_pos = x;

   170

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

   171

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

   172

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

   173

		u->direction = v->direction;

   174

   175

		DisasterVehicleUpdateImage(u);

   176

		VehiclePositionChanged(u);

   177

		EndVehicleMove(u);

   178

   179

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

   180

			BeginVehicleMove(u);

   181

			u->x_pos = x;

   182

			u->y_pos = y;

   183

			u->z_pos = z + 5;

   184

			VehiclePositionChanged(u);

   185

			EndVehicleMove(u);

   186

		}

   187

	}

   188

}

   189

   190

/**

   191

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

   192

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

   193

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

   194

 * 2: Create more smoke and leave debris on ground

   195

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

   196

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

   197

 */

   198

static void DisasterTick_Zeppeliner(Vehicle *v)

   199

{

   200

	Station *st;

   201

	int x, y;

   202

	byte z;

   203

	TileIndex tile;

   204

   205

	v->tick_counter++;

   206

   207

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

   208

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

   209

   210

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   211

   212

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

   213

   214

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

   215

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

   216

				v->current_order.dest = 2;

   217

				v->age = 0;

   218

			}

   219

   220

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

   221

   222

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

   223

			tile = v->tile;

   224

   225

			if (IsValidTile(tile) &&

   226

					IsTileType(tile, MP_STATION) &&

   227

					IsAirport(tile) &&

   228

					IsHumanPlayer(GetTileOwner(tile))) {

   229

				v->current_order.dest = 1;

   230

				v->age = 0;

   231

   232

				SetDParam(0, GetStationIndex(tile));

   233

				AddNewsItem(STR_B000_ZEPPELIN_DISASTER_AT,

   234

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

   235

					v->index,

   236

					0);

   237

			}

   238

		}

   239

   240

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

   241

		return;

   242

	}

   243

   244

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

   245

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

   246

   247

		tile = v->tile;

   248

   249

		if (IsValidTile(tile) &&

   250

				IsTileType(tile, MP_STATION) &&

   251

				IsAirport(tile) &&

   252

				IsHumanPlayer(GetTileOwner(tile))) {

   253

			st = GetStationByTile(tile);

   254

			CLRBITS(st->airport_flags, RUNWAY_IN_block);

   255

		}

   256

   257

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

   258

		DeleteDisasterVeh(v);

   259

		return;

   260

	}

   261

   262

	x = v->x_pos;

   263

	y = v->y_pos;

   264

	z = GetSlopeZ(x, y);

   265

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

   266

	SetDisasterVehiclePos(v, x, y, z);

   267

   268

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

   269

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

   270

		SndPlayVehicleFx(SND_12_EXPLOSION, v);

   271

		v->u.disaster.image_override = SPR_BLIMP_CRASHING;

   272

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

   273

		v->u.disaster.image_override = SPR_BLIMP_CRASHED;

   274

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

   275

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

   276

			uint32 r = Random();

   277

   278

			CreateEffectVehicleRel(v,

   279

				GB(r, 0, 4) - 7,

   280

				GB(r, 4, 4) - 7,

   281

				GB(r, 8, 3) + 5,

   282

				EV_EXPLOSION_SMALL);

   283

		}

   284

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

   285

		v->current_order.dest = 3;

   286

		v->age = 0;

   287

	}

   288

   289

	tile = v->tile;

   290

	if (IsValidTile(tile) &&

   291

			IsTileType(tile, MP_STATION) &&

   292

			IsAirport(tile) &&

   293

			IsHumanPlayer(GetTileOwner(tile))) {

   294

		st = GetStationByTile(tile);

   295

		SETBITS(st->airport_flags, RUNWAY_IN_block);

   296

	}

   297

}

   298

   299

/**

   300

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

   301

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

   302

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

   303

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

   304

 */

   305

static void DisasterTick_Ufo(Vehicle *v)

   306

{

   307

	Vehicle *u;

   308

	uint dist;

   309

	byte z;

   310

   311

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

   312

   313

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

   314

		/* Fly around randomly */

   315

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

   316

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

   317

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

   318

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

   319

			GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   320

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

   321

			return;

   322

		}

   323

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

   324

			v->dest_tile = RandomTile();

   325

			return;

   326

		}

   327

		v->current_order.dest = 1;

   328

   329

		FOR_ALL_VEHICLES(u) {

   330

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

   331

				v->dest_tile = u->index;

   332

				v->age = 0;

   333

				return;

   334

			}

   335

		}

   336

   337

		DeleteDisasterVeh(v);

   338

	} else {

   339

		/* Target a vehicle */

   340

		u = GetVehicle(v->dest_tile);

   341

		if (u->type != VEH_ROAD) {

   342

			DeleteDisasterVeh(v);

   343

			return;

   344

		}

   345

   346

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

   347

   348

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

   349

			u->breakdown_ctr = 3;

   350

			u->breakdown_delay = 140;

   351

		}

   352

   353

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

   354

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   355

   356

		z = v->z_pos;

   357

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

   358

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

   359

   360

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

   361

			v->age++;

   362

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

   363

				u->u.road.crashed_ctr++;

   364

				u->vehstatus |= VS_CRASHED;

   365

   366

				AddNewsItem(STR_B001_ROAD_VEHICLE_DESTROYED,

   367

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

   368

					u->index,

   369

					0);

   370

			}

   371

		}

   372

   373

		/* Destroy? */

   374

		if (v->age > 50) {

   375

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

   376

			SndPlayVehicleFx(SND_12_EXPLOSION, v);

   377

			DeleteDisasterVeh(v);

   378

		}

   379

	}

   380

}

   381

   382

static void DestructIndustry(Industry *i)

   383

{

   384

	TileIndex tile;

   385

   386

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

   387

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

   388

			ResetIndustryConstructionStage(tile);

   389

			MarkTileDirtyByTile(tile);

   390

		}

   391

	}

   392

}

   393

   394

/**

   395

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

   396

 * 0: Fly towards the targetted oil refinery

   397

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

   398

 * 2: Refinery explosions

   399

 * 3: Fly out of the map

   400

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

   401

 */

   402

static void DisasterTick_Airplane(Vehicle *v)

   403

{

   404

	v->tick_counter++;

   405

	v->u.disaster.image_override =

   406

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

   407

   408

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   409

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

   410

   411

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

   412

		DeleteDisasterVeh(v);

   413

		return;

   414

	}

   415

   416

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

   417

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

   418

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

   419

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

   420

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

   421

			uint32 r = Random();

   422

   423

			CreateEffectVehicleAbove(

   424

				GB(r,  0, 6) + x,

   425

				GB(r,  6, 6) + y,

   426

				GB(r, 12, 4),

   427

				EV_EXPLOSION_SMALL);

   428

   429

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

   430

		}

   431

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

   432

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

   433

			Industry *i;

   434

   435

			v->current_order.dest = 2;

   436

			v->age = 0;

   437

   438

			i = GetIndustry(v->dest_tile);

   439

			DestructIndustry(i);

   440

   441

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

   442

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

   443

			SndPlayTileFx(SND_12_EXPLOSION, i->xy);

   444

		}

   445

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

   446

		int x, y;

   447

		TileIndex tile;

   448

		uint ind;

   449

   450

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

   451

		y = v->y_pos;

   452

   453

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

   454

   455

		tile = TileVirtXY(x, y);

   456

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

   457

   458

		ind = GetIndustryIndex(tile);

   459

		v->dest_tile = ind;

   460

   461

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

   462

			v->current_order.dest = 1;

   463

			v->age = 0;

   464

		}

   465

	}

   466

}

   467

   468

/**

   469

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

   470

 * 0: Fly towards the targetted factory

   471

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

   472

 * 2: Factory explosions

   473

 * 3: Fly out of the map

   474

 */

   475

static void DisasterTick_Helicopter(Vehicle *v)

   476

{

   477

	v->tick_counter++;

   478

	v->u.disaster.image_override =

   479

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

   480

   481

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   482

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

   483

   484

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

   485

		DeleteDisasterVeh(v);

   486

		return;

   487

	}

   488

   489

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

   490

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

   491

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

   492

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

   493

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

   494

			uint32 r = Random();

   495