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"

    17

#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

 *

    64

 * Marks the region of a sign as dirty

    65

 *

    66

 * @param si Pointer to the Sign

    67

 */

    68

static void MarkSignDirty(Sign *si)

    69

{

    70

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

    71

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

    72

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

    73

	MarkAllViewportsDirty(

    74

		si->sign.left - 6,

    75

		si->sign.top  - 3,

    76

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

    77

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

    78

}

    79

    80

/**

    81

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

    82

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

    83

 * but everybody is able to rename/remove it.

    84

 * @param tile tile to place sign at

    85

 * @param flags type of operation

    86

 * @param p1 unused

    87

 * @param p2 unused

    88

 */

    89

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

    90

{

    91

	/* Try to locate a new sign */

    92

	Sign *si = new Sign(STR_280A_SIGN);

    93

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

    94

	AutoPtrT<Sign> s_auto_delete = si;

    95

    96

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

    97

	if (flags & DC_EXEC) {

    98

		int x = TileX(tile) * TILE_SIZE;

    99

		int y = TileY(tile) * TILE_SIZE;

   100

   101

		si->x = x;

   102

		si->y = y;

   103

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

   104

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

   105

		UpdateSignVirtCoords(si);

   106

		MarkSignDirty(si);

   107

		InvalidateWindow(WC_SIGN_LIST, 0);

   108

		_sign_sort_dirty = true;

   109

		_new_sign_id = si->index;

   110

		_total_signs++;

   111

		s_auto_delete.Detach();

   112

	}

   113

   114

	return CommandCost();

   115

}

   116

   117

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

   118

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

   119

 * has no meaning/effect whatsoever except for eyecandy

   120

 * @param tile unused

   121

 * @param flags type of operation

   122

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

   123

 * @param p2 unused

   124

 * @return 0 if succesfull, otherwise CMD_ERROR

   125

 */

   126

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

   127

{

   128

	if (!IsValidSignID(p1)) return CMD_ERROR;

   129

   130

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

   131

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

   133

		/* Create the name */

   134

		StringID str = AllocateName(_cmd_text, 0);

   135

		if (str == 0) return CMD_ERROR;

   136

   137

		if (flags & DC_EXEC) {

   138

			Sign *si = GetSign(p1);

   139

   140

			/* Delete the old name */

   141

			DeleteName(si->str);

   142

			/* Assign the new one */

   143

			si->str = str;

   144

			si->owner = _current_player;

   145

   146

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

   147

			MarkSignDirty(si);

   148

			UpdateSignVirtCoords(si);

   149

			MarkSignDirty(si);

   150

			InvalidateWindow(WC_SIGN_LIST, 0);

   151

			_sign_sort_dirty = true;

   152

		} else {

   153

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

   154

			DeleteName(str);

   155

		}

   156

	} else { // Delete sign

   157

		if (flags & DC_EXEC) {

   158

			Sign *si = GetSign(p1);

   159

   160

			MarkSignDirty(si);

   161

			delete si;

   162

   163

			InvalidateWindow(WC_SIGN_LIST, 0);

   164

			_sign_sort_dirty = true;

   165

			_total_signs--;

   166

		}

   167

	}

   168

   169

	return CommandCost();

   170

}

   171

   172

/**

   173

 * Callback function that is called after a sign is placed

   174

 * @param success of the operation

   175

 * @param tile unused

   176

 * @param p1 unused

   177

 * @param p2 unused

   178

 */

   179

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

   180

{

   181

	if (success) {

   182

		ShowRenameSignWindow(GetSign(_new_sign_id));

   183

		ResetObjectToPlace();

   184

	}

   185

}

   186

   187

/**

   188

 *

   189

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

   190

 *  sign-tool is selected

   191

 * @param tile on which to place the sign

   192

 */

   193

void PlaceProc_Sign(TileIndex tile)

   194

{

   195

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

   196

}

   197

   198

/**

   199

 *

   200

 * Initialize the signs

   201

 *

   202

 */

   203

void InitializeSigns()

   204

{

   205

	_total_signs = 0;

   206

	_Sign_pool.CleanPool();

   207

	_Sign_pool.AddBlockToPool();

   208

}

   209

   210

static const SaveLoad _sign_desc[] = {

   211

      SLE_VAR(Sign, str,   SLE_UINT16),

   212

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

   213

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

   214

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

   215

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

   216

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

   217

      SLE_VAR(Sign, z,     SLE_UINT8),

   218

	SLE_END()

   219

};

   220

   221

/**

   222

 *

   223

 * Save all signs

   224

 *

   225

 */

   226

static void Save_SIGN()

   227

{

   228

	Sign *si;

   229

   230

	FOR_ALL_SIGNS(si) {

   231

		SlSetArrayIndex(si->index);

   232

		SlObject(si, _sign_desc);

   233

	}

   234

}

   235

   236

/**

   237

 *

   238

 * Load all signs

   239

 *

   240

 */

   241

static void Load_SIGN()

   242

{

   243

	_total_signs = 0;

   244

	int index;

   245

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

   246

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

   247

		SlObject(si, _sign_desc);

   248

   249

		_total_signs++;

   250

	}

   251

   252

	_sign_sort_dirty = true;

   253

}

   254

   255

extern const ChunkHandler _sign_chunk_handlers[] = {

   256

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

   257

};