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 "player.h"

    10

#include "signs.h"

    11

#include "saveload.h"

    12

#include "command.h"

    13

#include "variables.h"

    14

    15

static Sign *_new_sign;

    16

    17

/**

    18

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

    19

 */

    20

static void SignPoolNewBlock(uint start_item)

    21

{

    22

	Sign *si;

    23

    24

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

    25

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

    26

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

    27

}

    28

    29

/* Initialize the sign-pool */

    30

DEFINE_OLD_POOL(Sign, Sign, SignPoolNewBlock, NULL)

    31

    32

/**

    33

 *

    34

 * Update the coordinate of one sign

    35

 * @param si Pointer to the Sign

    36

 *

    37

 */

    38

static void UpdateSignVirtCoords(Sign *si)

    39

{

    40

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

    41

	SetDParam(0, si->str);

    42

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

    43

}

    44

    45

/**

    46

 *

    47

 * Update the coordinates of all signs

    48

 *

    49

 */

    50

void UpdateAllSignVirtCoords()

    51

{

    52

	Sign *si;

    53

    54

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    55

    56

}

    57

    58

/**

    59

 *

    60

 * Marks the region of a sign as dirty

    61

 *

    62

 * @param si Pointer to the Sign

    63

 */

    64

static void MarkSignDirty(Sign *si)

    65

{

    66

	MarkAllViewportsDirty(

    67

		si->sign.left - 6,

    68

		si->sign.top  - 3,

    69

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

    70

		si->sign.top  + 45);

    71

}

    72

    73

/**

    74

 *

    75

 * Allocates a new sign

    76

 *

    77

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

    78

 */

    79

static Sign *AllocateSign()

    80

{

    81

	Sign *si;

    82

    83

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

    84

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

    85

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

    86

		if (!IsValidSign(si)) {

    87

			uint index = si->index;

    88

    89

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

    90

			si->index = index;

    91

    92

			return si;

    93

		}

    94

	}

    95

    96

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

    97

	if (AddBlockToPool(&_Sign_pool))

    98

		return AllocateSign();

    99

   100

	return NULL;

   101

}

   102

   103

/**

   104

 * Destroy a sign placed on the map

   105

 * @param si Pointer to the Sign to remove

   106

 */

   107

void DestroySign(Sign *si)

   108

{

   109

	DeleteName(si->str);

   110

}

   111

   112

/**

   113

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

   114

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

   115

 * but everybody is able to rename/remove it.

   116

 * @param tile tile to place sign at

   117

 * @param flags type of operation

   118

 * @param p1 unused

   119

 * @param p2 unused

   120

 */

   121

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

   122

{

   123

	Sign *si;

   124

   125

	/* Try to locate a new sign */

   126

	si = AllocateSign();

   127

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

   128

   129

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

   130

	if (flags & DC_EXEC) {

   131

		int x = TileX(tile) * TILE_SIZE;

   132

		int y = TileY(tile) * TILE_SIZE;

   133

   134

		si->str = STR_280A_SIGN;

   135

		si->x = x;

   136

		si->y = y;

   137

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

   138

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

   139

		UpdateSignVirtCoords(si);

   140

		MarkSignDirty(si);

   141

		InvalidateWindow(WC_SIGN_LIST, 0);

   142

		_sign_sort_dirty = true;

   143

		_new_sign = si;

   144

	}

   145

   146

	return 0;

   147

}

   148

   149

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

   150

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

   151

 * has no meaning/effect whatsoever except for eyecandy

   152

 * @param tile unused

   153

 * @param flags type of operation

   154

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

   155

 * @param p2 unused

   156

 * @return 0 if succesfull, otherwise CMD_ERROR

   157

 */

   158

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

   159

{

   160

	if (!IsValidSignID(p1)) return CMD_ERROR;

   161

   162

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

   163

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

   164

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

   165

		/* Create the name */

   166

		StringID str = AllocateName(_cmd_text, 0);

   167

		if (str == 0) return CMD_ERROR;

   168

   169

		if (flags & DC_EXEC) {

   170

			Sign *si = GetSign(p1);

   171

   172

			/* Delete the old name */

   173

			DeleteName(si->str);

   174

			/* Assign the new one */

   175

			si->str = str;

   176

			si->owner = _current_player;

   177

   178

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

   179

			MarkSignDirty(si);

   180

			UpdateSignVirtCoords(si);

   181

			MarkSignDirty(si);

   182

			InvalidateWindow(WC_SIGN_LIST, 0);

   183

			_sign_sort_dirty = true;

   184

		} else {

   185

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

   186

			DeleteName(str);

   187

		}

   188

	} else { // Delete sign

   189

		if (flags & DC_EXEC) {

   190

			Sign *si = GetSign(p1);

   191

   192

			MarkSignDirty(si);

   193

			DeleteSign(si);

   194

   195

			InvalidateWindow(WC_SIGN_LIST, 0);

   196

			_sign_sort_dirty = true;

   197

		}

   198

	}

   199

   200

	return 0;

   201

}

   202

   203

/**

   204

 * Callback function that is called after a sign is placed

   205

 * @param success of the operation

   206

 * @param tile unused

   207

 * @param p1 unused

   208

 * @param p2 unused

   209

 */

   210

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

   211

{

   212

	if (success) {

   213

		ShowRenameSignWindow(_new_sign);

   214

		ResetObjectToPlace();

   215

	}

   216

}

   217

   218

/**

   219

 *

   220

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

   221

 *  sign-tool is selected

   222

 * @param tile on which to place the sign

   223

 */

   224

void PlaceProc_Sign(TileIndex tile)

   225

{

   226

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

   227

}

   228

   229

/**

   230

 *

   231

 * Initialize the signs

   232

 *

   233

 */

   234

void InitializeSigns()

   235

{

   236

	CleanPool(&_Sign_pool);

   237

	AddBlockToPool(&_Sign_pool);

   238

}

   239

   240

static const SaveLoad _sign_desc[] = {

   241

      SLE_VAR(Sign, str,   SLE_UINT16),

   242

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

   243

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

   244

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

   245

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

   246

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

   247

      SLE_VAR(Sign, z,     SLE_UINT8),

   248

	SLE_END()

   249

};

   250

   251

/**

   252

 *

   253

 * Save all signs

   254

 *

   255

 */

   256

static void Save_SIGN()

   257

{

   258

	Sign *si;

   259

   260

	FOR_ALL_SIGNS(si) {

   261

		SlSetArrayIndex(si->index);

   262

		SlObject(si, _sign_desc);

   263

	}

   264

}

   265

   266

/**

   267

 *

   268

 * Load all signs

   269

 *

   270

 */

   271

static void Load_SIGN()

   272

{

   273

	int index;

   274

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

   275

		Sign *si;

   276

   277

		if (!AddBlockIfNeeded(&_Sign_pool, index))

   278

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

   279

   280

		si = GetSign(index);

   281

		SlObject(si, _sign_desc);

   282

	}

   283

   284

	_sign_sort_dirty = true;

   285

}

   286

   287

extern const ChunkHandler _sign_chunk_handlers[] = {

   288

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

   289

};