engine_sl.cpp File Reference

Code handling saving and loading of engines. More...

#include "../stdafx.h"
#include "saveload.h"
#include "compat/engine_sl_compat.h"
#include "saveload_internal.h"
#include "../engine_base.h"
#include "../string_func.h"
#include "../safeguards.h"

Go to the source code of this file.

Data Structures
struct	ENGNChunkHandler
struct	ENGSChunkHandler
struct	EIDSChunkHandler

Functions
static Engine *	CallocEngine ()
	Allocate an Engine structure, but not using the pools.
static void	FreeEngine (Engine *e)
	Deallocate an Engine constructed by CallocEngine.
Engine *	GetTempDataEngine (EngineID index)
void	CopyTempEngineData ()
	Copy data from temporary engine array into the real engine pool.
void	ResetTempEngineData ()
const ChunkHandlerTable	_engine_chunk_handlers (engine_chunk_handlers)

Variables
static const SaveLoad	_engine_desc []
static std::vector< Engine * >	_temp_engine
static const SaveLoad	_engine_id_mapping_desc []
	Save and load the mapping between the engine id in the pool, and the grf file it came from.
static const EIDSChunkHandler	EIDS
static const ENGNChunkHandler	ENGN
static const ENGSChunkHandler	ENGS
static const ChunkHandlerRef	engine_chunk_handlers []

Detailed Description

Code handling saving and loading of engines.

Definition in file engine_sl.cpp.

Function Documentation

CallocEngine()

static Engine * CallocEngine ( )

static

Allocate an Engine structure, but not using the pools.

The allocated Engine must be freed using FreeEngine;

Returns

Allocated engine.

Definition at line 51 of file engine_sl.cpp.

CopyTempEngineData()

void CopyTempEngineData

(

)

Copy data from temporary engine array into the real engine pool.

Definition at line 121 of file engine_sl.cpp.

References Engine::age, Engine::company_avail, Engine::company_hidden, Engine::duration_phase_1, Engine::duration_phase_2, Engine::duration_phase_3, Engine::flags, Engine::intro_date, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_engine_pool >::Iterate(), Engine::name, Engine::preview_asked, Engine::preview_company, Engine::preview_wait, Engine::reliability, Engine::reliability_final, Engine::reliability_max, Engine::reliability_spd_dec, and Engine::reliability_start.

Referenced by AfterLoadGame().

FreeEngine()

static void FreeEngine ( Engine *  e )

static

Deallocate an Engine constructed by CallocEngine.

Parameters

e	Engine to free.

Definition at line 62 of file engine_sl.cpp.

References free().

GetTempDataEngine()

Engine * GetTempDataEngine

(

EngineID

index

)

Definition at line 70 of file engine_sl.cpp.

ResetTempEngineData()

void ResetTempEngineData

(

)

Definition at line 149 of file engine_sl.cpp.

Variable Documentation

_engine_desc

const SaveLoad _engine_desc[]

static

Initial value:

= {
   SLE_CONDVAR(Engine, intro_date,          SLE_FILE_U16 | SLE_VAR_I32,  SL_MIN_VERSION,  SLV_31),
   SLE_CONDVAR(Engine, intro_date,          SLE_INT32,                  SLV_31, SL_MAX_VERSION),
   SLE_CONDVAR(Engine, age,                 SLE_FILE_U16 | SLE_VAR_I32,  SL_MIN_VERSION,  SLV_31),
   SLE_CONDVAR(Engine, age,                 SLE_INT32,                  SLV_31, SL_MAX_VERSION),
       SLE_VAR(Engine, reliability,         SLE_UINT16),
       SLE_VAR(Engine, reliability_spd_dec, SLE_UINT16),
       SLE_VAR(Engine, reliability_start,   SLE_UINT16),
       SLE_VAR(Engine, reliability_max,     SLE_UINT16),
       SLE_VAR(Engine, reliability_final,   SLE_UINT16),
       SLE_VAR(Engine, duration_phase_1,    SLE_UINT16),
       SLE_VAR(Engine, duration_phase_2,    SLE_UINT16),
       SLE_VAR(Engine, duration_phase_3,    SLE_UINT16),
       SLE_VAR(Engine, flags,               SLE_UINT8),
   SLE_CONDVAR(Engine, preview_asked,       SLE_UINT16,                SLV_179, SL_MAX_VERSION),
   SLE_CONDVAR(Engine, preview_company,     SLE_UINT8,                 SLV_179, SL_MAX_VERSION),
       SLE_VAR(Engine, preview_wait,        SLE_UINT8),
   SLE_CONDVAR(Engine, company_avail,       SLE_FILE_U8  | SLE_VAR_U16,  SL_MIN_VERSION, SLV_104),
   SLE_CONDVAR(Engine, company_avail,       SLE_UINT16,                SLV_104, SL_MAX_VERSION),
   SLE_CONDVAR(Engine, company_hidden,      SLE_UINT16,                SLV_193, SL_MAX_VERSION),
  SLE_CONDSSTR(Engine, name,                SLE_STR,                    SLV_84, SL_MAX_VERSION),
}

Definition at line 21 of file engine_sl.cpp.

_engine_id_mapping_desc

const SaveLoad _engine_id_mapping_desc[]

static

Initial value:

= {
  SLE_VAR(EngineIDMapping, grfid,         SLE_UINT32),
  SLE_VAR(EngineIDMapping, internal_id,   SLE_UINT16),
  SLE_VAR(EngineIDMapping, type,          SLE_UINT8),
  SLE_VAR(EngineIDMapping, substitute_id, SLE_UINT8),
}

Save and load the mapping between the engine id in the pool, and the grf file it came from.

Definition at line 178 of file engine_sl.cpp.

Referenced by EIDSChunkHandler::Load(), and EIDSChunkHandler::Save().

_temp_engine

std::vector<Engine*> _temp_engine

static

Definition at line 44 of file engine_sl.cpp.

EIDS

const EIDSChunkHandler EIDS

static

Definition at line 229 of file engine_sl.cpp.

engine_chunk_handlers

const ChunkHandlerRef engine_chunk_handlers[]

static

Initial value:

= {
  EIDS,
  ENGN,
  ENGS,
}

Definition at line 232 of file engine_sl.cpp.

ENGN

const ENGNChunkHandler ENGN

static

Definition at line 230 of file engine_sl.cpp.

ENGS

const ENGSChunkHandler ENGS

static

Definition at line 231 of file engine_sl.cpp.