OpenTTD

bridge_gui.cpp
Go to the documentation of this file.
1 /* $Id: bridge_gui.cpp 26960 2014-10-05 11:20:02Z peter1138 $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
9
12 #include "stdafx.h"
13 #include "error.h"
14 #include "command_func.h"
15 #include "rail.h"
16 #include "strings_func.h"
17 #include "window_func.h"
18 #include "sound_func.h"
19 #include "gfx_func.h"
20 #include "tunnelbridge.h"
21 #include "sortlist_type.h"
22 #include "widgets/dropdown_func.h"
23 #include "core/geometry_func.hpp"
24 #include "cmd_helper.h"
25 #include "tunnelbridge_map.h"
26 #include "road_gui.h"
27
28 #include "widgets/bridge_widget.h"
29
30 #include "table/strings.h"
31
32 #include "safeguards.h"
33
35 static BridgeType _last_railbridge_type = 0;
37 static BridgeType _last_roadbridge_type = 0;
38
42 struct BuildBridgeData {
43 BridgeType index;
44 const BridgeSpec *spec;
45 Money cost;
46 };
47
48 typedef GUIList<BuildBridgeData> GUIBridgeList;
49
61 void CcBuildBridge(const CommandCost &result, TileIndex end_tile, uint32 p1, uint32 p2)
62 {
63 if (result.Failed()) return;
64 if (_settings_client.sound.confirm) SndPlayTileFx(SND_27_BLACKSMITH_ANVIL, end_tile);
65
66 TransportType transport_type = Extract<TransportType, 15, 2>(p2);
67
68 if (transport_type == TRANSPORT_ROAD) {
69 DiagDirection end_direction = ReverseDiagDir(GetTunnelBridgeDirection(end_tile));
70 ConnectRoadToStructure(end_tile, end_direction);
71
72 DiagDirection start_direction = ReverseDiagDir(GetTunnelBridgeDirection(p1));
73 ConnectRoadToStructure(p1, start_direction);
74 }
75 }
76
78 class BuildBridgeWindow : public Window {
79 private:
80 /* Runtime saved values */
81 static Listing last_sorting;
82
83 /* Constants for sorting the bridges */
84 static const StringID sorter_names[];
85 static GUIBridgeList::SortFunction * const sorter_funcs[];
86
87 /* Internal variables */
88 TileIndex start_tile;
89 TileIndex end_tile;
90 uint32 type;
91 GUIBridgeList *bridges;
92 int bridgetext_offset;
93 Scrollbar *vscroll;
94
96 static int CDECL BridgeIndexSorter(const BuildBridgeData *a, const BuildBridgeData *b)
97 {
98 return a->index - b->index;
99 }
100
102 static int CDECL BridgePriceSorter(const BuildBridgeData *a, const BuildBridgeData *b)
103 {
104 return a->cost - b->cost;
105 }
106
108 static int CDECL BridgeSpeedSorter(const BuildBridgeData *a, const BuildBridgeData *b)
109 {
110 return a->spec->speed - b->spec->speed;
111 }
112
113 void BuildBridge(uint8 i)
114 {
115 switch ((TransportType)(this->type >> 15)) {
116 case TRANSPORT_RAIL: _last_railbridge_type = this->bridges->Get(i)->index; break;
117 case TRANSPORT_ROAD: _last_roadbridge_type = this->bridges->Get(i)->index; break;
118 default: break;
119 }
120 DoCommandP(this->end_tile, this->start_tile, this->type | this->bridges->Get(i)->index,
121 CMD_BUILD_BRIDGE | CMD_MSG(STR_ERROR_CAN_T_BUILD_BRIDGE_HERE), CcBuildBridge);
122 }
123
125 void SortBridgeList()
126 {
127 this->bridges->Sort();
128
129 /* Display the current sort variant */
130 this->GetWidget<NWidgetCore>(WID_BBS_DROPDOWN_CRITERIA)->widget_data = this->sorter_names[this->bridges->SortType()];
131
132 /* Set the modified widgets dirty */
133 this->SetWidgetDirty(WID_BBS_DROPDOWN_CRITERIA);
134 this->SetWidgetDirty(WID_BBS_BRIDGE_LIST);
135 }
136
137 public:
138 BuildBridgeWindow(WindowDesc *desc, TileIndex start, TileIndex end, uint32 br_type, GUIBridgeList *bl) : Window(desc),
139 start_tile(start),
140 end_tile(end),
141 type(br_type),
142 bridges(bl)
143 {
144 this->CreateNestedTree();
145 this->vscroll = this->GetScrollbar(WID_BBS_SCROLLBAR);
146 /* Change the data, or the caption of the gui. Set it to road or rail, accordingly. */
147 this->GetWidget<NWidgetCore>(WID_BBS_CAPTION)->widget_data = (GB(this->type, 15, 2) == TRANSPORT_ROAD) ? STR_SELECT_ROAD_BRIDGE_CAPTION : STR_SELECT_RAIL_BRIDGE_CAPTION;
148 this->FinishInitNested(GB(br_type, 15, 2)); // Initializes 'this->bridgetext_offset'.
149
150 this->parent = FindWindowById(WC_BUILD_TOOLBAR, GB(this->type, 15, 2));
151 this->bridges->SetListing(this->last_sorting);
152 this->bridges->SetSortFuncs(this->sorter_funcs);
153 this->bridges->NeedResort();
154 this->SortBridgeList();
155
156 this->vscroll->SetCount(bl->Length());
157 }
158
159 ~BuildBridgeWindow()
160 {
161 this->last_sorting = this->bridges->GetListing();
162
163 delete bridges;
164 }
165
166 virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
167 {
168 switch (widget) {
169 case WID_BBS_DROPDOWN_ORDER: {
170 Dimension d = GetStringBoundingBox(this->GetWidget<NWidgetCore>(widget)->widget_data);
171 d.width += padding.width + Window::SortButtonWidth() * 2; // Doubled since the string is centred and it also looks better.
172 d.height += padding.height;
173 *size = maxdim(*size, d);
174 break;
175 }
176 case WID_BBS_DROPDOWN_CRITERIA: {
177 Dimension d = {0, 0};
178 for (const StringID *str = this->sorter_names; *str != INVALID_STRING_ID; str++) {
179 d = maxdim(d, GetStringBoundingBox(*str));
180 }
181 d.width += padding.width;
182 d.height += padding.height;
183 *size = maxdim(*size, d);
184 break;
185 }
186 case WID_BBS_BRIDGE_LIST: {
187 Dimension sprite_dim = {0, 0}; // Biggest bridge sprite dimension
188 Dimension text_dim = {0, 0}; // Biggest text dimension
189 for (int i = 0; i < (int)this->bridges->Length(); i++) {
190 const BridgeSpec *b = this->bridges->Get(i)->spec;
191 sprite_dim = maxdim(sprite_dim, GetSpriteSize(b->sprite));
192
193 SetDParam(2, this->bridges->Get(i)->cost);
194 SetDParam(1, b->speed);
195 SetDParam(0, b->material);
196 text_dim = maxdim(text_dim, GetStringBoundingBox(_game_mode == GM_EDITOR ? STR_SELECT_BRIDGE_SCENEDIT_INFO : STR_SELECT_BRIDGE_INFO));
197 }
198 sprite_dim.height++; // Sprite is rendered one pixel down in the matrix field.
199 text_dim.height++; // Allowing the bottom row pixels to be rendered on the edge of the matrix field.
200 resize->height = max(sprite_dim.height, text_dim.height) + 2; // Max of both sizes + account for matrix edges.
201
202 this->bridgetext_offset = WD_MATRIX_LEFT + sprite_dim.width + 1; // Left edge of text, 1 pixel distance from the sprite.
203 size->width = this->bridgetext_offset + text_dim.width + WD_MATRIX_RIGHT;
204 size->height = 4 * resize->height; // Smallest bridge gui is 4 entries high in the matrix.
205 break;
206 }
207 }
208 }
209
210 virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
211 {
212 /* Position the window so hopefully the first bridge from the list is under the mouse pointer. */
213 NWidgetBase *list = this->GetWidget<NWidgetBase>(WID_BBS_BRIDGE_LIST);
214 Point corner; // point of the top left corner of the window.
215 corner.y = Clamp(_cursor.pos.y - list->pos_y - 5, GetMainViewTop(), GetMainViewBottom() - sm_height);
216 corner.x = Clamp(_cursor.pos.x - list->pos_x - 5, 0, _screen.width - sm_width);
217 return corner;
218 }
219
220 virtual void DrawWidget(const Rect &r, int widget) const
221 {
222 switch (widget) {
223 case WID_BBS_DROPDOWN_ORDER:
224 this->DrawSortButtonState(widget, this->bridges->IsDescSortOrder() ? SBS_DOWN : SBS_UP);
225 break;
226
227 case WID_BBS_BRIDGE_LIST: {
228 uint y = r.top;
229 for (int i = this->vscroll->GetPosition(); this->vscroll->IsVisible(i) && i < (int)this->bridges->Length(); i++) {
230 const BridgeSpec *b = this->bridges->Get(i)->spec;
231
232 SetDParam(2, this->bridges->Get(i)->cost);
233 SetDParam(1, b->speed);
234 SetDParam(0, b->material);
235
236 DrawSprite(b->sprite, b->pal, r.left + WD_MATRIX_LEFT, y + this->resize.step_height - 1 - GetSpriteSize(b->sprite).height);
237 DrawStringMultiLine(r.left + this->bridgetext_offset, r.right, y + 2, y + this->resize.step_height,
238 _game_mode == GM_EDITOR ? STR_SELECT_BRIDGE_SCENEDIT_INFO : STR_SELECT_BRIDGE_INFO);
239 y += this->resize.step_height;
240 }
241 break;
242 }
243 }
244 }
245
246 virtual EventState OnKeyPress(WChar key, uint16 keycode)
247 {
248 const uint8 i = keycode - '1';
249 if (i < 9 && i < this->bridges->Length()) {
250 /* Build the requested bridge */
251 this->BuildBridge(i);
252 delete this;
253 return ES_HANDLED;
254 }
255 return ES_NOT_HANDLED;
256 }
257
258 virtual void OnClick(Point pt, int widget, int click_count)
259 {
260 switch (widget) {
261 default: break;
262 case WID_BBS_BRIDGE_LIST: {
263 uint i = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_BBS_BRIDGE_LIST);
264 if (i < this->bridges->Length()) {
265 this->BuildBridge(i);
266 delete this;
267 }
268 break;
269 }
270
271 case WID_BBS_DROPDOWN_ORDER:
272 this->bridges->ToggleSortOrder();
273 this->SetDirty();
274 break;
275
276 case WID_BBS_DROPDOWN_CRITERIA:
277 ShowDropDownMenu(this, this->sorter_names, this->bridges->SortType(), WID_BBS_DROPDOWN_CRITERIA, 0, 0);
278 break;
279 }
280 }
281
282 virtual void OnDropdownSelect(int widget, int index)
283 {
284 if (widget == WID_BBS_DROPDOWN_CRITERIA && this->bridges->SortType() != index) {
285 this->bridges->SetSortType(index);
286
287 this->SortBridgeList();
288 }
289 }
290
291 virtual void OnResize()
292 {
293 this->vscroll->SetCapacityFromWidget(this, WID_BBS_BRIDGE_LIST);
294 }
295 };
296
298 Listing BuildBridgeWindow::last_sorting = {true, 2};
299
301 GUIBridgeList::SortFunction * const BuildBridgeWindow::sorter_funcs[] = {
302 &BridgeIndexSorter,
303 &BridgePriceSorter,
304 &BridgeSpeedSorter
305 };
306
308 const StringID BuildBridgeWindow::sorter_names[] = {
309 STR_SORT_BY_NUMBER,
310 STR_SORT_BY_COST,
311 STR_SORT_BY_MAX_SPEED,
312 INVALID_STRING_ID
313 };
314
316 static const NWidgetPart _nested_build_bridge_widgets[] = {
317 /* Header */
318 NWidget(NWID_HORIZONTAL),
319 NWidget(WWT_CLOSEBOX, COLOUR_DARK_GREEN),
320 NWidget(WWT_CAPTION, COLOUR_DARK_GREEN, WID_BBS_CAPTION), SetDataTip(STR_SELECT_RAIL_BRIDGE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
321 NWidget(WWT_DEFSIZEBOX, COLOUR_DARK_GREEN),
322 EndContainer(),
323
324 NWidget(NWID_HORIZONTAL),
325 NWidget(NWID_VERTICAL),
326 /* Sort order + criteria buttons */
327 NWidget(NWID_HORIZONTAL),
328 NWidget(WWT_TEXTBTN, COLOUR_DARK_GREEN, WID_BBS_DROPDOWN_ORDER), SetFill(1, 0), SetDataTip(STR_BUTTON_SORT_BY, STR_TOOLTIP_SORT_ORDER),
329 NWidget(WWT_DROPDOWN, COLOUR_DARK_GREEN, WID_BBS_DROPDOWN_CRITERIA), SetFill(1, 0), SetDataTip(0x0, STR_TOOLTIP_SORT_CRITERIA),
330 EndContainer(),
331 /* Matrix. */
332 NWidget(WWT_MATRIX, COLOUR_DARK_GREEN, WID_BBS_BRIDGE_LIST), SetFill(1, 0), SetResize(0, 22), SetMatrixDataTip(1, 0, STR_SELECT_BRIDGE_SELECTION_TOOLTIP), SetScrollbar(WID_BBS_SCROLLBAR),
333 EndContainer(),
334
335 /* scrollbar + resize button */
336 NWidget(NWID_VERTICAL),
337 NWidget(NWID_VSCROLLBAR, COLOUR_DARK_GREEN, WID_BBS_SCROLLBAR),
338 NWidget(WWT_RESIZEBOX, COLOUR_DARK_GREEN),
339 EndContainer(),
340 EndContainer(),
341 };
342
344 static WindowDesc _build_bridge_desc(
345 WDP_AUTO, "build_bridge", 200, 114,
346 WC_BUILD_BRIDGE, WC_BUILD_TOOLBAR,
347 WDF_CONSTRUCTION,
348 _nested_build_bridge_widgets, lengthof(_nested_build_bridge_widgets)
349 );
350
361 void ShowBuildBridgeWindow(TileIndex start, TileIndex end, TransportType transport_type, byte road_rail_type)
362 {
363 DeleteWindowByClass(WC_BUILD_BRIDGE);
364
365 /* Data type for the bridge.
366 * Bit 16,15 = transport type,
367 * 14..8 = road/rail types,
368 * 7..0 = type of bridge */
369 uint32 type = (transport_type << 15) | (road_rail_type << 8);
370
371 /* The bridge length without ramps. */
372 const uint bridge_len = GetTunnelBridgeLength(start, end);
373
374 /* If Ctrl is being pressed, check whether the last bridge built is available
375 * If so, return this bridge type. Otherwise continue normally.
376 * We store bridge types for each transport type, so we have to check for
377 * the transport type beforehand.
378 */
379 BridgeType last_bridge_type = 0;
380 switch (transport_type) {
381 case TRANSPORT_ROAD: last_bridge_type = _last_roadbridge_type; break;
382 case TRANSPORT_RAIL: last_bridge_type = _last_railbridge_type; break;
383 default: break; // water ways and air routes don't have bridge types
384 }
385 if (_ctrl_pressed && CheckBridgeAvailability(last_bridge_type, bridge_len).Succeeded()) {
386 DoCommandP(end, start, type | last_bridge_type, CMD_BUILD_BRIDGE | CMD_MSG(STR_ERROR_CAN_T_BUILD_BRIDGE_HERE), CcBuildBridge);
387 return;
388 }
389
390 /* only query bridge building possibility once, result is the same for all bridges!
391 * returns CMD_ERROR on failure, and price on success */
392 StringID errmsg = INVALID_STRING_ID;
393 CommandCost ret = DoCommand(end, start, type, CommandFlagsToDCFlags(GetCommandFlags(CMD_BUILD_BRIDGE)) | DC_QUERY_COST, CMD_BUILD_BRIDGE);
394
395 GUIBridgeList *bl = NULL;
396 if (ret.Failed()) {
397 errmsg = ret.GetErrorMessage();
398 } else {
399 /* check which bridges can be built */
400 const uint tot_bridgedata_len = CalcBridgeLenCostFactor(bridge_len + 2);
401
402 bl = new GUIBridgeList();
403
404 Money infra_cost = 0;
405 switch (transport_type) {
406 case TRANSPORT_ROAD:
407 infra_cost = (bridge_len + 2) * _price[PR_BUILD_ROAD] * 2;
408 /* In case we add a new road type as well, we must be aware of those costs. */
409 if (IsBridgeTile(start)) infra_cost *= CountBits(GetRoadTypes(start) | (RoadTypes)road_rail_type);
410 break;
411 case TRANSPORT_RAIL: infra_cost = (bridge_len + 2) * RailBuildCost((RailType)road_rail_type); break;
412 default: break;
413 }
414
415 /* loop for all bridgetypes */
416 for (BridgeType brd_type = 0; brd_type != MAX_BRIDGES; brd_type++) {
417 if (CheckBridgeAvailability(brd_type, bridge_len).Succeeded()) {
418 /* bridge is accepted, add to list */
419 BuildBridgeData *item = bl->Append();
420 item->index = brd_type;
421 item->spec = GetBridgeSpec(brd_type);
422 /* Add to terraforming & bulldozing costs the cost of the
423 * bridge itself (not computed with DC_QUERY_COST) */
424 item->cost = ret.GetCost() + (((int64)tot_bridgedata_len * _price[PR_BUILD_BRIDGE] * item->spec->price) >> 8) + infra_cost;
425 }
426 }
427 }
428
429 if (bl != NULL && bl->Length() != 0) {
430 new BuildBridgeWindow(&_build_bridge_desc, start, end, type, bl);
431 } else {
432 delete bl;
433 ShowErrorMessage(STR_ERROR_CAN_T_BUILD_BRIDGE_HERE, errmsg, WL_INFO, TileX(end) * TILE_SIZE, TileY(end) * TILE_SIZE);
434 }
435 }
EventState
EventState
State of handling an event.
Definition: window_type.h:701
BuildBridgeWindow::sorter_funcs
static GUIBridgeList::SortFunction *const sorter_funcs[]
Available bridge sorting functions.
Definition: bridge_gui.cpp:85
strings_func.h
Functions related to OTTD&#39;s strings.
ShowDropDownMenu
void ShowDropDownMenu(Window *w, const StringID *strings, int selected, int button, uint32 disabled_mask, uint32 hidden_mask, uint width)
Show a dropdown menu window near a widget of the parent window.
Definition: dropdown.cpp:462
sortlist_type.h
Base types for having sorted lists in GUIs.
GUIList
List template of &#39;things&#39; T to sort in a GUI.
Definition: sortlist_type.h:50
WID_BBS_DROPDOWN_ORDER
Direction of sort dropdown.
Definition: bridge_widget.h:18
GUIBridgeList
GUIList< BuildBridgeData > GUIBridgeList
List of bridges, used in BuildBridgeWindow.
Definition: bridge_gui.cpp:48
_last_roadbridge_type
static BridgeType _last_roadbridge_type
The type of the last built road bridge.
Definition: bridge_gui.cpp:37
CalcBridgeLenCostFactor
int CalcBridgeLenCostFactor(int x)
Calculate the price factor for building a long bridge.
Definition: tunnelbridge_cmd.cpp:105
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:930
WD_MATRIX_RIGHT
Offset at right of a matrix cell.
Definition: window_gui.h:79
CursorVars::pos
Point pos
logical mouse position
Definition: gfx_type.h:119
RailType
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:29
WindowDesc
High level window description.
Definition: window_gui.h:168
ConnectRoadToStructure
void ConnectRoadToStructure(TileIndex tile, DiagDirection direction)
If required, connects a new structure to an existing road or tram by building the missing roadbit...
Definition: road_gui.cpp:164
IsBridgeTile
static bool IsBridgeTile(TileIndex t)
checks if there is a bridge on this tile
Definition: bridge_map.h:35
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:589
NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:75
road_gui.h
Functions/types related to the road GUIs.
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1105
ES_NOT_HANDLED
The passed event is not handled.
Definition: window_type.h:703
DC_QUERY_COST
query cost only, don&#39;t build.
Definition: command_type.h:344
GUIList::SetSortFuncs
void SetSortFuncs(SortFunction *const *n_funcs)
Hand the array of sort function pointers to the sort list.
Definition: sortlist_type.h:286
rail.h
Rail specific functions.
BuildBridgeWindow::sorter_names
static const StringID sorter_names[]
Names of the sorting functions.
Definition: bridge_gui.cpp:84
WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:68
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:207
WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:69
BridgeSpec::speed
uint16 speed
maximum travel speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition: bridge.h:48
cmd_helper.h
Helper functions to extract data from command parameters.
GUIList::NeedResort
bool NeedResort()
Check if a resort is needed next loop If used the resort timer will decrease every call till 0...
Definition: sortlist_type.h:205
CommandCost::GetCost
Money GetCost() const
The costs as made up to this moment.
Definition: command_type.h:84
CommandCost
Common return value for all commands.
Definition: command_type.h:25
GetCommandFlags
CommandFlags GetCommandFlags(uint32 cmd)
Definition: command.cpp:379
max
static T max(const T a, const T b)
Returns the maximum of two values.
Definition: math_func.hpp:26
BuildBridgeWindow
Window class for handling the bridge-build GUI.
Definition: bridge_gui.cpp:78
BuildBridgeWindow::UpdateWidgetSize
virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
Update size and resize step of a widget in the window.
Definition: bridge_gui.cpp:166
BridgeSpec
Struct containing information about a single bridge type.
Definition: bridge.h:43
WID_BBS_CAPTION
Caption of the window.
Definition: bridge_widget.h:17
GUIList::SetListing
void SetListing(Listing l)
Import sort conditions.
Definition: sortlist_type.h:134
TILE_SIZE
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:15
SmallVector::Append
T * Append(uint to_add=1)
Append an item and return it.
Definition: smallvec_type.hpp:134
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:670
GetMainViewBottom
int GetMainViewBottom()
Return the bottom of the main view available for general use.
Definition: window.cpp:2163
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:910
Window
Data structure for an opened window.
Definition: window_gui.h:271
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:36
SetMatrixDataTip
static NWidgetPart SetMatrixDataTip(uint8 cols, uint8 rows, StringID tip)
Widget part function for setting the data and tooltip of WWT_MATRIX widgets.
Definition: widget_type.h:1032
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=NULL, uint textref_stack_size=0, const uint32 *textref_stack=NULL)
Display an error message in a window.
Definition: error_gui.cpp:378
BuildBridgeWindow::last_sorting
static Listing last_sorting
Last setting of the sort.
Definition: bridge_gui.cpp:81
BuildBridgeWindow::OnClick
virtual void OnClick(Point pt, int widget, int click_count)
A click with the left mouse button has been made on the window.
Definition: bridge_gui.cpp:258
error.h
Functions related to errors.
DoCommand
CommandCost DoCommand(const CommandContainer *container, DoCommandFlag flags)
Shorthand for calling the long DoCommand with a container.
Definition: command.cpp:436
_last_railbridge_type
static BridgeType _last_railbridge_type
The type of the last built rail bridge.
Definition: bridge_gui.cpp:35
WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX) ...
Definition: widget_type.h:65
SmallVector::Length
uint Length() const
Get the number of items in the list.
Definition: smallvec_type.hpp:262
Scrollbar::GetScrolledRowFromWidget
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0, int line_height=-1) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:1959
BuildBridgeWindow::DrawWidget
virtual void DrawWidget(const Rect &r, int widget) const
Draw the contents of a nested widget.
Definition: bridge_gui.cpp:220
NWidgetBase::pos_y
uint pos_y
Vertical position of top-left corner of the widget in the window.
Definition: widget_type.h:178
WDF_CONSTRUCTION
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:210
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition: settings_type.h:564
tunnelbridge.h
Header file for things common for tunnels and bridges.
_nested_build_bridge_widgets
static const NWidgetPart _nested_build_bridge_widgets[]
Widgets of the bridge gui.
Definition: bridge_gui.cpp:316
GUIList::GetListing
Listing GetListing() const
Export current sort conditions.
Definition: sortlist_type.h:120
BuildBridgeWindow::OnDropdownSelect
virtual void OnDropdownSelect(int widget, int index)
A dropdown option associated to this window has been selected.
Definition: bridge_gui.cpp:282
SBS_UP
Sort descending.
Definition: window_gui.h:227
CommandCost::GetErrorMessage
StringID GetErrorMessage() const
Returns the error message of a command.
Definition: command_type.h:142
ReverseDiagDir
static DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
Definition: direction_func.h:120
GetTunnelBridgeLength
static uint GetTunnelBridgeLength(TileIndex begin, TileIndex end)
Calculates the length of a tunnel or a bridge (without end tiles)
Definition: tunnelbridge.h:26
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1014
gfx_func.h
Functions related to the gfx engine.
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:76
CommandCost::Succeeded
bool Succeeded() const
Did this command succeed?
Definition: command_type.h:152
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
BuildBridgeWindow::OnResize
virtual void OnResize()
Called after the window got resized.
Definition: bridge_gui.cpp:291
GetMainViewTop
int GetMainViewTop()
Return the top of the main view available for general use.
Definition: window.cpp:2152
GetBridgeSpec
static const BridgeSpec * GetBridgeSpec(BridgeType i)
Get the specification of a bridge type.
Definition: bridge.h:67
safeguards.h
A number of safeguards to prevent using unsafe methods.
geometry_func.hpp
Geometry functions.
BuildBridgeWindow::SortBridgeList
void SortBridgeList()
Sort the builable bridges.
Definition: bridge_gui.cpp:125
WD_MATRIX_LEFT
Offset at left of a matrix cell.
Definition: window_gui.h:78
BridgeSpec::sprite
SpriteID sprite
the sprite which is used in the GUI
Definition: bridge.h:49
BuildBridgeData
Carriage for the data we need if we want to build a bridge.
Definition: bridge_gui.cpp:42
BridgeSpec::pal
PaletteID pal
the palette which is used in the GUI
Definition: bridge.h:50
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new &#39;real&#39; widget.
Definition: widget_type.h:1114
CommandFlagsToDCFlags
static DoCommandFlag CommandFlagsToDCFlags(CommandFlags cmd_flags)
Extracts the DC flags needed for DoCommand from the flags returned by GetCommandFlags.
Definition: command_func.h:62
NWidgetBase
Baseclass for nested widgets.
Definition: widget_type.h:126
DoCommandP
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:527
DiagDirection
DiagDirection
Enumeration for diagonal directions.
Definition: direction_type.h:80
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
ShowBuildBridgeWindow
void ShowBuildBridgeWindow(TileIndex start, TileIndex end, TransportType transport_type, byte road_rail_type)
Prepare the data for the build a bridge window.
Definition: bridge_gui.cpp:361
WC_BUILD_BRIDGE
Build bridge; Window numbers:
Definition: window_type.h:384
WWT_MATRIX
Grid of rows and columns.
Definition: widget_type.h:59
NWidgetBase::pos_x
uint pos_x
Horizontal position of top-left corner of the widget in the window.
Definition: widget_type.h:177
CheckBridgeAvailability
CommandCost CheckBridgeAvailability(BridgeType bridge_type, uint bridge_len, DoCommandFlag flags=DC_NONE)
Is a bridge of the specified type and length available?
Definition: tunnelbridge_cmd.cpp:209
sound_func.h
Functions related to sound.
GUIList::SetSortType
void SetSortType(uint8 n_type)
Set the sorttype of the list.
Definition: sortlist_type.h:107
GUIList::Sort
bool Sort(SortFunction *compare)
Sort the list.
Definition: sortlist_type.h:256
Window::SortButtonWidth
static int SortButtonWidth()
Get width of up/down arrow of sort button state.
Definition: widget.cpp:658
GetTunnelBridgeDirection
static DiagDirection GetTunnelBridgeDirection(TileIndex t)
Get the direction pointing to the other end.
Definition: tunnelbridge_map.h:28
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
BuildBridgeWindow::BridgeSpeedSorter
static int CDECL BridgeSpeedSorter(const BuildBridgeData *a, const BuildBridgeData *b)
Sort the bridges by their maximum speed.
Definition: bridge_gui.cpp:108
DeleteWindowByClass
void DeleteWindowByClass(WindowClass cls)
Delete all windows of a given class.
Definition: window.cpp:1150
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:161
WID_BBS_BRIDGE_LIST
List of bridges.
Definition: bridge_widget.h:20
RoadTypes
RoadTypes
The different roadtypes we support, but then a bitmask of them.
Definition: road_type.h:36
BridgeSpec::price
uint16 price
the price multiplier
Definition: bridge.h:47
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:139
Scrollbar::IsVisible
bool IsVisible(uint16 item) const
Checks whether given current item is visible in the list.
Definition: widget_type.h:641
WC_BUILD_TOOLBAR
Build toolbar; Window numbers:
Definition: window_type.h:68
_build_bridge_desc
static WindowDesc _build_bridge_desc(WDP_AUTO, "build_bridge", 200, 114, WC_BUILD_BRIDGE, WC_BUILD_TOOLBAR, WDF_CONSTRUCTION, _nested_build_bridge_widgets, lengthof(_nested_build_bridge_widgets))
Window definition for the rail bridge selection window.
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:699
BuildBridgeWindow::OnKeyPress
virtual EventState OnKeyPress(WChar key, uint16 keycode)
A key has been pressed.
Definition: bridge_gui.cpp:246
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:24
TRANSPORT_RAIL
Transport by train.
Definition: transport_type.h:29
BridgeSpec::material
StringID material
the string that contains the bridge description
Definition: bridge.h:51
BuildBridgeWindow::BridgeIndexSorter
static int CDECL BridgeIndexSorter(const BuildBridgeData *a, const BuildBridgeData *b)
Sort the bridges by their index.
Definition: bridge_gui.cpp:96
CcBuildBridge
void CcBuildBridge(const CommandCost &result, TileIndex end_tile, uint32 p1, uint32 p2)
Callback executed after a build Bridge CMD has been called.
Definition: bridge_gui.cpp:61
WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
GUIList::ToggleSortOrder
void ToggleSortOrder()
Toggle the sort order Since that is the worst condition for the sort function reverse the list here...
Definition: sortlist_type.h:239
RailBuildCost
static Money RailBuildCost(RailType railtype)
Returns the cost of building the specified railtype.
Definition: rail.h:344
SBS_DOWN
Sort ascending.
Definition: window_gui.h:226
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:217
WID_BBS_SCROLLBAR
Scrollbar of the list.
Definition: bridge_widget.h:21
BuildBridgeWindow::OnInitialPosition
virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
Compute the initial position of the window.
Definition: bridge_gui.cpp:210
NWID_VERTICAL
Vertical container.
Definition: widget_type.h:77
GUIList::SortFunction
int CDECL SortFunction(const T *, const T *)
Signature of sort function.
Definition: sortlist_type.h:52
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:999
MAX_BRIDGES
static const uint MAX_BRIDGES
Maximal number of available bridge specs.
Definition: bridge.h:36
TransportType
TransportType
Available types of transport.
Definition: transport_type.h:21
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:34
dropdown_func.h
Functions related to the drop down widget.
TRANSPORT_ROAD
Transport by road vehicle.
Definition: transport_type.h:30
SoundSettings::confirm
bool confirm
Play sound effect on succesful constructions or other actions.
Definition: settings_type.h:177
CountBits
static uint CountBits(T value)
Counts the number of set bits in a variable.
Definition: bitmath_func.hpp:253
command_func.h
Functions related to commands.
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:28
bridge_widget.h
Types related to the bridge widgets.
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:768
BridgeType
uint BridgeType
Bridge spec number.
Definition: bridge.h:38
Listing
Data structure describing how to show the list (what sort direction and criteria).
Definition: sortlist_type.h:34
WWT_DROPDOWN
Drop down list.
Definition: widget_type.h:70
CMD_BUILD_BRIDGE
build a bridge
Definition: command_type.h:183
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:19
tunnelbridge_map.h
Functions that have tunnels and bridges in common.
GetRoadTypes
static RoadTypes GetRoadTypes(TileIndex t)
Get the present road types of a tile.
Definition: road_map.h:166
WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:23
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:983
GUIList::IsDescSortOrder
bool IsDescSortOrder() const
Check if the sort order is descending.
Definition: sortlist_type.h:229
SmallVector::Get
const T * Get(uint index) const
Get the pointer to item "number" (const)
Definition: smallvec_type.hpp:313
CMD_MSG
#define CMD_MSG(x)
Used to combine a StringID with the command.
Definition: command_type.h:366
Scrollbar::SetCapacityFromWidget
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget. ...
Definition: widget.cpp:1973
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:40
NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:84
ES_HANDLED
The passed event is handled.
Definition: window_type.h:702
window_func.h
Window functions not directly related to making/drawing windows.
WDP_AUTO
Find a place automatically.
Definition: window_gui.h:156
WChar
uint32 WChar
Type for wide characters, i.e.
Definition: string_type.h:35
BuildBridgeWindow::bridgetext_offset
int bridgetext_offset
Horizontal offset of the text describing the bridge properties in WID_BBS_BRIDGE_LIST relative to the...
Definition: bridge_gui.cpp:92
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1095
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:34
OverflowSafeInt< int64, INT64_MAX, INT64_MIN >
DrawSprite
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:833
BuildBridgeWindow::BridgePriceSorter
static int CDECL BridgePriceSorter(const BuildBridgeData *a, const BuildBridgeData *b)
Sort the bridges by their price.
Definition: bridge_gui.cpp:102
WID_BBS_DROPDOWN_CRITERIA
Criteria of sort dropdown.
Definition: bridge_widget.h:19
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:620
WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:55
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:631
GUIList::SortType
uint8 SortType() const
Get the sorttype of the list.
Definition: sortlist_type.h:97
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:201