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

    14

#include "variables.h"

    15

#include "string.h"

    16

#include "misc/autoptr.hpp"

    17

#include "strings_func.h"

    19

    20

SignID _new_sign_id;

    21

uint _total_signs;

    22

    23

/* Initialize the sign-pool */

    24

DEFINE_OLD_POOL_GENERIC(Sign, Sign)

    25

    26

Sign::Sign(StringID string)

    27

{

    28

	this->str = string;

    29

}

    30

    31

Sign::~Sign()

    32

{

    33

	DeleteName(this->str);

    34

	this->str = STR_NULL;

    35

}

    36

    37

/**

    38

 *

    39

 * Update the coordinate of one sign

    40

 * @param si Pointer to the Sign

    41

 *

    42

 */

    43

static void UpdateSignVirtCoords(Sign *si)

    44

{

    45

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

    46

	SetDParam(0, si->index);

    47

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

    48

}

    49

    50

/**

    51

 *

    52

 * Update the coordinates of all signs

    53

 *

    54

 */

    55

void UpdateAllSignVirtCoords()

    56

{

    57

	Sign *si;

    58

    59

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    60

    61

}

    62

    63

/**

    64

 * Marks the region of a sign as dirty.

    65

 *

    66

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

    67

 *

    68

 * @param si Pointer to the Sign

    69

 * @ingroup dirty

    70

 */

    71

static void MarkSignDirty(Sign *si)

    72

{

    73

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

    74

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

    75

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

    76

	MarkAllViewportsDirty(

    77

		si->sign.left - 6,

    78

		si->sign.top  - 3,

    79

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

    80

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

    81

}

    82

    83

/**

    84

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

    85

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

    86

 * but everybody is able to rename/remove it.

    87

 * @param tile tile to place sign at

    88

 * @param flags type of operation

    89

 * @param p1 unused

    90

 * @param p2 unused

    91

 */

    92

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

    93

{

    94

	/* Try to locate a new sign */

    95

	Sign *si = new Sign(STR_280A_SIGN);

    96

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

    97

	AutoPtrT<Sign> s_auto_delete = si;

    98

    99

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

   100

	if (flags & DC_EXEC) {

   101

		int x = TileX(tile) * TILE_SIZE;

   102

		int y = TileY(tile) * TILE_SIZE;

   103

   104

		si->x = x;

   105

		si->y = y;

   106

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

   107

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

   108

		UpdateSignVirtCoords(si);

   109

		MarkSignDirty(si);

   110

		InvalidateWindow(WC_SIGN_LIST, 0);

   111

		_sign_sort_dirty = true;

   112

		_new_sign_id = si->index;

   113

		_total_signs++;

   114

		s_auto_delete.Detach();

   115

	}

   116

   117

	return CommandCost();

   118

}

   119

   120

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

   121

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

   122

 * has no meaning/effect whatsoever except for eyecandy

   123

 * @param tile unused

   124

 * @param flags type of operation

   125

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

   126

 * @param p2 unused

   127

 * @return 0 if succesfull, otherwise CMD_ERROR

   128

 */

   129

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

   130

{

   131

	if (!IsValidSignID(p1)) return CMD_ERROR;

   132

   133

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

   134

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

   135

	if (!StrEmpty(_cmd_text)) {

   136

		/* Create the name */

   137

		StringID str = AllocateName(_cmd_text, 0);

   138

		if (str == 0) return CMD_ERROR;

   139

   140

		if (flags & DC_EXEC) {

   141

			Sign *si = GetSign(p1);

   142

   143

			/* Delete the old name */

   144

			DeleteName(si->str);

   145

			/* Assign the new one */

   146

			si->str = str;

   147

			si->owner = _current_player;

   148

   149

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

   150

			MarkSignDirty(si);

   151

			UpdateSignVirtCoords(si);

   152

			MarkSignDirty(si);

   153

			InvalidateWindow(WC_SIGN_LIST, 0);

   154

			_sign_sort_dirty = true;

   155

		} else {

   156

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

   157

			DeleteName(str);

   158

		}

   159

	} else { // Delete sign

   160

		if (flags & DC_EXEC) {

   161

			Sign *si = GetSign(p1);

   162

   163

			MarkSignDirty(si);

   164

			delete si;

   165

   166

			InvalidateWindow(WC_SIGN_LIST, 0);

   167

			_sign_sort_dirty = true;

   168

			_total_signs--;

   169

		}

   170

	}

   171

   172

	return CommandCost();

   173

}

   174

   175

/**

   176

 * Callback function that is called after a sign is placed

   177

 * @param success of the operation

   178

 * @param tile unused

   179

 * @param p1 unused

   180

 * @param p2 unused

   181

 */

   182

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

   183

{

   184

	if (success) {

   185

		ShowRenameSignWindow(GetSign(_new_sign_id));

   186

		ResetObjectToPlace();

   187

	}

   188

}

   189

   190

/**

   191

 *

   192

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

   193

 *  sign-tool is selected

   194

 * @param tile on which to place the sign

   195

 */

   196

void PlaceProc_Sign(TileIndex tile)

   197

{

   198

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

   199

}

   200

   201

/**

   202

 *

   203

 * Initialize the signs

   204

 *

   205

 */

   206

void InitializeSigns()

   207

{

   208

	_total_signs = 0;

   209

	_Sign_pool.CleanPool();

   210

	_Sign_pool.AddBlockToPool();

   211

}

   212

   213

static const SaveLoad _sign_desc[] = {

   214

      SLE_VAR(Sign, str,   SLE_UINT16),

   215

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

   216

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

   217

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

   218

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

   219

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

   220

      SLE_VAR(Sign, z,     SLE_UINT8),

   221

	SLE_END()

   222

};

   223

   224

/**

   225

 *

   226

 * Save all signs

   227

 *

   228

 */

   229

static void Save_SIGN()

   230

{

   231

	Sign *si;

   232

   233

	FOR_ALL_SIGNS(si) {

   234

		SlSetArrayIndex(si->index);

   235

		SlObject(si, _sign_desc);

   236

	}

   237

}

   238

   239

/**

   240

 *

   241

 * Load all signs

   242

 *

   243

 */

   244

static void Load_SIGN()

   245

{

   246

	_total_signs = 0;

   247

	int index;

   248

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

   249

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

   250

		SlObject(si, _sign_desc);

   251

   252

		_total_signs++;

   253

	}

   254

   255

	_sign_sort_dirty = true;

   256

}

   257

   258

extern const ChunkHandler _sign_chunk_handlers[] = {

   259

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

   260

};