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

#include "string.h"

    16

#include "misc/autoptr.hpp"

    18

    19

SignID _new_sign_id;

    20

uint _total_signs;

    21

    22

/* Initialize the sign-pool */

    23

DEFINE_OLD_POOL_GENERIC(Sign, Sign)

    24

    25

Sign::Sign(StringID string)

    26

{

    27

	this->str = string;

    28

}

    29

    30

Sign::~Sign()

    31

{

    32

	DeleteName(this->str);

    33

	this->str = STR_NULL;

    34

}

    35

    36

/**

    37

 *

    38

 * Update the coordinate of one sign

    39

 * @param si Pointer to the Sign

    40

 *

    41

 */

    42

static void UpdateSignVirtCoords(Sign *si)

    43

{

    44

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

    45

	SetDParam(0, si->index);

    46

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

    47

}

    48

    49

/**

    50

 *

    51

 * Update the coordinates of all signs

    52

 *

    53

 */

    54

void UpdateAllSignVirtCoords()

    55

{

    56

	Sign *si;

    57

    58

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    59

    60

}

    61

    62

/**

    63

 * Marks the region of a sign as dirty.

    64

 *

    65

 * This function marks the sign in all viewports as dirty for repaint.

    66

 *

    67

 * @param si Pointer to the Sign

    68

 * @ingroup dirty

    69

 */

    70

static void MarkSignDirty(Sign *si)

    71

{

    72

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

    73

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

    74

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

    75

	MarkAllViewportsDirty(

    76

		si->sign.left - 6,

    77

		si->sign.top  - 3,

    78

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

    79

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

    80

}

    81

    82

/**

    83

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

    84

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

    85

 * but everybody is able to rename/remove it.

    86

 * @param tile tile to place sign at

    87

 * @param flags type of operation

    88

 * @param p1 unused

    89

 * @param p2 unused

    90

 */

    91

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

    92

{

    93

	/* Try to locate a new sign */

    94

	Sign *si = new Sign(STR_280A_SIGN);

    95

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

    96

	AutoPtrT<Sign> s_auto_delete = si;

    97

    98

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

    99

	if (flags & DC_EXEC) {

   100

		int x = TileX(tile) * TILE_SIZE;

   101

		int y = TileY(tile) * TILE_SIZE;

   102

   103

		si->x = x;

   104

		si->y = y;

   105

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

   106

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

   107

		UpdateSignVirtCoords(si);

   108

		MarkSignDirty(si);

   109

		InvalidateWindow(WC_SIGN_LIST, 0);

   110

		_sign_sort_dirty = true;

   111

		_new_sign_id = si->index;

   112

		_total_signs++;

   113

		s_auto_delete.Detach();

   114

	}

   115

   116

	return CommandCost();

   117

}

   118

   119

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

   120

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

   121

 * has no meaning/effect whatsoever except for eyecandy

   122

 * @param tile unused

   123

 * @param flags type of operation

   124

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

   125

 * @param p2 unused

   126

 * @return 0 if succesfull, otherwise CMD_ERROR

   127

 */

   128

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

   129

{

   130

	if (!IsValidSignID(p1)) return CMD_ERROR;

   131

   132

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

   133

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

   134

	if (!StrEmpty(_cmd_text)) {

   135

		/* Create the name */

   136

		StringID str = AllocateName(_cmd_text, 0);

   137

		if (str == 0) return CMD_ERROR;

   138

   139

		if (flags & DC_EXEC) {

   140

			Sign *si = GetSign(p1);

   141

   142

			/* Delete the old name */

   143

			DeleteName(si->str);

   144

			/* Assign the new one */

   145

			si->str = str;

   146

			si->owner = _current_player;

   147

   148

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

   149

			MarkSignDirty(si);

   150

			UpdateSignVirtCoords(si);

   151

			MarkSignDirty(si);

   152

			InvalidateWindow(WC_SIGN_LIST, 0);

   153

			_sign_sort_dirty = true;

   154

		} else {

   155

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

   156

			DeleteName(str);

   157

		}

   158

	} else { // Delete sign

   159

		if (flags & DC_EXEC) {

   160

			Sign *si = GetSign(p1);

   161

   162

			MarkSignDirty(si);

   163

			delete si;

   164

   165

			InvalidateWindow(WC_SIGN_LIST, 0);

   166

			_sign_sort_dirty = true;

   167

			_total_signs--;

   168

		}

   169

	}

   170

   171

	return CommandCost();

   172

}

   173

   174

/**

   175

 * Callback function that is called after a sign is placed

   176

 * @param success of the operation

   177

 * @param tile unused

   178

 * @param p1 unused

   179

 * @param p2 unused

   180

 */

   181

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

   182

{

   183

	if (success) {

   184

		ShowRenameSignWindow(GetSign(_new_sign_id));

   185

		ResetObjectToPlace();

   186

	}

   187

}

   188

   189

/**

   190

 *

   191

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

   192

 *  sign-tool is selected

   193

 * @param tile on which to place the sign

   194

 */

   195

void PlaceProc_Sign(TileIndex tile)

   196

{

   197

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

   198

}

   199

   200

/**

   201

 *

   202

 * Initialize the signs

   203

 *

   204

 */

   205

void InitializeSigns()

   206

{

   207

	_total_signs = 0;

   208

	_Sign_pool.CleanPool();

   209

	_Sign_pool.AddBlockToPool();

   210

}

   211

   212

static const SaveLoad _sign_desc[] = {

   213

      SLE_VAR(Sign, str,   SLE_UINT16),

   214

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

   215

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

   216

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

   217

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

   218

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

   219

      SLE_VAR(Sign, z,     SLE_UINT8),

   220

	SLE_END()

   221

};

   222

   223

/**

   224

 *

   225

 * Save all signs

   226

 *

   227

 */

   228

static void Save_SIGN()

   229

{

   230

	Sign *si;

   231

   232

	FOR_ALL_SIGNS(si) {

   233

		SlSetArrayIndex(si->index);

   234

		SlObject(si, _sign_desc);

   235

	}

   236

}

   237

   238

/**

   239

 *

   240

 * Load all signs

   241

 *

   242

 */

   243

static void Load_SIGN()

   244

{

   245

	_total_signs = 0;

   246

	int index;

   247

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

   248

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

   249

		SlObject(si, _sign_desc);

   250

   251

		_total_signs++;

   252

	}

   253

   254

	_sign_sort_dirty = true;

   255

}

   256

   257

extern const ChunkHandler _sign_chunk_handlers[] = {

   258

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

   259

};