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

    28

#include "station_base.h"

    29

#include "waypoint.h"

    30

#include "town.h"

    31

#include "industry.h"

    32

#include "company_func.h"

    33

#include "airport.h"

    34

#include "variables.h"

    35

#include "settings_type.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

#include "effectvehicle_func.h"

    43

#include "roadveh.h"

    44

    45

#include "table/strings.h"

    46

#include "table/sprites.h"

    47

    48

enum DisasterSubType {

    49

	ST_Zeppeliner,

    50

	ST_Zeppeliner_Shadow,

    51

	ST_Small_Ufo,

    52

	ST_Small_Ufo_Shadow,

    53

	ST_Airplane,

    54

	ST_Airplane_Shadow,

    55

	ST_Helicopter,

    56

	ST_Helicopter_Shadow,

    57

	ST_Helicopter_Rotors,

    58

	ST_Big_Ufo,

    59

	ST_Big_Ufo_Shadow,

    60

	ST_Big_Ufo_Destroyer,

    61

	ST_Big_Ufo_Destroyer_Shadow,

    62

	ST_Small_Submarine,

    63

	ST_Big_Submarine,

    64

};

    65

    66

static void DisasterClearSquare(TileIndex tile)

    67

{

    68

	if (!EnsureNoVehicleOnGround(tile)) return;

    69

    70

	switch (GetTileType(tile)) {

    71

		case MP_RAILWAY:

    72

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

    73

				CompanyID old_company = _current_company;

    74

				_current_company = OWNER_WATER;

    75

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

    76

				_current_company = old_company;

    77

    78

				/* update signals in buffer */

    79

				UpdateSignalsInBuffer();

    80

			}

    81

			break;

    82

    83

		case MP_HOUSE: {

    84

			CompanyID old_company = _current_company;

    85

			_current_company = OWNER_NONE;

    86

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

    87

			_current_company = old_company;

    88

			break;

    89

		}

    90

    91

		case MP_TREES:

    92

		case MP_CLEAR:

    93

			DoClearSquare(tile);

    94

			break;

    95

    96

		default:

    97

			break;

    98

	}

    99

}

   100

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

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

   108

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

   109

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

   110

   111

static const SpriteID * const _disaster_images[] = {

   112

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

   113

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

   114

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

   115

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

   116

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

   117

	_disaster_images_7, _disaster_images_7,                     ///< skyranger and shadow

   118

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

   119

};

   120

   121

static void DisasterVehicleUpdateImage(Vehicle *v)

   122

{

   123

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

   124

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

   125

	v->cur_image = img;

   126

}

   127

   128

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

   129

 * and owned by nobody */

   130

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

   131

{

   132

	v->x_pos = x;

   133

	v->y_pos = y;

   134

	v->z_pos = z;

   135

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

   136

	v->direction = direction;

   137

	v->subtype = subtype;

   138

	v->UpdateDeltaXY(INVALID_DIR);

   139

	v->owner = OWNER_NONE;

   140

	v->vehstatus = VS_UNCLICKABLE;

   141

	v->u.disaster.image_override = 0;

   142

	v->current_order.Free();

   143

   144

	DisasterVehicleUpdateImage(v);

   145

	VehiclePositionChanged(v);

   146

	MarkSingleVehicleDirty(v);

   147

}

   148

   149

static void DeleteDisasterVeh(Vehicle *v)

   150

{

   151

	DeleteVehicleChain(v);

   152

}

   153

   154

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

   155

{

   156

	Vehicle *u;

   157

   158

	BeginVehicleMove(v);

   159

	v->x_pos = x;

   160

	v->y_pos = y;

   161

	v->z_pos = z;

   162

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

   163

   164

	DisasterVehicleUpdateImage(v);

   165

	VehiclePositionChanged(v);

   166

	EndVehicleMove(v);

   167

   168

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

   169

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

   170

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

   171

		BeginVehicleMove(u);

   172

   173

		u->x_pos = x;

   174

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

   175

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

   176

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

   177

		u->direction = v->direction;

   178

   179

		DisasterVehicleUpdateImage(u);

   180

		VehiclePositionChanged(u);

   181

		EndVehicleMove(u);

   182

   183

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

   184

			BeginVehicleMove(u);

   185

			u->x_pos = x;

   186

			u->y_pos = y;

   187

			u->z_pos = z + 5;

   188

			VehiclePositionChanged(u);

   189

			EndVehicleMove(u);

   190

		}

   191

	}

   192

}

   193

   194

/**

   195

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

   196

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

   197

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

   198

 * 2: Create more smoke and leave debris on ground

   199

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

   200

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

   201

 */

   202

static void DisasterTick_Zeppeliner(Vehicle *v)

   203

{

   204

	Station *st;

   205

	int x, y;

   206

	byte z;

   207

	TileIndex tile;

   208

   209

	v->tick_counter++;

   210

   211

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

   212

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

   213

   214

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   215

   216

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

   217

   218

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

   219

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

   220

				v->current_order.SetDestination(2);

   221

				v->age = 0;

   222

			}

   223

   224

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

   225

   226

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

   227

			tile = v->tile;

   228

   229

			if (IsValidTile(tile) &&

   230

					IsTileType(tile, MP_STATION) &&

   231

					IsAirport(tile) &&

   232

					IsHumanCompany(GetTileOwner(tile))) {

   233

				v->current_order.SetDestination(1);

   234

				v->age = 0;

   235

   236

				SetDParam(0, GetStationIndex(tile));

   237

				AddNewsItem(STR_B000_ZEPPELIN_DISASTER_AT,

   238

					NS_ACCIDENT_VEHICLE,

   239

					v->index,

   240

					0);

   241

			}

   242

		}

   243

   244

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

   245

		return;

   246

	}

   247

   248

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

   249

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

   250

   251

		tile = v->tile;

   252

   253

		if (IsValidTile(tile) &&

   254

				IsTileType(tile, MP_STATION) &&

   255

				IsAirport(tile) &&

   256

				IsHumanCompany(GetTileOwner(tile))) {

   257

			st = GetStationByTile(tile);

   258

			CLRBITS(st->airport_flags, RUNWAY_IN_block);

   259

		}

   260

   261

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

   262

		DeleteDisasterVeh(v);

   263

		return;

   264

	}

   265

   266

	x = v->x_pos;

   267

	y = v->y_pos;

   268

	z = GetSlopeZ(x, y);

   269

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

   270

	SetDisasterVehiclePos(v, x, y, z);

   271

   272

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

   273

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

   274

		SndPlayVehicleFx(SND_12_EXPLOSION, v);

   275

		v->u.disaster.image_override = SPR_BLIMP_CRASHING;

   276

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

   277

		v->u.disaster.image_override = SPR_BLIMP_CRASHED;

   278

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

   279

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

   280

			uint32 r = Random();

   281

   282

			CreateEffectVehicleRel(v,

   283

				GB(r, 0, 4) - 7,

   284

				GB(r, 4, 4) - 7,

   285

				GB(r, 8, 3) + 5,

   286

				EV_EXPLOSION_SMALL);

   287

		}

   288

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

   289

		v->current_order.SetDestination(3);

   290

		v->age = 0;

   291

	}

   292

   293

	tile = v->tile;

   294

	if (IsValidTile(tile) &&

   295

			IsTileType(tile, MP_STATION) &&

   296

			IsAirport(tile) &&

   297

			IsHumanCompany(GetTileOwner(tile))) {

   298

		st = GetStationByTile(tile);

   299

		SETBITS(st->airport_flags, RUNWAY_IN_block);

   300

	}

   301

}

   302

   303

/**

   304

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

   305

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

   306

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

   307

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

   308

 */

   309

static void DisasterTick_Ufo(Vehicle *v)

   310

{

   311

	Vehicle *u;

   312

	uint dist;

   313

	byte z;

   314

   315

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

   316

   317

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

   318

		/* Fly around randomly */

   319

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

   320

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

   321

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

   322

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

   323

			GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   324

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

   325

			return;

   326

		}

   327

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

   328

			v->dest_tile = RandomTile();

   329

			return;

   330

		}

   331

		v->current_order.SetDestination(1);

   332

   333

		FOR_ALL_VEHICLES(u) {

   334

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

   335

				v->dest_tile = u->index;

   336

				v->age = 0;

   337

				return;

   338

			}

   339

		}

   340

   341

		DeleteDisasterVeh(v);

   342

	} else {

   343

		/* Target a vehicle */

   344

		u = GetVehicle(v->dest_tile);

   345

		if (u->type != VEH_ROAD || !IsRoadVehFront(u)) {

   346

			DeleteDisasterVeh(v);

   347

			return;

   348

		}

   349

   350

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

   351

   352

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

   353

			u->breakdown_ctr = 3;

   354

			u->breakdown_delay = 140;

   355

		}

   356

   357

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

   358

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   359

   360

		z = v->z_pos;

   361

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

   362

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

   363

   364

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

   365

			v->age++;

   366

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

   367

				u->u.road.crashed_ctr++;

   368

   369

				AddNewsItem(STR_B001_ROAD_VEHICLE_DESTROYED,

   370

					NS_ACCIDENT_VEHICLE,

   371

					u->index,

   372

					0);

   373

   374

				for (Vehicle *w = u; w != NULL; w = w->Next()) {

   375

					w->vehstatus |= VS_CRASHED;

   376

					MarkSingleVehicleDirty(w);

   377

				}

   378

			}

   379

		}

   380

   381

		/* Destroy? */

   382

		if (v->age > 50) {

   383

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

   384

			SndPlayVehicleFx(SND_12_EXPLOSION, v);

   385

			DeleteDisasterVeh(v);

   386

		}

   387

	}

   388

}

   389

   390

static void DestructIndustry(Industry *i)

   391

{

   392

	TileIndex tile;

   393

   394

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

   395

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

   396

			ResetIndustryConstructionStage(tile);

   397

			MarkTileDirtyByTile(tile);

   398

		}

   399

	}

   400

}

   401

   402

/**

   403

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

   404

 * 0: Fly towards the targetted oil refinery

   405

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

   406

 * 2: Refinery explosions

   407

 * 3: Fly out of the map

   408

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

   409

 */

   410

static void DisasterTick_Airplane(Vehicle *v)

   411

{

   412

	v->tick_counter++;

   413

	v->u.disaster.image_override =

   414

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

   415

   416

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   417

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

   418

   419

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

   420

		DeleteDisasterVeh(v);

   421

		return;

   422

	}

   423

   424

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

   425

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

   426

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

   427

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

   428

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

   429

			uint32 r = Random();

   430

   431

			CreateEffectVehicleAbove(

   432

				GB(r,  0, 6) + x,

   433

				GB(r,  6, 6) + y,

   434

				GB(r, 12, 4),

   435

				EV_EXPLOSION_SMALL);

   436

   437

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

   438

		}

   439

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

   440

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

   441

			Industry *i;

   442

   443

			v->current_order.SetDestination(2);

   444

			v->age = 0;

   445

   446

			i = GetIndustry(v->dest_tile);

   447

			DestructIndustry(i);

   448

   449

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

   450

			AddNewsItem(STR_B002_OIL_REFINERY_EXPLOSION, NS_ACCIDENT_TILE, i->xy, 0);

   451

			SndPlayTileFx(SND_12_EXPLOSION, i->xy);

   452

		}

   453

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

   454

		int x, y;

   455

		TileIndex tile;

   456

		uint ind;

   457

   458

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

   459

		y = v->y_pos;

   460

   461

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

   462

   463

		tile = TileVirtXY(x, y);

   464

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

   465

   466

		ind = GetIndustryIndex(tile);

   467

		v->dest_tile = ind;

   468

   469

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

   470

			v->current_order.SetDestination(1);

   471

			v->age = 0;

   472

		}

   473

	}

   474

}

   475

   476

/**

   477

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

   478

 * 0: Fly towards the targetted factory

   479

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

   480

 * 2: Factory explosions

   481

 * 3: Fly out of the map

   482

 */

   483

static void DisasterTick_Helicopter(Vehicle *v)

   484

{

   485

	v->tick_counter++;

   486

	v->u.disaster.image_override =

   487

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

   488

   489

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   490

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

   491

   492

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

   493

		DeleteDisasterVeh(v);

   494

		return;

   495