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"

    16

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

bool _sign_sort_dirty;

    28

    29

/* Initialize the sign-pool */

    30

DEFINE_OLD_POOL_GENERIC(Sign, Sign)

    31

    32

Sign::Sign(PlayerID owner)

    33

{

    34

	this->owner = owner;

    35

}

    36

    37

Sign::~Sign()

    38

{

    39

	free(this->name);

    40

	this->owner = INVALID_PLAYER;

    41

}

    42

    43

/**

    44

 *

    45

 * Update the coordinate of one sign

    46

 * @param si Pointer to the Sign

    47

 *

    48

 */

    49

static void UpdateSignVirtCoords(Sign *si)

    50

{

    51

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

    52

	SetDParam(0, si->index);

    53

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

    54

}

    55

    56

/**

    57

 *

    58

 * Update the coordinates of all signs

    59

 *

    60

 */

    61

void UpdateAllSignVirtCoords()

    62

{

    63

	Sign *si;

    64

    65

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    66

    67

}

    68

    69

/**

    70

 * Marks the region of a sign as dirty.

    71

 *

    72

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

    73

 *

    74

 * @param si Pointer to the Sign

    75

 * @ingroup dirty

    76

 */

    77

static void MarkSignDirty(Sign *si)

    78

{

    79

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

    80

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

    81

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

    82

	MarkAllViewportsDirty(

    83

		si->sign.left - 6,

    84

		si->sign.top  - 3,

    85

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

    86

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

    87

}

    88

    89

/**

    90

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

    91

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

    92

 * but everybody is able to rename/remove it.

    93

 * @param tile tile to place sign at

    94

 * @param flags type of operation

    95

 * @param p1 unused

    96

 * @param p2 unused

    97

 */

    98

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

    99

{

   100

	/* Try to locate a new sign */

   101

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

   102

   103

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

   104

	if (flags & DC_EXEC) {

   105

		Sign *si = new Sign(_current_player);

   106

		int x = TileX(tile) * TILE_SIZE;

   107

		int y = TileY(tile) * TILE_SIZE;

   108

   109

		si->x = x;

   110

		si->y = y;

   111

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

   112

		UpdateSignVirtCoords(si);

   113

		MarkSignDirty(si);

   114

		InvalidateWindow(WC_SIGN_LIST, 0);

   115

		_sign_sort_dirty = true;

   116

		_new_sign_id = si->index;

   117

	}

   118

   119

	return CommandCost();

   120

}

   121

   122

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

   123

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

   124

 * has no meaning/effect whatsoever except for eyecandy

   125

 * @param tile unused

   126

 * @param flags type of operation

   127

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

   128

 * @param p2 unused

   129

 * @return 0 if succesfull, otherwise CMD_ERROR

   130

 */

   131

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

   132

{

   133

	if (!IsValidSignID(p1)) return CMD_ERROR;

   134

   135

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

   136

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

   137

	if (!StrEmpty(_cmd_text)) {

   138

		if (flags & DC_EXEC) {

   139

			Sign *si = GetSign(p1);

   140

   141

			/* Delete the old name */

   142

			free(si->name);

   143

			/* Assign the new one */

   144

			si->name = strdup(_cmd_text);

   145

			si->owner = _current_player;

   146

   147

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

   148

			MarkSignDirty(si);

   149

			UpdateSignVirtCoords(si);

   150

			MarkSignDirty(si);

   151

			InvalidateWindow(WC_SIGN_LIST, 0);

   152

			_sign_sort_dirty = true;

   153

		}

   154

	} else { // Delete sign

   155

		if (flags & DC_EXEC) {

   156

			Sign *si = GetSign(p1);

   157

   158

			MarkSignDirty(si);

   159

			delete si;

   160

   161

			InvalidateWindow(WC_SIGN_LIST, 0);

   162

			_sign_sort_dirty = true;

   163

		}

   164

	}

   165

   166

	return CommandCost();

   167

}

   168

   169

/**

   170

 * Callback function that is called after a sign is placed

   171

 * @param success of the operation

   172

 * @param tile unused

   173

 * @param p1 unused

   174

 * @param p2 unused

   175

 */

   176

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

   177

{

   178

	if (success) {

   179

		ShowRenameSignWindow(GetSign(_new_sign_id));

   180

		ResetObjectToPlace();

   181

	}

   182

}

   183

   184

/**

   185

 *

   186

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

   187

 *  sign-tool is selected

   188

 * @param tile on which to place the sign

   189

 */

   190

void PlaceProc_Sign(TileIndex tile)

   191

{

   192

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

   193

}

   194

   195

/**

   196

 *

   197

 * Initialize the signs

   198

 *

   199

 */

   200

void InitializeSigns()

   201

{

   202

	_Sign_pool.CleanPool();

   203

	_Sign_pool.AddBlockToPool();

   204

}

   205

   206

static const SaveLoad _sign_desc[] = {

   207

  SLE_CONDVAR(Sign, name,  SLE_NAME,                   0, 83),

   208

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

   209

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

   210

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

   211

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

   212

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

   213

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

   214

      SLE_VAR(Sign, z,     SLE_UINT8),

   215

	SLE_END()

   216

};

   217

   218

/**

   219

 *

   220

 * Save all signs

   221

 *

   222

 */

   223

static void Save_SIGN()

   224

{

   225

	Sign *si;

   226

   227

	FOR_ALL_SIGNS(si) {

   228

		SlSetArrayIndex(si->index);

   229

		SlObject(si, _sign_desc);

   230

	}

   231

}

   232

   233

/**

   234

 *

   235

 * Load all signs

   236

 *

   237

 */

   238

static void Load_SIGN()

   239

{

   240

	int index;

   241

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

   242

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

   243

		SlObject(si, _sign_desc);

   244

	}

   245

   246

	_sign_sort_dirty = true;

   247

}

   248

   249

extern const ChunkHandler _sign_chunk_handlers[] = {

   250

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

   251

};