1

/* $Id$ */

     2

     3

/** @file tree_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "bridge_map.h"

     8

#include "clear_map.h"

     9

#include "table/strings.h"

    10

#include "table/sprites.h"

    11

#include "table/tree_land.h"

    12

#include "functions.h"

    13

#include "map.h"

    14

#include "landscape.h"

    15

#include "tile.h"

    16

#include "tree_map.h"

    17

#include "viewport.h"

    18

#include "command.h"

    19

#include "town.h"

    20

#include "sound.h"

    21

#include "variables.h"

    22

#include "genworld.h"

    23

    24

/**

    25

 * List of tree placer algorithm.

    26

 *

    27

 * This enumeration defines all possible tree placer algorithm in the game.

    28

 */

    29

enum TreePlacer {

    30

	TP_NONE,     ///< No tree placer algorithm

    31

	TP_ORIGINAL, ///< The original algorithm

    32

	TP_IMPROVED, ///< A 'improved' algorithm

    33

};

    34

    35

/**

    36

 * Get a random TreeType for the given tile based on a given seed

    37

 *

    38

 * This function returns a random TreeType which can be placed on the given tile.

    39

 * The seed for randomness must be less or equal 256, use #GB on the value of Random()

    40

 * to get such a value.

    41

 *

    42

 * @param tile The tile to get a random TreeType from

    43

 * @param seed The seed for randomness, must be less or equal 256

    44

 * @return The random tree type

    45

 */

    46

static TreeType GetRandomTreeType(TileIndex tile, uint seed)

    47

{

    48

	switch (_opt.landscape) {

    49

		case LT_TEMPERATE:

    50

			return (TreeType)(seed * TREE_COUNT_TEMPERATE / 256 + TREE_TEMPERATE);

    51

    52

		case LT_ARCTIC:

    53

			return (TreeType)(seed * TREE_COUNT_SUB_ARCTIC / 256 + TREE_SUB_ARCTIC);

    54

    55

		case LT_TROPIC:

    56

			switch (GetTropicZone(tile)) {

    57

				case TROPICZONE_INVALID: return (TreeType)(seed * TREE_COUNT_SUB_TROPICAL / 256 + TREE_SUB_TROPICAL);

    58

				case TROPICZONE_DESERT:  return (TreeType)((seed > 12) ? TREE_INVALID : TREE_CACTUS);

    59

				default:                 return (TreeType)(seed * TREE_COUNT_RAINFOREST / 256 + TREE_RAINFOREST);

    60

			}

    61

    62

		default:

    63

			return (TreeType)(seed * TREE_COUNT_TOYLAND / 256 + TREE_TOYLAND);

    64

	}

    65

}

    66

    67

/**

    68

 * Make a random tree tile of the given tile

    69

 *

    70

 * Create a new tree-tile for the given tile. The second parameter is used for

    71

 * randomness like type and number of trees.

    72

 *

    73

 * @param tile The tile to make a tree-tile from

    74

 * @param r The randomness value from a Random() value

    75

 */

    76

static void PlaceTree(TileIndex tile, uint32 r)

    77

{

    78

	TreeType tree = GetRandomTreeType(tile, GB(r, 24, 8));

    79

    80

	if (tree != TREE_INVALID) {

    81

		MakeTree(tile, tree, GB(r, 22, 2), min(GB(r, 16, 3), 6), TREE_GROUND_GRASS, 0);

    82

    83

		/* above snowline? */

    84

		if (_opt.landscape == LT_ARCTIC && GetTileZ(tile) > GetSnowLine()) {

    85

			SetTreeGroundDensity(tile, TREE_GROUND_SNOW_DESERT, 3);

    86

			SetTreeCounter(tile, (TreeGround)GB(r, 24, 3));

    87

		} else {

    88

			SetTreeGroundDensity(tile, (TreeGround)GB(r, 28, 1), 3);

    89

			SetTreeCounter(tile, (TreeGround)GB(r, 24, 4));

    90

		}

    91

	}

    92

}

    93

    94

/**

    95

 * Place some amount of trees around a given tile.

    96

 *

    97

 * This function adds some trees around a given tile. As this function use

    98

 * the Random() call it depends on the random how many trees are actually placed

    99

 * around the given tile.

   100

 *

   101

 * @param tile The center of the trees to add

   102

 */

   103

static void DoPlaceMoreTrees(TileIndex tile)

   104

{

   105

	uint i;

   106

   107

	for (i = 0; i < 1000; i++) {

   108

		uint32 r = Random();

   109

		int x = GB(r, 0, 5) - 16;

   110

		int y = GB(r, 8, 5) - 16;

   111

		uint dist = myabs(x) + myabs(y);

   112

		TileIndex cur_tile = TILE_MASK(tile + TileDiffXY(x, y));

   113

   114

		if (dist <= 13 &&

   115

				IsTileType(cur_tile, MP_CLEAR) &&

   116

				!IsBridgeAbove(cur_tile) &&

   117

				!IsClearGround(cur_tile, CLEAR_FIELDS) &&

   118

				!IsClearGround(cur_tile, CLEAR_ROCKS)) {

   119

			PlaceTree(cur_tile, r);

   120

		}

   121

	}

   122

}

   123

   124

/**

   125

 * Place more trees on the map.

   126

 *

   127

 * This function add more trees to the map.

   128

 */

   129

static void PlaceMoreTrees()

   130

{

   131

	uint i = ScaleByMapSize(GB(Random(), 0, 5) + 25);

   132

	do {

   133

		DoPlaceMoreTrees(RandomTile());

   134

	} while (--i);

   135

}

   136

   137

/**

   138

 * Place a tree at the same height as an existing tree.

   139

 *

   140

 * Add a new tree around the given tile which is at the same

   141

 * height or at some offset (2 units) of it.

   142

 *

   143

 * @param tile The base tile to add a new tree somewhere around

   144

 * @param height The height (like the one from the tile)

   145

 */

   146

void PlaceTreeAtSameHeight(TileIndex tile, uint height)

   147

{

   148

	uint i;

   149

   150

	for (i = 0; i < 1000; i++) {

   151

		uint32 r = Random();

   152

		int x = GB(r, 0, 5) - 16;

   153

		int y = GB(r, 8, 5) - 16;

   154

		TileIndex cur_tile = TILE_MASK(tile + TileDiffXY(x, y));

   155

   156

		/* Keep in range of the existing tree */

   157

		if (myabs(x) + myabs(y) > 16) continue;

   158

   159

		/* Clear tile, no farm-tiles or rocks */

   160

		if (!IsTileType(cur_tile, MP_CLEAR) ||

   161

				IsClearGround(cur_tile, CLEAR_FIELDS) ||

   162

				IsClearGround(cur_tile, CLEAR_ROCKS))

   163

			continue;

   164

   165

		/* Not too much height difference */

   166

		if (delta(GetTileZ(cur_tile), height) > 2) continue;

   167

   168

		/* Place one tree and quit */

   169

		PlaceTree(cur_tile, r);

   170

		break;

   171

	}

   172

}

   173

   174

/**

   175

 * Place some trees randomly

   176

 *

   177

 * This function just place some trees randomly on the map.

   178

 */

   179

void PlaceTreesRandomly()

   180

{

   181

	uint i, j, ht;

   182

   183

	i = ScaleByMapSize(1000);

   184

	do {

   185

		uint32 r = Random();

   186

		TileIndex tile = RandomTileSeed(r);

   187

   188

		IncreaseGeneratingWorldProgress(GWP_TREE);

   189

   190

		if (IsTileType(tile, MP_CLEAR) &&

   191

				!IsBridgeAbove(tile) &&

   192

				!IsClearGround(tile, CLEAR_FIELDS) &&

   193

				!IsClearGround(tile, CLEAR_ROCKS)) {

   194

			PlaceTree(tile, r);

   195

			if (_patches.tree_placer != TP_IMPROVED) continue;

   196

   197

			/* Place a number of trees based on the tile height.

   198

			 *  This gives a cool effect of multiple trees close together.

   199

			 *  It is almost real life ;) */

   200

			ht = GetTileZ(tile);

   201

			/* The higher we get, the more trees we plant */

   202

			j = GetTileZ(tile) / TILE_HEIGHT * 2;

   203

			while (j--) {

   204

				/* Above snowline more trees! */

   205

				if (_opt.landscape == LT_ARCTIC && ht > GetSnowLine()) {

   206

					PlaceTreeAtSameHeight(tile, ht);

   207

					PlaceTreeAtSameHeight(tile, ht);

   208

				};

   209

   210

				PlaceTreeAtSameHeight(tile, ht);

   211

			}

   212

		}

   213

	} while (--i);

   214

   215

	/* place extra trees at rainforest area */

   216

	if (_opt.landscape == LT_TROPIC) {

   217

		i = ScaleByMapSize(15000);

   218

   219

		do {

   220

			uint32 r = Random();

   221

			TileIndex tile = RandomTileSeed(r);

   222

   223

			IncreaseGeneratingWorldProgress(GWP_TREE);

   224

   225

			if (IsTileType(tile, MP_CLEAR) &&

   226

					!IsBridgeAbove(tile) &&

   227

					!IsClearGround(tile, CLEAR_FIELDS) &&

   228

					GetTropicZone(tile) == TROPICZONE_RAINFOREST) {

   229

				PlaceTree(tile, r);

   230

			}

   231

		} while (--i);

   232

	}

   233

}

   234

   235

/**

   236

 * Place new trees.

   237

 *

   238

 * This function takes care of the selected tree placer algorithm and

   239

 * place randomly the trees for a new game.

   240

 */

   241

void GenerateTrees()

   242

{

   243

	uint i, total;

   244

   245

	if (_patches.tree_placer == TP_NONE) return;

   246

   247

	if (_opt.landscape != LT_TOYLAND) PlaceMoreTrees();

   248

   249

	switch (_patches.tree_placer) {

   250

		case TP_ORIGINAL: i = _opt.landscape == LT_ARCTIC ? 15 : 6; break;

   251

		case TP_IMPROVED: i = _opt.landscape == LT_ARCTIC ?  4 : 2; break;

   252

		default: NOT_REACHED(); return;

   253

	}

   254

   255

	total = ScaleByMapSize(1000);

   256

	if (_opt.landscape == LT_TROPIC) total += ScaleByMapSize(15000);

   257

	total *= i;

   258

	SetGeneratingWorldProgress(GWP_TREE, total);

   259

   260

	for (; i != 0; i--) {

   261

		PlaceTreesRandomly();

   262

	}

   263

}

   264

   265

/** Plant a tree.

   266

 * @param tile start tile of area-drag of tree plantation

   267

 * @param flags type of operation

   268

 * @param p1 tree type, -1 means random.

   269

 * @param p2 end tile of area-drag

   270

 */

   271

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

   272

{

   273

	StringID msg = INVALID_STRING_ID;

   274

	CommandCost cost;

   275

	int ex;

   276

	int ey;

   277

	int sx, sy, x, y;

   278

   279

	if (p2 >= MapSize()) return CMD_ERROR;

   280

	/* Check the tree type. It can be random or some valid value within the current climate */

   281

	if (p1 != (uint)-1 && p1 - _tree_base_by_landscape[_opt.landscape] >= _tree_count_by_landscape[_opt.landscape]) return CMD_ERROR;

   282

   283

	SET_EXPENSES_TYPE(EXPENSES_OTHER);

   284

   285

	// make sure sx,sy are smaller than ex,ey

   286

	ex = TileX(tile);

   287

	ey = TileY(tile);

   288

	sx = TileX(p2);

   289

	sy = TileY(p2);

   290

	if (ex < sx) Swap(ex, sx);

   291

	if (ey < sy) Swap(ey, sy);

   292

   293

	for (x = sx; x <= ex; x++) {

   294

		for (y = sy; y <= ey; y++) {

   295

			TileIndex tile = TileXY(x, y);

   296

   297

			switch (GetTileType(tile)) {

   298

				case MP_TREES:

   299

					/* no more space for trees? */

   300

					if (_game_mode != GM_EDITOR && GetTreeCount(tile) == 3) {

   301

						msg = STR_2803_TREE_ALREADY_HERE;

   302

						continue;

   303

					}

   304

   305

					if (flags & DC_EXEC) {

   306

						AddTreeCount(tile, 1);

   307

						MarkTileDirtyByTile(tile);

   308

					}

   309

					/* 2x as expensive to add more trees to an existing tile */

   310

					cost.AddCost(_price.build_trees * 2);

   311

					break;

   312

   313

				case MP_WATER:

   314

					msg = STR_3807_CAN_T_BUILD_ON_WATER;

   315

					continue;

   316

					break;

   317

   318

				case MP_CLEAR:

   319

					if (!IsTileOwner(tile, OWNER_NONE) ||

   320

							IsBridgeAbove(tile)) {

   321

						msg = STR_2804_SITE_UNSUITABLE;

   322

						continue;

   323

					}

   324

   325

					switch (GetClearGround(tile)) {

   326

						case CLEAR_FIELDS: cost.AddCost(_price.clear_3); break;

   327

						case CLEAR_ROCKS:  cost.AddCost(_price.clear_2); break;

   328

						default: break;

   329

					}

   330

   331

					if (flags & DC_EXEC) {

   332

						TreeType treetype;

   333

						uint growth;

   334

   335

						if (_game_mode != GM_EDITOR && IsValidPlayer(_current_player)) {

   336

							Town *t = ClosestTownFromTile(tile, _patches.dist_local_authority);

   337

							if (t != NULL)

   338

								ChangeTownRating(t, RATING_TREE_UP_STEP, RATING_TREE_MAXIMUM);

   339

						}

   340

   341

						treetype = (TreeType)p1;

   342

						if (treetype == TREE_INVALID) {

   343

							treetype = GetRandomTreeType(tile, GB(Random(), 24, 8));

   344

							if (treetype == TREE_INVALID) treetype = TREE_CACTUS;

   345

						}

   346

   347

						growth = _game_mode == GM_EDITOR ? 3 : 0;

   348

						switch (GetClearGround(tile)) {

   349

							case CLEAR_ROUGH:  MakeTree(tile, treetype, 0, growth, TREE_GROUND_ROUGH, 3); break;

   350

							case CLEAR_SNOW:

   351

							case CLEAR_DESERT: MakeTree(tile, treetype, 0, growth, TREE_GROUND_SNOW_DESERT, GetClearDensity(tile)); break;

   352

							default:           MakeTree(tile, treetype, 0, growth, TREE_GROUND_GRASS, GetClearDensity(tile)); break;

   353

						}

   354

						MarkTileDirtyByTile(tile);

   355

   356

						if (_game_mode == GM_EDITOR && IS_INT_INSIDE(treetype, TREE_RAINFOREST, TREE_CACTUS))

   357

							SetTropicZone(tile, TROPICZONE_RAINFOREST);

   358

					}

   359

					cost.AddCost(_price.build_trees);

   360

					break;

   361

   362

				default:

   363

					msg = STR_2804_SITE_UNSUITABLE;

   364

					break;

   365

			}

   366

		}

   367

	}

   368

   369

	if (cost.GetCost() == 0) {

   370

		return_cmd_error(msg);

   371

	} else {

   372

		return cost;

   373

	}

   374

}

   375

   376

struct TreeListEnt {

   377

	SpriteID image;

   378

	SpriteID pal;

   379

	byte x, y;

   380

};

   381

   382

static void DrawTile_Trees(TileInfo *ti)

   383

{

   384

	const PalSpriteID *s;

   385

	const TreePos* d;

   386

	byte z;

   387

   388

	switch (GetTreeGround(ti->tile)) {

   389

		case TREE_GROUND_GRASS: DrawClearLandTile(ti, GetTreeDensity(ti->tile)); break;

   390

		case TREE_GROUND_ROUGH: DrawHillyLandTile(ti); break;

   391

		default: DrawGroundSprite(_tree_sprites_1[GetTreeDensity(ti->tile)] + _tileh_to_sprite[ti->tileh], PAL_NONE); break;

   392

	}

   393

   394

	DrawClearLandFence(ti);

   395

   396

	z = ti->z;

   397

	if (ti->tileh != SLOPE_FLAT) {

   398

		z += 4;

   399

		if (IsSteepSlope(ti->tileh)) z += 4;

   400

	}

   401

   402

	{

   403

		uint16 tmp = ti->x;

   404

		uint index;

   405

   406

		tmp = ROR(tmp, 2);

   407

		tmp -= ti->y;

   408

		tmp = ROR(tmp, 3);

   409

		tmp -= ti->x;

   410

		tmp = ROR(tmp, 1);

   411

		tmp += ti->y;

   412

   413

		d = _tree_layout_xy[GB(tmp, 4, 2)];

   414

   415

		index = GB(tmp, 6, 2) + (GetTreeType(ti->tile) << 2);

   416

   417

		/* different tree styles above one of the grounds */

   418

		if (GetTreeGround(ti->tile) == TREE_GROUND_SNOW_DESERT &&

   419

				GetTreeDensity(ti->tile) >= 2 &&

   420

				IS_INT_INSIDE(index, TREE_SUB_ARCTIC << 2, TREE_RAINFOREST << 2)) {

   421

			index += 164 - (TREE_SUB_ARCTIC << 2);

   422

		}

   423

   424

		assert(index < lengthof(_tree_layout_sprite));

   425

		s = _tree_layout_sprite[index];

   426

	}

   427

   428

	StartSpriteCombine();

   429

   430

	if (!HASBIT(_transparent_opt, TO_TREES) || !_patches.invisible_trees) {

   431

		TreeListEnt te[4];

   432

		uint i;

   433

   434

		/* put the trees to draw in a list */

   435

		i = GetTreeCount(ti->tile) + 1;

   436

		do {

   437

			SpriteID image = s[0].sprite + (--i == 0 ? GetTreeGrowth(ti->tile) : 3);

   438

			SpriteID pal = s[0].pal;

   439

   440

			te[i].image = image;

   441

			te[i].pal   = pal;

   442

			te[i].x = d->x;

   443

			te[i].y = d->y;

   444

			s++;

   445

			d++;

   446

		} while (i);

   447

   448

		/* draw them in a sorted way */

   449

		for (;;) {

   450

			byte min = 0xFF;

   451

			TreeListEnt *tep = NULL;

   452

   453

			i = GetTreeCount(ti->tile) + 1;

   454

			do {

   455

				if (te[--i].image != 0 && te[i].x + te[i].y < min) {

   456

					min = te[i].x + te[i].y;

   457

					tep = &te[i];

   458

				}

   459

			} while (i);

   460

   461

			if (tep == NULL) break;

   462

   463

			AddSortableSpriteToDraw(tep->image, tep->pal, ti->x + tep->x, ti->y + tep->y, 16 - tep->x, 16 - tep->y, 0x30, z, HASBIT(_transparent_opt, TO_TREES), -tep->x, -tep->y);

   464

			tep->image = 0;

   465

		}

   466

	}

   467

   468

	EndSpriteCombine();

   469

}

   470

   471

   472

static uint GetSlopeZ_Trees(TileIndex tile, uint x, uint y)

   473

{

   474

	uint z;

   475

	Slope tileh = GetTileSlope(tile, &z);

   476

   477

	return z + GetPartialZ(x & 0xF, y & 0xF, tileh);

   478

}

   479

   480

static Foundation GetFoundation_Trees(TileIndex tile, Slope tileh)

   481

{

   482

	return FOUNDATION_NONE;

   483

}

   484

   485

static CommandCost ClearTile_Trees(TileIndex tile, byte flags)

   486

{

   487