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 "player_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

    44

#include "table/strings.h"

    45

#include "table/sprites.h"

    46

    47

enum DisasterSubType {

    48

	ST_Zeppeliner,

    49

	ST_Zeppeliner_Shadow,

    50

	ST_Small_Ufo,

    51

	ST_Small_Ufo_Shadow,

    52

	ST_Airplane,

    53

	ST_Airplane_Shadow,

    54

	ST_Helicopter,

    55

	ST_Helicopter_Shadow,

    56

	ST_Helicopter_Rotors,

    57

	ST_Big_Ufo,

    58

	ST_Big_Ufo_Shadow,

    59

	ST_Big_Ufo_Destroyer,

    60

	ST_Big_Ufo_Destroyer_Shadow,

    61

	ST_Small_Submarine,

    62

	ST_Big_Submarine,

    63

};

    64

    65

static void DisasterClearSquare(TileIndex tile)

    66

{

    67

	if (!EnsureNoVehicleOnGround(tile)) return;

    68

    69

	switch (GetTileType(tile)) {

    70

		case MP_RAILWAY:

    71

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

    72

				PlayerID p = _current_player;

    73

				_current_player = OWNER_WATER;

    74

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

    75

				_current_player = p;

    76

    77

				/* update signals in buffer */

    78

				UpdateSignalsInBuffer();

    79

			}

    80

			break;

    81

    82

		case MP_HOUSE: {

    83

			PlayerID p = _current_player;

    84

			_current_player = OWNER_NONE;

    85

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

    86

			_current_player = p;

    87

			break;

    88

		}

    89

    90

		case MP_TREES:

    91

		case MP_CLEAR:

    92

			DoClearSquare(tile);

    93

			break;

    94

    95

		default:

    96

			break;

    97

	}

    98

}

    99

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

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

   108

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

   109

   110

static const SpriteID * const _disaster_images[] = {

   111

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

   112

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

   113

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

   114

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

   115

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

   116

	_disaster_images_7, _disaster_images_7,                     ///< skyranger and shadow

   117

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

   118

};

   119

   120

static void DisasterVehicleUpdateImage(Vehicle *v)

   121

{

   122

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

   123

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

   124

	v->cur_image = img;

   125

}

   126

   127

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

   128

 * and owned by nobody */

   129

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

   130

{

   131

	v->x_pos = x;

   132

	v->y_pos = y;

   133

	v->z_pos = z;

   134

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

   135

	v->direction = direction;

   136

	v->subtype = subtype;

   137

	v->UpdateDeltaXY(INVALID_DIR);

   138

	v->owner = OWNER_NONE;

   139

	v->vehstatus = VS_UNCLICKABLE;

   140

	v->u.disaster.image_override = 0;

   141

	v->current_order.Free();

   142

   143

	DisasterVehicleUpdateImage(v);

   144

	VehiclePositionChanged(v);

   145

	MarkSingleVehicleDirty(v);

   146

}

   147

   148

static void DeleteDisasterVeh(Vehicle *v)

   149

{

   150

	DeleteVehicleChain(v);

   151

}

   152

   153

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

   154

{

   155

	Vehicle *u;

   156

   157

	BeginVehicleMove(v);

   158

	v->x_pos = x;

   159

	v->y_pos = y;

   160

	v->z_pos = z;

   161

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

   162

   163

	DisasterVehicleUpdateImage(v);

   164

	VehiclePositionChanged(v);

   165

	EndVehicleMove(v);

   166

   167

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

   168

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

   169

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

   170

		BeginVehicleMove(u);

   171

   172

		u->x_pos = x;

   173

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

   174

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

   175

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

   176

		u->direction = v->direction;

   177

   178

		DisasterVehicleUpdateImage(u);

   179

		VehiclePositionChanged(u);

   180

		EndVehicleMove(u);

   181

   182

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

   183

			BeginVehicleMove(u);

   184

			u->x_pos = x;

   185

			u->y_pos = y;

   186

			u->z_pos = z + 5;

   187

			VehiclePositionChanged(u);

   188

			EndVehicleMove(u);

   189

		}

   190

	}

   191

}

   192

   193

/**

   194

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

   195

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

   196

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

   197

 * 2: Create more smoke and leave debris on ground

   198

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

   199

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

   200

 */

   201

static void DisasterTick_Zeppeliner(Vehicle *v)

   202

{

   203

	Station *st;

   204

	int x, y;

   205

	byte z;

   206

	TileIndex tile;

   207

   208

	v->tick_counter++;

   209

   210

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

   211

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

   212

   213

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   214

   215

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

   216

   217

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

   218

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

   219

				v->current_order.SetDestination(2);

   220

				v->age = 0;

   221

			}

   222

   223

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

   224

   225

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

   226

			tile = v->tile;

   227

   228

			if (IsValidTile(tile) &&

   229

					IsTileType(tile, MP_STATION) &&

   230

					IsAirport(tile) &&

   231

					IsHumanPlayer(GetTileOwner(tile))) {

   232

				v->current_order.SetDestination(1);

   233

				v->age = 0;

   234

   235

				SetDParam(0, GetStationIndex(tile));

   236

				AddNewsItem(STR_B000_ZEPPELIN_DISASTER_AT,

   237

					NM_THIN, NF_VIEWPORT | NF_VEHICLE, NT_ACCIDENT, DNC_NONE,

   238

					v->index,

   239

					0);

   240

			}

   241

		}

   242

   243

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

   244

		return;

   245

	}

   246

   247

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

   248

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

   249

   250

		tile = v->tile;

   251

   252

		if (IsValidTile(tile) &&

   253

				IsTileType(tile, MP_STATION) &&

   254

				IsAirport(tile) &&

   255

				IsHumanPlayer(GetTileOwner(tile))) {

   256

			st = GetStationByTile(tile);

   257

			CLRBITS(st->airport_flags, RUNWAY_IN_block);

   258

		}

   259

   260

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

   261

		DeleteDisasterVeh(v);

   262

		return;

   263

	}

   264

   265

	x = v->x_pos;

   266

	y = v->y_pos;

   267

	z = GetSlopeZ(x, y);

   268

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

   269

	SetDisasterVehiclePos(v, x, y, z);

   270

   271

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

   272

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

   273

		SndPlayVehicleFx(SND_12_EXPLOSION, v);

   274

		v->u.disaster.image_override = SPR_BLIMP_CRASHING;

   275

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

   276

		v->u.disaster.image_override = SPR_BLIMP_CRASHED;

   277

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

   278

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

   279

			uint32 r = Random();

   280

   281

			CreateEffectVehicleRel(v,

   282

				GB(r, 0, 4) - 7,

   283

				GB(r, 4, 4) - 7,

   284

				GB(r, 8, 3) + 5,

   285

				EV_EXPLOSION_SMALL);

   286

		}

   287

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

   288

		v->current_order.SetDestination(3);

   289

		v->age = 0;

   290

	}

   291

   292

	tile = v->tile;

   293

	if (IsValidTile(tile) &&

   294

			IsTileType(tile, MP_STATION) &&

   295

			IsAirport(tile) &&

   296

			IsHumanPlayer(GetTileOwner(tile))) {

   297

		st = GetStationByTile(tile);

   298

		SETBITS(st->airport_flags, RUNWAY_IN_block);

   299

	}

   300

}

   301

   302

/**

   303

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

   304

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

   305

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

   306

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

   307

 */

   308

static void DisasterTick_Ufo(Vehicle *v)

   309

{

   310

	Vehicle *u;

   311

	uint dist;

   312

	byte z;

   313

   314

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

   315

   316

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

   317

		/* Fly around randomly */

   318

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

   319

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

   320

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

   321

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

   322

			GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   323

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

   324

			return;

   325

		}

   326

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

   327

			v->dest_tile = RandomTile();

   328

			return;

   329

		}

   330

		v->current_order.SetDestination(1);

   331

   332

		FOR_ALL_VEHICLES(u) {

   333

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

   334

				v->dest_tile = u->index;

   335

				v->age = 0;

   336

				return;

   337

			}

   338

		}

   339

   340

		DeleteDisasterVeh(v);

   341

	} else {

   342

		/* Target a vehicle */

   343

		u = GetVehicle(v->dest_tile);

   344

		if (u->type != VEH_ROAD) {

   345

			DeleteDisasterVeh(v);

   346

			return;

   347

		}

   348

   349

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

   350

   351

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

   352

			u->breakdown_ctr = 3;

   353

			u->breakdown_delay = 140;

   354

		}

   355

   356

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

   357

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   358

   359

		z = v->z_pos;

   360

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

   361

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

   362

   363

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

   364

			v->age++;

   365

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

   366

				u->u.road.crashed_ctr++;

   367

				u->vehstatus |= VS_CRASHED;

   368

   369

				AddNewsItem(STR_B001_ROAD_VEHICLE_DESTROYED,

   370

					NM_THIN, NF_VIEWPORT | NF_VEHICLE, NT_ACCIDENT, DNC_NONE,

   371

					u->index,

   372

					0);

   373

			}

   374

		}

   375

   376

		/* Destroy? */

   377

		if (v->age > 50) {

   378

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

   379

			SndPlayVehicleFx(SND_12_EXPLOSION, v);

   380

			DeleteDisasterVeh(v);

   381

		}

   382

	}

   383

}

   384

   385

static void DestructIndustry(Industry *i)

   386

{

   387

	TileIndex tile;

   388

   389

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

   390

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

   391

			ResetIndustryConstructionStage(tile);

   392

			MarkTileDirtyByTile(tile);

   393

		}

   394

	}

   395

}

   396

   397

/**

   398

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

   399

 * 0: Fly towards the targetted oil refinery

   400

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

   401

 * 2: Refinery explosions

   402

 * 3: Fly out of the map

   403

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

   404

 */

   405

static void DisasterTick_Airplane(Vehicle *v)

   406

{

   407

	v->tick_counter++;

   408

	v->u.disaster.image_override =

   409

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

   410

   411

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   412

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

   413

   414

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

   415

		DeleteDisasterVeh(v);

   416

		return;

   417

	}

   418

   419

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

   420

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

   421

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

   422

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

   423

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

   424

			uint32 r = Random();

   425

   426

			CreateEffectVehicleAbove(

   427

				GB(r,  0, 6) + x,

   428

				GB(r,  6, 6) + y,

   429

				GB(r, 12, 4),

   430

				EV_EXPLOSION_SMALL);

   431

   432

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

   433

		}

   434

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

   435

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

   436

			Industry *i;

   437

   438

			v->current_order.SetDestination(2);

   439

			v->age = 0;

   440

   441

			i = GetIndustry(v->dest_tile);

   442

			DestructIndustry(i);

   443

   444

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

   445

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

   446

			SndPlayTileFx(SND_12_EXPLOSION, i->xy);

   447

		}

   448

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

   449

		int x, y;

   450

		TileIndex tile;

   451

		uint ind;

   452

   453

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

   454

		y = v->y_pos;

   455

   456

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

   457

   458

		tile = TileVirtXY(x, y);

   459

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

   460

   461

		ind = GetIndustryIndex(tile);

   462

		v->dest_tile = ind;

   463

   464

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

   465

			v->current_order.SetDestination(1);

   466

			v->age = 0;

   467

		}

   468

	}

   469

}

   470

   471

/**

   472

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

   473

 * 0: Fly towards the targetted factory

   474

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

   475

 * 2: Factory explosions

   476

 * 3: Fly out of the map

   477

 */

   478

static void DisasterTick_Helicopter(Vehicle *v)

   479

{

   480

	v->tick_counter++;

   481

	v->u.disaster.image_override =

   482

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

   483

   484

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   485

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

   486

   487

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

   488

		DeleteDisasterVeh(v);

   489

		return;

   490

	}

   491

   492

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

   493

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

   494

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

   495