1

/* $Id$ */

     2

     3

/** @file functions.h */

     4

     5

#ifndef FUNCTIONS_H

     6

#define FUNCTIONS_H

     7

     8

#include "gfx.h"

     9

    10

void DoClearSquare(TileIndex tile);

    11

void RunTileLoop();

    12

    13

uint GetPartialZ(int x, int y, Slope corners);

    14

uint GetSlopeZ(int x, int y);

    15

uint32 GetTileTrackStatus(TileIndex tile, TransportType mode);

    16

void GetAcceptedCargo(TileIndex tile, AcceptedCargo ac);

    17

void ChangeTileOwner(TileIndex tile, PlayerID old_player, PlayerID new_player);

    18

void AnimateTile(TileIndex tile);

    19

void ClickTile(TileIndex tile);

    20

void GetTileDesc(TileIndex tile, TileDesc *td);

    21

void UpdateTownMaxPass(Town *t);

    22

    23

bool IsValidTile(TileIndex tile);

    24

    25

static inline Point RemapCoords(int x, int y, int z)

    26

{

    27

	Point pt;

    28

	pt.x = (y - x) * 2;

    29

	pt.y = y + x - z;

    30

	return pt;

    31

}

    32

    33

static inline Point RemapCoords2(int x, int y)

    34

{

    35

	return RemapCoords(x, y, GetSlopeZ(x, y));

    36

}

    37

    38

    39

/* clear_land.cpp */

    40

void DrawHillyLandTile(const TileInfo *ti);

    41

void DrawClearLandTile(const TileInfo *ti, byte set);

    42

void DrawClearLandFence(const TileInfo *ti);

    43

void TileLoopClearHelper(TileIndex tile);

    44

    45

/* water_land.cpp */

    46

void DrawShipDepotSprite(int x, int y, int image);

    47

void TileLoop_Water(TileIndex tile);

    48

    49

/* players.cpp */

    50

bool CheckPlayerHasMoney(int32 cost);

    51

void SubtractMoneyFromPlayer(int32 cost);

    52

void SubtractMoneyFromPlayerFract(PlayerID player, int32 cost);

    53

bool CheckOwnership(Owner owner);

    54

bool CheckTileOwnership(TileIndex tile);

    55

StringID GetPlayerNameString(PlayerID player, uint index);

    56

    57

/* standard */

    58

void ShowInfo(const char *str);

    59

void CDECL ShowInfoF(const char *str, ...);

    60

void NORETURN CDECL error(const char *str, ...);

    61

    62

/* openttd.cpp */

    63

    64

/**************

    65

 * Warning: DO NOT enable this unless you understand what it does

    66

 *

    67

 * If enabled, in a network game all randoms will be dumped to the

    68

 *  stdout if the first client joins (or if you are a client). This

    69

 *  is to help finding desync problems.

    70

 *

    71

 * Warning: DO NOT enable this unless you understand what it does

    72

 **************/

    73

    74

//#define RANDOM_DEBUG

    75

    76

    77

// Enable this to produce higher quality random numbers.

    78

// Doesn't work with network yet.

    79

//#define MERSENNE_TWISTER

    80

    81

// Mersenne twister functions

    82

void SeedMT(uint32 seed);

    83

uint32 RandomMT();

    84

    85

    86

#ifdef MERSENNE_TWISTER

    87

	static inline uint32 Random() { return RandomMT(); }

    88

	uint RandomRange(uint max);

    89

#else

    90

    91

#ifdef RANDOM_DEBUG

    92

	#define Random() DoRandom(__LINE__, __FILE__)

    93

	uint32 DoRandom(int line, const char *file);

    94

	#define RandomRange(max) DoRandomRange(max, __LINE__, __FILE__)

    95

	uint DoRandomRange(uint max, int line, const char *file);

    96

#else

    97

	uint32 Random();

    98

	uint RandomRange(uint max);

    99

#endif

   100

#endif // MERSENNE_TWISTER

   101

   102

static inline TileIndex RandomTileSeed(uint32 r) { return TILE_MASK(r); }

   103

static inline TileIndex RandomTile() { return TILE_MASK(Random()); }

   104

   105

   106

uint32 InteractiveRandom(); // Used for random sequences that are not the same on the other end of the multiplayer link

   107

uint InteractiveRandomRange(uint max);

   108

   109

/* texteff.cpp */

   110

void MoveAllTextEffects();

   111

void AddTextEffect(StringID msg, int x, int y, uint16 duration);

   112

void InitTextEffects();

   113

void DrawTextEffects(DrawPixelInfo *dpi);

   114

   115

void InitTextMessage();

   116

void DrawTextMessage();

   117

void CDECL AddTextMessage(uint16 color, uint8 duration, const char *message, ...);

   118

void UndrawTextMessage();

   119

   120

bool AddAnimatedTile(TileIndex tile);

   121

void DeleteAnimatedTile(TileIndex tile);

   122

void AnimateAnimatedTiles();

   123

void InitializeAnimatedTiles();

   124

   125

/* tunnelbridge_cmd.cpp */

   126

bool CheckBridge_Stuff(byte bridge_type, uint bridge_len);

   127

uint32 GetBridgeLength(TileIndex begin, TileIndex end);

   128

int CalcBridgeLenCostFactor(int x);

   129

   130

/* misc_cmd.cpp */

   131

void PlaceTreesRandomly();

   132

   133

void InitializeLandscapeVariables(bool only_constants);

   134

   135

/* misc.cpp */

   136

bool IsCustomName(StringID id);

   137

void DeleteName(StringID id);

   138

char *GetName(char *buff, StringID id, const char* last);

   139

   140

/* AllocateNameUnique also tests if the name used is not used anywere else

   141

 * and if it is used, it returns an error. */

   142

#define AllocateNameUnique(name, skip) RealAllocateName(name, skip, true)

   143

#define AllocateName(name, skip) RealAllocateName(name, skip, false)

   144

StringID RealAllocateName(const char *name, byte skip, bool check_double);

   145

void ConvertNameArray();

   146

   147

/* misc functions */

   148

void MarkTileDirty(int x, int y);

   149

void MarkTileDirtyByTile(TileIndex tile);

   150

void InvalidateWindow(WindowClass cls, WindowNumber number);

   151

void InvalidateWindowWidget(WindowClass cls, WindowNumber number, byte widget_index);

   152

void InvalidateWindowClasses(WindowClass cls);

   153

void InvalidateWindowClassesData(WindowClass cls);

   154

void DeleteWindowById(WindowClass cls, WindowNumber number);

   155

void DeleteWindowByClass(WindowClass cls);

   156

   157

void SetObjectToPlaceWnd(CursorID icon, SpriteID pal, byte mode, Window *w);

   158

void SetObjectToPlace(CursorID icon, SpriteID pal, byte mode, WindowClass window_class, WindowNumber window_num);

   159

   160

void ResetObjectToPlace();

   161

   162

bool ScrollWindowTo(int x, int y, Window * w);

   163

   164

bool ScrollMainWindowToTile(TileIndex tile);

   165

bool ScrollMainWindowTo(int x, int y);

   166

void DrawSprite(SpriteID img, SpriteID pal, int x, int y);

   167

bool EnsureNoVehicle(TileIndex tile);

   168

bool EnsureNoVehicleOnGround(TileIndex tile);

   169

void MarkAllViewportsDirty(int left, int top, int right, int bottom);

   170

void ShowCostOrIncomeAnimation(int x, int y, int z, int32 cost);

   171

void ShowFeederIncomeAnimation(int x, int y, int z, int32 cost);

   172

   173

void DrawFoundation(TileInfo *ti, uint f);

   174

   175

bool CheckIfAuthorityAllows(TileIndex tile);

   176

Town *ClosestTownFromTile(TileIndex tile, uint threshold);

   177

void ChangeTownRating(Town *t, int add, int max);

   178

   179

uint GetTownRadiusGroup(const Town* t, TileIndex tile);

   180

int FindFirstBit(uint32 x);

   181

void ShowHighscoreTable(int difficulty, int8 rank);

   182

TileIndex AdjustTileCoordRandomly(TileIndex a, byte rng);

   183

   184

void AfterLoadTown();

   185

void UpdatePatches();

   186

void AskExitGame();

   187

void AskExitToGameMenu();

   188

   189

void RedrawAutosave();

   190

   191

StringID RemapOldStringID(StringID s);

   192

   193

void UpdateViewportSignPos(ViewportSign *sign, int left, int top, StringID str);

   194

   195

enum {

   196

	SLD_LOAD_GAME,

   197

	SLD_LOAD_SCENARIO,

   198

	SLD_SAVE_GAME,

   199

	SLD_SAVE_SCENARIO,

   200

	SLD_LOAD_HEIGHTMAP,

   201

	SLD_NEW_GAME,

   202

};

   203

void ShowSaveLoadDialog(int mode);

   204

   205

/* callback from drivers that is called if the game size changes dynamically */

   206

void GameSizeChanged();

   207

bool FileExists(const char *filename);

   208

bool ReadLanguagePack(int index);

   209

void InitializeLanguagePacks();

   210

const char *GetCurrentLocale(const char *param);

   211

void *ReadFileToMem(const char *filename, size_t *lenp, size_t maxsize);

   212

   213

void LoadFromConfig();

   214

void SaveToConfig();

   215

void CheckConfig();

   216

int ttd_main(int argc, char* argv[]);

   217

void HandleExitGameRequest();

   218

   219

void DeterminePaths();

   220

   221

#endif /* FUNCTIONS_H */