OpenTTD/src/engine_func.h

/* $Id$ */

/** @file engine_func.h Functions related to engines. */

#ifndef ENGINE_H
#define ENGINE_H

#include "engine_type.h"

void SetupEngines();
void StartupEngines();

Engine *GetTempDataEngine(EngineID index);
void CopyTempEngineData();

/* Original engine data counts and offsets */
extern const uint8 _engine_counts[4];
extern const uint8 _engine_offsets[4];

void DrawTrainEngine(int x, int y, EngineID engine, SpriteID pal);
void DrawRoadVehEngine(int x, int y, EngineID engine, SpriteID pal);
void DrawShipEngine(int x, int y, EngineID engine, SpriteID pal);
void DrawAircraftEngine(int x, int y, EngineID engine, SpriteID pal);

void LoadCustomEngineNames();
void DeleteCustomEngineNames();

bool IsEngineBuildable(EngineID engine, VehicleType type, PlayerID player);
CargoID GetEngineCargoType(EngineID engine);

typedef int CDECL EngList_SortTypeFunction(const void*, const void*); ///< argument type for EngList_Sort()
void EngList_Sort(EngineList *el, EngList_SortTypeFunction compare);  ///< qsort of the engine list
void EngList_SortPartial(EngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items); ///< qsort of specified portion of the engine list

#endif /* ENGINE_H */
(svn r2701) Insert Id tags into all source files 2005-07-24 15:12:37 +01:00			`/* $Id$ */`

(svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description. 2008-05-06 16:11:33 +01:00			`/** @file engine_func.h Functions related to engines. */`
(svn r8862) -Cleanup: doxygen changes, again. Mostly @files missing tags and a few comments style. Some documentation addition, when i can easily supply them 2007-02-23 18:55:07 +00:00
(svn r1) Import of revision 975 of old (crashed) SVN 2004-08-09 18:04:08 +01:00			`#ifndef ENGINE_H`
			`#define ENGINE_H`

(svn r12476) -Codechange: split type engine related types from engine.h (and openttd.h) to engine_type.h. 2008-03-28 18:00:38 +00:00			`#include "engine_type.h"`
(svn r3396) - Autoreplace changes: - Change fixed array per player to a single pool. This avoids future problems with vehicle numbers and decreases savegame size. Engine replacements from previous savegames will be lost. - Move engine replacement code from players.c to engine.c. (thanks to blathijs for rewriting this) 2006-01-12 15:52:18 +00:00
(svn r11784) -Codechange: set up initial engine data in one place 2008-01-08 18:25:51 +00:00			`void SetupEngines();`
(svn r9050) -Codechange: Foo(void) -> Foo() 2007-03-07 11:47:46 +00:00			`void StartupEngines();`
(svn r1) Import of revision 975 of old (crashed) SVN 2004-08-09 18:04:08 +01:00
(svn r12924) -Feature: Introducing the so called 'engine pool' which primarily removes the fixed engine type limits and also happens to allow (with the patch option 'dynamic_engines') multiple NewGRF vehicle sets to coexist. 2008-04-29 22:31:29 +01:00			`Engine *GetTempDataEngine(EngineID index);`
			`void CopyTempEngineData();`

			`/* Original engine data counts and offsets */`
			`extern const uint8 _engine_counts[4];`
			`extern const uint8 _engine_offsets[4];`
(svn r1) Import of revision 975 of old (crashed) SVN 2004-08-09 18:04:08 +01:00
(svn r8128) -Codechange: Split sprite and palette remap into separate 32 bit values. This lets us increase the sprite width from 14 to up to 29 bits, effectively nulling the old sprite limit. Table changes in next commit. 2007-01-14 19:57:49 +00:00			`void DrawTrainEngine(int x, int y, EngineID engine, SpriteID pal);`
			`void DrawRoadVehEngine(int x, int y, EngineID engine, SpriteID pal);`
			`void DrawShipEngine(int x, int y, EngineID engine, SpriteID pal);`
			`void DrawAircraftEngine(int x, int y, EngineID engine, SpriteID pal);`
(svn r1) Import of revision 975 of old (crashed) SVN 2004-08-09 18:04:08 +01:00
(svn r9050) -Codechange: Foo(void) -> Foo() 2007-03-07 11:47:46 +00:00			`void LoadCustomEngineNames();`
			`void DeleteCustomEngineNames();`
(svn r1) Import of revision 975 of old (crashed) SVN 2004-08-09 18:04:08 +01:00
(svn r12054) -Cleanup: Use VehicleType instead of byte for vehicle types... 2008-02-04 11:28:12 +00:00			`bool IsEngineBuildable(EngineID engine, VehicleType type, PlayerID player);`
(svn r9688) -Codechange: Created a function to get default cargo type for a cargo type 2007-04-20 17:56:55 +01:00			`CargoID GetEngineCargoType(EngineID engine);`
(svn r1) Import of revision 975 of old (crashed) SVN 2004-08-09 18:04:08 +01:00
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit: - using one engine list instead of 3 - removed engine filters (loco, wagons, helicopters, etc.) - EngineList code isolated from GUI (moved to helpers.cpp - reusing CBlobT code which does exactly what is needed for EngineList) - removed unnecessary "optimization" (rebuild and sort engine list on each WE_PAINT) 2006-11-30 16:03:12 +00:00			`typedef int CDECL EngList_SortTypeFunction(const void, const void); ///< argument type for EngList_Sort()`
(svn r12995) -Codechange: use std::vector for EngineList instead of C/C++ wrapper for CBlobT 2008-05-07 19:31:29 +01:00			`void EngList_Sort(EngineList *el, EngList_SortTypeFunction compare); ///< qsort of the engine list`
(svn r7299) -CodeChange: Train and Aircraft Build window GUI code simplified a bit: - using one engine list instead of 3 - removed engine filters (loco, wagons, helicopters, etc.) - EngineList code isolated from GUI (moved to helpers.cpp - reusing CBlobT code which does exactly what is needed for EngineList) - removed unnecessary "optimization" (rebuild and sort engine list on each WE_PAINT) 2006-11-30 16:03:12 +00:00			`void EngList_SortPartial(EngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items); ///< qsort of specified portion of the engine list`

(svn r2962) - const correctness for all Get* functions and most Draw* functions that don't change their pointer parameters - change a lot of byte player types to PlayerID - beautify header files, same "#endif /* filename */" ending 2005-09-18 21:56:44 +01:00			`#endif /* ENGINE_H */`