1

/* $Id$ */

     2

     3

/** @file signs.cpp Handling of signs. */

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

    15

#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

#include "oldpool_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

	if (!Sign::CanAllocateItem()) return_cmd_error(STR_2808_TOO_MANY_SIGNS);

   103

   104

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

   105

	if (flags & DC_EXEC) {

   106

		Sign *si = new Sign(_current_player);

   107

		int x = TileX(tile) * TILE_SIZE;

   108

		int y = TileY(tile) * TILE_SIZE;

   109

   110

		si->x = x;

   111

		si->y = y;

   112

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

   113

		UpdateSignVirtCoords(si);

   114

		MarkSignDirty(si);

   115

		InvalidateWindow(WC_SIGN_LIST, 0);

   116

		_sign_sort_dirty = true;

   117

		_new_sign_id = si->index;

   118

		_total_signs++;

   119

	}

   120

   121

	return CommandCost();

   122

}

   123

   124

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

   125

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

   126

 * has no meaning/effect whatsoever except for eyecandy

   127

 * @param tile unused

   128

 * @param flags type of operation

   129

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

   130

 * @param p2 unused

   131

 * @return 0 if succesfull, otherwise CMD_ERROR

   132

 */

   133

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

   134

{

   135

	if (!IsValidSignID(p1)) return CMD_ERROR;

   136

   137

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

   138

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

   139

	if (!StrEmpty(_cmd_text)) {

   140

		if (flags & DC_EXEC) {

   141

			Sign *si = GetSign(p1);

   142

   143

			/* Delete the old name */

   144

			free(si->name);

   145

			/* Assign the new one */

   146

			si->name = strdup(_cmd_text);

   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

		}

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

   212

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

   213

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

   214

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

   215

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

   216

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

   217

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

   218

      SLE_VAR(Sign, z,     SLE_UINT8),

   219

	SLE_END()

   220

};

   221

   222

/**

   223

 *

   224

 * Save all signs

   225

 *

   226

 */

   227

static void Save_SIGN()

   228

{

   229

	Sign *si;

   230

   231

	FOR_ALL_SIGNS(si) {

   232

		SlSetArrayIndex(si->index);

   233

		SlObject(si, _sign_desc);

   234

	}

   235

}

   236

   237

/**

   238

 *

   239

 * Load all signs

   240

 *

   241

 */

   242

static void Load_SIGN()

   243

{

   244

	_total_signs = 0;

   245

	int index;

   246

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

   247

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

   248

		SlObject(si, _sign_desc);

   249

   250

		_total_signs++;

   251

	}

   252

   253

	_sign_sort_dirty = true;

   254

}

   255

   256

extern const ChunkHandler _sign_chunk_handlers[] = {

   257

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

   258

};