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

    13

#include "landscape.h"

    14

#include "tree_map.h"

    15

#include "viewport.h"

    16

#include "command_func.h"

    17

#include "economy_func.h"

    18

#include "town.h"

    19

#include "variables.h"

    20

#include "genworld.h"

    21

#include "transparency.h"

    22

#include "functions.h"

    23

#include "player.h"

    24

#include "sound_func.h"

    25

    26

/**

    27

 * List of tree placer algorithm.

    28

 *

    29

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

    30

 */

    31

enum TreePlacer {

    32

	TP_NONE,     ///< No tree placer algorithm

    33

	TP_ORIGINAL, ///< The original algorithm

    34

	TP_IMPROVED, ///< A 'improved' algorithm

    35

};

    36

    37

/**

    38

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

    39

 *

    40

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

    41

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

    42

 * to get such a value.

    43

 *

    44

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

    45

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

    46

 * @return The random tree type

    47

 */

    48

static TreeType GetRandomTreeType(TileIndex tile, uint seed)

    49

{

    50

	switch (_opt.landscape) {

    51

		case LT_TEMPERATE:

    52

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

    53

    54

		case LT_ARCTIC:

    55

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

    56

    57

		case LT_TROPIC:

    58

			switch (GetTropicZone(tile)) {

    59

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

    60

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

    61

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

    62

			}

    63

    64

		default:

    65

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

    66

	}

    67

}

    68

    69

/**

    70

 * Make a random tree tile of the given tile

    71

 *

    72

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

    73

 * randomness like type and number of trees.

    74

 *

    75

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

    76

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

    77

 */

    78

static void PlaceTree(TileIndex tile, uint32 r)

    79

{

    80

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

    81

    82

	if (tree != TREE_INVALID) {

    83

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

    84

    85

		/* above snowline? */

    86

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

    87

			SetTreeGroundDensity(tile, TREE_GROUND_SNOW_DESERT, 3);

    88

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

    89

		} else {

    90

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

    91

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

    92

		}

    93

	}

    94

}

    95

    96

/**

    97

 * Place some amount of trees around a given tile.

    98

 *

    99

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

   100

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

   101

 * around the given tile.

   102

 *

   103

 * @param tile The center of the trees to add

   104

 */

   105

static void DoPlaceMoreTrees(TileIndex tile)

   106

{

   107

	uint i;

   108

   109

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

   110

		uint32 r = Random();

   111

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

   112

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

   113

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

   114

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

   115

   116

		if (dist <= 13 &&

   117

				IsTileType(cur_tile, MP_CLEAR) &&

   118

				!IsBridgeAbove(cur_tile) &&

   119

				!IsClearGround(cur_tile, CLEAR_FIELDS) &&

   120

				!IsClearGround(cur_tile, CLEAR_ROCKS)) {

   121

			PlaceTree(cur_tile, r);

   122

		}

   123

	}

   124

}

   125

   126

/**

   127

 * Place more trees on the map.

   128

 *

   129

 * This function add more trees to the map.

   130

 */

   131

static void PlaceMoreTrees()

   132

{

   133

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

   134

	do {

   135

		DoPlaceMoreTrees(RandomTile());

   136

	} while (--i);

   137

}

   138

   139

/**

   140

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

   141

 *

   142

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

   143

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

   144

 *

   145

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

   146

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

   147

 */

   148

void PlaceTreeAtSameHeight(TileIndex tile, uint height)

   149

{

   150

	uint i;

   151

   152

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

   153

		uint32 r = Random();

   154

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

   155

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

   156

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

   157

   158

		/* Keep in range of the existing tree */

   159

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

   160

   161

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

   162

		if (!IsTileType(cur_tile, MP_CLEAR) ||

   163

				IsClearGround(cur_tile, CLEAR_FIELDS) ||

   164

				IsClearGround(cur_tile, CLEAR_ROCKS))

   165

			continue;

   166

   167

		/* Not too much height difference */

   168

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

   169

   170

		/* Place one tree and quit */

   171

		PlaceTree(cur_tile, r);

   172

		break;

   173

	}

   174

}

   175

   176

/**

   177

 * Place some trees randomly

   178

 *

   179

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

   180

 */

   181

void PlaceTreesRandomly()

   182

{

   183

	uint i, j, ht;

   184

   185

	i = ScaleByMapSize(1000);

   186

	do {

   187

		uint32 r = Random();

   188

		TileIndex tile = RandomTileSeed(r);

   189

   190

		IncreaseGeneratingWorldProgress(GWP_TREE);

   191

   192

		if (IsTileType(tile, MP_CLEAR) &&

   193

				!IsBridgeAbove(tile) &&

   194

				!IsClearGround(tile, CLEAR_FIELDS) &&

   195

				!IsClearGround(tile, CLEAR_ROCKS)) {

   196

			PlaceTree(tile, r);

   197

			if (_patches.tree_placer != TP_IMPROVED) continue;

   198

   199

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

   200

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

   201

			 *  It is almost real life ;) */

   202

			ht = GetTileZ(tile);

   203

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

   204

			j = GetTileZ(tile) / TILE_HEIGHT * 2;

   205

			while (j--) {

   206

				/* Above snowline more trees! */

   207

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

   208

					PlaceTreeAtSameHeight(tile, ht);

   209

					PlaceTreeAtSameHeight(tile, ht);

   210

				};

   211

   212

				PlaceTreeAtSameHeight(tile, ht);

   213

			}

   214

		}

   215

	} while (--i);

   216

   217

	/* place extra trees at rainforest area */

   218

	if (_opt.landscape == LT_TROPIC) {

   219

		i = ScaleByMapSize(15000);

   220

   221

		do {

   222

			uint32 r = Random();

   223

			TileIndex tile = RandomTileSeed(r);

   224

   225

			IncreaseGeneratingWorldProgress(GWP_TREE);

   226

   227

			if (IsTileType(tile, MP_CLEAR) &&

   228

					!IsBridgeAbove(tile) &&

   229

					!IsClearGround(tile, CLEAR_FIELDS) &&

   230

					GetTropicZone(tile) == TROPICZONE_RAINFOREST) {

   231

				PlaceTree(tile, r);

   232

			}

   233

		} while (--i);

   234

	}

   235

}

   236

   237

/**

   238

 * Place new trees.

   239

 *

   240

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

   241

 * place randomly the trees for a new game.

   242

 */

   243

void GenerateTrees()

   244

{

   245

	uint i, total;

   246

   247

	if (_patches.tree_placer == TP_NONE) return;

   248

   249

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

   250

   251

	switch (_patches.tree_placer) {

   252

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

   253

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

   254

		default: NOT_REACHED(); return;

   255

	}

   256

   257

	total = ScaleByMapSize(1000);

   258

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

   259

	total *= i;

   260

	SetGeneratingWorldProgress(GWP_TREE, total);

   261

   262

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

   263

		PlaceTreesRandomly();

   264

	}

   265

}

   266

   267

/** Plant a tree.

   268

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

   269

 * @param flags type of operation

   270

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

   271

 * @param p2 end tile of area-drag

   272

 */

   273

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

   274

{

   275

	StringID msg = INVALID_STRING_ID;

   276

	CommandCost cost;

   277

	int ex;

   278

	int ey;

   279

	int sx, sy, x, y;

   280

   281

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

   282

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

   283

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

   284

   285

	SET_EXPENSES_TYPE(EXPENSES_OTHER);

   286

   287

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

   288

	ex = TileX(tile);

   289

	ey = TileY(tile);

   290

	sx = TileX(p2);

   291

	sy = TileY(p2);

   292

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

   293

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

   294

   295

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

   296

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

   297

			TileIndex tile = TileXY(x, y);

   298

   299

			switch (GetTileType(tile)) {

   300

				case MP_TREES:

   301

					/* no more space for trees? */

   302

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

   303

						msg = STR_2803_TREE_ALREADY_HERE;

   304

						continue;

   305

					}

   306

   307

					if (flags & DC_EXEC) {

   308

						AddTreeCount(tile, 1);

   309

						MarkTileDirtyByTile(tile);

   310

					}

   311

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

   312

					cost.AddCost(_price.build_trees * 2);

   313

					break;

   314

   315

				case MP_WATER:

   316

					msg = STR_3807_CAN_T_BUILD_ON_WATER;

   317

					continue;

   318

					break;

   319

   320

				case MP_CLEAR:

   321

					if (!IsTileOwner(tile, OWNER_NONE) ||

   322

							IsBridgeAbove(tile)) {

   323

						msg = STR_2804_SITE_UNSUITABLE;

   324

						continue;

   325

					}

   326

   327

					switch (GetClearGround(tile)) {

   328

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

   329

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

   330

						default: break;

   331

					}

   332

   339

					if (flags & DC_EXEC) {

   340

						TreeType treetype;

   341

						uint growth;

   342

   343

						treetype = (TreeType)p1;

   344

						if (treetype == TREE_INVALID) {

   345

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

   346

							if (treetype == TREE_INVALID) treetype = TREE_CACTUS;

   347

						}

   348

   349

						growth = _game_mode == GM_EDITOR ? 3 : 0;

   350

						switch (GetClearGround(tile)) {

   351

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

   352

							case CLEAR_SNOW:

   353

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

   354

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

   355

						}

   356

						MarkTileDirtyByTile(tile);

   357

   358

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

   359

							SetTropicZone(tile, TROPICZONE_RAINFOREST);

   360

					}

   361

					cost.AddCost(_price.build_trees);

   362

					break;

   363

   364

				default:

   365

					msg = STR_2804_SITE_UNSUITABLE;

   366

					break;

   367

			}

   368

		}

   369

	}

   370

   371

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

   372

		return_cmd_error(msg);

   373

	} else {

   374

		return cost;

   375

	}

   376

}

   377

   378

struct TreeListEnt {

   379

	SpriteID image;

   380

	SpriteID pal;

   381

	byte x, y;

   382

};

   383

   384

static void DrawTile_Trees(TileInfo *ti)

   385

{

   386

	const PalSpriteID *s;

   387

	const TreePos* d;

   388

	byte z;

   389

   390

	switch (GetTreeGround(ti->tile)) {

   391

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

   392

		case TREE_GROUND_ROUGH: DrawHillyLandTile(ti); break;

   393

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

   394

	}

   395

   396

	DrawClearLandFence(ti);

   397

   398

	z = ti->z;

   399

	if (ti->tileh != SLOPE_FLAT) {

   400

		z += 4;

   401

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

   402

	}

   403

   404

	{

   405

		uint16 tmp = ti->x;

   406

		uint index;

   407

   408

		tmp = ROR(tmp, 2);

   409

		tmp -= ti->y;

   410

		tmp = ROR(tmp, 3);

   411

		tmp -= ti->x;

   412

		tmp = ROR(tmp, 1);

   413

		tmp += ti->y;

   414

   415

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

   416

   417

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

   418

   419

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

   420

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

   421

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

   422

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

   423

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

   424

		}

   425

   426

		assert(index < lengthof(_tree_layout_sprite));

   427

		s = _tree_layout_sprite[index];

   428

	}

   429

   430

	StartSpriteCombine();

   431

   432

	if (!(IsTransparencySet(TO_TREES) && _patches.invisible_trees)) {

   433

		TreeListEnt te[4];

   434

		uint i;

   435

   436

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

   437

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

   438

		do {

   439

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

   440

			SpriteID pal = s[0].pal;

   441

   442

			te[i].image = image;

   443

			te[i].pal   = pal;

   444

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

   445

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

   446

			s++;

   447

			d++;

   448

		} while (i);

   449

   450

		/* draw them in a sorted way */

   451

		for (;;) {

   452

			byte min = 0xFF;

   453

			TreeListEnt *tep = NULL;

   454

   455

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

   456

			do {

   457

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

   458

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

   459

					tep = &te[i];

   460

				}

   461

			} while (i);

   462

   463

			if (tep == NULL) break;

   464

   465

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

   466

			tep->image = 0;

   467

		}

   468

	}

   469

   470

	EndSpriteCombine();

   471

}

   472

   473

   474

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

   475

{

   476

	uint z;

   477

	Slope tileh = GetTileSlope(tile, &z);

   478

   479

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

   480

}

   481

   482

static Foundation GetFoundation_Trees(TileIndex tile, Slope tileh)

   483

{

   484

	return FOUNDATION_NONE;

   485

}

   486