tron@2186: /* $Id$ */
tron@2186: 
belugas@6451: /** @file engine.cpp */
belugas@6451: 
truelight@0: #include "stdafx.h"
Darkvater@1891: #include "openttd.h"
tron@1299: #include "debug.h"
tron@2163: #include "functions.h"
tron@507: #include "table/strings.h"
truelight@0: #include "engine.h"
tron@1009: #include "gfx.h"
truelight@0: #include "player.h"
truelight@0: #include "command.h"
truelight@0: #include "vehicle.h"
truelight@0: #include "news.h"
truelight@0: #include "saveload.h"
tron@2159: #include "variables.h"
peter1138@2708: #include "train.h"
Darkvater@6105: #include "aircraft.h"
belugas@3866: #include "newgrf_cargo.h"
rubidium@4261: #include "date.h"
rubidium@4322: #include "table/engines.h"
truelight@0: 
tron@2763: EngineInfo _engine_info[TOTAL_NUM_ENGINES];
tron@2763: RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];
tron@2763: ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];
tron@2763: AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];
tron@2763: RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];
tron@2763: 
truelight@0: enum {
truelight@4300: 	YEAR_ENGINE_AGING_STOPS = 2050,
truelight@4300: };
truelight@4300: 
truelight@0: 
tron@2477: void ShowEnginePreviewWindow(EngineID engine);
truelight@0: 
celestar@9895: void DeleteCustomEngineNames()
truelight@0: {
truelight@0: 	uint i;
truelight@0: 	StringID old;
truelight@0: 
Darkvater@1474: 	for (i = 0; i != TOTAL_NUM_ENGINES; i++) {
truelight@0: 		old = _engine_name_strings[i];
truelight@0: 		_engine_name_strings[i] = i + STR_8000_KIRBY_PAUL_TANK_STEAM;
truelight@0: 		DeleteName(old);
truelight@0: 	}
truelight@0: 
truelight@0: 	_vehicle_design_names &= ~1;
truelight@0: }
truelight@0: 
celestar@9895: void LoadCustomEngineNames()
truelight@0: {
rubidium@4432: 	/* XXX: not done */
Darkvater@5568: 	DEBUG(misc, 1, "LoadCustomEngineNames: not done");
truelight@0: }
truelight@0: 
celestar@9895: static void SetupEngineNames()
truelight@0: {
Darkvater@1474: 	StringID *name;
truelight@0: 
Darkvater@1474: 	for (name = _engine_name_strings; name != endof(_engine_name_strings); name++)
Darkvater@1474: 		*name = STR_SV_EMPTY;
truelight@0: 
truelight@0: 	DeleteCustomEngineNames();
truelight@0: 	LoadCustomEngineNames();
truelight@0: }
truelight@0: 
truelight@0: 
truelight@0: static void CalcEngineReliability(Engine *e)
truelight@0: {
truelight@0: 	uint age = e->age;
truelight@0: 
truelight@0: 	if (age < e->duration_phase_1) {
truelight@0: 		uint start = e->reliability_start;
truelight@0: 		e->reliability = age * (e->reliability_max - start) / e->duration_phase_1 + start;
bjarni@4767: 	} else if ((age -= e->duration_phase_1) < e->duration_phase_2 || _patches.never_expire_vehicles) {
bjarni@4767: 		/* We are at the peak of this engines life. It will have max reliability.
bjarni@4767: 		 * This is also true if the engines never expire. They will not go bad over time */
truelight@0: 		e->reliability = e->reliability_max;
truelight@0: 	} else if ((age -= e->duration_phase_2) < e->duration_phase_3) {
truelight@0: 		uint max = e->reliability_max;
truelight@0: 		e->reliability = (int)age * (int)(e->reliability_final - max) / e->duration_phase_3 + max;
truelight@0: 	} else {
bjarni@4767: 		/* time's up for this engine.
bjarni@4767: 		 * We will now completely retire this design */
bjarni@4767: 		e->player_avail = 0;
truelight@0: 		e->reliability = e->reliability_final;
bjarni@6195: 		/* Kick this engine out of the lists */
bjarni@6195: 		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);
truelight@0: 	}
bjarni@4767: 	InvalidateWindowClasses(WC_BUILD_VEHICLE); // Update to show the new reliability
bjarni@6195: 	InvalidateWindowClasses(WC_REPLACE_VEHICLE);
truelight@0: }
truelight@0: 
celestar@9895: void AddTypeToEngines()
bjarni@842: {
tron@2242: 	Engine* e = _engines;
bjarni@842: 
celestar@9895: 	do e->type = VEH_TRAIN;    while (++e < &_engines[ROAD_ENGINES_INDEX]);
celestar@9895: 	do e->type = VEH_ROAD;     while (++e < &_engines[SHIP_ENGINES_INDEX]);
celestar@9895: 	do e->type = VEH_SHIP;     while (++e < &_engines[AIRCRAFT_ENGINES_INDEX]);
celestar@9895: 	do e->type = VEH_AIRCRAFT; while (++e < &_engines[TOTAL_NUM_ENGINES]);
bjarni@842: }
bjarni@842: 
celestar@9895: void StartupEngines()
truelight@0: {
truelight@0: 	Engine *e;
truelight@0: 	const EngineInfo *ei;
truelight@4300: 	/* Aging of vehicles stops, so account for that when starting late */
rubidium@4322: 	const Date aging_date = min(_date, ConvertYMDToDate(YEAR_ENGINE_AGING_STOPS, 0, 1));
truelight@0: 
truelight@0: 	SetupEngineNames();
truelight@0: 
tron@2242: 	for (e = _engines, ei = _engine_info; e != endof(_engines); e++, ei++) {
tron@2242: 		uint32 r;
truelight@0: 
truelight@0: 		e->age = 0;
truelight@0: 		e->flags = 0;
truelight@0: 		e->player_avail = 0;
truelight@193: 
belugas@6451: 		/* The magic value of 729 days below comes from the NewGRF spec. If the
belugas@6451: 		 * base intro date is before 1922 then the random number of days is not
belugas@6451: 		 * added. */
truelight@0: 		r = Random();
rubidium@4297: 		e->intro_date = ei->base_intro <= ConvertYMDToDate(1922, 0, 1) ? ei->base_intro : (Date)GB(r, 0, 9) + ei->base_intro;
truelight@0: 		if (e->intro_date <= _date) {
truelight@4300: 			e->age = (aging_date - e->intro_date) >> 5;
truelight@0: 			e->player_avail = (byte)-1;
truelight@0: 			e->flags |= ENGINE_AVAILABLE;
truelight@0: 		}
truelight@0: 
tron@2140: 		e->reliability_start = GB(r, 16, 14) + 0x7AE0;
truelight@0: 		r = Random();
tron@2140: 		e->reliability_max   = GB(r,  0, 14) + 0xBFFF;
tron@2140: 		e->reliability_final = GB(r, 16, 14) + 0x3FFF;
truelight@0: 
truelight@0: 		r = Random();
tron@2140: 		e->duration_phase_1 = GB(r, 0, 5) + 7;
tron@2140: 		e->duration_phase_2 = GB(r, 5, 4) + ei->base_life * 12 - 96;
tron@2140: 		e->duration_phase_3 = GB(r, 9, 7) + 120;
truelight@0: 
truelight@0: 		e->reliability_spd_dec = (ei->unk2&0x7F) << 2;
truelight@0: 
truelight@0: 		/* my invented flag for something that is a wagon */
truelight@0: 		if (ei->unk2 & 0x80) {
truelight@0: 			e->age = 0xFFFF;
truelight@0: 		} else {
truelight@0: 			CalcEngineReliability(e);
truelight@0: 		}
truelight@0: 
truelight@0: 		e->lifelength = ei->lifelength + _patches.extend_vehicle_life;
truelight@0: 
belugas@6451: 		/* prevent certain engines from ever appearing. */
tron@2530: 		if (!HASBIT(ei->climates, _opt.landscape)) {
truelight@0: 			e->flags |= ENGINE_AVAILABLE;
truelight@0: 			e->player_avail = 0;
truelight@0: 		}
tron@915: 
bjarni@819: 		/* This sets up type for the engine
rubidium@4549: 		 * It is needed if you want to ask the engine what type it is
rubidium@4549: 		 * It should hopefully be the same as when you ask a vehicle what it is
rubidium@4549: 		 * but using this, you can ask what type an engine number is
rubidium@4549: 		 * even if it is not a vehicle (yet)*/
truelight@0: 	}
truelight@0: }
truelight@0: 
tron@6074: static void AcceptEnginePreview(EngineID eid, PlayerID player)
truelight@0: {
tron@6074: 	Engine *e = GetEngine(eid);
truelight@0: 
truelight@0: 	SETBIT(e->player_avail, player);
celestar@9895: 	if (e->type == VEH_TRAIN) {
tron@6074: 		const RailVehicleInfo *rvi = RailVehInfo(eid);
tron@6074: 		Player *p = GetPlayer(player);
tron@6074: 
tron@6074: 		assert(rvi->railtype < RAILTYPE_END);
tron@6074: 		SETBIT(p->avail_railtypes, rvi->railtype);
tron@6074: 	}
truelight@0: 
rubidium@5838: 	e->preview_player = INVALID_PLAYER;
bjarni@4766: 	if (player == _local_player) {
bjarni@6195: 		AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);
bjarni@4766: 	}
truelight@0: }
truelight@0: 
Darkvater@1786: static PlayerID GetBestPlayer(PlayerID pp)
Darkvater@1786: {
Darkvater@1786: 	const Player *p;
Darkvater@1786: 	int32 best_hist;
Darkvater@1786: 	PlayerID best_player;
Darkvater@1786: 	uint mask = 0;
Darkvater@1786: 
Darkvater@1786: 	do {
Darkvater@1786: 		best_hist = -1;
Darkvater@4848: 		best_player = PLAYER_SPECTATOR;
Darkvater@1786: 		FOR_ALL_PLAYERS(p) {
Darkvater@1786: 			if (p->is_active && p->block_preview == 0 && !HASBIT(mask, p->index) &&
Darkvater@1786: 					p->old_economy[0].performance_history > best_hist) {
Darkvater@1786: 				best_hist = p->old_economy[0].performance_history;
Darkvater@1786: 				best_player = p->index;
Darkvater@1786: 			}
Darkvater@1786: 		}
Darkvater@1786: 
Darkvater@4848: 		if (best_player == PLAYER_SPECTATOR) return PLAYER_SPECTATOR;
Darkvater@1786: 
Darkvater@1786: 		SETBIT(mask, best_player);
rubidium@5838: 	} while (pp--, pp != 0);
Darkvater@1786: 
Darkvater@1786: 	return best_player;
Darkvater@1786: }
Darkvater@1786: 
celestar@9895: void EnginesDailyLoop()
truelight@0: {
tron@2477: 	EngineID i;
truelight@0: 
truelight@4300: 	if (_cur_year >= YEAR_ENGINE_AGING_STOPS) return;
truelight@0: 
tron@2242: 	for (i = 0; i != lengthof(_engines); i++) {
belugas@4171: 		Engine *e = &_engines[i];
tron@2242: 
maedhros@6500: 		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {
maedhros@6500: 			if (e->flags & ENGINE_OFFER_WINDOW_OPEN) {
truelight@740: 				if (e->preview_player != 0xFF && !--e->preview_wait) {
maedhros@6500: 					e->flags &= ~ENGINE_OFFER_WINDOW_OPEN;
truelight@0: 					DeleteWindowById(WC_ENGINE_PREVIEW, i);
truelight@0: 					e->preview_player++;
truelight@193: 				}
tron@4077: 			} else if (e->preview_player != 0xFF) {
Darkvater@1786: 				PlayerID best_player = GetBestPlayer(e->preview_player);
Darkvater@1786: 
Darkvater@4848: 				if (best_player == PLAYER_SPECTATOR) {
rubidium@5838: 					e->preview_player = INVALID_PLAYER;
Darkvater@1786: 					continue;
Darkvater@1786: 				}
truelight@193: 
Darkvater@4845: 				if (!IsHumanPlayer(best_player)) {
Darkvater@1786: 					/* XXX - TTDBUG: TTD has a bug here ???? */
tron@6074: 					AcceptEnginePreview(i, best_player);
truelight@0: 				} else {
maedhros@6500: 					e->flags |= ENGINE_OFFER_WINDOW_OPEN;
truelight@0: 					e->preview_wait = 20;
Darkvater@4845: 					if (IsInteractivePlayer(best_player)) ShowEnginePreviewWindow(i);
truelight@0: 				}
truelight@0: 			}
truelight@0: 		}
truelight@0: 	}
truelight@0: }
truelight@0: 
Darkvater@1786: /** Accept an engine prototype. XXX - it is possible that the top-player
Darkvater@1786:  * changes while you are waiting to accept the offer? Then it becomes invalid
tron@3491:  * @param tile unused
celestar@9909:  * @param flags operation to perfom
Darkvater@1786:  * @param p1 engine-prototype offered
Darkvater@1786:  * @param p2 unused
Darkvater@1786:  */
tron@3491: int32 CmdWantEnginePreview(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
Darkvater@1786: 	Engine *e;
tron@2951: 
Darkvater@1786: 	if (!IsEngineIndex(p1)) return CMD_ERROR;
tron@1926: 	e = GetEngine(p1);
Darkvater@1786: 	if (GetBestPlayer(e->preview_player) != _current_player) return CMD_ERROR;
Darkvater@1786: 
tron@6074: 	if (flags & DC_EXEC) AcceptEnginePreview(p1, _current_player);
Darkvater@1786: 
truelight@0: 	return 0;
truelight@0: }
truelight@0: 
belugas@6451: /* Determine if an engine type is a wagon (and not a loco) */
tron@2477: static bool IsWagon(EngineID index)
dominik@257: {
belugas@6119: 	return index < NUM_TRAIN_ENGINES && RailVehInfo(index)->railveh_type == RAILVEH_WAGON;
dominik@257: }
dominik@257: 
tron@410: static void NewVehicleAvailable(Engine *e)
truelight@0: {
truelight@0: 	Vehicle *v;
truelight@0: 	Player *p;
tron@2477: 	EngineID index = e - _engines;
truelight@0: 
belugas@6451: 	/* In case the player didn't build the vehicle during the intro period,
belugas@6451: 	 * prevent that player from getting future intro periods for a while. */
maedhros@6500: 	if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) {
truelight@0: 		FOR_ALL_PLAYERS(p) {
truelight@919: 			uint block_preview = p->block_preview;
truelight@919: 
tron@2639: 			if (!HASBIT(e->player_avail, p->index)) continue;
truelight@193: 
truelight@919: 			/* We assume the user did NOT build it.. prove me wrong ;) */
truelight@919: 			p->block_preview = 20;
truelight@919: 
truelight@919: 			FOR_ALL_VEHICLES(v) {
celestar@9895: 				if (v->type == VEH_TRAIN || v->type == VEH_ROAD || v->type == VEH_SHIP ||
celestar@9895: 						(v->type == VEH_AIRCRAFT && IsNormalAircraft(v))) {
truelight@919: 					if (v->owner == p->index && v->engine_type == index) {
truelight@919: 						/* The user did prove me wrong, so restore old value */
truelight@919: 						p->block_preview = block_preview;
truelight@919: 						break;
truelight@919: 					}
truelight@0: 				}
truelight@0: 			}
truelight@0: 		}
truelight@0: 	}
truelight@0: 
maedhros@6500: 	e->flags = (e->flags & ~ENGINE_EXCLUSIVE_PREVIEW) | ENGINE_AVAILABLE;
bjarni@6195: 	AddRemoveEngineFromAutoreplaceAndBuildWindows(e->type);
dominik@114: 
belugas@6451: 	/* Now available for all players */
truelight@0: 	e->player_avail = (byte)-1;
dominik@114: 
belugas@6451: 	/* Do not introduce new rail wagons */
tron@2639: 	if (IsWagon(index)) return;
dominik@114: 
tron@6074: 	if (index < NUM_TRAIN_ENGINES) {
belugas@6451: 		/* maybe make another rail type available */
tron@6074: 		RailType railtype = RailVehInfo(index)->railtype;
tron@6074: 		assert(railtype < RAILTYPE_END);
tron@6074: 		FOR_ALL_PLAYERS(p) {
tron@6074: 			if (p->is_active) SETBIT(p->avail_railtypes, railtype);
celestar@2147: 		}
truelight@0: 	}
rubidium@6535: 	AddNewsItem(index, NEWS_FLAGS(NM_CALLBACK, 0, NT_NEW_VEHICLES, DNC_VEHICLEAVAIL), 0, 0);
truelight@0: }
truelight@0: 
celestar@9895: void EnginesMonthlyLoop()
truelight@0: {
truelight@0: 	Engine *e;
truelight@0: 
truelight@4300: 	if (_cur_year < YEAR_ENGINE_AGING_STOPS) {
tron@2242: 		for (e = _engines; e != endof(_engines); e++) {
belugas@6451: 			/* Age the vehicle */
tron@2242: 			if (e->flags & ENGINE_AVAILABLE && e->age != 0xFFFF) {
truelight@0: 				e->age++;
truelight@0: 				CalcEngineReliability(e);
truelight@0: 			}
truelight@0: 
peter1138@2990: 			if (!(e->flags & ENGINE_AVAILABLE) && _date >= (e->intro_date + 365)) {
belugas@6451: 				/* Introduce it to all players */
truelight@0: 				NewVehicleAvailable(e);
maedhros@6500: 			} else if (!(e->flags & (ENGINE_AVAILABLE|ENGINE_EXCLUSIVE_PREVIEW)) && _date >= e->intro_date) {
belugas@6451: 				/* Introduction date has passed.. show introducing dialog to one player. */
maedhros@6500: 				e->flags |= ENGINE_EXCLUSIVE_PREVIEW;
dominik@257: 
belugas@6451: 				/* Do not introduce new rail wagons */
tron@964: 				if (!IsWagon(e - _engines))
rubidium@5838: 					e->preview_player = (PlayerID)1; // Give to the player with the highest rating.
truelight@0: 			}
truelight@0: 		}
truelight@0: 	}
truelight@0: }
truelight@0: 
Darkvater@1786: /** Rename an engine.
tron@3491:  * @param tile unused
celestar@9909:  * @param flags operation to perfom
Darkvater@1786:  * @param p1 engine ID to rename
Darkvater@1786:  * @param p2 unused
Darkvater@1786:  */
tron@3491: int32 CmdRenameEngine(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
truelight@0: 	StringID str;
truelight@0: 
Darkvater@1840: 	if (!IsEngineIndex(p1) || _cmd_text[0] == '\0') return CMD_ERROR;
Darkvater@1786: 
tron@1820: 	str = AllocateNameUnique(_cmd_text, 0);
Darkvater@1786: 	if (str == 0) return CMD_ERROR;
truelight@193: 
truelight@0: 	if (flags & DC_EXEC) {
truelight@0: 		StringID old_str = _engine_name_strings[p1];
truelight@0: 		_engine_name_strings[p1] = str;
truelight@0: 		DeleteName(old_str);
truelight@0: 		_vehicle_design_names |= 3;
truelight@0: 		MarkWholeScreenDirty();
truelight@0: 	} else {
truelight@0: 		DeleteName(str);
truelight@0: 	}
truelight@0: 
truelight@0: 	return 0;
truelight@0: }
truelight@0: 
truelight@0: 
peter1138@2848: /*
peter1138@2848:  * returns true if an engine is valid, of the specified type, and buildable by
peter1138@5215:  * the given player, false otherwise
peter1138@2848:  *
peter1138@2848:  * engine = index of the engine to check
peter1138@2848:  * type   = the type the engine should be of (VEH_xxx)
peter1138@5215:  * player = index of the player
peter1138@2848:  */
peter1138@5215: bool IsEngineBuildable(EngineID engine, byte type, PlayerID player)
peter1138@2848: {
peter1138@2848: 	const Engine *e;
peter1138@2848: 
belugas@6451: 	/* check if it's an engine that is in the engine array */
peter1138@2848: 	if (!IsEngineIndex(engine)) return false;
peter1138@2848: 
peter1138@2848: 	e = GetEngine(engine);
peter1138@2848: 
belugas@6451: 	/* check if it's an engine of specified type */
peter1138@2848: 	if (e->type != type) return false;
peter1138@2848: 
belugas@6451: 	/* check if it's available */
peter1138@5215: 	if (!HASBIT(e->player_avail, player)) return false;
peter1138@2848: 
peter1138@2848: 	return true;
peter1138@2848: }
peter1138@2848: 
celestar@9910: /** Get the default cargo type for a certain engine type
celestar@9910:  * @param engine The ID to get the cargo for
celestar@9910:  * @return The cargo type. CT_INVALID means no cargo capacity
celestar@9910:  */
celestar@9910: CargoID GetEngineCargoType(EngineID engine)
celestar@9910: {
celestar@9910: 	assert(IsEngineIndex(engine));
celestar@9910: 
celestar@9910: 	switch (GetEngine(engine)->type) {
celestar@9910: 		case VEH_TRAIN:
celestar@9910: 			if (RailVehInfo(engine)->capacity == 0) return CT_INVALID;
celestar@9910: 			return RailVehInfo(engine)->cargo_type;
celestar@9910: 
celestar@9910: 		case VEH_ROAD:
celestar@9910: 			if (RoadVehInfo(engine)->capacity == 0) return CT_INVALID;
celestar@9910: 			return RoadVehInfo(engine)->cargo_type;
celestar@9910: 
celestar@9910: 		case VEH_SHIP:
celestar@9910: 			if (ShipVehInfo(engine)->capacity == 0) return CT_INVALID;
celestar@9910: 			return ShipVehInfo(engine)->cargo_type;
celestar@9910: 
celestar@9910: 		case VEH_AIRCRAFT:
celestar@9910: 			/* all aircraft starts as passenger planes with cargo capacity */
celestar@9910: 			return CT_PASSENGERS;
celestar@9910: 
celestar@9910: 		default: NOT_REACHED(); return CT_INVALID;
celestar@9910: 	}
celestar@9910: }
celestar@9910: 
peter1138@2848: /************************************************************************
peter1138@2848:  * Engine Replacement stuff
peter1138@2848:  ************************************************************************/
peter1138@2848: 
tron@4974: static void EngineRenewPoolNewBlock(uint start_item);
peter1138@2848: 
matthijs@5216: DEFINE_OLD_POOL(EngineRenew, EngineRenew, EngineRenewPoolNewBlock, NULL)
peter1138@2848: 
peter1138@2848: static void EngineRenewPoolNewBlock(uint start_item)
peter1138@2848: {
peter1138@2848: 	EngineRenew *er;
peter1138@2848: 
truelight@4348: 	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.
truelight@4348: 	 *  TODO - This is just a temporary stage, this will be removed. */
tron@4974: 	for (er = GetEngineRenew(start_item); er != NULL; er = (er->index + 1U < GetEngineRenewPoolSize()) ? GetEngineRenew(er->index + 1U) : NULL) {
peter1138@2848: 		er->index = start_item++;
peter1138@2848: 		er->from = INVALID_ENGINE;
peter1138@2848: 	}
peter1138@2848: }
peter1138@2848: 
peter1138@2848: 
celestar@9895: static EngineRenew *AllocateEngineRenew()
peter1138@2848: {
peter1138@2848: 	EngineRenew *er;
peter1138@2848: 
truelight@4348: 	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.
truelight@4348: 	 *  TODO - This is just a temporary stage, this will be removed. */
tron@4974: 	for (er = GetEngineRenew(0); er != NULL; er = (er->index + 1U < GetEngineRenewPoolSize()) ? GetEngineRenew(er->index + 1U) : NULL) {
truelight@4348: 		if (IsValidEngineRenew(er)) continue;
truelight@4348: 
truelight@4348: 		er->to = INVALID_ENGINE;
truelight@4348: 		er->next = NULL;
truelight@4348: 		return er;
peter1138@2848: 	}
peter1138@2848: 
peter1138@2848: 	/* Check if we can add a block to the pool */
tron@4974: 	if (AddBlockToPool(&_EngineRenew_pool)) return AllocateEngineRenew();
peter1138@2848: 
peter1138@2848: 	return NULL;
peter1138@2848: }
peter1138@2848: 
peter1138@2848: /**
peter1138@2848:  * Retrieves the EngineRenew that specifies the replacement of the given
peter1138@2848:  * engine type from the given renewlist */
peter1138@2848: static EngineRenew *GetEngineReplacement(EngineRenewList erl, EngineID engine)
peter1138@2848: {
truelight@4348: 	EngineRenew *er = (EngineRenew *)erl;
truelight@4348: 
peter1138@2848: 	while (er) {
peter1138@2848: 		if (er->from == engine) return er;
peter1138@2848: 		er = er->next;
peter1138@2848: 	}
peter1138@2848: 	return NULL;
peter1138@2848: }
peter1138@2848: 
belugas@4171: void RemoveAllEngineReplacement(EngineRenewList *erl)
peter1138@2848: {
truelight@4348: 	EngineRenew *er = (EngineRenew *)(*erl);
truelight@4384: 	EngineRenew *next;
truelight@4348: 
peter1138@2848: 	while (er) {
truelight@4384: 		next = er->next;
truelight@4384: 		DeleteEngineRenew(er);
truelight@4384: 		er = next;
peter1138@2848: 	}
truelight@4348: 	*erl = NULL; // Empty list
peter1138@2848: }
peter1138@2848: 
peter1138@2848: EngineID EngineReplacement(EngineRenewList erl, EngineID engine)
peter1138@2848: {
peter1138@2848: 	const EngineRenew *er = GetEngineReplacement(erl, engine);
peter1138@2848: 	return er == NULL ? INVALID_ENGINE : er->to;
peter1138@2848: }
peter1138@2848: 
belugas@4171: int32 AddEngineReplacement(EngineRenewList *erl, EngineID old_engine, EngineID new_engine, uint32 flags)
peter1138@2848: {
peter1138@2848: 	EngineRenew *er;
peter1138@2848: 
truelight@4348: 	/* Check if the old vehicle is already in the list */
peter1138@2848: 	er = GetEngineReplacement(*erl, old_engine);
peter1138@2848: 	if (er != NULL) {
peter1138@2848: 		if (flags & DC_EXEC) er->to = new_engine;
peter1138@2848: 		return 0;
peter1138@2848: 	}
peter1138@2848: 
peter1138@2848: 	er = AllocateEngineRenew();
peter1138@2848: 	if (er == NULL) return CMD_ERROR;
peter1138@2848: 
peter1138@2848: 	if (flags & DC_EXEC) {
peter1138@2848: 		er->from = old_engine;
peter1138@2848: 		er->to = new_engine;
peter1138@2848: 
truelight@4348: 		/* Insert before the first element */
truelight@4348: 		er->next = (EngineRenew *)(*erl);
truelight@4348: 		*erl = (EngineRenewList)er;
peter1138@2848: 	}
peter1138@2848: 
peter1138@2848: 	return 0;
peter1138@2848: }
peter1138@2848: 
belugas@4171: int32 RemoveEngineReplacement(EngineRenewList *erl, EngineID engine, uint32 flags)
peter1138@2848: {
truelight@4348: 	EngineRenew *er = (EngineRenew *)(*erl);
belugas@4171: 	EngineRenew *prev = NULL;
peter1138@2848: 
peter1138@2848: 	while (er)
peter1138@2848: 	{
peter1138@2848: 		if (er->from == engine) {
peter1138@2848: 			if (flags & DC_EXEC) {
truelight@4348: 				if (prev == NULL) { // First element
truelight@4348: 					/* The second becomes the new first element */
truelight@4348: 					*erl = (EngineRenewList)er->next;
peter1138@2848: 				} else {
truelight@4348: 					/* Cut this element out */
truelight@4348: 					prev->next = er->next;
peter1138@2848: 				}
truelight@4384: 				DeleteEngineRenew(er);
peter1138@2848: 			}
peter1138@2848: 			return 0;
peter1138@2848: 		}
peter1138@2848: 		prev = er;
truelight@4348: 		er = er->next;
peter1138@2848: 	}
peter1138@2848: 
truelight@4348: 	return CMD_ERROR;
peter1138@2848: }
peter1138@2848: 
peter1138@2848: static const SaveLoad _engine_renew_desc[] = {
peter1138@2848: 	SLE_VAR(EngineRenew, from, SLE_UINT16),
peter1138@2848: 	SLE_VAR(EngineRenew, to,   SLE_UINT16),
peter1138@2848: 
peter1138@2848: 	SLE_REF(EngineRenew, next, REF_ENGINE_RENEWS),
peter1138@2848: 
peter1138@2848: 	SLE_END()
peter1138@2848: };
peter1138@2848: 
celestar@9895: static void Save_ERNW()
peter1138@2848: {
peter1138@2848: 	EngineRenew *er;
peter1138@2848: 
peter1138@2848: 	FOR_ALL_ENGINE_RENEWS(er) {
truelight@4348: 		SlSetArrayIndex(er->index);
truelight@4348: 		SlObject(er, _engine_renew_desc);
peter1138@2848: 	}
peter1138@2848: }
peter1138@2848: 
celestar@9895: static void Load_ERNW()
peter1138@2848: {
peter1138@2848: 	int index;
peter1138@2848: 
peter1138@2848: 	while ((index = SlIterateArray()) != -1) {
peter1138@2848: 		EngineRenew *er;
peter1138@2848: 
tron@4974: 		if (!AddBlockIfNeeded(&_EngineRenew_pool, index))
peter1138@2848: 			error("EngineRenews: failed loading savegame: too many EngineRenews");
peter1138@2848: 
peter1138@2848: 		er = GetEngineRenew(index);
peter1138@2848: 		SlObject(er, _engine_renew_desc);
peter1138@2848: 	}
peter1138@2848: }
peter1138@2848: 
Darkvater@1881: static const SaveLoad _engine_desc[] = {
rubidium@4344: 	SLE_CONDVAR(Engine, intro_date,          SLE_FILE_U16 | SLE_VAR_I32,  0,  30),
rubidium@4344: 	SLE_CONDVAR(Engine, intro_date,          SLE_INT32,                  31, SL_MAX_VERSION),
rubidium@4344: 	SLE_CONDVAR(Engine, age,                 SLE_FILE_U16 | SLE_VAR_I32,  0,  30),
rubidium@4344: 	SLE_CONDVAR(Engine, age,                 SLE_INT32,                  31, SL_MAX_VERSION),
rubidium@4344: 	    SLE_VAR(Engine, reliability,         SLE_UINT16),
rubidium@4344: 	    SLE_VAR(Engine, reliability_spd_dec, SLE_UINT16),
rubidium@4344: 	    SLE_VAR(Engine, reliability_start,   SLE_UINT16),
rubidium@4344: 	    SLE_VAR(Engine, reliability_max,     SLE_UINT16),
rubidium@4344: 	    SLE_VAR(Engine, reliability_final,   SLE_UINT16),
rubidium@4344: 	    SLE_VAR(Engine, duration_phase_1,    SLE_UINT16),
rubidium@4344: 	    SLE_VAR(Engine, duration_phase_2,    SLE_UINT16),
rubidium@4344: 	    SLE_VAR(Engine, duration_phase_3,    SLE_UINT16),
truelight@0: 
rubidium@4344: 	    SLE_VAR(Engine, lifelength,          SLE_UINT8),
rubidium@4344: 	    SLE_VAR(Engine, flags,               SLE_UINT8),
rubidium@4344: 	    SLE_VAR(Engine, preview_player,      SLE_UINT8),
rubidium@4344: 	    SLE_VAR(Engine, preview_wait,        SLE_UINT8),
tron@6074: 	SLE_CONDNULL(1, 0, 44),
rubidium@4344: 	    SLE_VAR(Engine, player_avail,        SLE_UINT8),
truelight@0: 
belugas@6451: 	/* reserve extra space in savegame here. (currently 16 bytes) */
Darkvater@3222: 	SLE_CONDNULL(16, 2, SL_MAX_VERSION),
truelight@0: 
truelight@0: 	SLE_END()
truelight@0: };
truelight@0: 
celestar@9895: static void Save_ENGN()
truelight@0: {
tron@2242: 	uint i;
tron@2242: 
tron@2242: 	for (i = 0; i != lengthof(_engines); i++) {
truelight@0: 		SlSetArrayIndex(i);
tron@2242: 		SlObject(&_engines[i], _engine_desc);
truelight@0: 	}
truelight@0: }
truelight@0: 
celestar@9895: static void Load_ENGN()
truelight@0: {
truelight@0: 	int index;
truelight@0: 	while ((index = SlIterateArray()) != -1) {
tron@1926: 		SlObject(GetEngine(index), _engine_desc);
truelight@0: 	}
truelight@0: }
truelight@0: 
celestar@9895: static void LoadSave_ENGS()
truelight@0: {
truelight@0: 	SlArray(_engine_name_strings, lengthof(_engine_name_strings), SLE_STRINGID);
truelight@0: }
truelight@0: 
rubidium@5838: extern const ChunkHandler _engine_chunk_handlers[] = {
peter1138@2848: 	{ 'ENGN', Save_ENGN,     Load_ENGN,     CH_ARRAY          },
peter1138@2848: 	{ 'ENGS', LoadSave_ENGS, LoadSave_ENGS, CH_RIFF           },
peter1138@2848: 	{ 'ERNW', Save_ERNW,     Load_ERNW,     CH_ARRAY | CH_LAST},
truelight@0: };
truelight@0: 
celestar@9895: void InitializeEngines()
tron@1197: {
peter1138@2848: 	/* Clean the engine renew pool and create 1 block in it */
tron@4974: 	CleanPool(&_EngineRenew_pool);
tron@4974: 	AddBlockToPool(&_EngineRenew_pool);
bjarni@1196: }