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"

    10

#include "signs.h"

    11

#include "saveload.h"

    12

#include "command_func.h"

    13

#include "variables.h"

    14

#include "misc/autoptr.hpp"

    15

#include "strings_func.h"

    16

#include "viewport_func.h"

    17

#include "zoom_func.h"

    18

#include "functions.h"

    19

#include "window_func.h"

    20

#include "map_func.h"

    21

#include "string_func.h"

    22

    23

SignID _new_sign_id;

    24

uint _total_signs;

    25

    26

/* Initialize the sign-pool */

    27

DEFINE_OLD_POOL_GENERIC(Sign, Sign)

    28

    29

Sign::Sign(StringID string)

    30

{

    31

	this->str = string;

    32

}

    33

    34

Sign::~Sign()

    35

{

    36

	DeleteName(this->str);

    37

	this->str = STR_NULL;

    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

 * Marks the region of a sign as dirty.

    68

 *

    69

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

    70

 *

    71

 * @param si Pointer to the Sign

    72

 * @ingroup dirty

    73

 */

    74

static void MarkSignDirty(Sign *si)

    75

{

    76

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

    77

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

    78

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

    79

	MarkAllViewportsDirty(

    80

		si->sign.left - 6,

    81

		si->sign.top  - 3,

    82

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

    83

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

    84

}

    85

    86

/**

    87

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

    88

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

    89

 * but everybody is able to rename/remove it.

    90

 * @param tile tile to place sign at

    91

 * @param flags type of operation

    92

 * @param p1 unused

    93

 * @param p2 unused

    94

 */

    95

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

    96

{

    97

	/* Try to locate a new sign */

    98

	Sign *si = new Sign(STR_280A_SIGN);

    99

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

   100

	AutoPtrT<Sign> s_auto_delete = si;

   101

   102

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

   103

	if (flags & DC_EXEC) {

   104

		int x = TileX(tile) * TILE_SIZE;

   105

		int y = TileY(tile) * TILE_SIZE;

   106

   107

		si->x = x;

   108

		si->y = y;

   109

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

   110

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

   111

		UpdateSignVirtCoords(si);

   112

		MarkSignDirty(si);

   113

		InvalidateWindow(WC_SIGN_LIST, 0);

   114

		_sign_sort_dirty = true;

   115

		_new_sign_id = si->index;

   116

		_total_signs++;

   117

		s_auto_delete.Detach();

   118

	}

   119

   120

	return CommandCost();

   121

}

   122

   123

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

   124

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

   125

 * has no meaning/effect whatsoever except for eyecandy

   126

 * @param tile unused

   127

 * @param flags type of operation

   128

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

   129

 * @param p2 unused

   130

 * @return 0 if succesfull, otherwise CMD_ERROR

   131

 */

   132

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

   133

{

   134

	if (!IsValidSignID(p1)) return CMD_ERROR;

   135

   136

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

   137

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

   138

	if (!StrEmpty(_cmd_text)) {

   139

		/* Create the name */

   140

		StringID str = AllocateName(_cmd_text, 0);

   141

		if (str == 0) return CMD_ERROR;

   142

   143

		if (flags & DC_EXEC) {

   144

			Sign *si = GetSign(p1);

   145

   146

			/* Delete the old name */

   147

			DeleteName(si->str);

   148

			/* Assign the new one */

   149

			si->str = str;

   150

			si->owner = _current_player;

   151

   152

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

   153

			MarkSignDirty(si);

   154

			UpdateSignVirtCoords(si);

   155

			MarkSignDirty(si);

   156

			InvalidateWindow(WC_SIGN_LIST, 0);

   157

			_sign_sort_dirty = true;

   158

		} else {

   159

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

   160

			DeleteName(str);

   161

		}

   162

	} else { // Delete sign

   163

		if (flags & DC_EXEC) {

   164

			Sign *si = GetSign(p1);

   165

   166

			MarkSignDirty(si);

   167

			delete si;

   168

   169

			InvalidateWindow(WC_SIGN_LIST, 0);

   170

			_sign_sort_dirty = true;

   171

			_total_signs--;

   172

		}

   173

	}

   174

   175

	return CommandCost();

   176

}

   177

   178

/**

   179

 * Callback function that is called after a sign is placed

   180

 * @param success of the operation

   181

 * @param tile unused

   182

 * @param p1 unused

   183

 * @param p2 unused

   184

 */

   185

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

   186

{

   187

	if (success) {

   188

		ShowRenameSignWindow(GetSign(_new_sign_id));

   189

		ResetObjectToPlace();

   190

	}

   191

}

   192

   193

/**

   194

 *

   195

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

   196

 *  sign-tool is selected

   197

 * @param tile on which to place the sign

   198

 */

   199

void PlaceProc_Sign(TileIndex tile)

   200

{

   201

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

   202

}

   203

   204

/**

   205

 *

   206

 * Initialize the signs

   207

 *

   208

 */

   209

void InitializeSigns()

   210

{

   211

	_total_signs = 0;

   212

	_Sign_pool.CleanPool();

   213

	_Sign_pool.AddBlockToPool();

   214

}

   215

   216

static const SaveLoad _sign_desc[] = {

   217

      SLE_VAR(Sign, str,   SLE_UINT16),

   218

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

   219

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

   220

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

   221

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

   222

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

   223

      SLE_VAR(Sign, z,     SLE_UINT8),

   224

	SLE_END()

   225

};

   226

   227

/**

   228

 *

   229

 * Save all signs

   230

 *

   231

 */

   232

static void Save_SIGN()

   233

{

   234

	Sign *si;

   235

   236

	FOR_ALL_SIGNS(si) {

   237

		SlSetArrayIndex(si->index);

   238

		SlObject(si, _sign_desc);

   239

	}

   240

}

   241

   242

/**

   243

 *

   244

 * Load all signs

   245

 *

   246

 */

   247

static void Load_SIGN()

   248

{

   249

	_total_signs = 0;

   250

	int index;

   251

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

   252

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

   253

		SlObject(si, _sign_desc);

   254

   255

		_total_signs++;

   256

	}

   257

   258

	_sign_sort_dirty = true;

   259

}

   260

   261

extern const ChunkHandler _sign_chunk_handlers[] = {

   262

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

   263

};