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

static Sign *_new_sign;

    17

    18

/**

    19

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

    20

 */

    21

static void SignPoolNewBlock(uint start_item)

    22

{

    23

	Sign *si;

    24

    25

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

    26

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

    27

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

    28

}

    29

    30

/* Initialize the sign-pool */

    31

DEFINE_OLD_POOL(Sign, Sign, SignPoolNewBlock, NULL)

    32

    33

/**

    34

 *

    35

 * Update the coordinate of one sign

    36

 * @param si Pointer to the Sign

    37

 *

    38

 */

    39

static void UpdateSignVirtCoords(Sign *si)

    40

{

    41

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

    42

	SetDParam(0, si->str);

    43

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

    44

}

    45

    46

/**

    47

 *

    48

 * Update the coordinates of all signs

    49

 *

    50

 */

    51

void UpdateAllSignVirtCoords()

    52

{

    53

	Sign *si;

    54

    55

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    56

    57

}

    58

    59

/**

    60

 *

    61

 * Marks the region of a sign as dirty

    62

 *

    63

 * @param si Pointer to the Sign

    64

 */

    65

static void MarkSignDirty(Sign *si)

    66

{

    67

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

    68

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

    69

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

    70

	MarkAllViewportsDirty(

    71

		si->sign.left - 6,

    72

		si->sign.top  - 3,

    73

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

    74

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

    75

}

    76

    77

/**

    78

 *

    79

 * Allocates a new sign

    80

 *

    81

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

    82

 */

    83

static Sign *AllocateSign()

    84

{

    85

	Sign *si;

    86

    87

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

    88

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

    89

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

    90

		if (!IsValidSign(si)) {

    91

			uint index = si->index;

    92

    93

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

    94

			si->index = index;

    95

    96

			return si;

    97

		}

    98

	}

    99

   100

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

   101

	if (AddBlockToPool(&_Sign_pool))

   102

		return AllocateSign();

   103

   104

	return NULL;

   105

}

   106

   107

/**

   108

 * Destroy a sign placed on the map

   109

 * @param si Pointer to the Sign to remove

   110

 */

   111

void DestroySign(Sign *si)

   112

{

   113

	DeleteName(si->str);

   114

}

   115

   116

/**

   117

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

   118

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

   119

 * but everybody is able to rename/remove it.

   120

 * @param tile tile to place sign at

   121

 * @param flags type of operation

   122

 * @param p1 unused

   123

 * @param p2 unused

   124

 */

   126

{

   127

	Sign *si;

   128

   129

	/* Try to locate a new sign */

   130

	si = AllocateSign();

   131

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

   132

   133

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

   134

	if (flags & DC_EXEC) {

   135

		int x = TileX(tile) * TILE_SIZE;

   136

		int y = TileY(tile) * TILE_SIZE;

   137

   138

		si->str = STR_280A_SIGN;

   139

		si->x = x;

   140

		si->y = y;

   141

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

   142

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

   143

		UpdateSignVirtCoords(si);

   144

		MarkSignDirty(si);

   145

		InvalidateWindow(WC_SIGN_LIST, 0);

   146

		_sign_sort_dirty = true;

   147

		_new_sign = si;

   148

	}

   149

   150

	return 0;

   151

}

   152

   153

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

   154

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

   155

 * has no meaning/effect whatsoever except for eyecandy

   156

 * @param tile unused

   157

 * @param flags type of operation

   158

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

   159

 * @param p2 unused

   160

 * @return 0 if succesfull, otherwise CMD_ERROR

   161

 */

   163

{

   164

	if (!IsValidSignID(p1)) return CMD_ERROR;

   165

   166

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

   167

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

   168

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

   169

		/* Create the name */

   170

		StringID str = AllocateName(_cmd_text, 0);

   171

		if (str == 0) return CMD_ERROR;

   172

   173

		if (flags & DC_EXEC) {

   174

			Sign *si = GetSign(p1);

   175

   176

			/* Delete the old name */

   177

			DeleteName(si->str);

   178

			/* Assign the new one */

   179

			si->str = str;

   180

			si->owner = _current_player;

   181

   182

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

   183

			MarkSignDirty(si);

   184

			UpdateSignVirtCoords(si);

   185

			MarkSignDirty(si);

   186

			InvalidateWindow(WC_SIGN_LIST, 0);

   187

			_sign_sort_dirty = true;

   188

		} else {

   189

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

   190

			DeleteName(str);

   191

		}

   192

	} else { // Delete sign

   193

		if (flags & DC_EXEC) {

   194

			Sign *si = GetSign(p1);

   195

   196

			MarkSignDirty(si);

   197

			DeleteSign(si);

   198

   199

			InvalidateWindow(WC_SIGN_LIST, 0);

   200

			_sign_sort_dirty = true;

   201

		}

   202

	}

   203

   204

	return 0;

   205

}

   206

   207

/**

   208

 * Callback function that is called after a sign is placed

   209

 * @param success of the operation

   210

 * @param tile unused

   211

 * @param p1 unused

   212

 * @param p2 unused

   213

 */

   214

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

   215

{

   216

	if (success) {

   217

		ShowRenameSignWindow(_new_sign);

   218

		ResetObjectToPlace();

   219

	}

   220

}

   221

   222

/**

   223

 *

   224

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

   225

 *  sign-tool is selected

   226

 * @param tile on which to place the sign

   227

 */

   228

void PlaceProc_Sign(TileIndex tile)

   229

{

   230

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

   231

}

   232

   233

/**

   234

 *

   235

 * Initialize the signs

   236

 *

   237

 */

   238

void InitializeSigns()

   239

{

   240

	CleanPool(&_Sign_pool);

   241

	AddBlockToPool(&_Sign_pool);

   242

}

   243

   244

static const SaveLoad _sign_desc[] = {

   245

      SLE_VAR(Sign, str,   SLE_UINT16),

   246

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

   247

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

   248

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

   249

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

   250

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

   251

      SLE_VAR(Sign, z,     SLE_UINT8),

   252

	SLE_END()

   253

};

   254

   255

/**

   256

 *

   257

 * Save all signs

   258

 *

   259

 */

   260

static void Save_SIGN()

   261

{

   262

	Sign *si;

   263

   264

	FOR_ALL_SIGNS(si) {

   265

		SlSetArrayIndex(si->index);

   266

		SlObject(si, _sign_desc);

   267

	}

   268

}

   269

   270

/**

   271

 *

   272

 * Load all signs

   273

 *

   274

 */

   275

static void Load_SIGN()

   276

{

   277

	int index;

   278

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

   279

		Sign *si;

   280

   281

		if (!AddBlockIfNeeded(&_Sign_pool, index))

   282

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

   283

   284

		si = GetSign(index);

   285

		SlObject(si, _sign_desc);

   286

	}

   287

   288

	_sign_sort_dirty = true;

   289

}

   290

   291

extern const ChunkHandler _sign_chunk_handlers[] = {

   292

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

   293

};