OpenTTD Source  1.11.2
engine_gui.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #include "stdafx.h"
11 #include "window_gui.h"
12 #include "engine_base.h"
13 #include "command_func.h"
14 #include "strings_func.h"
15 #include "engine_gui.h"
16 #include "articulated_vehicles.h"
17 #include "vehicle_func.h"
18 #include "company_func.h"
19 #include "rail.h"
20 #include "road.h"
21 #include "settings_type.h"
22 #include "train.h"
23 #include "roadveh.h"
24 #include "ship.h"
25 #include "aircraft.h"
26 
27 #include "widgets/engine_widget.h"
28 
29 #include "table/strings.h"
30 
31 #include "safeguards.h"
32 
39 {
40  const Engine *e = Engine::Get(engine);
41  switch (e->type) {
42  default: NOT_REACHED();
43  case VEH_ROAD:
44  return GetRoadTypeInfo(e->u.road.roadtype)->strings.new_engine;
45  case VEH_AIRCRAFT: return STR_ENGINE_PREVIEW_AIRCRAFT;
46  case VEH_SHIP: return STR_ENGINE_PREVIEW_SHIP;
47  case VEH_TRAIN:
48  return GetRailTypeInfo(e->u.rail.railtype)->strings.new_loco;
49  }
50 }
51 
52 static const NWidgetPart _nested_engine_preview_widgets[] = {
54  NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE),
55  NWidget(WWT_CAPTION, COLOUR_LIGHT_BLUE), SetDataTip(STR_ENGINE_PREVIEW_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
56  EndContainer(),
57  NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE),
58  NWidget(WWT_EMPTY, INVALID_COLOUR, WID_EP_QUESTION), SetMinimalSize(300, 0), SetPadding(8, 8, 8, 8), SetFill(1, 0),
60  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_EP_NO), SetDataTip(STR_QUIT_NO, STR_NULL), SetFill(1, 0),
61  NWidget(WWT_PUSHTXTBTN, COLOUR_LIGHT_BLUE, WID_EP_YES), SetDataTip(STR_QUIT_YES, STR_NULL), SetFill(1, 0),
62  EndContainer(),
64  EndContainer(),
65 };
66 
68  int vehicle_space; // The space to show the vehicle image
69 
71  {
72  this->InitNested(window_number);
73 
74  /* There is no way to recover the window; so disallow closure via DEL; unless SHIFT+DEL */
75  this->flags |= WF_STICKY;
76  }
77 
78  void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
79  {
80  if (widget != WID_EP_QUESTION) return;
81 
82  /* Get size of engine sprite, on loan from depot_gui.cpp */
83  EngineID engine = this->window_number;
84  EngineImageType image_type = EIT_PURCHASE;
85  uint x, y;
86  int x_offs, y_offs;
87 
88  const Engine *e = Engine::Get(engine);
89  switch (e->type) {
90  default: NOT_REACHED();
91  case VEH_TRAIN: GetTrainSpriteSize( engine, x, y, x_offs, y_offs, image_type); break;
92  case VEH_ROAD: GetRoadVehSpriteSize( engine, x, y, x_offs, y_offs, image_type); break;
93  case VEH_SHIP: GetShipSpriteSize( engine, x, y, x_offs, y_offs, image_type); break;
94  case VEH_AIRCRAFT: GetAircraftSpriteSize(engine, x, y, x_offs, y_offs, image_type); break;
95  }
96  this->vehicle_space = std::max<int>(40, y - y_offs);
97 
98  size->width = std::max(size->width, x - x_offs);
99  SetDParam(0, GetEngineCategoryName(engine));
100  size->height = GetStringHeight(STR_ENGINE_PREVIEW_MESSAGE, size->width) + WD_PAR_VSEP_WIDE + FONT_HEIGHT_NORMAL + this->vehicle_space;
101  SetDParam(0, engine);
102  size->height += GetStringHeight(GetEngineInfoString(engine), size->width);
103  }
104 
105  void DrawWidget(const Rect &r, int widget) const override
106  {
107  if (widget != WID_EP_QUESTION) return;
108 
109  EngineID engine = this->window_number;
110  SetDParam(0, GetEngineCategoryName(engine));
111  int y = r.top + GetStringHeight(STR_ENGINE_PREVIEW_MESSAGE, r.right - r.left + 1);
112  y = DrawStringMultiLine(r.left, r.right, r.top, y, STR_ENGINE_PREVIEW_MESSAGE, TC_FROMSTRING, SA_CENTER) + WD_PAR_VSEP_WIDE;
113 
114  SetDParam(0, engine);
115  DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, STR_ENGINE_NAME, TC_BLACK, SA_HOR_CENTER);
116  y += FONT_HEIGHT_NORMAL;
117 
118  DrawVehicleEngine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, this->width >> 1, y + this->vehicle_space / 2, engine, GetEnginePalette(engine, _local_company), EIT_PREVIEW);
119 
120  y += this->vehicle_space;
121  DrawStringMultiLine(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, y, r.bottom, GetEngineInfoString(engine), TC_FROMSTRING, SA_CENTER);
122  }
123 
124  void OnClick(Point pt, int widget, int click_count) override
125  {
126  switch (widget) {
127  case WID_EP_YES:
128  DoCommandP(0, this->window_number, 0, CMD_WANT_ENGINE_PREVIEW);
129  FALLTHROUGH;
130  case WID_EP_NO:
131  if (!_shift_pressed) delete this;
132  break;
133  }
134  }
135 
136  void OnInvalidateData(int data = 0, bool gui_scope = true) override
137  {
138  if (!gui_scope) return;
139 
140  EngineID engine = this->window_number;
141  if (Engine::Get(engine)->preview_company != _local_company) delete this;
142  }
143 };
144 
145 static WindowDesc _engine_preview_desc(
146  WDP_CENTER, "engine_preview", 0, 0,
149  _nested_engine_preview_widgets, lengthof(_nested_engine_preview_widgets)
150 );
151 
152 
153 void ShowEnginePreviewWindow(EngineID engine)
154 {
155  AllocateWindowDescFront<EnginePreviewWindow>(&_engine_preview_desc, engine);
156 }
157 
164 {
166  return cap.GetSum<uint>();
167 }
168 
169 static StringID GetTrainEngineInfoString(const Engine *e)
170 {
171  SetDParam(0, e->GetCost());
172  SetDParam(2, e->GetDisplayMaxSpeed());
173  SetDParam(3, e->GetPower());
174  SetDParam(1, e->GetDisplayWeight());
176 
177  SetDParam(4, e->GetRunningCost());
178 
179  uint capacity = GetTotalCapacityOfArticulatedParts(e->index);
180  if (capacity != 0) {
182  SetDParam(6, capacity);
183  } else {
184  SetDParam(5, CT_INVALID);
185  }
186  return (_settings_game.vehicle.train_acceleration_model != AM_ORIGINAL && GetRailTypeInfo(e->u.rail.railtype)->acceleration_type != 2) ? STR_ENGINE_PREVIEW_COST_WEIGHT_SPEED_POWER_MAX_TE : STR_ENGINE_PREVIEW_COST_WEIGHT_SPEED_POWER;
187 }
188 
189 static StringID GetAircraftEngineInfoString(const Engine *e)
190 {
191  CargoID cargo = e->GetDefaultCargoType();
192  uint16 mail_capacity;
193  uint capacity = e->GetDisplayDefaultCapacity(&mail_capacity);
194  uint16 range = e->GetRange();
195 
196  uint i = 0;
197  SetDParam(i++, e->GetCost());
198  SetDParam(i++, e->GetDisplayMaxSpeed());
199  SetDParam(i++, e->GetAircraftTypeText());
200  if (range > 0) SetDParam(i++, range);
201  SetDParam(i++, cargo);
202  SetDParam(i++, capacity);
203 
204  if (mail_capacity > 0) {
205  SetDParam(i++, CT_MAIL);
206  SetDParam(i++, mail_capacity);
207  SetDParam(i++, e->GetRunningCost());
208  return range > 0 ? STR_ENGINE_PREVIEW_COST_MAX_SPEED_TYPE_RANGE_CAP_CAP_RUNCOST : STR_ENGINE_PREVIEW_COST_MAX_SPEED_TYPE_CAP_CAP_RUNCOST;
209  } else {
210  SetDParam(i++, e->GetRunningCost());
211  return range > 0 ? STR_ENGINE_PREVIEW_COST_MAX_SPEED_TYPE_RANGE_CAP_RUNCOST : STR_ENGINE_PREVIEW_COST_MAX_SPEED_TYPE_CAP_RUNCOST;
212  }
213 }
214 
215 static StringID GetRoadVehEngineInfoString(const Engine *e)
216 {
218  SetDParam(0, e->GetCost());
219  SetDParam(1, e->GetDisplayMaxSpeed());
220  uint capacity = GetTotalCapacityOfArticulatedParts(e->index);
221  if (capacity != 0) {
223  SetDParam(3, capacity);
224  } else {
225  SetDParam(2, CT_INVALID);
226  }
227  SetDParam(4, e->GetRunningCost());
228  return STR_ENGINE_PREVIEW_COST_MAX_SPEED_CAP_RUNCOST;
229  } else {
230  SetDParam(0, e->GetCost());
231  SetDParam(2, e->GetDisplayMaxSpeed());
232  SetDParam(3, e->GetPower());
233  SetDParam(1, e->GetDisplayWeight());
235 
236  SetDParam(4, e->GetRunningCost());
237 
238  uint capacity = GetTotalCapacityOfArticulatedParts(e->index);
239  if (capacity != 0) {
241  SetDParam(6, capacity);
242  } else {
243  SetDParam(5, CT_INVALID);
244  }
245  return STR_ENGINE_PREVIEW_COST_WEIGHT_SPEED_POWER_MAX_TE;
246  }
247 }
248 
249 static StringID GetShipEngineInfoString(const Engine *e)
250 {
251  SetDParam(0, e->GetCost());
252  SetDParam(1, e->GetDisplayMaxSpeed());
255  SetDParam(4, e->GetRunningCost());
256  return STR_ENGINE_PREVIEW_COST_MAX_SPEED_CAP_RUNCOST;
257 }
258 
259 
267 {
268  const Engine *e = Engine::Get(engine);
269 
270  switch (e->type) {
271  case VEH_TRAIN:
272  return GetTrainEngineInfoString(e);
273 
274  case VEH_ROAD:
275  return GetRoadVehEngineInfoString(e);
276 
277  case VEH_SHIP:
278  return GetShipEngineInfoString(e);
279 
280  case VEH_AIRCRAFT:
281  return GetAircraftEngineInfoString(e);
282 
283  default: NOT_REACHED();
284  }
285 }
286 
296 void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
297 {
298  const Engine *e = Engine::Get(engine);
299 
300  switch (e->type) {
301  case VEH_TRAIN:
302  DrawTrainEngine(left, right, preferred_x, y, engine, pal, image_type);
303  break;
304 
305  case VEH_ROAD:
306  DrawRoadVehEngine(left, right, preferred_x, y, engine, pal, image_type);
307  break;
308 
309  case VEH_SHIP:
310  DrawShipEngine(left, right, preferred_x, y, engine, pal, image_type);
311  break;
312 
313  case VEH_AIRCRAFT:
314  DrawAircraftEngine(left, right, preferred_x, y, engine, pal, image_type);
315  break;
316 
317  default: NOT_REACHED();
318  }
319 }
320 
327 {
328  if (el->size() < 2) return;
329  std::sort(el->begin(), el->end(), compare);
330 }
331 
339 void EngList_SortPartial(GUIEngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items)
340 {
341  if (num_items < 2) return;
342  assert(begin < el->size());
343  assert(begin + num_items <= el->size());
344  std::sort(el->begin() + begin, el->begin() + begin + num_items, compare);
345 }
346 
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
GetEngineInfoString
StringID GetEngineInfoString(EngineID engine)
Get a multi-line string with some technical data, describing the engine.
Definition: engine_gui.cpp:266
RoadTypeInfo::new_engine
StringID new_engine
Name of an engine for this type of road in the engine preview GUI.
Definition: road.h:105
Engine::GetDisplayDefaultCapacity
uint GetDisplayDefaultCapacity(uint16 *mail_capacity=nullptr) const
Determines the default cargo capacity of an engine for display purposes.
Definition: engine_base.h:99
EnginePreviewWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: engine_gui.cpp:136
CargoArray::GetSum
const T GetSum() const
Get the sum of all cargo amounts.
Definition: cargo_type.h:121
EIT_PREVIEW
@ EIT_PREVIEW
Vehicle drawn in preview window, news, ...
Definition: vehicle_type.h:91
EnginePreviewWindow
Definition: engine_gui.cpp:67
Pool::PoolItem<&_engine_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:329
VehicleSettings::train_acceleration_model
uint8 train_acceleration_model
realistic acceleration for trains
Definition: settings_type.h:466
train.h
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
command_func.h
RoadTypeInfo::strings
struct RoadTypeInfo::@44 strings
Strings associated with the rail type.
SetPadding
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1055
WDF_CONSTRUCTION
@ WDF_CONSTRUCTION
This window is used for construction; close it whenever changing company.
Definition: window_gui.h:208
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
EnginePreviewWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: engine_gui.cpp:105
GUIList< EngineID, CargoID >
WC_ENGINE_PREVIEW
@ WC_ENGINE_PREVIEW
Engine preview window; Window numbers:
Definition: window_type.h:583
GetCapacityOfArticulatedParts
CargoArray GetCapacityOfArticulatedParts(EngineID engine)
Get the capacity of the parts of a given engine.
Definition: articulated_vehicles.cpp:139
Engine::GetDisplayMaxTractiveEffort
uint GetDisplayMaxTractiveEffort() const
Returns the tractive effort of the engine for display purposes.
Definition: engine.cpp:425
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:227
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
EIT_PURCHASE
@ EIT_PURCHASE
Vehicle drawn in purchase list, autoreplace gui, ...
Definition: vehicle_type.h:90
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:81
WF_STICKY
@ WF_STICKY
Window is made sticky by user.
Definition: window_gui.h:238
EnginePreviewWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: engine_gui.cpp:124
ship.h
Engine::GetRunningCost
Money GetRunningCost() const
Return how much the running costs of this engine are.
Definition: engine.cpp:280
GetEngineCategoryName
StringID GetEngineCategoryName(EngineID engine)
Return the category of an engine.
Definition: engine_gui.cpp:38
aircraft.h
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:640
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
WindowNumber
int32 WindowNumber
Number to differentiate different windows of the same class.
Definition: window_type.h:711
SA_CENTER
@ SA_CENTER
Center both horizontally and vertically.
Definition: gfx_func.h:106
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:85
Engine
Definition: engine_base.h:21
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
SA_HOR_CENTER
@ SA_HOR_CENTER
Horizontally center the text.
Definition: gfx_func.h:97
Engine::GetDefaultCargoType
CargoID GetDefaultCargoType() const
Determines the default cargo type of an engine.
Definition: engine_base.h:79
RoadVehicleInfo::roadtype
RoadType roadtype
Road type.
Definition: engine_type.h:125
GetEnginePalette
PaletteID GetEnginePalette(EngineID engine_type, CompanyID company)
Get the colour map for an engine.
Definition: vehicle.cpp:2034
GetShipSpriteSize
void GetShipSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of a ship sprite heading west (used for lists).
Definition: ship_cmd.cpp:113
Window::Window
Window(WindowDesc *desc)
Empty constructor, initialization has been moved to InitNested() called from the constructor of the d...
Definition: window.cpp:1871
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:199
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:919
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1023
WID_EP_YES
@ WID_EP_YES
Yes button.
Definition: engine_widget.h:17
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:763
WindowDesc
High level window description.
Definition: window_gui.h:166
GetRailTypeInfo
static const RailtypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:304
window_gui.h
Engine::GetDisplayMaxSpeed
uint GetDisplayMaxSpeed() const
Returns max speed of the engine for display purposes.
Definition: engine.cpp:357
NC_EQUALSIZE
@ NC_EQUALSIZE
Value of the NCB_EQUALSIZE flag.
Definition: widget_type.h:438
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
DrawRoadVehEngine
void DrawRoadVehEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
Draw a road vehicle engine.
Definition: roadveh_cmd.cpp:145
CMD_WANT_ENGINE_PREVIEW
@ CMD_WANT_ENGINE_PREVIEW
confirm the preview of an engine
Definition: command_type.h:241
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:323
DoCommandP
bool DoCommandP(const CommandContainer *container, bool my_cmd)
Shortcut for the long DoCommandP when having a container with the data.
Definition: command.cpp:541
Window::InitNested
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
Definition: window.cpp:1861
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:60
WD_FRAMERECT_RIGHT
@ WD_FRAMERECT_RIGHT
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:61
WWT_PUSHTXTBTN
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:102
WID_EP_QUESTION
@ WID_EP_QUESTION
The container for the question.
Definition: engine_widget.h:15
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:80
Engine::GetDisplayWeight
uint GetDisplayWeight() const
Returns the weight of the engine for display purposes.
Definition: engine.cpp:407
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
safeguards.h
Window::flags
WindowFlags flags
Window flags.
Definition: window_gui.h:311
rail.h
_shift_pressed
bool _shift_pressed
Is Shift pressed?
Definition: gfx.cpp:36
road.h
settings_type.h
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
Engine::GetCost
Money GetCost() const
Return how much a new engine costs.
Definition: engine.cpp:317
stdafx.h
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:313
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
GetStringHeight
int GetStringHeight(const char *str, int maxw, FontSize fontsize)
Calculates height of string (in pixels).
Definition: gfx.cpp:689
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
EngList_SortPartial
void EngList_SortPartial(GUIEngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items)
Sort selected range of items (on indices @ <begin, begin+num_items-1>)
Definition: engine_gui.cpp:339
RailtypeInfo::acceleration_type
uint8 acceleration_type
Acceleration type of this rail type.
Definition: rail.h:223
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
vehicle_func.h
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1008
engine_gui.h
strings_func.h
GetAircraftSpriteSize
void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of an aircraft sprite heading west (used for lists).
Definition: aircraft_cmd.cpp:245
VehicleSettings::roadveh_acceleration_model
uint8 roadveh_acceleration_model
realistic acceleration for road vehicles
Definition: settings_type.h:467
Engine::GetPower
uint GetPower() const
Returns the power of the engine for display and sorting purposes.
Definition: engine.cpp:389
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:179
GetTrainSpriteSize
void GetTrainSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of a train sprite heading west, or both heads (used for lists).
Definition: train_cmd.cpp:549
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1123
GetTotalCapacityOfArticulatedParts
uint GetTotalCapacityOfArticulatedParts(EngineID engine)
Get the capacity of an engine with articulated parts.
Definition: engine_gui.cpp:163
PaletteID
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:18
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:956
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
GetRoadVehSpriteSize
void GetRoadVehSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of a road vehicle sprite heading west (used for lists).
Definition: roadveh_cmd.cpp:168
EngList_Sort
void EngList_Sort(GUIEngineList *el, EngList_SortTypeFunction compare)
Sort all items using quick sort and given 'CompareItems' function.
Definition: engine_gui.cpp:326
GetRoadTypeInfo
static const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
Definition: road.h:224
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:77
RailtypeInfo::strings
struct RailtypeInfo::@41 strings
Strings associated with the rail type.
company_func.h
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:369
RailtypeInfo::new_loco
StringID new_loco
Name of an engine for this type of rail in the engine preview GUI.
Definition: rail.h:178
SetPIP
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1085
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
engine_widget.h
engine_base.h
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:992
articulated_vehicles.h
GameSettings::vehicle
VehicleSettings vehicle
options for vehicles
Definition: settings_type.h:572
Window
Data structure for an opened window.
Definition: window_gui.h:277
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
EngList_SortTypeFunction
bool EngList_SortTypeFunction(const EngineID &, const EngineID &)
argument type for EngList_Sort.
Definition: engine_gui.h:20
Engine::GetRange
uint16 GetRange() const
Get the range of an aircraft type.
Definition: engine.cpp:452
EnginePreviewWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: engine_gui.cpp:78
CT_INVALID
@ CT_INVALID
Invalid cargo type.
Definition: cargo_type.h:68
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
WD_PAR_VSEP_WIDE
@ WD_PAR_VSEP_WIDE
Large amount of vertical space between two paragraphs of text.
Definition: window_gui.h:138
WID_EP_NO
@ WID_EP_NO
No button.
Definition: engine_widget.h:16
WDP_CENTER
@ WDP_CENTER
Center the window.
Definition: window_gui.h:155
Engine::GetAircraftTypeText
StringID GetAircraftTypeText() const
Get the name of the aircraft type for display purposes.
Definition: engine.cpp:466
DrawVehicleEngine
void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
Draw an engine.
Definition: engine_gui.cpp:296
Engine::type
VehicleType type
Vehicle type, ie VEH_ROAD, VEH_TRAIN, etc.
Definition: engine_base.h:40
roadveh.h