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"

    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);

    43

	SetDParam(0, si->str);

    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

	MarkAllViewportsDirty(

    69

		si->sign.left - 6,

    70

		si->sign.top  - 3,

    71

		si->sign.left + si->sign.width_1 * 4 + 12,

    72

		si->sign.top  + 45);

    73

}

    74

    75

/**

    76

 *

    77

 * Allocates a new sign

    78

 *

    79

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

    80

 */

    81

static Sign *AllocateSign()

    82

{

    83

	Sign *si;

    84

    85

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

    86

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

    87

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

    88

		if (!IsValidSign(si)) {

    89

			uint index = si->index;

    90

    91

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

    92

			si->index = index;

    93

    94

			return si;

    95

		}

    96

	}

    97

    98

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

    99

	if (AddBlockToPool(&_Sign_pool))

   100

		return AllocateSign();

   101

   102

	return NULL;

   103

}

   104

   105

/**

   106

 * Destroy a sign placed on the map

   107

 * @param si Pointer to the Sign to remove

   108

 */

   109

void DestroySign(Sign *si)

   110

{

   111

	DeleteName(si->str);

   112

}

   113

   114

/**

   115

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

   116

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

   117

 * but everybody is able to rename/remove it.

   118

 * @param tile tile to place sign at

   119

 * @param flags type of operation

   120

 * @param p1 unused

   121

 * @param p2 unused

   122

 */

   123

int32 CmdPlaceSign(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   124

{

   125

	Sign *si;

   126

   127

	/* Try to locate a new sign */

   128

	si = AllocateSign();

   129

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

   130

   131

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

   132

	if (flags & DC_EXEC) {

   133

		int x = TileX(tile) * TILE_SIZE;

   134

		int y = TileY(tile) * TILE_SIZE;

   135

   136

		si->str = STR_280A_SIGN;

   137

		si->x = x;

   138

		si->y = y;

   139

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

   140

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

   141

		UpdateSignVirtCoords(si);

   142

		MarkSignDirty(si);

   143

		InvalidateWindow(WC_SIGN_LIST, 0);

   144

		_sign_sort_dirty = true;

   145

		_new_sign_id = si->index;

   146

		_total_signs++;

   147

	}

   148

   149

	return 0;

   150

}

   151

   152

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

   153

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

   154

 * has no meaning/effect whatsoever except for eyecandy

   155

 * @param tile unused

   156

 * @param flags type of operation

   157

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

   158

 * @param p2 unused

   159

 * @return 0 if succesfull, otherwise CMD_ERROR

   160

 */

   161

int32 CmdRenameSign(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   162

{

   163

	if (!IsValidSignID(p1)) return CMD_ERROR;

   164

   165

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

   166

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

   167

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

   168

		/* Create the name */

   169

		StringID str = AllocateName(_cmd_text, 0);

   170

		if (str == 0) return CMD_ERROR;

   171

   172

		if (flags & DC_EXEC) {

   173

			Sign *si = GetSign(p1);

   174

   175

			/* Delete the old name */

   176

			DeleteName(si->str);

   177

			/* Assign the new one */

   178

			si->str = str;

   179

			si->owner = _current_player;

   180

   181

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

   182

			MarkSignDirty(si);

   183

			UpdateSignVirtCoords(si);

   184

			MarkSignDirty(si);

   185

			InvalidateWindow(WC_SIGN_LIST, 0);

   186

			_sign_sort_dirty = true;

   187

		} else {

   188

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

   189

			DeleteName(str);

   190

		}

   191

	} else { // Delete sign

   192

		if (flags & DC_EXEC) {

   193

			Sign *si = GetSign(p1);

   194

   195

			MarkSignDirty(si);

   196

			DeleteSign(si);

   197

   198

			InvalidateWindow(WC_SIGN_LIST, 0);

   199

			_sign_sort_dirty = true;

   200

			_total_signs--;

   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(GetSign(_new_sign_id));

   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

	_total_signs = 0;

   241

	CleanPool(&_Sign_pool);

   242

	AddBlockToPool(&_Sign_pool);

   243

}

   244

   245

static const SaveLoad _sign_desc[] = {

   246

      SLE_VAR(Sign, str,   SLE_UINT16),

   247

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

   248

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

   249

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

   250

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

   251

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

   252

      SLE_VAR(Sign, z,     SLE_UINT8),

   253

	SLE_END()

   254

};

   255

   256

/**

   257

 *

   258

 * Save all signs

   259

 *

   260

 */

   261

static void Save_SIGN()

   262

{

   263

	Sign *si;

   264

   265

	FOR_ALL_SIGNS(si) {

   266

		SlSetArrayIndex(si->index);

   267

		SlObject(si, _sign_desc);

   268

	}

   269

}

   270

   271

/**

   272

 *

   273

 * Load all signs

   274

 *

   275

 */

   276

static void Load_SIGN()

   277

{

   278

	_total_signs = 0;

   279

	int index;

   280

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

   281

		Sign *si;

   282

   283

		if (!AddBlockIfNeeded(&_Sign_pool, index))

   284

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

   285

   286

		si = GetSign(index);

   287

		SlObject(si, _sign_desc);

   288

   289

		_total_signs++;

   290

	}

   291

   292

	_sign_sort_dirty = true;

   293

}

   294

   295

extern const ChunkHandler _sign_chunk_handlers[] = {

   296

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

   297

};