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

    28

/* Initialize the sign-pool */

    29

DEFINE_OLD_POOL_GENERIC(Sign, Sign)

    30

    31

Sign::Sign(PlayerID owner)

    32

{

    33

	this->owner = owner;

    34

}

    35

    36

Sign::~Sign()

    37

{

    38

	free(this->name);

    39

	this->owner = INVALID_PLAYER;

    40

}

    41

    42

/**

    43

 *

    44

 * Update the coordinate of one sign

    45

 * @param si Pointer to the Sign

    46

 *

    47

 */

    48

static void UpdateSignVirtCoords(Sign *si)

    49

{

    50

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

    51

	SetDParam(0, si->index);

    52

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

    53

}

    54

    55

/**

    56

 *

    57

 * Update the coordinates of all signs

    58

 *

    59

 */

    60

void UpdateAllSignVirtCoords()

    61

{

    62

	Sign *si;

    63

    64

	FOR_ALL_SIGNS(si) UpdateSignVirtCoords(si);

    65

    66

}

    67

    68

/**

    69

 * Marks the region of a sign as dirty.

    70

 *

    71

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

    72

 *

    73

 * @param si Pointer to the Sign

    74

 * @ingroup dirty

    75

 */

    76

static void MarkSignDirty(Sign *si)

    77

{

    78

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

    79

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

    80

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

    81

	MarkAllViewportsDirty(

    82

		si->sign.left - 6,

    83

		si->sign.top  - 3,

    84

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

    85

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

    86

}

    87

    88

/**

    89

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

    90

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

    91

 * but everybody is able to rename/remove it.

    92

 * @param tile tile to place sign at

    93

 * @param flags type of operation

    94

 * @param p1 unused

    95

 * @param p2 unused

    96

 */

    97

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

    98

{

    99

	/* Try to locate a new sign */

   100

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

   101

   102

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

   103

	if (flags & DC_EXEC) {

   104

		Sign *si = new Sign(_current_player);

   105

		int x = TileX(tile) * TILE_SIZE;

   106

		int y = TileY(tile) * TILE_SIZE;

   107

   108

		si->x = x;

   109

		si->y = y;

   110

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

   111

		UpdateSignVirtCoords(si);

   112

		MarkSignDirty(si);

   113

		InvalidateWindowData(WC_SIGN_LIST, 0, 0);

   114

		_new_sign_id = si->index;

   115

	}

   116

   117

	return CommandCost();

   118

}

   119

   120

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

   121

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

   122

 * has no meaning/effect whatsoever except for eyecandy

   123

 * @param tile unused

   124

 * @param flags type of operation

   125

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

   126

 * @param p2 unused

   127

 * @return 0 if succesfull, otherwise CMD_ERROR

   128

 */

   129

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

   130

{

   131

	if (!IsValidSignID(p1)) return CMD_ERROR;

   132

   133

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

   134

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

   135

	if (!StrEmpty(_cmd_text)) {

   136

		if (strlen(_cmd_text) >= MAX_LENGTH_SIGN_NAME_BYTES) return CMD_ERROR;

   137

   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

			InvalidateWindowData(WC_SIGN_LIST, 0, 1);

   152

		}

   153

	} else { // Delete sign

   154

		if (flags & DC_EXEC) {

   155

			Sign *si = GetSign(p1);

   156

   157

			MarkSignDirty(si);

   158

			delete si;

   159

   161

		}

   162

	}

   163

   164

	return CommandCost();

   165

}

   166

   167

/**

   168

 * Callback function that is called after a sign is placed

   169

 * @param success of the operation

   170

 * @param tile unused

   171

 * @param p1 unused

   172

 * @param p2 unused

   173

 */

   174

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

   175

{

   176

	if (success) {

   177

		ShowRenameSignWindow(GetSign(_new_sign_id));

   178

		ResetObjectToPlace();

   179

	}

   180

}

   181

   182

/**

   183

 *

   184

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

   185

 *  sign-tool is selected

   186

 * @param tile on which to place the sign

   187

 */

   188

void PlaceProc_Sign(TileIndex tile)

   189

{

   190

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

   191

}

   192

   193

/**

   194

 *

   195

 * Initialize the signs

   196

 *

   197

 */

   198

void InitializeSigns()

   199

{

   200

	_Sign_pool.CleanPool();

   201

	_Sign_pool.AddBlockToPool();

   202

}

   203

   204

static const SaveLoad _sign_desc[] = {

   205

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

   206

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

   207

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

   208

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

   209

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

   210

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

   211

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

   212

      SLE_VAR(Sign, z,     SLE_UINT8),

   213

	SLE_END()

   214

};

   215

   216

/**

   217

 *

   218

 * Save all signs

   219

 *

   220

 */

   221

static void Save_SIGN()

   222

{

   223

	Sign *si;

   224

   225

	FOR_ALL_SIGNS(si) {

   226

		SlSetArrayIndex(si->index);

   227

		SlObject(si, _sign_desc);

   228

	}

   229

}

   230

   231

/**

   232

 *

   233

 * Load all signs

   234

 *

   235

 */

   236

static void Load_SIGN()

   237

{

   238

	int index;

   239

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

   240

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

   241

		SlObject(si, _sign_desc);

   242

	}

   243

}

   244

   245

extern const ChunkHandler _sign_chunk_handlers[] = {

   246

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

   247

};