1

/* $Id$ */

     2

     3

/** @file signs.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "table/strings.h"

     8

#include "functions.h"

     9

#include "landscape.h"

    10

#include "player.h"

    11

#include "signs.h"

    12

#include "saveload.h"

    13

#include "command.h"

    14

#include "variables.h"

    15

    16

SignID _new_sign_id;

    17

uint _total_signs;

    18

    19

/**

    20

 * Called if a new block is added to the sign-pool

    21

 */

    22

static void SignPoolNewBlock(uint start_item)

    23

{

    24

	Sign *si;

    25

    26

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    27

	 * TODO - This is just a temporary stage, this will be removed. */

    28

	for (si = GetSign(start_item); si != NULL; si = (si->index + 1U < GetSignPoolSize()) ? GetSign(si->index + 1U) : NULL) si->index = start_item++;

    29

}

    30

    31

/* Initialize the sign-pool */

    32

DEFINE_OLD_POOL(Sign, Sign, SignPoolNewBlock, NULL)

    33

    34

/**

    35

 *

    36

 * Update the coordinate of one sign

    37

 * @param si Pointer to the Sign

    38

 *

    39

 */

    40

static void UpdateSignVirtCoords(Sign *si)

    41

{

    42

	Point pt = RemapCoords(si->x, si->y, si->z);

    44

	UpdateViewportSignPos(&si->sign, pt.x, pt.y - 6, STR_2806);

    45

}

    46

    47

/**

    48

 *

    49

 * Update the coordinates of all signs

    50

 *

    51

 */

    52

void UpdateAllSignVirtCoords()

    53

{

    54

	Sign *si;

    55

    56

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    57

    58

}

    59

    60

/**

    61

 *

    62

 * Marks the region of a sign as dirty

    63

 *

    64

 * @param si Pointer to the Sign

    65

 */

    66

static void MarkSignDirty(Sign *si)

    67

{

    68

	/* We use ZOOM_LVL_MAX here, as every viewport can have an other zoom,

    69

		*  and there is no way for us to know which is the biggest. So make the

    70

		*  biggest area dirty, and we are safe for sure. */

    71

	MarkAllViewportsDirty(

    72

		si->sign.left - 6,

    73

		si->sign.top  - 3,

    74

		si->sign.left + ScaleByZoom(si->sign.width_1 + 12, ZOOM_LVL_MAX),

    75

		si->sign.top  + ScaleByZoom(12, ZOOM_LVL_MAX));

    76

}

    77

    78

/**

    79

 *

    80

 * Allocates a new sign

    81

 *

    82

 * @return The pointer to the new sign, or NULL if there is no more free space

    83

 */

    84

static Sign *AllocateSign()

    85

{

    86

	Sign *si;

    87

    88

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    89

	 * TODO - This is just a temporary stage, this will be removed. */

    90

	for (si = GetSign(0); si != NULL; si = (si->index + 1U < GetSignPoolSize()) ? GetSign(si->index + 1U) : NULL) {

    91

		if (!IsValidSign(si)) {

    92

			uint index = si->index;

    93

    94

			memset(si, 0, sizeof(Sign));

    95

			si->index = index;

    96

    97

			return si;

    98

		}

    99

	}

   100

   101

	/* Check if we can add a block to the pool */

   102

	if (AddBlockToPool(&_Sign_pool))

   103

		return AllocateSign();

   104

   105

	return NULL;

   106

}

   107

   108

/**

   109

 * Destroy a sign placed on the map

   110

 * @param si Pointer to the Sign to remove

   111

 */

   112

void DestroySign(Sign *si)

   113

{

   114

	DeleteName(si->str);

   115

}

   116

   117

/**

   118

 * Place a sign at the given coordinates. Ownership of sign has

   119

 * no effect whatsoever except for the colour the sign gets for easy recognition,

   120

 * but everybody is able to rename/remove it.

   121

 * @param tile tile to place sign at

   122

 * @param flags type of operation

   123

 * @param p1 unused

   124

 * @param p2 unused

   125

 */

   127

{

   128

	Sign *si;

   129

   130

	/* Try to locate a new sign */

   131

	si = AllocateSign();

   132

	if (si == NULL) return_cmd_error(STR_2808_TOO_MANY_SIGNS);

   133

   134

	/* When we execute, really make the sign */

   135

	if (flags & DC_EXEC) {

   136

		int x = TileX(tile) * TILE_SIZE;

   137

		int y = TileY(tile) * TILE_SIZE;

   138

   139

		si->str = STR_280A_SIGN;

   140

		si->x = x;

   141

		si->y = y;

   142

		si->owner = _current_player; // owner of the sign; just eyecandy

   143

		si->z = GetSlopeZ(x, y);

   144

		UpdateSignVirtCoords(si);

   145

		MarkSignDirty(si);

   146

		InvalidateWindow(WC_SIGN_LIST, 0);

   147

		_sign_sort_dirty = true;

   148

		_new_sign_id = si->index;

   149

		_total_signs++;

   150

	}

   151

   153

}

   154

   155

/** Rename a sign. If the new name of the sign is empty, we assume

   156

 * the user wanted to delete it. So delete it. Ownership of signs

   157

 * has no meaning/effect whatsoever except for eyecandy

   158

 * @param tile unused

   159

 * @param flags type of operation

   160

 * @param p1 index of the sign to be renamed/removed

   161

 * @param p2 unused

   162

 * @return 0 if succesfull, otherwise CMD_ERROR

   163

 */

   165

{

   166

	if (!IsValidSignID(p1)) return CMD_ERROR;

   167

   168

	/* If _cmd_text 0 means the new text for the sign is non-empty.

   169

	 * So rename the sign. If it is empty, it has no name, so delete it */

   170

	if (_cmd_text[0] != '\0') {

   171

		/* Create the name */

   172

		StringID str = AllocateName(_cmd_text, 0);

   173

		if (str == 0) return CMD_ERROR;

   174

   175

		if (flags & DC_EXEC) {

   176

			Sign *si = GetSign(p1);

   177

   178

			/* Delete the old name */

   179

			DeleteName(si->str);

   180

			/* Assign the new one */

   181

			si->str = str;

   182

			si->owner = _current_player;

   183

   184

			/* Update; mark sign dirty twice, because it can either becom longer, or shorter */

   185

			MarkSignDirty(si);

   186

			UpdateSignVirtCoords(si);

   187

			MarkSignDirty(si);

   188

			InvalidateWindow(WC_SIGN_LIST, 0);

   189

			_sign_sort_dirty = true;

   190

		} else {

   191

			/* Free the name, because we did not assign it yet */

   192

			DeleteName(str);

   193

		}

   194

	} else { // Delete sign

   195

		if (flags & DC_EXEC) {

   196

			Sign *si = GetSign(p1);

   197

   198

			MarkSignDirty(si);

   199

			DeleteSign(si);

   200

   201

			InvalidateWindow(WC_SIGN_LIST, 0);

   202

			_sign_sort_dirty = true;

   203

			_total_signs--;

   204

		}

   205

	}

   206

   208

}

   209

   210

/**

   211

 * Callback function that is called after a sign is placed

   212

 * @param success of the operation

   213

 * @param tile unused

   214

 * @param p1 unused

   215

 * @param p2 unused

   216

 */

   217

void CcPlaceSign(bool success, TileIndex tile, uint32 p1, uint32 p2)

   218

{

   219

	if (success) {

   220

		ShowRenameSignWindow(GetSign(_new_sign_id));

   221

		ResetObjectToPlace();

   222

	}

   223

}

   224

   225

/**

   226

 *

   227

 * PlaceProc function, called when someone pressed the button if the

   228

 *  sign-tool is selected

   229

 * @param tile on which to place the sign

   230

 */

   231

void PlaceProc_Sign(TileIndex tile)

   232

{

   233

	DoCommandP(tile, 0, 0, CcPlaceSign, CMD_PLACE_SIGN | CMD_MSG(STR_2809_CAN_T_PLACE_SIGN_HERE));

   234

}

   235

   236

/**

   237

 *

   238

 * Initialize the signs

   239

 *

   240

 */

   241

void InitializeSigns()

   242

{

   243

	_total_signs = 0;

   244

	CleanPool(&_Sign_pool);

   245

	AddBlockToPool(&_Sign_pool);

   246

}

   247

   248

static const SaveLoad _sign_desc[] = {

   249

      SLE_VAR(Sign, str,   SLE_UINT16),

   250

  SLE_CONDVAR(Sign, x,     SLE_FILE_I16 | SLE_VAR_I32, 0, 4),

   251

  SLE_CONDVAR(Sign, y,     SLE_FILE_I16 | SLE_VAR_I32, 0, 4),

   252

  SLE_CONDVAR(Sign, x,     SLE_INT32,                  5, SL_MAX_VERSION),

   253

  SLE_CONDVAR(Sign, y,     SLE_INT32,                  5, SL_MAX_VERSION),

   254

  SLE_CONDVAR(Sign, owner, SLE_UINT8,                  6, SL_MAX_VERSION),

   255

      SLE_VAR(Sign, z,     SLE_UINT8),

   256

	SLE_END()

   257

};

   258

   259

/**

   260

 *

   261

 * Save all signs

   262

 *

   263

 */

   264

static void Save_SIGN()

   265

{

   266

	Sign *si;

   267

   268

	FOR_ALL_SIGNS(si) {

   269

		SlSetArrayIndex(si->index);

   270

		SlObject(si, _sign_desc);

   271

	}

   272

}

   273

   274

/**

   275

 *

   276

 * Load all signs

   277

 *

   278

 */

   279

static void Load_SIGN()

   280

{

   281

	_total_signs = 0;

   282

	int index;

   283

	while ((index = SlIterateArray()) != -1) {

   284

		Sign *si;

   285

   286

		if (!AddBlockIfNeeded(&_Sign_pool, index))

   287

			error("Signs: failed loading savegame: too many signs");

   288

   289

		si = GetSign(index);

   290

		SlObject(si, _sign_desc);

   291

   292

		_total_signs++;

   293

	}

   294

   295

	_sign_sort_dirty = true;

   296

}

   297

   298

extern const ChunkHandler _sign_chunk_handlers[] = {

   299

	{ 'SIGN', Save_SIGN, Load_SIGN, CH_ARRAY | CH_LAST},

   300

};