dock_gui.cpp File Reference

GUI to create amazing water objects. More...

#include "stdafx.h"
#include "terraform_gui.h"
#include "window_gui.h"
#include "station_gui.h"
#include "command_func.h"
#include "water.h"
#include "window_func.h"
#include "vehicle_func.h"
#include "sound_func.h"
#include "viewport_func.h"
#include "gfx_func.h"
#include "company_func.h"
#include "slope_func.h"
#include "tilehighlight_func.h"
#include "company_base.h"
#include "hotkeys.h"
#include "gui.h"
#include "zoom_func.h"
#include "tunnelbridge_cmd.h"
#include "dock_cmd.h"
#include "station_cmd.h"
#include "water_cmd.h"
#include "waypoint_cmd.h"
#include "timer/timer.h"
#include "timer/timer_game_calendar.h"
#include "widgets/dock_widget.h"
#include "table/sprites.h"
#include "table/strings.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures
struct	BuildDocksToolbarWindow
	Toolbar window for constructing water infrastructure. More...
struct	BuildDocksStationWindow
struct	BuildDocksDepotWindow

Enumerations
enum	BuildDockStationWidgets {   BDSW_BACKGROUND , BDSW_LT_OFF , BDSW_LT_ON , BDSW_INFO ,   BDSW_ACCEPTANCE }
	Widget numbers of the build-dock GUI. More...

Functions
static void	ShowBuildDockStationPicker (Window *parent)
static void	ShowBuildDocksDepotPicker (Window *parent)
void	CcBuildDocks (Commands, const CommandCost &result, TileIndex tile)
void	CcPlaySound_CONSTRUCTION_WATER (Commands, const CommandCost &result, TileIndex tile)
static TileIndex	GetOtherAqueductEnd (TileIndex tile_from, TileIndex *tile_to=nullptr)
	Gets the other end of the aqueduct, if possible.
Window *	ShowBuildDocksToolbar ()
	Open the build water toolbar window.
Window *	ShowBuildDocksScenToolbar ()
	Open the build water toolbar window for the scenario editor.
void	InitializeDockGui ()

Variables
static Axis	_ship_depot_direction
static constexpr NWidgetPart	_nested_build_docks_toolbar_widgets []
	Nested widget parts of docks toolbar, game version.
static WindowDesc	_build_docks_toolbar_desc (WDP_ALIGN_TOOLBAR, "toolbar_water", 0, 0, WC_BUILD_TOOLBAR, WC_NONE, WindowDefaultFlag::Construction, _nested_build_docks_toolbar_widgets, &BuildDocksToolbarWindow::hotkeys)
static constexpr NWidgetPart	_nested_build_docks_scen_toolbar_widgets []
	Nested widget parts of docks toolbar, scenario editor version.
static WindowDesc	_build_docks_scen_toolbar_desc (WDP_AUTO, "toolbar_water_scen", 0, 0, WC_SCEN_BUILD_TOOLBAR, WC_NONE, WindowDefaultFlag::Construction, _nested_build_docks_scen_toolbar_widgets)
	Window definition for the build docks in scenario editor window.
static constexpr NWidgetPart	_nested_build_dock_station_widgets []
	Nested widget parts of a build dock station window.
static WindowDesc	_build_dock_station_desc (WDP_AUTO, nullptr, 0, 0, WC_BUILD_STATION, WC_BUILD_TOOLBAR, WindowDefaultFlag::Construction, _nested_build_dock_station_widgets)
static constexpr NWidgetPart	_nested_build_docks_depot_widgets []
static WindowDesc	_build_docks_depot_desc (WDP_AUTO, nullptr, 0, 0, WC_BUILD_DEPOT, WC_BUILD_TOOLBAR, WindowDefaultFlag::Construction, _nested_build_docks_depot_widgets)

Detailed Description

GUI to create amazing water objects.

Definition in file dock_gui.cpp.

Enumeration Type Documentation

BuildDockStationWidgets

enum BuildDockStationWidgets

Widget numbers of the build-dock GUI.

Enumerator
BDSW_BACKGROUND	Background panel.
BDSW_LT_OFF	'Off' button of coverage high light.
BDSW_LT_ON	'On' button of coverage high light.
BDSW_INFO	'Coverage highlight' label.
BDSW_ACCEPTANCE	Acceptance info.

Definition at line 416 of file dock_gui.cpp.

Function Documentation

CcBuildDocks()

void CcBuildDocks	(	Commands	,
		const CommandCost &	result,
		TileIndex	tile
	)

Definition at line 48 of file dock_gui.cpp.

CcPlaySound_CONSTRUCTION_WATER()

void CcPlaySound_CONSTRUCTION_WATER	(	Commands	,
		const CommandCost &	result,
		TileIndex	tile
	)

Definition at line 56 of file dock_gui.cpp.

GetOtherAqueductEnd()

static TileIndex GetOtherAqueductEnd ( TileIndex  tile_from, TileIndex *  tile_to = nullptr  )

static

Gets the other end of the aqueduct, if possible.

Parameters

	tile_from	The begin tile for the aqueduct.
[out]	tile_to	The tile till where to show a selection for the aqueduct.

Returns

The other end of the aqueduct, or otherwise a tile in line with the aqueduct to cause the right error message.

Definition at line 68 of file dock_gui.cpp.

References _settings_game, GameSettings::construction, DistanceFromEdgeDir(), GetInclinedSlopeDirection(), GetTileMaxZ(), GetTileSlopeZ(), IsValidDiagDirection(), IsValidTile(), ConstructionSettings::max_bridge_length, ReverseDiagDir(), TileAdd(), TileAddXY(), TileOffsByDiagDir(), TileX(), and TileY().

Referenced by BuildDocksToolbarWindow::OnPlaceObject(), and BuildDocksToolbarWindow::OnPlacePresize().

InitializeDockGui()

void InitializeDockGui

(

)

Definition at line 618 of file dock_gui.cpp.

ShowBuildDocksDepotPicker()

static void ShowBuildDocksDepotPicker ( Window *  parent )

static

Definition at line 612 of file dock_gui.cpp.

ShowBuildDocksScenToolbar()

Window * ShowBuildDocksScenToolbar

(

)

Open the build water toolbar window for the scenario editor.

Returns

newly opened water toolbar, or nullptr if the toolbar could not be opened.

Definition at line 410 of file dock_gui.cpp.

References _build_docks_scen_toolbar_desc, and TRANSPORT_WATER.

ShowBuildDockStationPicker()

static void ShowBuildDockStationPicker ( Window *  parent )

static

Definition at line 516 of file dock_gui.cpp.

ShowBuildDocksToolbar()

Window * ShowBuildDocksToolbar

(

)

Open the build water toolbar window.

If the terraform toolbar is linked to the toolbar, that window is also opened.

Returns

newly opened water toolbar, or nullptr if the toolbar could not be opened.

Definition at line 369 of file dock_gui.cpp.

References _local_company, CloseWindowByClass(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::IsValidID(), TRANSPORT_WATER, and WC_BUILD_TOOLBAR.

Referenced by BuildDocksToolbarWindow::DockToolbarGlobalHotkeys(), MenuClickBuildWater(), and MainToolbarWindow::OnHotkey().

Variable Documentation

_nested_build_dock_station_widgets

constexpr NWidgetPart _nested_build_dock_station_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_STATION_BUILD_DOCK_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_DARK_GREEN, BDSW_BACKGROUND),
    NWidget(NWID_VERTICAL), SetPIP(0, WidgetDimensions::unscaled.vsep_normal, 0), SetPadding(WidgetDimensions::unscaled.picker),
      NWidget(NWID_VERTICAL), SetPIP(0, WidgetDimensions::unscaled.vsep_picker, 0),
        NWidget(WWT_LABEL, INVALID_COLOUR, BDSW_INFO), SetStringTip(STR_STATION_BUILD_COVERAGE_AREA_TITLE), SetFill(1, 0),
        NWidget(NWID_HORIZONTAL, NWidContainerFlag::EqualSize), SetPIP(14, 0, 14),
          NWidget(WWT_TEXTBTN, COLOUR_GREY, BDSW_LT_OFF), SetMinimalSize(60, 12), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_COVERAGE_OFF, STR_STATION_BUILD_COVERAGE_AREA_OFF_TOOLTIP),
          NWidget(WWT_TEXTBTN, COLOUR_GREY, BDSW_LT_ON), SetMinimalSize(60, 12), SetFill(1, 0), SetStringTip(STR_STATION_BUILD_COVERAGE_ON, STR_STATION_BUILD_COVERAGE_AREA_ON_TOOLTIP),
        EndContainer(),
      EndContainer(),
      NWidget(WWT_EMPTY, INVALID_COLOUR, BDSW_ACCEPTANCE), SetResize(0, 1), SetMinimalTextLines(2, WidgetDimensions::unscaled.vsep_normal),
    EndContainer(),
  EndContainer(),
}

Nested widget parts of a build dock station window.

Definition at line 490 of file dock_gui.cpp.

_nested_build_docks_depot_widgets

constexpr NWidgetPart _nested_build_docks_depot_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_DEPOT_BUILD_SHIP_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_DARK_GREEN, WID_BDD_BACKGROUND),
    NWidget(NWID_HORIZONTAL_LTR), SetPIP(0, WidgetDimensions::unscaled.hsep_normal, 0), SetPIPRatio(1, 0, 1), SetPadding(WidgetDimensions::unscaled.picker),
      NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BDD_X), SetToolTip(STR_DEPOT_BUILD_SHIP_ORIENTATION_TOOLTIP),
      NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_BDD_Y), SetToolTip(STR_DEPOT_BUILD_SHIP_ORIENTATION_TOOLTIP),
    EndContainer(),
  EndContainer(),
}

Definition at line 591 of file dock_gui.cpp.

_nested_build_docks_scen_toolbar_widgets

constexpr NWidgetPart _nested_build_docks_scen_toolbar_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_WATERWAYS_TOOLBAR_CAPTION_SE, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_CANAL), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_BUILD_CANAL, STR_WATERWAYS_TOOLBAR_CREATE_LAKE_TOOLTIP),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_LOCK), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_BUILD_LOCK, STR_WATERWAYS_TOOLBAR_BUILD_LOCKS_TOOLTIP),
    NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetMinimalSize(5, 22), SetFill(1, 1), EndContainer(),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_DEMOLISH), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_RIVER), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_BUILD_RIVER, STR_WATERWAYS_TOOLBAR_CREATE_RIVER_TOOLTIP),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_BUILD_AQUEDUCT), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_AQUEDUCT, STR_WATERWAYS_TOOLBAR_BUILD_AQUEDUCT_TOOLTIP),
  EndContainer(),
}

Nested widget parts of docks toolbar, scenario editor version.

Positions of WID_DT_DEPOT, WID_DT_STATION, and WID_DT_BUOY widgets have changed.

Definition at line 381 of file dock_gui.cpp.

_nested_build_docks_toolbar_widgets

constexpr NWidgetPart _nested_build_docks_toolbar_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
    NWidget(WWT_CAPTION, COLOUR_DARK_GREEN), SetStringTip(STR_WATERWAYS_TOOLBAR_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_STICKYBOX, COLOUR_DARK_GREEN),
  EndContainer(),
  NWidget(NWID_HORIZONTAL_LTR),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_CANAL), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_BUILD_CANAL, STR_WATERWAYS_TOOLBAR_BUILD_CANALS_TOOLTIP),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_LOCK), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_BUILD_LOCK, STR_WATERWAYS_TOOLBAR_BUILD_LOCKS_TOOLTIP),
    NWidget(WWT_PANEL, COLOUR_DARK_GREEN), SetMinimalSize(5, 22), SetFill(1, 1), EndContainer(),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_DEMOLISH), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_DYNAMITE, STR_TOOLTIP_DEMOLISH_BUILDINGS_ETC),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_DEPOT), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_SHIP_DEPOT, STR_WATERWAYS_TOOLBAR_BUILD_DEPOT_TOOLTIP),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_STATION), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_SHIP_DOCK, STR_WATERWAYS_TOOLBAR_BUILD_DOCK_TOOLTIP),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_BUOY), SetMinimalSize(22, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_BUOY, STR_WATERWAYS_TOOLBAR_BUOY_TOOLTIP),
    NWidget(WWT_IMGBTN, COLOUR_DARK_GREEN, WID_DT_BUILD_AQUEDUCT), SetMinimalSize(23, 22), SetFill(0, 1), SetSpriteTip(SPR_IMG_AQUEDUCT, STR_WATERWAYS_TOOLBAR_BUILD_AQUEDUCT_TOOLTIP),
  EndContainer(),
}

Nested widget parts of docks toolbar, game version.

Position of WID_DT_RIVER widget has changed.

Definition at line 336 of file dock_gui.cpp.

_ship_depot_direction

Axis _ship_depot_direction

static

Definition at line 46 of file dock_gui.cpp.