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

	MarkAllViewportsDirty(

    68

		si->sign.left - 6,

    69

		si->sign.top  - 3,

    70

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

    71

		si->sign.top  + 45);

    72

}

    73

    74

/**

    75

 *

    76

 * Allocates a new sign

    77

 *

    78

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

    79

 */

    80

static Sign *AllocateSign()

    81

{

    82

	Sign *si;

    83

    84

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

    85

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

    86

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

    87

		if (!IsValidSign(si)) {

    88

			uint index = si->index;

    89

    90

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

    91

			si->index = index;

    92

    93

			return si;

    94

		}

    95

	}

    96

    97

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

    98

	if (AddBlockToPool(&_Sign_pool))

    99

		return AllocateSign();

   100

   101

	return NULL;

   102

}

   103

   104

/**

   105

 * Destroy a sign placed on the map

   106

 * @param si Pointer to the Sign to remove

   107

 */

   108

void DestroySign(Sign *si)

   109

{

   110

	DeleteName(si->str);

   111

}

   112

   113

/**

   114

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

   115

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

   116

 * but everybody is able to rename/remove it.

   117

 * @param tile tile to place sign at

   118

 * @param flags type of operation

   119

 * @param p1 unused

   120

 * @param p2 unused

   121

 */

   122

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

   123

{

   124

	Sign *si;

   125

   126

	/* Try to locate a new sign */

   127

	si = AllocateSign();

   128

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

   129

   130

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

   131

	if (flags & DC_EXEC) {

   132

		int x = TileX(tile) * TILE_SIZE;

   133

		int y = TileY(tile) * TILE_SIZE;

   134

   135

		si->str = STR_280A_SIGN;

   136

		si->x = x;

   137

		si->y = y;

   138

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

   140

		UpdateSignVirtCoords(si);

   141

		MarkSignDirty(si);

   142

		InvalidateWindow(WC_SIGN_LIST, 0);

   143

		_sign_sort_dirty = true;

   144

		_new_sign = si;

   145

	}

   146

   147

	return 0;

   148

}

   149

   150

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

   151

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

   152

 * has no meaning/effect whatsoever except for eyecandy

   153

 * @param tile unused

   154

 * @param flags type of operation

   155

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

   156

 * @param p2 unused

   157

 * @return 0 if succesfull, otherwise CMD_ERROR

   158

 */

   159

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

   160

{

   161

	if (!IsValidSignID(p1)) return CMD_ERROR;

   162

   163

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

   164

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

   165

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

   166

		/* Create the name */

   167

		StringID str = AllocateName(_cmd_text, 0);

   168

		if (str == 0) return CMD_ERROR;

   169

   170

		if (flags & DC_EXEC) {

   171

			Sign *si = GetSign(p1);

   172

   173

			/* Delete the old name */

   174

			DeleteName(si->str);

   175

			/* Assign the new one */

   176

			si->str = str;

   177

			si->owner = _current_player;

   178

   179

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

   180

			MarkSignDirty(si);

   181

			UpdateSignVirtCoords(si);

   182

			MarkSignDirty(si);

   183

			InvalidateWindow(WC_SIGN_LIST, 0);

   184

			_sign_sort_dirty = true;

   185

		} else {

   186

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

   187

			DeleteName(str);

   188

		}

   189

	} else { // Delete sign

   190

		if (flags & DC_EXEC) {

   191

			Sign *si = GetSign(p1);

   192

   193

			MarkSignDirty(si);

   194

			DeleteSign(si);

   195

   196

			InvalidateWindow(WC_SIGN_LIST, 0);

   197

			_sign_sort_dirty = true;

   198

		}

   199

	}

   200

   201

	return 0;

   202

}

   203

   204

/**

   205

 * Callback function that is called after a sign is placed

   206

 * @param success of the operation

   207

 * @param tile unused

   208

 * @param p1 unused

   209

 * @param p2 unused

   210

 */

   211

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

   212

{

   213

	if (success) {

   214

		ShowRenameSignWindow(_new_sign);

   215

		ResetObjectToPlace();

   216

	}

   217

}

   218

   219

/**

   220

 *

   221

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

   222

 *  sign-tool is selected

   223

 * @param tile on which to place the sign

   224

 */

   225

void PlaceProc_Sign(TileIndex tile)

   226

{

   227

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

   228

}

   229

   230

/**

   231

 *

   232

 * Initialize the signs

   233

 *

   234

 */

   235

void InitializeSigns()

   236

{

   237

	CleanPool(&_Sign_pool);

   238

	AddBlockToPool(&_Sign_pool);

   239

}

   240

   241

static const SaveLoad _sign_desc[] = {

   242

      SLE_VAR(Sign, str,   SLE_UINT16),

   243

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

   244

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

   245

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

   246

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

   247

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

   248

      SLE_VAR(Sign, z,     SLE_UINT8),

   249

	SLE_END()

   250

};

   251

   252

/**

   253

 *

   254

 * Save all signs

   255

 *

   256

 */

   257

static void Save_SIGN()

   258

{

   259

	Sign *si;

   260

   261

	FOR_ALL_SIGNS(si) {

   262

		SlSetArrayIndex(si->index);

   263

		SlObject(si, _sign_desc);

   264

	}

   265

}

   266

   267

/**

   268

 *

   269

 * Load all signs

   270

 *

   271

 */

   272

static void Load_SIGN()

   273

{

   274

	int index;

   275

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

   276

		Sign *si;

   277

   278

		if (!AddBlockIfNeeded(&_Sign_pool, index))

   279

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

   280

   281

		si = GetSign(index);

   282

		SlObject(si, _sign_desc);

   283

	}

   284

   285

	_sign_sort_dirty = true;

   286

}

   287

   288

extern const ChunkHandler _sign_chunk_handlers[] = {

   289

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

   290

};