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 "company_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

    28

/* Initialize the sign-pool */

    29

DEFINE_OLD_POOL_GENERIC(Sign, Sign)

    30

    31

Sign::Sign(Owner owner)

    32

{

    33

	this->owner = owner;

    34

}

    35

    36

Sign::~Sign()

    37

{

    38

	free(this->name);

    39

    40

	if (CleaningPool()) return;

    41

    42

	DeleteRenameSignWindow(this->index);

    43

	this->owner = INVALID_OWNER;

    44

}

    45

    46

/**

    47

 *

    48

 * Update the coordinate of one sign

    49

 * @param si Pointer to the Sign

    50

 *

    51

 */

    52

static void UpdateSignVirtCoords(Sign *si)

    53

{

    54

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

    55

	SetDParam(0, si->index);

    56

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

    57

}

    58

    59

/**

    60

 *

    61

 * Update the coordinates of all signs

    62

 *

    63

 */

    64

void UpdateAllSignVirtCoords()

    65

{

    66

	Sign *si;

    67

    68

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    69

    70

}

    71

    72

/**

    73

 * Marks the region of a sign as dirty.

    74

 *

    75

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

    76

 *

    77

 * @param si Pointer to the Sign

    78

 * @ingroup dirty

    79

 */

    80

static void MarkSignDirty(Sign *si)

    81

{

    82

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

    83

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

    84

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

    85

	MarkAllViewportsDirty(

    86

		si->sign.left - 6,

    87

		si->sign.top  - 3,

    88

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

    89

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

    90

}

    91

    92

/**

    93

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

    94

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

    95

 * but everybody is able to rename/remove it.

    96

 * @param tile tile to place sign at

    97

 * @param flags type of operation

    98

 * @param p1 unused

    99

 * @param p2 unused

   100

 */

   101

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

   102

{

   103

	/* Try to locate a new sign */

   104

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

   105

   106

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

   107

	if (flags & DC_EXEC) {

   108

		Sign *si = new Sign(_current_company);

   109

		int x = TileX(tile) * TILE_SIZE;

   110

		int y = TileY(tile) * TILE_SIZE;

   111

   112

		si->x = x;

   113

		si->y = y;

   114

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

   115

		UpdateSignVirtCoords(si);

   116

		MarkSignDirty(si);

   117

		InvalidateWindowData(WC_SIGN_LIST, 0, 0);

   118

		_new_sign_id = si->index;

   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 (strlen(_cmd_text) >= MAX_LENGTH_SIGN_NAME_BYTES) return CMD_ERROR;

   141

   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_company;

   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

			InvalidateWindowData(WC_SIGN_LIST, 0, 1);

   156

		}

   157

	} else { // Delete sign

   158

		if (flags & DC_EXEC) {

   159

			Sign *si = GetSign(p1);

   160

   161

			MarkSignDirty(si);

   162

			delete si;

   163

   164

			InvalidateWindowData(WC_SIGN_LIST, 0, 0);

   165

		}

   166

	}

   167

   168

	return CommandCost();

   169

}

   170

   171

/**

   172

 * Callback function that is called after a sign is placed

   173

 * @param success of the operation

   174

 * @param tile unused

   175

 * @param p1 unused

   176

 * @param p2 unused

   177

 */

   178

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

   179

{

   180

	if (success) {

   181

		ShowRenameSignWindow(GetSign(_new_sign_id));

   182

		ResetObjectToPlace();

   183

	}

   184

}

   185

   186

/**

   187

 *

   188

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

   189

 *  sign-tool is selected

   190

 * @param tile on which to place the sign

   191

 */

   192

void PlaceProc_Sign(TileIndex tile)

   193

{

   194

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

   195

}

   196

   197

/**

   198

 *

   199

 * Initialize the signs

   200

 *

   201

 */

   202

void InitializeSigns()

   203

{

   204

	_Sign_pool.CleanPool();

   205

	_Sign_pool.AddBlockToPool();

   206

}

   207

   208

static const SaveLoad _sign_desc[] = {

   209

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

   210

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

   211

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

   212

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

   213

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

   214

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

   215

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

   216

      SLE_VAR(Sign, z,     SLE_UINT8),

   217

	SLE_END()

   218

};

   219

   220

/**

   221

 *

   222

 * Save all signs

   223

 *

   224

 */

   225

static void Save_SIGN()

   226

{

   227

	Sign *si;

   228

   229

	FOR_ALL_SIGNS(si) {

   230

		SlSetArrayIndex(si->index);

   231

		SlObject(si, _sign_desc);

   232

	}

   233

}

   234

   235

/**

   236

 *

   237

 * Load all signs

   238

 *

   239

 */

   240

static void Load_SIGN()

   241

{

   242

	int index;

   243

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

   244

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

   245

		SlObject(si, _sign_desc);

   246

	}

   247

}

   248

   249

extern const ChunkHandler _sign_chunk_handlers[] = {

   250

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

   251

};