tree_gui.cpp File Reference

GUIs for building trees. More...

#include "stdafx.h"
#include "window_gui.h"
#include "gfx_func.h"
#include "tilehighlight_func.h"
#include "company_func.h"
#include "company_base.h"
#include "command_func.h"
#include "core/random_func.hpp"
#include "sound_func.h"
#include "strings_func.h"
#include "zoom_func.h"
#include "tree_map.h"
#include "tree_cmd.h"
#include "widgets/tree_widget.h"
#include "table/sprites.h"
#include "table/strings.h"
#include "table/tree_land.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures
class	BuildTreesWindow
	The build trees window. More...

Functions
void	PlaceTreesRandomly ()
	Place some trees randomly.
uint	PlaceTreeGroupAroundTile (TileIndex tile, TreeType treetype, uint radius, uint count, bool set_zone)
	Place some trees in a radius around a tile.
static Dimension	GetMaxTreeSpriteSize ()
	Calculate the maximum size of all tree sprites.
static std::unique_ptr< NWidgetBase >	MakeTreeTypeButtons ()
	Make widgets for the current available tree types.
void	ShowBuildTreesToolbar ()

Variables
const PalSpriteID	tree_sprites []
	Tree Sprites with their palettes.
static constexpr std::initializer_list< NWidgetPart >	_nested_build_trees_widgets
static WindowDesc	_build_trees_desc (WDP_AUTO, "build_tree", 0, 0, WC_BUILD_TREES, WC_NONE, WindowDefaultFlag::Construction, _nested_build_trees_widgets)

Detailed Description

GUIs for building trees.

Definition in file tree_gui.cpp.

Function Documentation

GetMaxTreeSpriteSize()

static Dimension GetMaxTreeSpriteSize ( )

static

Calculate the maximum size of all tree sprites.

Returns

Dimension of the largest tree sprite

Definition at line 53 of file tree_gui.cpp.

References _settings_game, GameSettings::game_creation, GetSpriteSize(), GameCreationSettings::landscape, lengthof, ScaleGUITrad(), to_underlying(), tree_sprites, Coord2D< T >::x, and Coord2D< T >::y.

Referenced by BuildTreesWindow::UpdateWidgetSize().

MakeTreeTypeButtons()

static std::unique_ptr< NWidgetBase > MakeTreeTypeButtons ( )

static

Make widgets for the current available tree types.

This does not use a NWID_MATRIX or WWT_MATRIX control as those are more difficult to get producing the correct result than dynamically building the widgets is.

See also

NWidgetFunctionType

Definition at line 259 of file tree_gui.cpp.

References _settings_game, CeilDiv(), EqualSize, GameSettings::game_creation, GameCreationSettings::landscape, to_underlying(), WID_BT_TYPE_BUTTON_FIRST, and WWT_PANEL.

PlaceTreeGroupAroundTile()

uint PlaceTreeGroupAroundTile	(	TileIndex	tile,
		TreeType	treetype,
		uint	radius,
		uint	count,
		bool	set_zone
	)

Place some trees in a radius around a tile.

The trees are placed in an quasi-normal distribution around the indicated tile, meaning that while the radius does define a square, the distribution inside the square will be roughly circular.

Note

This function the interactive RNG and must only be used in editor and map generation.

Parameters

tile	Tile to place trees around.
treetype	Type of trees to place. Must be a valid tree type for the climate.
radius	Maximum distance (on each axis) from tile to place trees.
count	Maximum number of trees to place.
set_zone	Whether to create a rainforest zone when placing rainforest trees.

Returns

Number of trees actually placed.

Definition at line 429 of file tree_cmd.cpp.

References AddTreeCount(), CanPlantTreesOnTile(), DistanceSquare(), OrthogonalTileArea::Expand(), GetTileType(), GetTreeCount(), Growing1, Grown, INVALID_TILE, IsInsideMM(), IsTileType(), MarkTileDirtyByTile(), MP_TREES, MP_VOID, PlantTreesOnTile(), SetTreeGrowth(), SetTropicZone(), TileAddWrap(), TREE_CACTUS, TREE_COUNT_TOYLAND, TREE_RAINFOREST, TREE_TOYLAND, and TROPICZONE_RAINFOREST.

PlaceTreesRandomly()

void PlaceTreesRandomly

(

)

Place some trees randomly.

This function just place some trees randomly on the map.

Definition at line 366 of file tree_cmd.cpp.

References _settings_game, CanPlantTreesOnTile(), GameSettings::construction, DEFAULT_RAINFOREST_TREE_STEPS, DEFAULT_TREE_STEPS, EDITOR_TREE_DIV, GameSettings::game_creation, GetSnowLine(), GetTileZ(), GetTropicZone(), GWP_TREE, IncreaseGeneratingWorldProgress(), GameCreationSettings::landscape, ConstructionSettings::map_height_limit, MAP_HEIGHT_LIMIT_ORIGINAL, PlaceTree(), PlaceTreeAtSameHeight(), Random, RandomTileSeed(), Map::ScaleBySize(), TP_IMPROVED, GameCreationSettings::tree_placer, and TROPICZONE_RAINFOREST.

Referenced by GenerateTrees(), and BuildTreesWindow::OnClick().

ShowBuildTreesToolbar()

void ShowBuildTreesToolbar

(

)

Definition at line 320 of file tree_gui.cpp.

Variable Documentation

_nested_build_trees_widgets

constexpr std::initializer_list<NWidgetPart> _nested_build_trees_widgets

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_PLANT_TREE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_SHADEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_DARK_GREEN),
    NWidget(NWID_VERTICAL), SetPIP(0, 1, 0), SetPadding(2),
      NWidgetFunction(MakeTreeTypeButtons),
      NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BT_TYPE_RANDOM), SetStringTip(STR_TREES_RANDOM_TYPE, STR_TREES_RANDOM_TYPE_TOOLTIP),
      NWidget(NWID_SELECTION, INVALID_COLOUR, WID_BT_SE_PANE),
        NWidget(NWID_VERTICAL), SetPIP(0, 1, 0),
          NWidget(NWID_HORIZONTAL, NWidContainerFlag::EqualSize),
            NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BT_MODE_NORMAL), SetFill(1, 0), SetStringTip(STR_TREES_MODE_NORMAL_BUTTON, STR_TREES_MODE_NORMAL_TOOLTIP),
            NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BT_MODE_FOREST_SM), SetFill(1, 0), SetStringTip(STR_TREES_MODE_FOREST_SM_BUTTON, STR_TREES_MODE_FOREST_SM_TOOLTIP),
            NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BT_MODE_FOREST_LG), SetFill(1, 0), SetStringTip(STR_TREES_MODE_FOREST_LG_BUTTON, STR_TREES_MODE_FOREST_LG_TOOLTIP),
          EndContainer(),
          NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_BT_MANY_RANDOM), SetStringTip(STR_TREES_RANDOM_TREES_BUTTON, STR_TREES_RANDOM_TREES_TOOLTIP),
        EndContainer(),
      EndContainer(),
    EndContainer(),
  EndContainer(),
}

Definition at line 288 of file tree_gui.cpp.

tree_sprites

const PalSpriteID tree_sprites[]

Initial value:

= {
  { 1621, PAL_NONE }, { 1635, PAL_NONE }, { 1656, PAL_NONE }, { 1579, PAL_NONE },
  { 1607, PAL_NONE }, { 1593, PAL_NONE }, { 1614, PAL_NONE }, { 1586, PAL_NONE },
  { 1663, PAL_NONE }, { 1677, PAL_NONE }, { 1691, PAL_NONE }, { 1705, PAL_NONE },
  { 1711, PAL_NONE }, { 1746, PAL_NONE }, { 1753, PAL_NONE }, { 1732, PAL_NONE },
  { 1739, PAL_NONE }, { 1718, PAL_NONE }, { 1725, PAL_NONE }, { 1760, PAL_NONE },
  { 1838, PAL_NONE }, { 1844, PAL_NONE }, { 1866, PAL_NONE }, { 1871, PAL_NONE },
  { 1899, PAL_NONE }, { 1935, PAL_NONE }, { 1928, PAL_NONE }, { 1915, PAL_NONE },
  { 1887, PAL_NONE }, { 1908, PAL_NONE }, { 1824, PAL_NONE }, { 1943, PAL_NONE },
  { 1950, PAL_NONE }, { 1957, PALETTE_TO_GREEN }, { 1964, PALETTE_TO_RED },        { 1971, PAL_NONE },
  { 1978, PAL_NONE }, { 1985, PALETTE_TO_RED, },  { 1992, PALETTE_TO_PALE_GREEN }, { 1999, PALETTE_TO_YELLOW }, { 2006, PALETTE_TO_RED }
}

Tree Sprites with their palettes.

Definition at line 36 of file tree_gui.cpp.

Referenced by BuildTreesWindow::DrawWidget(), and GetMaxTreeSpriteSize().