1

/* $Id$ */

     2

     3

/** @file signs.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "table/strings.h"

     8

#include "strings.h"

     9

#include "functions.h"

    10

#include "landscape.h"

    11

#include "player.h"

    12

#include "signs.h"

    13

#include "saveload.h"

    14

#include "command.h"

    15

#include "variables.h"

    16

#include "misc/autoptr.hpp"

    17

    18

SignID _new_sign_id;

    19

uint _total_signs;

    20

    21

/* Initialize the sign-pool */

    22

DEFINE_OLD_POOL_GENERIC(Sign, Sign)

    23

    24

Sign::Sign(StringID string)

    25

{

    26

	this->str = string;

    27

}

    28

    29

Sign::~Sign()

    30

{

    31

	this->QuickFree();

    32

	this->str = STR_NULL;

    33

}

    34

    35

void Sign::QuickFree()

    36

{

    37

	DeleteName(this->str);

    38

}

    39

    40

/**

    41

 *

    42

 * Update the coordinate of one sign

    43

 * @param si Pointer to the Sign

    44

 *

    45

 */

    46

static void UpdateSignVirtCoords(Sign *si)

    47

{

    48

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

    49

	SetDParam(0, si->index);

    50

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

    51

}

    52

    53

/**

    54

 *

    55

 * Update the coordinates of all signs

    56

 *

    57

 */

    58

void UpdateAllSignVirtCoords()

    59

{

    60

	Sign *si;

    61

    62

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    63

    64

}

    65

    66

/**

    67

 *

    68

 * Marks the region of a sign as dirty

    69

 *

    70

 * @param si Pointer to the Sign

    71

 */

    72

static void MarkSignDirty(Sign *si)

    73

{

    74

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

    75

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

    76

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

    77

	MarkAllViewportsDirty(

    78

		si->sign.left - 6,

    79

		si->sign.top  - 3,

    80

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

    81

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

    82

}

    83

    84

/**

    85

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

    86

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

    87

 * but everybody is able to rename/remove it.

    88

 * @param tile tile to place sign at

    89

 * @param flags type of operation

    90

 * @param p1 unused

    91

 * @param p2 unused

    92

 */

    93

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

    94

{

    95

	/* Try to locate a new sign */

    96

	Sign *si = new Sign(STR_280A_SIGN);

    97

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

    98

	AutoPtrT<Sign> s_auto_delete = si;

    99

   100

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

   101

	if (flags & DC_EXEC) {

   102

		int x = TileX(tile) * TILE_SIZE;

   103

		int y = TileY(tile) * TILE_SIZE;

   104

   105

		si->x = x;

   106

		si->y = y;

   107

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

   108

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

   109

		UpdateSignVirtCoords(si);

   110

		MarkSignDirty(si);

   111

		InvalidateWindow(WC_SIGN_LIST, 0);

   112

		_sign_sort_dirty = true;

   113

		_new_sign_id = si->index;

   114

		_total_signs++;

   115

		s_auto_delete.Detach();

   116

	}

   117

   118

	return CommandCost();

   119

}

   120

   121

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

   122

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

   123

 * has no meaning/effect whatsoever except for eyecandy

   124

 * @param tile unused

   125

 * @param flags type of operation

   126

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

   127

 * @param p2 unused

   128

 * @return 0 if succesfull, otherwise CMD_ERROR

   129

 */

   130

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

   131

{

   132

	if (!IsValidSignID(p1)) return CMD_ERROR;

   133

   134

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

   135

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

   136

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

   137

		/* Create the name */

   138

		StringID str = AllocateName(_cmd_text, 0);

   139

		if (str == 0) return CMD_ERROR;

   140

   141

		if (flags & DC_EXEC) {

   142

			Sign *si = GetSign(p1);

   143

   144

			/* Delete the old name */

   145

			DeleteName(si->str);

   146

			/* Assign the new one */

   147

			si->str = str;

   148

			si->owner = _current_player;

   149

   150

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

   151

			MarkSignDirty(si);

   152

			UpdateSignVirtCoords(si);

   153

			MarkSignDirty(si);

   154

			InvalidateWindow(WC_SIGN_LIST, 0);

   155

			_sign_sort_dirty = true;

   156

		} else {

   157

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

   158

			DeleteName(str);

   159

		}

   160

	} else { // Delete sign

   161

		if (flags & DC_EXEC) {

   162

			Sign *si = GetSign(p1);

   163

   164

			MarkSignDirty(si);

   165

			delete si;

   166

   167

			InvalidateWindow(WC_SIGN_LIST, 0);

   168

			_sign_sort_dirty = true;

   169

			_total_signs--;

   170

		}

   171

	}

   172

   173

	return CommandCost();

   174

}

   175

   176

/**

   177

 * Callback function that is called after a sign is placed

   178

 * @param success of the operation

   179

 * @param tile unused

   180

 * @param p1 unused

   181

 * @param p2 unused

   182

 */

   183

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

   184

{

   185

	if (success) {

   186

		ShowRenameSignWindow(GetSign(_new_sign_id));

   187

		ResetObjectToPlace();

   188

	}

   189

}

   190

   191

/**

   192

 *

   193

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

   194

 *  sign-tool is selected

   195

 * @param tile on which to place the sign

   196

 */

   197

void PlaceProc_Sign(TileIndex tile)

   198

{

   199

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

   200

}

   201

   202

/**

   203

 *

   204

 * Initialize the signs

   205

 *

   206

 */

   207

void InitializeSigns()

   208

{

   209

	_total_signs = 0;

   210

	_Sign_pool.CleanPool();

   211

	_Sign_pool.AddBlockToPool();

   212

}

   213

   214

static const SaveLoad _sign_desc[] = {

   215

      SLE_VAR(Sign, str,   SLE_UINT16),

   216

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

   217

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

   218

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

   219

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

   220

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

   221

      SLE_VAR(Sign, z,     SLE_UINT8),

   222

	SLE_END()

   223

};

   224

   225

/**

   226

 *

   227

 * Save all signs

   228

 *

   229

 */

   230

static void Save_SIGN()

   231

{

   232

	Sign *si;

   233

   234

	FOR_ALL_SIGNS(si) {

   235

		SlSetArrayIndex(si->index);

   236

		SlObject(si, _sign_desc);

   237

	}

   238

}

   239

   240

/**

   241

 *

   242

 * Load all signs

   243

 *

   244

 */

   245

static void Load_SIGN()

   246

{

   247

	_total_signs = 0;

   248

	int index;

   249

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

   250

		Sign *si = new (index) Sign();

   251

		SlObject(si, _sign_desc);

   252

   253

		_total_signs++;

   254

	}

   255

   256

	_sign_sort_dirty = true;

   257

}

   258

   259

extern const ChunkHandler _sign_chunk_handlers[] = {

   260

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

   261

};