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"

    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

    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

				/* update signals in buffer */

    77

				UpdateSignalsInBuffer();

    78

			}

    79

			break;

    80

    81

		case MP_HOUSE: {

    82

			PlayerID p = _current_player;

    83

			_current_player = OWNER_NONE;

    84

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

    85

			_current_player = p;

    86

			break;

    87

		}

    88

    89

		case MP_TREES:

    90

		case MP_CLEAR:

    91

			DoClearSquare(tile);

    92

			break;

    93

    94

		default:

    95

			break;

    96

	}

    97

}

    98

    99

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

   100

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

   101

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

   102

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

   103

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

   104

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

   105

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

   106

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

   107

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

   108

   109

static const SpriteID * const _disaster_images[] = {

   110

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

   111

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

   112

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

   113

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

   114

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

   115

	_disaster_images_7, _disaster_images_7,                     ///< skyranger and shadow

   116

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

   117

};

   118

   119

static void DisasterVehicleUpdateImage(Vehicle *v)

   120

{

   121

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

   122

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

   123

	v->cur_image = img;

   124

}

   125

   126

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

   127

 * and owned by nobody */

   128

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

   129

{

   130

	v->x_pos = x;

   131

	v->y_pos = y;

   132

	v->z_pos = z;

   133

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

   134

	v->direction = direction;

   135

	v->subtype = subtype;

   136

	v->UpdateDeltaXY(INVALID_DIR);

   137

	v->owner = OWNER_NONE;

   138

	v->vehstatus = VS_UNCLICKABLE;

   139

	v->u.disaster.image_override = 0;

   140

	v->current_order.Free();

   141

   142

	DisasterVehicleUpdateImage(v);

   143

	VehiclePositionChanged(v);

   144

	MarkSingleVehicleDirty(v);

   145

}

   146

   147

static void DeleteDisasterVeh(Vehicle *v)

   148

{

   149

	DeleteVehicleChain(v);

   150

}

   151

   152

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

   153

{

   154

	Vehicle *u;

   155

   156

	BeginVehicleMove(v);

   157

	v->x_pos = x;

   158

	v->y_pos = y;

   159

	v->z_pos = z;

   160

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

   161

   162

	DisasterVehicleUpdateImage(v);

   163

	VehiclePositionChanged(v);

   164

	EndVehicleMove(v);

   165

   166

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

   167

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

   168

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

   169

		BeginVehicleMove(u);

   170

   171

		u->x_pos = x;

   172

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

   173

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

   174

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

   175

		u->direction = v->direction;

   176

   177

		DisasterVehicleUpdateImage(u);

   178

		VehiclePositionChanged(u);

   179

		EndVehicleMove(u);

   180

   181

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

   182

			BeginVehicleMove(u);

   183

			u->x_pos = x;

   184

			u->y_pos = y;

   185

			u->z_pos = z + 5;

   186

			VehiclePositionChanged(u);

   187

			EndVehicleMove(u);

   188

		}

   189

	}

   190

}

   191

   192

   193

static const byte SMALL_AIRPORT_RUNWAY_BLOCK = 40;

   194

   195

/**

   196

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

   197

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

   198

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

   199

 * 2: Create more smoke and leave debris on ground

   200

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

   201

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

   202

 */

   203

static void DisasterTick_Zeppeliner(Vehicle *v)

   204

{

   205

	Station *st;

   206

	int x, y;

   207

	byte z;

   208

	TileIndex tile;

   209

   210

	v->tick_counter++;

   211

   212

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

   213

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

   214

   215

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   216

   217

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

   218

   219

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

   220

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

   221

				v->current_order.dest = 2;

   222

				v->age = 0;

   223

			}

   224

   225

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

   226

   227

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

   228

			tile = v->tile;

   229

   230

			if (IsValidTile(tile) &&

   231

					IsTileType(tile, MP_STATION) &&

   232

					IsAirport(tile) &&

   233

					IsHumanPlayer(GetTileOwner(tile))) {

   234

				v->current_order.dest = 1;

   235

				v->age = 0;

   236

   237

				SetDParam(0, GetStationIndex(tile));

   238

				AddNewsItem(STR_B000_ZEPPELIN_DISASTER_AT,

   239

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

   240

					v->index,

   241

					0);

   242

			}

   243

		}

   244

   245

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

   246

		return;

   247

	}

   248

   249

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

   250

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

   251

   252

		tile = v->tile;

   253

   254

		if (IsValidTile(tile) &&

   255

				IsTileType(tile, MP_STATION) &&

   256

				IsAirport(tile) &&

   257

				IsHumanPlayer(GetTileOwner(tile))) {

   258

			st = GetStationByTile(tile);

   259

			st->airport_flags.ReleaseBlocks(SetFSMSingleBlock(&SMALL_AIRPORT_RUNWAY_BLOCK));

   260

		}

   261

   262

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

   263

		DeleteDisasterVeh(v);

   264

		return;

   265

	}

   266

   267

	x = v->x_pos;

   268

	y = v->y_pos;

   269

	z = GetSlopeZ(x, y);

   270

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

   271

	SetDisasterVehiclePos(v, x, y, z);

   272

   273

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

   274

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

   275

		SndPlayVehicleFx(SND_12_EXPLOSION, v);

   276

		v->u.disaster.image_override = SPR_BLIMP_CRASHING;

   277

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

   278

		v->u.disaster.image_override = SPR_BLIMP_CRASHED;

   279

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

   280

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

   281

			uint32 r = Random();

   282

   283

			CreateEffectVehicleRel(v,

   284

				GB(r, 0, 4) - 7,

   285

				GB(r, 4, 4) - 7,

   286

				GB(r, 8, 3) + 5,

   287

				EV_EXPLOSION_SMALL);

   288

		}

   289

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

   290

		v->current_order.dest = 3;

   291

		v->age = 0;

   292

	}

   293

   294

	tile = v->tile;

   295

	if (IsValidTile(tile) &&

   296

			IsTileType(tile, MP_STATION) &&

   297

			IsAirport(tile) &&

   298

			IsHumanPlayer(GetTileOwner(tile))) {

   299

		st = GetStationByTile(tile);

   300

		st->airport_flags.ReleaseBlocks(SetFSMSingleBlock(&SMALL_AIRPORT_RUNWAY_BLOCK));

   301

	}

   302

}

   303

   304

/**

   305

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

   306

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

   307

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

   308

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

   309

 */

   310

static void DisasterTick_Ufo(Vehicle *v)

   311

{

   312

	Vehicle *u;

   313

	uint dist;

   314

	byte z;

   315

   316

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

   317

   318

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

   319

		/* Fly around randomly */

   320

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

   321

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

   322

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

   323

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

   324

			GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   325

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

   326

			return;

   327

		}

   328

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

   329

			v->dest_tile = RandomTile();

   330

			return;

   331

		}

   332

		v->current_order.dest = 1;

   333

   334

		FOR_ALL_VEHICLES(u) {

   335

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

   336

				v->dest_tile = u->index;

   337

				v->age = 0;

   338

				return;

   339

			}

   340

		}

   341

   342

		DeleteDisasterVeh(v);

   343

	} else {

   344

		/* Target a vehicle */

   345

		u = GetVehicle(v->dest_tile);

   346

		if (u->type != VEH_ROAD) {

   347

			DeleteDisasterVeh(v);

   348

			return;

   349

		}

   350

   351

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

   352

   353

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

   354

			u->breakdown_ctr = 3;

   355

			u->breakdown_delay = 140;

   356

		}

   357

   358

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

   359

		GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   360

   361

		z = v->z_pos;

   362

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

   363

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

   364

   365

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

   366

			v->age++;

   367

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

   368

				u->u.road.crashed_ctr++;

   369

				u->vehstatus |= VS_CRASHED;

   370

   371

				AddNewsItem(STR_B001_ROAD_VEHICLE_DESTROYED,

   372

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

   373

					u->index,

   374

					0);

   375

			}

   376

		}

   377

   378

		/* Destroy? */

   379

		if (v->age > 50) {

   380

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

   381

			SndPlayVehicleFx(SND_12_EXPLOSION, v);

   382

			DeleteDisasterVeh(v);

   383

		}

   384

	}

   385

}

   386

   387

static void DestructIndustry(Industry *i)

   388

{

   389

	TileIndex tile;

   390

   391

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

   392

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

   393

			ResetIndustryConstructionStage(tile);

   394

			MarkTileDirtyByTile(tile);

   395

		}

   396

	}

   397

}

   398

   399

/**

   400

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

   401

 * 0: Fly towards the targetted oil refinery

   402

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

   403

 * 2: Refinery explosions

   404

 * 3: Fly out of the map

   405

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

   406

 */

   407

static void DisasterTick_Airplane(Vehicle *v)

   408

{

   409

	v->tick_counter++;

   410

	v->u.disaster.image_override =

   411

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

   412

   413

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   414

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

   415

   416

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

   417

		DeleteDisasterVeh(v);

   418

		return;

   419

	}

   420

   421

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

   422

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

   423

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

   424

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

   425

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

   426

			uint32 r = Random();

   427

   428

			CreateEffectVehicleAbove(

   429

				GB(r,  0, 6) + x,

   430

				GB(r,  6, 6) + y,

   431

				GB(r, 12, 4),

   432

				EV_EXPLOSION_SMALL);

   433

   434

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

   435

		}

   436

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

   437

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

   438

			Industry *i;

   439

   440

			v->current_order.dest = 2;

   441

			v->age = 0;

   442

   443

			i = GetIndustry(v->dest_tile);

   444

			DestructIndustry(i);

   445

   446

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

   447

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

   448

			SndPlayTileFx(SND_12_EXPLOSION, i->xy);

   449

		}

   450

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

   451

		int x, y;

   452

		TileIndex tile;

   453

		uint ind;

   454

   455

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

   456

		y = v->y_pos;

   457

   458

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

   459

   460

		tile = TileVirtXY(x, y);

   461

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

   462

   463

		ind = GetIndustryIndex(tile);

   464

		v->dest_tile = ind;

   465

   466

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

   467

			v->current_order.dest = 1;

   468

			v->age = 0;

   469

		}

   470

	}

   471

}

   472

   473

/**

   474

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

   475

 * 0: Fly towards the targetted factory

   476

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

   477

 * 2: Factory explosions

   478

 * 3: Fly out of the map

   479

 */

   480

static void DisasterTick_Helicopter(Vehicle *v)

   481

{

   482

	v->tick_counter++;

   483

	v->u.disaster.image_override =

   484

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

   485

   486

	GetNewVehiclePosResult gp = GetNewVehiclePos(v);

   487

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

   488

   489

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

   490

		DeleteDisasterVeh(v);

   491

		return;

   492

	}

   493

   494

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

   495