1

/* $Id$ */

     2

     3

/** @file signs.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "landscape.h"

     8

#include "player_func.h"

     9

#include "signs_base.h"

    10

#include "signs_func.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"

    23

    24

#include "table/strings.h"

    25

    26

SignID _new_sign_id;

    27

uint _total_signs;

    28

bool _sign_sort_dirty;

    29

    30

/* Initialize the sign-pool */

    31

DEFINE_OLD_POOL_GENERIC(Sign, Sign)

    32

    33

Sign::Sign(PlayerID owner)

    34

{

    35

	this->owner = owner;

    36

}

    37

    38

Sign::~Sign()

    39

{

    40

	free(this->name);

    41

	this->owner = INVALID_PLAYER;

    42

}

    43

    44

/**

    45

 *

    46

 * Update the coordinate of one sign

    47

 * @param si Pointer to the Sign

    48

 *

    49

 */

    50

static void UpdateSignVirtCoords(Sign *si)

    51

{

    52

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

    53

	SetDParam(0, si->index);

    54

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

    55

}

    56

    57

/**

    58

 *

    59

 * Update the coordinates of all signs

    60

 *

    61

 */

    62

void UpdateAllSignVirtCoords()

    63

{

    64

	Sign *si;

    65

    66

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    67

    68

}

    69

    70

/**

    71

 * Marks the region of a sign as dirty.

    72

 *

    73

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

    74

 *

    75

 * @param si Pointer to the Sign

    76

 * @ingroup dirty

    77

 */

    78

static void MarkSignDirty(Sign *si)

    79

{

    80

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

    81

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

    82

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

    83

	MarkAllViewportsDirty(

    84

		si->sign.left - 6,

    85

		si->sign.top  - 3,

    86

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

    87

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

    88

}

    89

    90

/**

    91

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

    92

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

    93

 * but everybody is able to rename/remove it.

    94

 * @param tile tile to place sign at

    95

 * @param flags type of operation

    96

 * @param p1 unused

    97

 * @param p2 unused

    98

 */

    99

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

   100

{

   101

	/* Try to locate a new sign */

   102

	Sign *si = new Sign(_current_player);

   103

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

   104

	AutoPtrT<Sign> s_auto_delete = si;

   105

   106

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

   107

	if (flags & DC_EXEC) {

   108

		int x = TileX(tile) * TILE_SIZE;

   109

		int y = TileY(tile) * TILE_SIZE;

   110

   111

		si->x = x;

   112

		si->y = y;

   113

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

   114

		UpdateSignVirtCoords(si);

   115

		MarkSignDirty(si);

   116

		InvalidateWindow(WC_SIGN_LIST, 0);

   117

		_sign_sort_dirty = true;

   118

		_new_sign_id = si->index;

   119

		_total_signs++;

   120

		s_auto_delete.Detach();

   121

	}

   122

   123

	return CommandCost();

   124

}

   125

   126

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

   127

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

   128

 * has no meaning/effect whatsoever except for eyecandy

   129

 * @param tile unused

   130

 * @param flags type of operation

   131

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

   132

 * @param p2 unused

   133

 * @return 0 if succesfull, otherwise CMD_ERROR

   134

 */

   135

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

   136

{

   137

	if (!IsValidSignID(p1)) return CMD_ERROR;

   138

   139

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

   140

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

   141

	if (!StrEmpty(_cmd_text)) {

   142

		if (flags & DC_EXEC) {

   143

			Sign *si = GetSign(p1);

   144

   145

			/* Delete the old name */

   146

			free(si->name);

   147

			/* Assign the new one */

   148

			si->name = strdup(_cmd_text);

   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

		}

   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_CONDVAR(Sign, name,  SLE_NAME,                   0, 83),

   214

  SLE_CONDSTR(Sign, name,  SLE_STR, 0,                84, SL_MAX_VERSION),

   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

};