1

/* $Id$ */

     2

     3

/** @file signs.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "table/strings.h"

     8

#include "landscape.h"

     9

#include "player.h"

    10

#include "signs.h"

    11

#include "saveload.h"

    12

#include "command_func.h"

    13

#include "variables.h"

    14

#include "string.h"

    15

#include "misc/autoptr.hpp"

    16

#include "strings_func.h"

    17

#include "viewport.h"

    18

#include "zoom_func.h"

    21

    22

SignID _new_sign_id;

    23

uint _total_signs;

    24

    25

/* Initialize the sign-pool */

    26

DEFINE_OLD_POOL_GENERIC(Sign, Sign)

    27

    28

Sign::Sign(StringID string)

    29

{

    30

	this->str = string;

    31

}

    32

    33

Sign::~Sign()

    34

{

    35

	DeleteName(this->str);

    36

	this->str = STR_NULL;

    37

}

    38

    39

/**

    40

 *

    41

 * Update the coordinate of one sign

    42

 * @param si Pointer to the Sign

    43

 *

    44

 */

    45

static void UpdateSignVirtCoords(Sign *si)

    46

{

    47

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

    48

	SetDParam(0, si->index);

    49

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

    50

}

    51

    52

/**

    53

 *

    54

 * Update the coordinates of all signs

    55

 *

    56

 */

    57

void UpdateAllSignVirtCoords()

    58

{

    59

	Sign *si;

    60

    61

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    62

    63

}

    64

    65

/**

    66

 * Marks the region of a sign as dirty.

    67

 *

    68

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

    69

 *

    70

 * @param si Pointer to the Sign

    71

 * @ingroup dirty

    72

 */

    73

static void MarkSignDirty(Sign *si)

    74

{

    75

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

    76

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

    77

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

    78

	MarkAllViewportsDirty(

    79

		si->sign.left - 6,

    80

		si->sign.top  - 3,

    81

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

    82

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

    83

}

    84

    85

/**

    86

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

    87

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

    88

 * but everybody is able to rename/remove it.

    89

 * @param tile tile to place sign at

    90

 * @param flags type of operation

    91

 * @param p1 unused

    92

 * @param p2 unused

    93

 */

    94

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

    95

{

    96

	/* Try to locate a new sign */

    97

	Sign *si = new Sign(STR_280A_SIGN);

    98

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

    99

	AutoPtrT<Sign> s_auto_delete = si;

   100

   101

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

   102

	if (flags & DC_EXEC) {

   103

		int x = TileX(tile) * TILE_SIZE;

   104

		int y = TileY(tile) * TILE_SIZE;

   105

   106

		si->x = x;

   107

		si->y = y;

   108

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

   109

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

   110

		UpdateSignVirtCoords(si);

   111

		MarkSignDirty(si);

   112

		InvalidateWindow(WC_SIGN_LIST, 0);

   113

		_sign_sort_dirty = true;

   114

		_new_sign_id = si->index;

   115

		_total_signs++;

   116

		s_auto_delete.Detach();

   117

	}

   118

   119

	return CommandCost();

   120

}

   121

   122

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

   123

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

   124

 * has no meaning/effect whatsoever except for eyecandy

   125

 * @param tile unused

   126

 * @param flags type of operation

   127

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

   128

 * @param p2 unused

   129

 * @return 0 if succesfull, otherwise CMD_ERROR

   130

 */

   131

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

   132

{

   133

	if (!IsValidSignID(p1)) return CMD_ERROR;

   134

   135

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

   136

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

   137

	if (!StrEmpty(_cmd_text)) {

   138

		/* Create the name */

   139

		StringID str = AllocateName(_cmd_text, 0);

   140

		if (str == 0) return CMD_ERROR;

   141

   142

		if (flags & DC_EXEC) {

   143

			Sign *si = GetSign(p1);

   144

   145

			/* Delete the old name */

   146

			DeleteName(si->str);

   147

			/* Assign the new one */

   148

			si->str = str;

   149

			si->owner = _current_player;

   150

   151

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

   152

			MarkSignDirty(si);

   153

			UpdateSignVirtCoords(si);

   154

			MarkSignDirty(si);

   155

			InvalidateWindow(WC_SIGN_LIST, 0);

   156

			_sign_sort_dirty = true;

   157

		} else {

   158

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

   159

			DeleteName(str);

   160

		}

   161

	} else { // Delete sign

   162

		if (flags & DC_EXEC) {

   163

			Sign *si = GetSign(p1);

   164

   165

			MarkSignDirty(si);

   166

			delete si;

   167

   168

			InvalidateWindow(WC_SIGN_LIST, 0);

   169

			_sign_sort_dirty = true;

   170

			_total_signs--;

   171

		}

   172

	}

   173

   174

	return CommandCost();

   175

}

   176

   177

/**

   178

 * Callback function that is called after a sign is placed

   179

 * @param success of the operation

   180

 * @param tile unused

   181

 * @param p1 unused

   182

 * @param p2 unused

   183

 */

   184

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

   185

{

   186

	if (success) {

   187

		ShowRenameSignWindow(GetSign(_new_sign_id));

   188

		ResetObjectToPlace();

   189

	}

   190

}

   191

   192

/**

   193

 *

   194

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

   195

 *  sign-tool is selected

   196

 * @param tile on which to place the sign

   197

 */

   198

void PlaceProc_Sign(TileIndex tile)

   199

{

   200

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

   201

}

   202

   203

/**

   204

 *

   205

 * Initialize the signs

   206

 *

   207

 */

   208

void InitializeSigns()

   209

{

   210

	_total_signs = 0;

   211

	_Sign_pool.CleanPool();

   212

	_Sign_pool.AddBlockToPool();

   213

}

   214

   215

static const SaveLoad _sign_desc[] = {

   216

      SLE_VAR(Sign, str,   SLE_UINT16),

   217

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

   218

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

   219

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

   220

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

   221

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

   222

      SLE_VAR(Sign, z,     SLE_UINT8),

   223

	SLE_END()

   224

};

   225

   226

/**

   227

 *

   228

 * Save all signs

   229

 *

   230

 */

   231

static void Save_SIGN()

   232

{

   233

	Sign *si;

   234

   235

	FOR_ALL_SIGNS(si) {

   236

		SlSetArrayIndex(si->index);

   237

		SlObject(si, _sign_desc);

   238

	}

   239

}

   240

   241

/**

   242

 *

   243

 * Load all signs

   244

 *

   245

 */

   246

static void Load_SIGN()

   247

{

   248

	_total_signs = 0;

   249

	int index;

   250

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

   251

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

   252

		SlObject(si, _sign_desc);

   253

   254

		_total_signs++;

   255

	}

   256

   257

	_sign_sort_dirty = true;

   258

}

   259

   260

extern const ChunkHandler _sign_chunk_handlers[] = {

   261

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

   262

};