Fix #10117: Decrement object burst limit after build check
[openttd-github.git] / src / order_gui.cpp
blob16f5d49447a97fe7955f4db261100bb61a2474e7
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 */
8 /** @file order_gui.cpp GUI related to orders. */
10 #include "stdafx.h"
11 #include "command_func.h"
12 #include "viewport_func.h"
13 #include "depot_map.h"
14 #include "roadveh.h"
15 #include "timetable.h"
16 #include "strings_func.h"
17 #include "company_func.h"
18 #include "widgets/dropdown_type.h"
19 #include "widgets/dropdown_func.h"
20 #include "textbuf_gui.h"
21 #include "string_func.h"
22 #include "tilehighlight_func.h"
23 #include "network/network.h"
24 #include "station_base.h"
25 #include "industry.h"
26 #include "waypoint_base.h"
27 #include "core/geometry_func.hpp"
28 #include "hotkeys.h"
29 #include "aircraft.h"
30 #include "engine_func.h"
31 #include "vehicle_func.h"
32 #include "order_cmd.h"
33 #include "company_cmd.h"
35 #include "widgets/order_widget.h"
37 #include "safeguards.h"
40 /** Order load types that could be given to station orders. */
41 static const StringID _station_load_types[][5][5] = {
43 /* No refitting. */
45 STR_EMPTY,
46 INVALID_STRING_ID,
47 STR_ORDER_FULL_LOAD,
48 STR_ORDER_FULL_LOAD_ANY,
49 STR_ORDER_NO_LOAD,
50 }, {
51 STR_ORDER_UNLOAD,
52 INVALID_STRING_ID,
53 STR_ORDER_UNLOAD_FULL_LOAD,
54 STR_ORDER_UNLOAD_FULL_LOAD_ANY,
55 STR_ORDER_UNLOAD_NO_LOAD,
56 }, {
57 STR_ORDER_TRANSFER,
58 INVALID_STRING_ID,
59 STR_ORDER_TRANSFER_FULL_LOAD,
60 STR_ORDER_TRANSFER_FULL_LOAD_ANY,
61 STR_ORDER_TRANSFER_NO_LOAD,
62 }, {
63 /* Unload and transfer do not work together. */
64 INVALID_STRING_ID,
65 INVALID_STRING_ID,
66 INVALID_STRING_ID,
67 INVALID_STRING_ID,
68 }, {
69 STR_ORDER_NO_UNLOAD,
70 INVALID_STRING_ID,
71 STR_ORDER_NO_UNLOAD_FULL_LOAD,
72 STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY,
73 STR_ORDER_NO_UNLOAD_NO_LOAD,
75 }, {
76 /* With auto-refitting. No loading and auto-refitting do not work together. */
78 STR_ORDER_AUTO_REFIT,
79 INVALID_STRING_ID,
80 STR_ORDER_FULL_LOAD_REFIT,
81 STR_ORDER_FULL_LOAD_ANY_REFIT,
82 INVALID_STRING_ID,
83 }, {
84 STR_ORDER_UNLOAD_REFIT,
85 INVALID_STRING_ID,
86 STR_ORDER_UNLOAD_FULL_LOAD_REFIT,
87 STR_ORDER_UNLOAD_FULL_LOAD_ANY_REFIT,
88 INVALID_STRING_ID,
89 }, {
90 STR_ORDER_TRANSFER_REFIT,
91 INVALID_STRING_ID,
92 STR_ORDER_TRANSFER_FULL_LOAD_REFIT,
93 STR_ORDER_TRANSFER_FULL_LOAD_ANY_REFIT,
94 INVALID_STRING_ID,
95 }, {
96 /* Unload and transfer do not work together. */
97 INVALID_STRING_ID,
98 INVALID_STRING_ID,
99 INVALID_STRING_ID,
100 INVALID_STRING_ID,
101 }, {
102 STR_ORDER_NO_UNLOAD_REFIT,
103 INVALID_STRING_ID,
104 STR_ORDER_NO_UNLOAD_FULL_LOAD_REFIT,
105 STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY_REFIT,
106 INVALID_STRING_ID,
111 static const StringID _order_non_stop_drowdown[] = {
112 STR_ORDER_GO_TO,
113 STR_ORDER_GO_NON_STOP_TO,
114 STR_ORDER_GO_VIA,
115 STR_ORDER_GO_NON_STOP_VIA,
116 INVALID_STRING_ID
119 static const StringID _order_full_load_drowdown[] = {
120 STR_ORDER_DROP_LOAD_IF_POSSIBLE,
121 STR_EMPTY,
122 STR_ORDER_DROP_FULL_LOAD_ALL,
123 STR_ORDER_DROP_FULL_LOAD_ANY,
124 STR_ORDER_DROP_NO_LOADING,
125 INVALID_STRING_ID
128 static const StringID _order_unload_drowdown[] = {
129 STR_ORDER_DROP_UNLOAD_IF_ACCEPTED,
130 STR_ORDER_DROP_UNLOAD,
131 STR_ORDER_DROP_TRANSFER,
132 STR_EMPTY,
133 STR_ORDER_DROP_NO_UNLOADING,
134 INVALID_STRING_ID
137 static const StringID _order_goto_dropdown[] = {
138 STR_ORDER_GO_TO,
139 STR_ORDER_GO_TO_NEAREST_DEPOT,
140 STR_ORDER_CONDITIONAL,
141 STR_ORDER_SHARE,
142 INVALID_STRING_ID
145 static const StringID _order_goto_dropdown_aircraft[] = {
146 STR_ORDER_GO_TO,
147 STR_ORDER_GO_TO_NEAREST_HANGAR,
148 STR_ORDER_CONDITIONAL,
149 STR_ORDER_SHARE,
150 INVALID_STRING_ID
153 /** Variables for conditional orders; this defines the order of appearance in the dropdown box */
154 static const OrderConditionVariable _order_conditional_variable[] = {
155 OCV_LOAD_PERCENTAGE,
156 OCV_RELIABILITY,
157 OCV_MAX_RELIABILITY,
158 OCV_MAX_SPEED,
159 OCV_AGE,
160 OCV_REMAINING_LIFETIME,
161 OCV_REQUIRES_SERVICE,
162 OCV_UNCONDITIONALLY,
165 static const StringID _order_conditional_condition[] = {
166 STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS,
167 STR_ORDER_CONDITIONAL_COMPARATOR_NOT_EQUALS,
168 STR_ORDER_CONDITIONAL_COMPARATOR_LESS_THAN,
169 STR_ORDER_CONDITIONAL_COMPARATOR_LESS_EQUALS,
170 STR_ORDER_CONDITIONAL_COMPARATOR_MORE_THAN,
171 STR_ORDER_CONDITIONAL_COMPARATOR_MORE_EQUALS,
172 STR_ORDER_CONDITIONAL_COMPARATOR_IS_TRUE,
173 STR_ORDER_CONDITIONAL_COMPARATOR_IS_FALSE,
174 INVALID_STRING_ID,
177 extern uint ConvertSpeedToDisplaySpeed(uint speed);
178 extern uint ConvertDisplaySpeedToSpeed(uint speed);
180 static const StringID _order_depot_action_dropdown[] = {
181 STR_ORDER_DROP_GO_ALWAYS_DEPOT,
182 STR_ORDER_DROP_SERVICE_DEPOT,
183 STR_ORDER_DROP_HALT_DEPOT,
184 INVALID_STRING_ID
187 static int DepotActionStringIndex(const Order *order)
189 if (order->GetDepotActionType() & ODATFB_HALT) {
190 return DA_STOP;
191 } else if (order->GetDepotOrderType() & ODTFB_SERVICE) {
192 return DA_SERVICE;
193 } else {
194 return DA_ALWAYS_GO;
198 static const StringID _order_refit_action_dropdown[] = {
199 STR_ORDER_DROP_REFIT_AUTO,
200 STR_ORDER_DROP_REFIT_AUTO_ANY,
201 INVALID_STRING_ID
205 * Draws an order in order or timetable GUI
206 * @param v Vehicle the order belongs to
207 * @param order The order to draw
208 * @param order_index Index of the order in the orders of the vehicle
209 * @param y Y position for drawing
210 * @param selected True, if the order is selected
211 * @param timetable True, when drawing in the timetable GUI
212 * @param left Left border for text drawing
213 * @param middle X position between order index and order text
214 * @param right Right border for text drawing
216 void DrawOrderString(const Vehicle *v, const Order *order, int order_index, int y, bool selected, bool timetable, int left, int middle, int right)
218 bool rtl = _current_text_dir == TD_RTL;
220 SpriteID sprite = rtl ? SPR_ARROW_LEFT : SPR_ARROW_RIGHT;
221 Dimension sprite_size = GetSpriteSize(sprite);
222 if (v->cur_real_order_index == order_index) {
223 DrawSprite(sprite, PAL_NONE, rtl ? right - sprite_size.width : left, y + ((int)FONT_HEIGHT_NORMAL - (int)sprite_size.height) / 2);
224 DrawSprite(sprite, PAL_NONE, rtl ? right - 2 * sprite_size.width : left + sprite_size.width, y + ((int)FONT_HEIGHT_NORMAL - (int)sprite_size.height) / 2);
225 } else if (v->cur_implicit_order_index == order_index) {
226 DrawSprite(sprite, PAL_NONE, rtl ? right - sprite_size.width : left, y + ((int)FONT_HEIGHT_NORMAL - (int)sprite_size.height) / 2);
229 TextColour colour = TC_BLACK;
230 if (order->IsType(OT_IMPLICIT)) {
231 colour = (selected ? TC_SILVER : TC_GREY) | TC_NO_SHADE;
232 } else if (selected) {
233 colour = TC_WHITE;
236 SetDParam(0, order_index + 1);
237 DrawString(left, rtl ? right - 2 * sprite_size.width - 3 : middle, y, STR_ORDER_INDEX, colour, SA_RIGHT | SA_FORCE);
239 SetDParam(5, STR_EMPTY);
240 SetDParam(8, STR_EMPTY);
242 /* Check range for aircraft. */
243 if (v->type == VEH_AIRCRAFT && Aircraft::From(v)->GetRange() > 0 && order->IsGotoOrder()) {
244 const Order *next = order->next != nullptr ? order->next : v->GetFirstOrder();
245 if (GetOrderDistance(order, next, v) > Aircraft::From(v)->acache.cached_max_range_sqr) SetDParam(8, STR_ORDER_OUT_OF_RANGE);
248 switch (order->GetType()) {
249 case OT_DUMMY:
250 SetDParam(0, STR_INVALID_ORDER);
251 SetDParam(1, order->GetDestination());
252 break;
254 case OT_IMPLICIT:
255 SetDParam(0, STR_ORDER_GO_TO_STATION);
256 SetDParam(1, STR_ORDER_GO_TO);
257 SetDParam(2, order->GetDestination());
258 SetDParam(3, timetable ? STR_EMPTY : STR_ORDER_IMPLICIT);
259 break;
261 case OT_GOTO_STATION: {
262 OrderLoadFlags load = order->GetLoadType();
263 OrderUnloadFlags unload = order->GetUnloadType();
264 bool valid_station = CanVehicleUseStation(v, Station::Get(order->GetDestination()));
266 SetDParam(0, valid_station ? STR_ORDER_GO_TO_STATION : STR_ORDER_GO_TO_STATION_CAN_T_USE_STATION);
267 SetDParam(1, STR_ORDER_GO_TO + (v->IsGroundVehicle() ? order->GetNonStopType() : 0));
268 SetDParam(2, order->GetDestination());
270 if (timetable) {
271 SetDParam(3, STR_EMPTY);
273 if (order->GetWaitTime() > 0) {
274 SetDParam(5, order->IsWaitTimetabled() ? STR_TIMETABLE_STAY_FOR : STR_TIMETABLE_STAY_FOR_ESTIMATED);
275 SetTimetableParams(6, 7, order->GetWaitTime());
277 } else {
278 SetDParam(3, (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) ? STR_EMPTY : _station_load_types[order->IsRefit()][unload][load]);
279 if (order->IsRefit()) {
280 SetDParam(4, order->IsAutoRefit() ? STR_ORDER_AUTO_REFIT_ANY : CargoSpec::Get(order->GetRefitCargo())->name);
282 if (v->type == VEH_TRAIN && (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) == 0) {
283 SetDParam(5, order->GetStopLocation() + STR_ORDER_STOP_LOCATION_NEAR_END);
286 break;
289 case OT_GOTO_DEPOT:
290 if (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) {
291 SetDParam(0, STR_ORDER_GO_TO_NEAREST_DEPOT_FORMAT);
292 if (v->type == VEH_AIRCRAFT) {
293 SetDParam(2, STR_ORDER_NEAREST_HANGAR);
294 SetDParam(3, STR_EMPTY);
295 } else {
296 SetDParam(2, STR_ORDER_NEAREST_DEPOT);
297 SetDParam(3, STR_ORDER_TRAIN_DEPOT + v->type);
299 } else {
300 SetDParam(0, STR_ORDER_GO_TO_DEPOT_FORMAT);
301 SetDParam(2, v->type);
302 SetDParam(3, order->GetDestination());
305 if (order->GetDepotOrderType() & ODTFB_SERVICE) {
306 SetDParam(1, (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_ORDER_SERVICE_NON_STOP_AT : STR_ORDER_SERVICE_AT);
307 } else {
308 SetDParam(1, (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_ORDER_GO_NON_STOP_TO : STR_ORDER_GO_TO);
311 if (!timetable && (order->GetDepotActionType() & ODATFB_HALT)) {
312 SetDParam(5, STR_ORDER_STOP_ORDER);
315 if (!timetable && order->IsRefit()) {
316 SetDParam(5, (order->GetDepotActionType() & ODATFB_HALT) ? STR_ORDER_REFIT_STOP_ORDER : STR_ORDER_REFIT_ORDER);
317 SetDParam(6, CargoSpec::Get(order->GetRefitCargo())->name);
319 break;
321 case OT_GOTO_WAYPOINT:
322 SetDParam(0, (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_ORDER_GO_NON_STOP_TO_WAYPOINT : STR_ORDER_GO_TO_WAYPOINT);
323 SetDParam(1, order->GetDestination());
324 break;
326 case OT_CONDITIONAL:
327 SetDParam(1, order->GetConditionSkipToOrder() + 1);
328 if (order->GetConditionVariable() == OCV_UNCONDITIONALLY) {
329 SetDParam(0, STR_ORDER_CONDITIONAL_UNCONDITIONAL);
330 } else {
331 OrderConditionComparator occ = order->GetConditionComparator();
332 SetDParam(0, (occ == OCC_IS_TRUE || occ == OCC_IS_FALSE) ? STR_ORDER_CONDITIONAL_TRUE_FALSE : STR_ORDER_CONDITIONAL_NUM);
333 SetDParam(2, STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE + order->GetConditionVariable());
334 SetDParam(3, STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS + occ);
336 uint value = order->GetConditionValue();
337 if (order->GetConditionVariable() == OCV_MAX_SPEED) value = ConvertSpeedToDisplaySpeed(value);
338 SetDParam(4, value);
341 if (timetable && order->GetWaitTime() > 0) {
342 SetDParam(5, order->IsWaitTimetabled() ? STR_TIMETABLE_AND_TRAVEL_FOR : STR_TIMETABLE_AND_TRAVEL_FOR_ESTIMATED);
343 SetTimetableParams(6, 7, order->GetWaitTime());
344 } else {
345 SetDParam(5, STR_EMPTY);
347 break;
349 default: NOT_REACHED();
352 DrawString(rtl ? left : middle, rtl ? middle : right, y, STR_ORDER_TEXT, colour);
356 * Get the order command a vehicle can do in a given tile.
357 * @param v Vehicle involved.
358 * @param tile Tile being queried.
359 * @return The order associated to vehicle v in given tile (or empty order if vehicle can do nothing in the tile).
361 static Order GetOrderCmdFromTile(const Vehicle *v, TileIndex tile)
363 /* Hack-ish; unpack order 0, so everything gets initialised with either zero
364 * or a suitable default value for the variable. Then also override the index
365 * as it is not coming from a pool, so would be initialised. */
366 Order order(0);
367 order.index = 0;
369 /* check depot first */
370 if (IsDepotTypeTile(tile, (TransportType)(uint)v->type) && IsTileOwner(tile, _local_company)) {
371 order.MakeGoToDepot(v->type == VEH_AIRCRAFT ? GetStationIndex(tile) : GetDepotIndex(tile),
372 ODTFB_PART_OF_ORDERS,
373 (_settings_client.gui.new_nonstop && v->IsGroundVehicle()) ? ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS : ONSF_STOP_EVERYWHERE);
375 if (_ctrl_pressed) order.SetDepotOrderType((OrderDepotTypeFlags)(order.GetDepotOrderType() ^ ODTFB_SERVICE));
377 return order;
380 /* check rail waypoint */
381 if (IsRailWaypointTile(tile) &&
382 v->type == VEH_TRAIN &&
383 IsTileOwner(tile, _local_company)) {
384 order.MakeGoToWaypoint(GetStationIndex(tile));
385 if (_settings_client.gui.new_nonstop != _ctrl_pressed) order.SetNonStopType(ONSF_NO_STOP_AT_ANY_STATION);
386 return order;
389 /* check buoy (no ownership) */
390 if (IsBuoyTile(tile) && v->type == VEH_SHIP) {
391 order.MakeGoToWaypoint(GetStationIndex(tile));
392 return order;
395 /* check for station or industry with neutral station */
396 if (IsTileType(tile, MP_STATION) || IsTileType(tile, MP_INDUSTRY)) {
397 const Station *st = nullptr;
399 if (IsTileType(tile, MP_STATION)) {
400 st = Station::GetByTile(tile);
401 } else {
402 const Industry *in = Industry::GetByTile(tile);
403 st = in->neutral_station;
405 if (st != nullptr && (st->owner == _local_company || st->owner == OWNER_NONE)) {
406 byte facil;
407 switch (v->type) {
408 case VEH_SHIP: facil = FACIL_DOCK; break;
409 case VEH_TRAIN: facil = FACIL_TRAIN; break;
410 case VEH_AIRCRAFT: facil = FACIL_AIRPORT; break;
411 case VEH_ROAD: facil = FACIL_BUS_STOP | FACIL_TRUCK_STOP; break;
412 default: NOT_REACHED();
414 if (st->facilities & facil) {
415 order.MakeGoToStation(st->index);
416 if (_ctrl_pressed) order.SetLoadType(OLF_FULL_LOAD_ANY);
417 if (_settings_client.gui.new_nonstop && v->IsGroundVehicle()) order.SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);
418 order.SetStopLocation(v->type == VEH_TRAIN ? (OrderStopLocation)(_settings_client.gui.stop_location) : OSL_PLATFORM_FAR_END);
419 return order;
424 /* not found */
425 order.Free();
426 return order;
429 /** Hotkeys for order window. */
430 enum {
431 OHK_SKIP,
432 OHK_DELETE,
433 OHK_GOTO,
434 OHK_NONSTOP,
435 OHK_FULLLOAD,
436 OHK_UNLOAD,
437 OHK_NEAREST_DEPOT,
438 OHK_ALWAYS_SERVICE,
439 OHK_TRANSFER,
440 OHK_NO_UNLOAD,
441 OHK_NO_LOAD,
445 * %Order window code for all vehicles.
447 * At the bottom of the window two button rows are located for changing the orders of the vehicle.
449 * \section top-row Top row
450 * The top-row is for manipulating an individual order. What row is displayed depends on the type of vehicle, and whether or not you are the owner of the vehicle.
452 * The top-row buttons of one of your trains or road vehicles is one of the following three cases:
453 * \verbatim
454 * +-----------------+-----------------+-----------------+-----------------+
455 * | NON-STOP | FULL_LOAD | UNLOAD | REFIT | (normal)
456 * +-----------------+-----+-----------+-----------+-----+-----------------+
457 * | COND_VAR | COND_COMPARATOR | COND_VALUE | (for conditional orders)
458 * +-----------------+-----+-----------+-----------+-----+-----------------+
459 * | NON-STOP | REFIT | SERVICE | (empty) | (for depot orders)
460 * +-----------------+-----------------+-----------------+-----------------+
461 * \endverbatim
463 * Airplanes and ships have one of the following three top-row button rows:
464 * \verbatim
465 * +-----------------+-----------------+-----------------+
466 * | FULL_LOAD | UNLOAD | REFIT | (normal)
467 * +-----------------+-----------------+-----------------+
468 * | COND_VAR | COND_COMPARATOR | COND_VALUE | (for conditional orders)
469 * +-----------------+--------+--------+-----------------+
470 * | REFIT | SERVICE | (for depot order)
471 * +--------------------------+--------------------------+
472 * \endverbatim
474 * \section bottom-row Bottom row
475 * The second row (the bottom row) is for manipulating the list of orders:
476 * \verbatim
477 * +-----------------+-----------------+-----------------+
478 * | SKIP | DELETE | GOTO |
479 * +-----------------+-----------------+-----------------+
480 * \endverbatim
482 * For vehicles of other companies, both button rows are not displayed.
484 struct OrdersWindow : public Window {
485 private:
486 /** Under what reason are we using the PlaceObject functionality? */
487 enum OrderPlaceObjectState {
488 OPOS_NONE,
489 OPOS_GOTO,
490 OPOS_CONDITIONAL,
491 OPOS_SHARE,
492 OPOS_END,
495 /** Displayed planes of the #NWID_SELECTION widgets. */
496 enum DisplayPane {
497 /* WID_O_SEL_TOP_ROW_GROUNDVEHICLE */
498 DP_GROUNDVEHICLE_ROW_NORMAL = 0, ///< Display the row for normal/depot orders in the top row of the train/rv order window.
499 DP_GROUNDVEHICLE_ROW_CONDITIONAL = 1, ///< Display the row for conditional orders in the top row of the train/rv order window.
501 /* WID_O_SEL_TOP_LEFT */
502 DP_LEFT_LOAD = 0, ///< Display 'load' in the left button of the top row of the train/rv order window.
503 DP_LEFT_REFIT = 1, ///< Display 'refit' in the left button of the top row of the train/rv order window.
505 /* WID_O_SEL_TOP_MIDDLE */
506 DP_MIDDLE_UNLOAD = 0, ///< Display 'unload' in the middle button of the top row of the train/rv order window.
507 DP_MIDDLE_SERVICE = 1, ///< Display 'service' in the middle button of the top row of the train/rv order window.
509 /* WID_O_SEL_TOP_RIGHT */
510 DP_RIGHT_EMPTY = 0, ///< Display an empty panel in the right button of the top row of the train/rv order window.
511 DP_RIGHT_REFIT = 1, ///< Display 'refit' in the right button of the top row of the train/rv order window.
513 /* WID_O_SEL_TOP_ROW */
514 DP_ROW_LOAD = 0, ///< Display 'load' / 'unload' / 'refit' buttons in the top row of the ship/airplane order window.
515 DP_ROW_DEPOT = 1, ///< Display 'refit' / 'service' buttons in the top row of the ship/airplane order window.
516 DP_ROW_CONDITIONAL = 2, ///< Display the conditional order buttons in the top row of the ship/airplane order window.
518 /* WID_O_SEL_BOTTOM_MIDDLE */
519 DP_BOTTOM_MIDDLE_DELETE = 0, ///< Display 'delete' in the middle button of the bottom row of the vehicle order window.
520 DP_BOTTOM_MIDDLE_STOP_SHARING = 1, ///< Display 'stop sharing' in the middle button of the bottom row of the vehicle order window.
523 int selected_order;
524 VehicleOrderID order_over; ///< Order over which another order is dragged, \c INVALID_VEH_ORDER_ID if none.
525 OrderPlaceObjectState goto_type;
526 const Vehicle *vehicle; ///< Vehicle owning the orders being displayed and manipulated.
527 Scrollbar *vscroll;
528 bool can_do_refit; ///< Vehicle chain can be refitted in depot.
529 bool can_do_autorefit; ///< Vehicle chain can be auto-refitted.
532 * Return the memorised selected order.
533 * @return the memorised order if it is a valid one
534 * else return the number of orders
536 VehicleOrderID OrderGetSel() const
538 int num = this->selected_order;
539 return (num >= 0 && num < vehicle->GetNumOrders()) ? num : vehicle->GetNumOrders();
543 * Calculate the selected order.
544 * The calculation is based on the relative (to the window) y click position and
545 * the position of the scrollbar.
547 * @param y Y-value of the click relative to the window origin
548 * @return The selected order if the order is valid, else return \c INVALID_VEH_ORDER_ID.
550 VehicleOrderID GetOrderFromPt(int y)
552 NWidgetBase *nwid = this->GetWidget<NWidgetBase>(WID_O_ORDER_LIST);
553 uint sel = (y - nwid->pos_y - WD_FRAMERECT_TOP) / nwid->resize_y; // Selected line in the WID_O_ORDER_LIST panel.
555 if (sel >= this->vscroll->GetCapacity()) return INVALID_VEH_ORDER_ID;
557 sel += this->vscroll->GetPosition();
559 return (sel <= vehicle->GetNumOrders()) ? sel : INVALID_VEH_ORDER_ID;
563 * Handle the click on the goto button.
565 void OrderClick_Goto(OrderPlaceObjectState type)
567 assert(type > OPOS_NONE && type < OPOS_END);
569 static const HighLightStyle goto_place_style[OPOS_END - 1] = {
570 HT_RECT | HT_VEHICLE, // OPOS_GOTO
571 HT_NONE, // OPOS_CONDITIONAL
572 HT_VEHICLE, // OPOS_SHARE
574 SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, goto_place_style[type - 1], this);
575 this->goto_type = type;
576 this->SetWidgetDirty(WID_O_GOTO);
580 * Handle the click on the full load button.
581 * @param load_type Load flag to apply. If matches existing load type, toggles to default of 'load if possible'.
582 * @param toggle If we toggle or not (used for hotkey behavior)
584 void OrderClick_FullLoad(OrderLoadFlags load_type, bool toggle = false)
586 VehicleOrderID sel_ord = this->OrderGetSel();
587 const Order *order = this->vehicle->GetOrder(sel_ord);
589 if (order == nullptr) return;
591 if (toggle && order->GetLoadType() == load_type) {
592 load_type = OLF_LOAD_IF_POSSIBLE; // reset to 'default'
594 if (order->GetLoadType() == load_type) return; // If we still match, do nothing
596 Command<CMD_MODIFY_ORDER>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, sel_ord, MOF_LOAD, load_type);
600 * Handle the click on the service.
602 void OrderClick_Service(int i)
604 VehicleOrderID sel_ord = this->OrderGetSel();
606 if (i < 0) {
607 const Order *order = this->vehicle->GetOrder(sel_ord);
608 if (order == nullptr) return;
609 i = (order->GetDepotOrderType() & ODTFB_SERVICE) ? DA_ALWAYS_GO : DA_SERVICE;
611 Command<CMD_MODIFY_ORDER>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, sel_ord, MOF_DEPOT_ACTION, i);
615 * Handle the click on the service in nearest depot button.
617 void OrderClick_NearestDepot()
619 Order order;
620 order.next = nullptr;
621 order.index = 0;
622 order.MakeGoToDepot(INVALID_DEPOT, ODTFB_PART_OF_ORDERS,
623 _settings_client.gui.new_nonstop && this->vehicle->IsGroundVehicle() ? ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS : ONSF_STOP_EVERYWHERE);
624 order.SetDepotActionType(ODATFB_NEAREST_DEPOT);
626 Command<CMD_INSERT_ORDER>::Post(STR_ERROR_CAN_T_INSERT_NEW_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), order);
630 * Handle the click on the unload button.
631 * @param unload_type Unload flag to apply. If matches existing unload type, toggles to default of 'unload if possible'.
632 * @param toggle If we toggle or not (used for hotkey behavior)
634 void OrderClick_Unload(OrderUnloadFlags unload_type, bool toggle = false)
636 VehicleOrderID sel_ord = this->OrderGetSel();
637 const Order *order = this->vehicle->GetOrder(sel_ord);
639 if (order == nullptr) return;
641 if (toggle && order->GetUnloadType() == unload_type) {
642 unload_type = OUF_UNLOAD_IF_POSSIBLE;
644 if (order->GetUnloadType() == unload_type) return; // If we still match, do nothing
646 Command<CMD_MODIFY_ORDER>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, sel_ord, MOF_UNLOAD, unload_type);
648 /* Transfer and unload orders with leave empty as default */
649 if (unload_type == OUFB_TRANSFER || unload_type == OUFB_UNLOAD) {
650 Command<CMD_MODIFY_ORDER>::Post(this->vehicle->tile, this->vehicle->index, sel_ord, MOF_LOAD, OLFB_NO_LOAD);
651 this->SetWidgetDirty(WID_O_FULL_LOAD);
656 * Handle the click on the nonstop button.
657 * @param non_stop what non-stop type to use; -1 to use the 'next' one.
659 void OrderClick_Nonstop(int non_stop)
661 if (!this->vehicle->IsGroundVehicle()) return;
663 VehicleOrderID sel_ord = this->OrderGetSel();
664 const Order *order = this->vehicle->GetOrder(sel_ord);
666 if (order == nullptr || order->GetNonStopType() == non_stop) return;
668 /* Keypress if negative, so 'toggle' to the next */
669 if (non_stop < 0) {
670 non_stop = order->GetNonStopType() ^ ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS;
673 this->SetWidgetDirty(WID_O_NON_STOP);
674 Command<CMD_MODIFY_ORDER>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, sel_ord, MOF_NON_STOP, non_stop);
678 * Handle the click on the skip button.
679 * If ctrl is pressed, skip to selected order, else skip to current order + 1
681 void OrderClick_Skip()
683 /* Don't skip when there's nothing to skip */
684 if (_ctrl_pressed && this->vehicle->cur_implicit_order_index == this->OrderGetSel()) return;
685 if (this->vehicle->GetNumOrders() <= 1) return;
687 Command<CMD_SKIP_TO_ORDER>::Post(_ctrl_pressed ? STR_ERROR_CAN_T_SKIP_TO_ORDER : STR_ERROR_CAN_T_SKIP_ORDER,
688 this->vehicle->tile, this->vehicle->index, _ctrl_pressed ? this->OrderGetSel() : ((this->vehicle->cur_implicit_order_index + 1) % this->vehicle->GetNumOrders()));
692 * Handle the click on the delete button.
694 void OrderClick_Delete()
696 /* When networking, move one order lower */
697 int selected = this->selected_order + (int)_networking;
699 if (Command<CMD_DELETE_ORDER>::Post(STR_ERROR_CAN_T_DELETE_THIS_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel())) {
700 this->selected_order = selected >= this->vehicle->GetNumOrders() ? -1 : selected;
701 this->UpdateButtonState();
706 * Handle the click on the 'stop sharing' button.
707 * If 'End of Shared Orders' isn't selected, do nothing. If Ctrl is pressed, call OrderClick_Delete and exit.
708 * To stop sharing this vehicle order list, we copy the orders of a vehicle that share this order list. That way we
709 * exit the group of shared vehicles while keeping the same order list.
711 void OrderClick_StopSharing()
713 /* Don't try to stop sharing orders if 'End of Shared Orders' isn't selected. */
714 if (!this->vehicle->IsOrderListShared() || this->selected_order != this->vehicle->GetNumOrders()) return;
715 /* If Ctrl is pressed, delete the order list as if we clicked the 'Delete' button. */
716 if (_ctrl_pressed) {
717 this->OrderClick_Delete();
718 return;
721 /* Get another vehicle that share orders with this vehicle. */
722 Vehicle *other_shared = (this->vehicle->FirstShared() == this->vehicle) ? this->vehicle->NextShared() : this->vehicle->PreviousShared();
723 /* Copy the order list of the other vehicle. */
724 if (Command<CMD_CLONE_ORDER>::Post(STR_ERROR_CAN_T_STOP_SHARING_ORDER_LIST, this->vehicle->tile, CO_COPY, this->vehicle->index, other_shared->index)) {
725 this->UpdateButtonState();
730 * Handle the click on the refit button.
731 * If ctrl is pressed, cancel refitting, else show the refit window.
732 * @param i Selected refit command.
733 * @param auto_refit Select refit for auto-refitting.
735 void OrderClick_Refit(int i, bool auto_refit)
737 if (_ctrl_pressed) {
738 /* Cancel refitting */
739 Command<CMD_ORDER_REFIT>::Post(this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), CT_NO_REFIT);
740 } else {
741 if (i == 1) { // Auto-refit to available cargo type.
742 Command<CMD_ORDER_REFIT>::Post(this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), CT_AUTO_REFIT);
743 } else {
744 ShowVehicleRefitWindow(this->vehicle, this->OrderGetSel(), this, auto_refit);
749 /** Cache auto-refittability of the vehicle chain. */
750 void UpdateAutoRefitState()
752 this->can_do_refit = false;
753 this->can_do_autorefit = false;
754 for (const Vehicle *w = this->vehicle; w != nullptr; w = w->IsGroundVehicle() ? w->Next() : nullptr) {
755 if (IsEngineRefittable(w->engine_type)) this->can_do_refit = true;
756 if (HasBit(Engine::Get(w->engine_type)->info.misc_flags, EF_AUTO_REFIT)) this->can_do_autorefit = true;
760 public:
761 OrdersWindow(WindowDesc *desc, const Vehicle *v) : Window(desc)
763 this->vehicle = v;
765 this->CreateNestedTree();
766 this->vscroll = this->GetScrollbar(WID_O_SCROLLBAR);
767 this->FinishInitNested(v->index);
768 if (v->owner == _local_company) {
769 this->DisableWidget(WID_O_EMPTY);
772 this->selected_order = -1;
773 this->order_over = INVALID_VEH_ORDER_ID;
774 this->goto_type = OPOS_NONE;
775 this->owner = v->owner;
777 this->UpdateAutoRefitState();
779 if (_settings_client.gui.quick_goto && v->owner == _local_company) {
780 /* If there are less than 2 station, make Go To active. */
781 int station_orders = 0;
782 for(const Order *order : v->Orders()) {
783 if (order->IsType(OT_GOTO_STATION)) station_orders++;
786 if (station_orders < 2) this->OrderClick_Goto(OPOS_GOTO);
788 this->OnInvalidateData(VIWD_MODIFY_ORDERS);
791 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
793 switch (widget) {
794 case WID_O_ORDER_LIST:
795 resize->height = FONT_HEIGHT_NORMAL;
796 size->height = 6 * resize->height + WD_FRAMERECT_TOP + WD_FRAMERECT_BOTTOM;
797 break;
799 case WID_O_COND_VARIABLE: {
800 Dimension d = {0, 0};
801 for (uint i = 0; i < lengthof(_order_conditional_variable); i++) {
802 d = maxdim(d, GetStringBoundingBox(STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE + _order_conditional_variable[i]));
804 d.width += padding.width;
805 d.height += padding.height;
806 *size = maxdim(*size, d);
807 break;
810 case WID_O_COND_COMPARATOR: {
811 Dimension d = {0, 0};
812 for (int i = 0; _order_conditional_condition[i] != INVALID_STRING_ID; i++) {
813 d = maxdim(d, GetStringBoundingBox(_order_conditional_condition[i]));
815 d.width += padding.width;
816 d.height += padding.height;
817 *size = maxdim(*size, d);
818 break;
824 * Some data on this window has become invalid.
825 * @param data Information about the changed data.
826 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
828 void OnInvalidateData(int data = 0, bool gui_scope = true) override
830 VehicleOrderID from = INVALID_VEH_ORDER_ID;
831 VehicleOrderID to = INVALID_VEH_ORDER_ID;
833 switch (data) {
834 case VIWD_AUTOREPLACE:
835 /* Autoreplace replaced the vehicle */
836 this->vehicle = Vehicle::Get(this->window_number);
837 FALLTHROUGH;
839 case VIWD_CONSIST_CHANGED:
840 /* Vehicle composition was changed. */
841 this->UpdateAutoRefitState();
842 break;
844 case VIWD_REMOVE_ALL_ORDERS:
845 /* Removed / replaced all orders (after deleting / sharing) */
846 if (this->selected_order == -1) break;
848 this->CloseChildWindows();
849 HideDropDownMenu(this);
850 this->selected_order = -1;
851 break;
853 case VIWD_MODIFY_ORDERS:
854 /* Some other order changes */
855 break;
857 default:
858 if (data < 0) break;
860 if (gui_scope) break; // only do this once; from command scope
861 from = GB(data, 0, 8);
862 to = GB(data, 8, 8);
863 /* Moving an order. If one of these is INVALID_VEH_ORDER_ID, then
864 * the order is being created / removed */
865 if (this->selected_order == -1) break;
867 if (from == to) break; // no need to change anything
869 if (from != this->selected_order) {
870 /* Moving from preceding order? */
871 this->selected_order -= (int)(from <= this->selected_order);
872 /* Moving to preceding order? */
873 this->selected_order += (int)(to <= this->selected_order);
874 break;
877 /* Now we are modifying the selected order */
878 if (to == INVALID_VEH_ORDER_ID) {
879 /* Deleting selected order */
880 this->CloseChildWindows();
881 HideDropDownMenu(this);
882 this->selected_order = -1;
883 break;
886 /* Moving selected order */
887 this->selected_order = to;
888 break;
891 this->vscroll->SetCount(this->vehicle->GetNumOrders() + 1);
892 if (gui_scope) this->UpdateButtonState();
894 /* Scroll to the new order. */
895 if (from == INVALID_VEH_ORDER_ID && to != INVALID_VEH_ORDER_ID && !this->vscroll->IsVisible(to)) {
896 this->vscroll->ScrollTowards(to);
900 void UpdateButtonState()
902 if (this->vehicle->owner != _local_company) return; // No buttons are displayed with competitor order windows.
904 bool shared_orders = this->vehicle->IsOrderListShared();
905 VehicleOrderID sel = this->OrderGetSel();
906 const Order *order = this->vehicle->GetOrder(sel);
908 /* Second row. */
909 /* skip */
910 this->SetWidgetDisabledState(WID_O_SKIP, this->vehicle->GetNumOrders() <= 1);
912 /* delete / stop sharing */
913 NWidgetStacked *delete_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_BOTTOM_MIDDLE);
914 if (shared_orders && this->selected_order == this->vehicle->GetNumOrders()) {
915 /* The 'End of Shared Orders' order is selected, show the 'stop sharing' button. */
916 delete_sel->SetDisplayedPlane(DP_BOTTOM_MIDDLE_STOP_SHARING);
917 } else {
918 /* The 'End of Shared Orders' order isn't selected, show the 'delete' button. */
919 delete_sel->SetDisplayedPlane(DP_BOTTOM_MIDDLE_DELETE);
920 this->SetWidgetDisabledState(WID_O_DELETE,
921 (uint)this->vehicle->GetNumOrders() + ((shared_orders || this->vehicle->GetNumOrders() != 0) ? 1 : 0) <= (uint)this->selected_order);
923 /* Set the tooltip of the 'delete' button depending on whether the
924 * 'End of Orders' order or a regular order is selected. */
925 NWidgetCore *nwi = this->GetWidget<NWidgetCore>(WID_O_DELETE);
926 if (this->selected_order == this->vehicle->GetNumOrders()) {
927 nwi->SetDataTip(STR_ORDERS_DELETE_BUTTON, STR_ORDERS_DELETE_ALL_TOOLTIP);
928 } else {
929 nwi->SetDataTip(STR_ORDERS_DELETE_BUTTON, STR_ORDERS_DELETE_TOOLTIP);
933 /* First row. */
934 this->RaiseWidget(WID_O_FULL_LOAD);
935 this->RaiseWidget(WID_O_UNLOAD);
936 this->RaiseWidget(WID_O_SERVICE);
938 /* Selection widgets. */
939 /* Train or road vehicle. */
940 NWidgetStacked *train_row_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_TOP_ROW_GROUNDVEHICLE);
941 NWidgetStacked *left_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_TOP_LEFT);
942 NWidgetStacked *middle_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_TOP_MIDDLE);
943 NWidgetStacked *right_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_TOP_RIGHT);
944 /* Ship or airplane. */
945 NWidgetStacked *row_sel = this->GetWidget<NWidgetStacked>(WID_O_SEL_TOP_ROW);
946 assert(row_sel != nullptr || (train_row_sel != nullptr && left_sel != nullptr && middle_sel != nullptr && right_sel != nullptr));
949 if (order == nullptr) {
950 if (row_sel != nullptr) {
951 row_sel->SetDisplayedPlane(DP_ROW_LOAD);
952 } else {
953 train_row_sel->SetDisplayedPlane(DP_GROUNDVEHICLE_ROW_NORMAL);
954 left_sel->SetDisplayedPlane(DP_LEFT_LOAD);
955 middle_sel->SetDisplayedPlane(DP_MIDDLE_UNLOAD);
956 right_sel->SetDisplayedPlane(DP_RIGHT_EMPTY);
957 this->DisableWidget(WID_O_NON_STOP);
958 this->RaiseWidget(WID_O_NON_STOP);
960 this->DisableWidget(WID_O_FULL_LOAD);
961 this->DisableWidget(WID_O_UNLOAD);
962 this->DisableWidget(WID_O_REFIT_DROPDOWN);
963 } else {
964 this->SetWidgetDisabledState(WID_O_FULL_LOAD, (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) != 0); // full load
965 this->SetWidgetDisabledState(WID_O_UNLOAD, (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) != 0); // unload
967 switch (order->GetType()) {
968 case OT_GOTO_STATION:
969 if (row_sel != nullptr) {
970 row_sel->SetDisplayedPlane(DP_ROW_LOAD);
971 } else {
972 train_row_sel->SetDisplayedPlane(DP_GROUNDVEHICLE_ROW_NORMAL);
973 left_sel->SetDisplayedPlane(DP_LEFT_LOAD);
974 middle_sel->SetDisplayedPlane(DP_MIDDLE_UNLOAD);
975 right_sel->SetDisplayedPlane(DP_RIGHT_REFIT);
976 this->EnableWidget(WID_O_NON_STOP);
977 this->SetWidgetLoweredState(WID_O_NON_STOP, order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);
979 this->SetWidgetLoweredState(WID_O_FULL_LOAD, order->GetLoadType() == OLF_FULL_LOAD_ANY);
980 this->SetWidgetLoweredState(WID_O_UNLOAD, order->GetUnloadType() == OUFB_UNLOAD);
982 /* Can only do refitting when stopping at the destination and loading cargo.
983 * Also enable the button if a refit is already set to allow clearing it. */
984 this->SetWidgetDisabledState(WID_O_REFIT_DROPDOWN,
985 order->GetLoadType() == OLFB_NO_LOAD || (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) ||
986 ((!this->can_do_refit || !this->can_do_autorefit) && !order->IsRefit()));
988 break;
990 case OT_GOTO_WAYPOINT:
991 if (row_sel != nullptr) {
992 row_sel->SetDisplayedPlane(DP_ROW_LOAD);
993 } else {
994 train_row_sel->SetDisplayedPlane(DP_GROUNDVEHICLE_ROW_NORMAL);
995 left_sel->SetDisplayedPlane(DP_LEFT_LOAD);
996 middle_sel->SetDisplayedPlane(DP_MIDDLE_UNLOAD);
997 right_sel->SetDisplayedPlane(DP_RIGHT_EMPTY);
998 this->EnableWidget(WID_O_NON_STOP);
999 this->SetWidgetLoweredState(WID_O_NON_STOP, order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);
1001 this->DisableWidget(WID_O_FULL_LOAD);
1002 this->DisableWidget(WID_O_UNLOAD);
1003 this->DisableWidget(WID_O_REFIT_DROPDOWN);
1004 break;
1006 case OT_GOTO_DEPOT:
1007 if (row_sel != nullptr) {
1008 row_sel->SetDisplayedPlane(DP_ROW_DEPOT);
1009 } else {
1010 train_row_sel->SetDisplayedPlane(DP_GROUNDVEHICLE_ROW_NORMAL);
1011 left_sel->SetDisplayedPlane(DP_LEFT_REFIT);
1012 middle_sel->SetDisplayedPlane(DP_MIDDLE_SERVICE);
1013 right_sel->SetDisplayedPlane(DP_RIGHT_EMPTY);
1014 this->EnableWidget(WID_O_NON_STOP);
1015 this->SetWidgetLoweredState(WID_O_NON_STOP, order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);
1017 /* Disable refit button if the order is no 'always go' order.
1018 * However, keep the service button enabled for refit-orders to allow clearing refits (without knowing about ctrl). */
1019 this->SetWidgetDisabledState(WID_O_REFIT,
1020 (order->GetDepotOrderType() & ODTFB_SERVICE) || (order->GetDepotActionType() & ODATFB_HALT) ||
1021 (!this->can_do_refit && !order->IsRefit()));
1022 this->SetWidgetLoweredState(WID_O_SERVICE, order->GetDepotOrderType() & ODTFB_SERVICE);
1023 break;
1025 case OT_CONDITIONAL: {
1026 if (row_sel != nullptr) {
1027 row_sel->SetDisplayedPlane(DP_ROW_CONDITIONAL);
1028 } else {
1029 train_row_sel->SetDisplayedPlane(DP_GROUNDVEHICLE_ROW_CONDITIONAL);
1031 OrderConditionVariable ocv = order->GetConditionVariable();
1032 /* Set the strings for the dropdown boxes. */
1033 this->GetWidget<NWidgetCore>(WID_O_COND_VARIABLE)->widget_data = STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE + ocv;
1034 this->GetWidget<NWidgetCore>(WID_O_COND_COMPARATOR)->widget_data = _order_conditional_condition[order->GetConditionComparator()];
1035 this->SetWidgetDisabledState(WID_O_COND_COMPARATOR, ocv == OCV_UNCONDITIONALLY);
1036 this->SetWidgetDisabledState(WID_O_COND_VALUE, ocv == OCV_REQUIRES_SERVICE || ocv == OCV_UNCONDITIONALLY);
1037 break;
1040 default: // every other order
1041 if (row_sel != nullptr) {
1042 row_sel->SetDisplayedPlane(DP_ROW_LOAD);
1043 } else {
1044 train_row_sel->SetDisplayedPlane(DP_GROUNDVEHICLE_ROW_NORMAL);
1045 left_sel->SetDisplayedPlane(DP_LEFT_LOAD);
1046 middle_sel->SetDisplayedPlane(DP_MIDDLE_UNLOAD);
1047 right_sel->SetDisplayedPlane(DP_RIGHT_EMPTY);
1048 this->DisableWidget(WID_O_NON_STOP);
1050 this->DisableWidget(WID_O_FULL_LOAD);
1051 this->DisableWidget(WID_O_UNLOAD);
1052 this->DisableWidget(WID_O_REFIT_DROPDOWN);
1053 break;
1057 /* Disable list of vehicles with the same shared orders if there is no list */
1058 this->SetWidgetDisabledState(WID_O_SHARED_ORDER_LIST, !shared_orders);
1060 this->SetDirty();
1063 void OnPaint() override
1065 if (this->vehicle->owner != _local_company) {
1066 this->selected_order = -1; // Disable selection any selected row at a competitor order window.
1067 } else {
1068 this->SetWidgetLoweredState(WID_O_GOTO, this->goto_type != OPOS_NONE);
1070 this->DrawWidgets();
1073 void DrawWidget(const Rect &r, int widget) const override
1075 if (widget != WID_O_ORDER_LIST) return;
1077 bool rtl = _current_text_dir == TD_RTL;
1078 SetDParamMaxValue(0, this->vehicle->GetNumOrders(), 2);
1079 int index_column_width = GetStringBoundingBox(STR_ORDER_INDEX).width + 2 * GetSpriteSize(rtl ? SPR_ARROW_RIGHT : SPR_ARROW_LEFT).width + 3;
1080 int middle = rtl ? r.right - WD_FRAMETEXT_RIGHT - index_column_width : r.left + WD_FRAMETEXT_LEFT + index_column_width;
1082 int y = r.top + WD_FRAMERECT_TOP;
1083 int line_height = this->GetWidget<NWidgetBase>(WID_O_ORDER_LIST)->resize_y;
1085 int i = this->vscroll->GetPosition();
1086 const Order *order = this->vehicle->GetOrder(i);
1087 /* First draw the highlighting underground if it exists. */
1088 if (this->order_over != INVALID_VEH_ORDER_ID) {
1089 while (order != nullptr) {
1090 /* Don't draw anything if it extends past the end of the window. */
1091 if (!this->vscroll->IsVisible(i)) break;
1093 if (i != this->selected_order && i == this->order_over) {
1094 /* Highlight dragged order destination. */
1095 int top = (this->order_over < this->selected_order ? y : y + line_height) - WD_FRAMERECT_TOP;
1096 int bottom = std::min(top + 2, r.bottom - WD_FRAMERECT_BOTTOM);
1097 top = std::max(top - 3, r.top + WD_FRAMERECT_TOP);
1098 GfxFillRect(r.left + WD_FRAMETEXT_LEFT, top, r.right - WD_FRAMETEXT_RIGHT, bottom, _colour_gradient[COLOUR_GREY][7]);
1099 break;
1101 y += line_height;
1103 i++;
1104 order = order->next;
1107 /* Reset counters for drawing the orders. */
1108 y = r.top + WD_FRAMERECT_TOP;
1109 i = this->vscroll->GetPosition();
1110 order = this->vehicle->GetOrder(i);
1113 /* Draw the orders. */
1114 while (order != nullptr) {
1115 /* Don't draw anything if it extends past the end of the window. */
1116 if (!this->vscroll->IsVisible(i)) break;
1118 DrawOrderString(this->vehicle, order, i, y, i == this->selected_order, false, r.left + WD_FRAMETEXT_LEFT, middle, r.right - WD_FRAMETEXT_RIGHT);
1119 y += line_height;
1121 i++;
1122 order = order->next;
1125 if (this->vscroll->IsVisible(i)) {
1126 StringID str = this->vehicle->IsOrderListShared() ? STR_ORDERS_END_OF_SHARED_ORDERS : STR_ORDERS_END_OF_ORDERS;
1127 DrawString(rtl ? r.left + WD_FRAMETEXT_LEFT : middle, rtl ? middle : r.right - WD_FRAMETEXT_RIGHT, y, str, (i == this->selected_order) ? TC_WHITE : TC_BLACK);
1131 void SetStringParameters(int widget) const override
1133 switch (widget) {
1134 case WID_O_COND_VALUE: {
1135 VehicleOrderID sel = this->OrderGetSel();
1136 const Order *order = this->vehicle->GetOrder(sel);
1138 if (order != nullptr && order->IsType(OT_CONDITIONAL)) {
1139 uint value = order->GetConditionValue();
1140 if (order->GetConditionVariable() == OCV_MAX_SPEED) value = ConvertSpeedToDisplaySpeed(value);
1141 SetDParam(0, value);
1143 break;
1146 case WID_O_CAPTION:
1147 SetDParam(0, this->vehicle->index);
1148 break;
1152 void OnClick(Point pt, int widget, int click_count) override
1154 switch (widget) {
1155 case WID_O_ORDER_LIST: {
1156 if (this->goto_type == OPOS_CONDITIONAL) {
1157 VehicleOrderID order_id = this->GetOrderFromPt(_cursor.pos.y - this->top);
1158 if (order_id != INVALID_VEH_ORDER_ID) {
1159 Order order;
1160 order.next = nullptr;
1161 order.index = 0;
1162 order.MakeConditional(order_id);
1164 Command<CMD_INSERT_ORDER>::Post(STR_ERROR_CAN_T_INSERT_NEW_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), order);
1166 ResetObjectToPlace();
1167 break;
1170 VehicleOrderID sel = this->GetOrderFromPt(pt.y);
1172 if (_ctrl_pressed && sel < this->vehicle->GetNumOrders()) {
1173 TileIndex xy = this->vehicle->GetOrder(sel)->GetLocation(this->vehicle);
1174 if (xy != INVALID_TILE) ScrollMainWindowToTile(xy);
1175 return;
1178 /* This order won't be selected any more, close all child windows and dropdowns */
1179 this->CloseChildWindows();
1180 HideDropDownMenu(this);
1182 if (sel == INVALID_VEH_ORDER_ID || this->vehicle->owner != _local_company) {
1183 /* Deselect clicked order */
1184 this->selected_order = -1;
1185 } else if (sel == this->selected_order) {
1186 if (this->vehicle->type == VEH_TRAIN && sel < this->vehicle->GetNumOrders()) {
1187 Command<CMD_MODIFY_ORDER>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER,
1188 this->vehicle->tile, this->vehicle->index, sel,
1189 MOF_STOP_LOCATION, (this->vehicle->GetOrder(sel)->GetStopLocation() + 1) % OSL_END);
1191 } else {
1192 /* Select clicked order */
1193 this->selected_order = sel;
1195 if (this->vehicle->owner == _local_company) {
1196 /* Activate drag and drop */
1197 SetObjectToPlaceWnd(SPR_CURSOR_MOUSE, PAL_NONE, HT_DRAG, this);
1201 this->UpdateButtonState();
1202 break;
1205 case WID_O_SKIP:
1206 this->OrderClick_Skip();
1207 break;
1209 case WID_O_DELETE:
1210 this->OrderClick_Delete();
1211 break;
1213 case WID_O_STOP_SHARING:
1214 this->OrderClick_StopSharing();
1215 break;
1217 case WID_O_NON_STOP:
1218 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1219 this->OrderClick_Nonstop(-1);
1220 } else {
1221 const Order *o = this->vehicle->GetOrder(this->OrderGetSel());
1222 ShowDropDownMenu(this, _order_non_stop_drowdown, o->GetNonStopType(), WID_O_NON_STOP, 0,
1223 o->IsType(OT_GOTO_STATION) ? 0 : (o->IsType(OT_GOTO_WAYPOINT) ? 3 : 12));
1225 break;
1227 case WID_O_GOTO:
1228 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1229 if (this->goto_type != OPOS_NONE) {
1230 ResetObjectToPlace();
1231 } else {
1232 this->OrderClick_Goto(OPOS_GOTO);
1234 } else {
1235 int sel;
1236 switch (this->goto_type) {
1237 case OPOS_NONE: sel = -1; break;
1238 case OPOS_GOTO: sel = 0; break;
1239 case OPOS_CONDITIONAL: sel = 2; break;
1240 case OPOS_SHARE: sel = 3; break;
1241 default: NOT_REACHED();
1243 ShowDropDownMenu(this, this->vehicle->type == VEH_AIRCRAFT ? _order_goto_dropdown_aircraft : _order_goto_dropdown, sel, WID_O_GOTO, 0, 0);
1245 break;
1247 case WID_O_FULL_LOAD:
1248 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1249 this->OrderClick_FullLoad(OLF_FULL_LOAD_ANY, true);
1250 } else {
1251 ShowDropDownMenu(this, _order_full_load_drowdown, this->vehicle->GetOrder(this->OrderGetSel())->GetLoadType(), WID_O_FULL_LOAD, 0, 2);
1253 break;
1255 case WID_O_UNLOAD:
1256 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1257 this->OrderClick_Unload(OUFB_UNLOAD, true);
1258 } else {
1259 ShowDropDownMenu(this, _order_unload_drowdown, this->vehicle->GetOrder(this->OrderGetSel())->GetUnloadType(), WID_O_UNLOAD, 0, 8);
1261 break;
1263 case WID_O_REFIT:
1264 this->OrderClick_Refit(0, false);
1265 break;
1267 case WID_O_SERVICE:
1268 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1269 this->OrderClick_Service(-1);
1270 } else {
1271 ShowDropDownMenu(this, _order_depot_action_dropdown, DepotActionStringIndex(this->vehicle->GetOrder(this->OrderGetSel())), WID_O_SERVICE, 0, 0);
1273 break;
1275 case WID_O_REFIT_DROPDOWN:
1276 if (this->GetWidget<NWidgetLeaf>(widget)->ButtonHit(pt)) {
1277 this->OrderClick_Refit(0, true);
1278 } else {
1279 ShowDropDownMenu(this, _order_refit_action_dropdown, 0, WID_O_REFIT_DROPDOWN, 0, 0);
1281 break;
1283 case WID_O_TIMETABLE_VIEW:
1284 ShowTimetableWindow(this->vehicle);
1285 break;
1287 case WID_O_COND_VARIABLE: {
1288 DropDownList list;
1289 for (uint i = 0; i < lengthof(_order_conditional_variable); i++) {
1290 list.emplace_back(new DropDownListStringItem(STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE + _order_conditional_variable[i], _order_conditional_variable[i], false));
1292 ShowDropDownList(this, std::move(list), this->vehicle->GetOrder(this->OrderGetSel())->GetConditionVariable(), WID_O_COND_VARIABLE);
1293 break;
1296 case WID_O_COND_COMPARATOR: {
1297 const Order *o = this->vehicle->GetOrder(this->OrderGetSel());
1298 ShowDropDownMenu(this, _order_conditional_condition, o->GetConditionComparator(), WID_O_COND_COMPARATOR, 0, (o->GetConditionVariable() == OCV_REQUIRES_SERVICE) ? 0x3F : 0xC0);
1299 break;
1302 case WID_O_COND_VALUE: {
1303 const Order *order = this->vehicle->GetOrder(this->OrderGetSel());
1304 uint value = order->GetConditionValue();
1305 if (order->GetConditionVariable() == OCV_MAX_SPEED) value = ConvertSpeedToDisplaySpeed(value);
1306 SetDParam(0, value);
1307 ShowQueryString(STR_JUST_INT, STR_ORDER_CONDITIONAL_VALUE_CAPT, 5, this, CS_NUMERAL, QSF_NONE);
1308 break;
1311 case WID_O_SHARED_ORDER_LIST:
1312 ShowVehicleListWindow(this->vehicle);
1313 break;
1317 void OnQueryTextFinished(char *str) override
1319 if (!StrEmpty(str)) {
1320 VehicleOrderID sel = this->OrderGetSel();
1321 uint value = atoi(str);
1323 switch (this->vehicle->GetOrder(sel)->GetConditionVariable()) {
1324 case OCV_MAX_SPEED:
1325 value = ConvertDisplaySpeedToSpeed(value);
1326 break;
1328 case OCV_RELIABILITY:
1329 case OCV_LOAD_PERCENTAGE:
1330 value = Clamp(value, 0, 100);
1331 break;
1333 default:
1334 break;
1336 Command<CMD_MODIFY_ORDER>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, sel, MOF_COND_VALUE, Clamp(value, 0, 2047));
1340 void OnDropdownSelect(int widget, int index) override
1342 switch (widget) {
1343 case WID_O_NON_STOP:
1344 this->OrderClick_Nonstop(index);
1345 break;
1347 case WID_O_FULL_LOAD:
1348 this->OrderClick_FullLoad((OrderLoadFlags)index);
1349 break;
1351 case WID_O_UNLOAD:
1352 this->OrderClick_Unload((OrderUnloadFlags)index);
1353 break;
1355 case WID_O_GOTO:
1356 switch (index) {
1357 case 0: this->OrderClick_Goto(OPOS_GOTO); break;
1358 case 1: this->OrderClick_NearestDepot(); break;
1359 case 2: this->OrderClick_Goto(OPOS_CONDITIONAL); break;
1360 case 3: this->OrderClick_Goto(OPOS_SHARE); break;
1361 default: NOT_REACHED();
1363 break;
1365 case WID_O_SERVICE:
1366 this->OrderClick_Service(index);
1367 break;
1369 case WID_O_REFIT_DROPDOWN:
1370 this->OrderClick_Refit(index, true);
1371 break;
1373 case WID_O_COND_VARIABLE:
1374 Command<CMD_MODIFY_ORDER>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), MOF_COND_VARIABLE, index);
1375 break;
1377 case WID_O_COND_COMPARATOR:
1378 Command<CMD_MODIFY_ORDER>::Post(STR_ERROR_CAN_T_MODIFY_THIS_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), MOF_COND_COMPARATOR, index);
1379 break;
1383 void OnDragDrop(Point pt, int widget) override
1385 switch (widget) {
1386 case WID_O_ORDER_LIST: {
1387 VehicleOrderID from_order = this->OrderGetSel();
1388 VehicleOrderID to_order = this->GetOrderFromPt(pt.y);
1390 if (!(from_order == to_order || from_order == INVALID_VEH_ORDER_ID || from_order > this->vehicle->GetNumOrders() || to_order == INVALID_VEH_ORDER_ID || to_order > this->vehicle->GetNumOrders()) &&
1391 Command<CMD_MOVE_ORDER>::Post(STR_ERROR_CAN_T_MOVE_THIS_ORDER, this->vehicle->tile, this->vehicle->index, from_order, to_order)) {
1392 this->selected_order = -1;
1393 this->UpdateButtonState();
1395 break;
1398 case WID_O_DELETE:
1399 this->OrderClick_Delete();
1400 break;
1402 case WID_O_STOP_SHARING:
1403 this->OrderClick_StopSharing();
1404 break;
1407 ResetObjectToPlace();
1409 if (this->order_over != INVALID_VEH_ORDER_ID) {
1410 /* End of drag-and-drop, hide dragged order destination highlight. */
1411 this->order_over = INVALID_VEH_ORDER_ID;
1412 this->SetWidgetDirty(WID_O_ORDER_LIST);
1416 EventState OnHotkey(int hotkey) override
1418 if (this->vehicle->owner != _local_company) return ES_NOT_HANDLED;
1420 switch (hotkey) {
1421 case OHK_SKIP: this->OrderClick_Skip(); break;
1422 case OHK_DELETE: this->OrderClick_Delete(); break;
1423 case OHK_GOTO: this->OrderClick_Goto(OPOS_GOTO); break;
1424 case OHK_NONSTOP: this->OrderClick_Nonstop(-1); break;
1425 case OHK_FULLLOAD: this->OrderClick_FullLoad(OLF_FULL_LOAD_ANY, true); break;
1426 case OHK_UNLOAD: this->OrderClick_Unload(OUFB_UNLOAD, true); break;
1427 case OHK_NEAREST_DEPOT: this->OrderClick_NearestDepot(); break;
1428 case OHK_ALWAYS_SERVICE: this->OrderClick_Service(-1); break;
1429 case OHK_TRANSFER: this->OrderClick_Unload(OUFB_TRANSFER, true); break;
1430 case OHK_NO_UNLOAD: this->OrderClick_Unload(OUFB_NO_UNLOAD, true); break;
1431 case OHK_NO_LOAD: this->OrderClick_FullLoad(OLFB_NO_LOAD, true); break;
1432 default: return ES_NOT_HANDLED;
1434 return ES_HANDLED;
1437 void OnPlaceObject(Point pt, TileIndex tile) override
1439 if (this->goto_type == OPOS_GOTO) {
1440 const Order cmd = GetOrderCmdFromTile(this->vehicle, tile);
1441 if (cmd.IsType(OT_NOTHING)) return;
1443 if (Command<CMD_INSERT_ORDER>::Post(STR_ERROR_CAN_T_INSERT_NEW_ORDER, this->vehicle->tile, this->vehicle->index, this->OrderGetSel(), cmd)) {
1444 /* With quick goto the Go To button stays active */
1445 if (!_settings_client.gui.quick_goto) ResetObjectToPlace();
1450 bool OnVehicleSelect(const Vehicle *v) override
1452 /* v is vehicle getting orders. Only copy/clone orders if vehicle doesn't have any orders yet.
1453 * We disallow copying orders of other vehicles if we already have at least one order entry
1454 * ourself as it easily copies orders of vehicles within a station when we mean the station.
1455 * Obviously if you press CTRL on a non-empty orders vehicle you know what you are doing
1456 * TODO: give a warning message */
1457 bool share_order = _ctrl_pressed || this->goto_type == OPOS_SHARE;
1458 if (this->vehicle->GetNumOrders() != 0 && !share_order) return false;
1460 if (Command<CMD_CLONE_ORDER>::Post(share_order ? STR_ERROR_CAN_T_SHARE_ORDER_LIST : STR_ERROR_CAN_T_COPY_ORDER_LIST,
1461 this->vehicle->tile, share_order ? CO_SHARE : CO_COPY, this->vehicle->index, v->index)) {
1462 this->selected_order = -1;
1463 ResetObjectToPlace();
1465 return true;
1468 void OnPlaceObjectAbort() override
1470 this->goto_type = OPOS_NONE;
1471 this->SetWidgetDirty(WID_O_GOTO);
1473 /* Remove drag highlighting if it exists. */
1474 if (this->order_over != INVALID_VEH_ORDER_ID) {
1475 this->order_over = INVALID_VEH_ORDER_ID;
1476 this->SetWidgetDirty(WID_O_ORDER_LIST);
1480 void OnMouseDrag(Point pt, int widget) override
1482 if (this->selected_order != -1 && widget == WID_O_ORDER_LIST) {
1483 /* An order is dragged.. */
1484 VehicleOrderID from_order = this->OrderGetSel();
1485 VehicleOrderID to_order = this->GetOrderFromPt(pt.y);
1486 uint num_orders = this->vehicle->GetNumOrders();
1488 if (from_order != INVALID_VEH_ORDER_ID && from_order <= num_orders) {
1489 if (to_order != INVALID_VEH_ORDER_ID && to_order <= num_orders) { // ..over an existing order.
1490 this->order_over = to_order;
1491 this->SetWidgetDirty(widget);
1492 } else if (from_order != to_order && this->order_over != INVALID_VEH_ORDER_ID) { // ..outside of the order list.
1493 this->order_over = INVALID_VEH_ORDER_ID;
1494 this->SetWidgetDirty(widget);
1500 void OnResize() override
1502 /* Update the scroll bar */
1503 this->vscroll->SetCapacityFromWidget(this, WID_O_ORDER_LIST);
1506 static HotkeyList hotkeys;
1509 static Hotkey order_hotkeys[] = {
1510 Hotkey('D', "skip", OHK_SKIP),
1511 Hotkey('F', "delete", OHK_DELETE),
1512 Hotkey('G', "goto", OHK_GOTO),
1513 Hotkey('H', "nonstop", OHK_NONSTOP),
1514 Hotkey('J', "fullload", OHK_FULLLOAD),
1515 Hotkey('K', "unload", OHK_UNLOAD),
1516 Hotkey((uint16)0, "nearest_depot", OHK_NEAREST_DEPOT),
1517 Hotkey((uint16)0, "always_service", OHK_ALWAYS_SERVICE),
1518 Hotkey((uint16)0, "transfer", OHK_TRANSFER),
1519 Hotkey((uint16)0, "no_unload", OHK_NO_UNLOAD),
1520 Hotkey((uint16)0, "no_load", OHK_NO_LOAD),
1521 HOTKEY_LIST_END
1523 HotkeyList OrdersWindow::hotkeys("order", order_hotkeys);
1525 /** Nested widget definition for "your" train orders. */
1526 static const NWidgetPart _nested_orders_train_widgets[] = {
1527 NWidget(NWID_HORIZONTAL),
1528 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1529 NWidget(WWT_CAPTION, COLOUR_GREY, WID_O_CAPTION), SetDataTip(STR_ORDERS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1530 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_TIMETABLE_VIEW), SetMinimalSize(61, 14), SetDataTip(STR_ORDERS_TIMETABLE_VIEW, STR_ORDERS_TIMETABLE_VIEW_TOOLTIP),
1531 NWidget(WWT_SHADEBOX, COLOUR_GREY),
1532 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1533 NWidget(WWT_STICKYBOX, COLOUR_GREY),
1534 EndContainer(),
1535 NWidget(NWID_HORIZONTAL),
1536 NWidget(WWT_PANEL, COLOUR_GREY, WID_O_ORDER_LIST), SetMinimalSize(372, 62), SetDataTip(0x0, STR_ORDERS_LIST_TOOLTIP), SetResize(1, 1), SetScrollbar(WID_O_SCROLLBAR), EndContainer(),
1537 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_O_SCROLLBAR),
1538 EndContainer(),
1540 /* First button row. */
1541 NWidget(NWID_HORIZONTAL),
1542 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_O_SEL_TOP_ROW_GROUNDVEHICLE),
1543 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1544 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_NON_STOP), SetMinimalSize(93, 12), SetFill(1, 0),
1545 SetDataTip(STR_ORDER_NON_STOP, STR_ORDER_TOOLTIP_NON_STOP), SetResize(1, 0),
1546 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_O_SEL_TOP_LEFT),
1547 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_FULL_LOAD), SetMinimalSize(93, 12), SetFill(1, 0),
1548 SetDataTip(STR_ORDER_TOGGLE_FULL_LOAD, STR_ORDER_TOOLTIP_FULL_LOAD), SetResize(1, 0),
1549 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_REFIT), SetMinimalSize(93, 12), SetFill(1, 0),
1550 SetDataTip(STR_ORDER_REFIT, STR_ORDER_REFIT_TOOLTIP), SetResize(1, 0),
1551 EndContainer(),
1552 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_O_SEL_TOP_MIDDLE),
1553 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_UNLOAD), SetMinimalSize(93, 12), SetFill(1, 0),
1554 SetDataTip(STR_ORDER_TOGGLE_UNLOAD, STR_ORDER_TOOLTIP_UNLOAD), SetResize(1, 0),
1555 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_SERVICE), SetMinimalSize(93, 12), SetFill(1, 0),
1556 SetDataTip(STR_ORDER_SERVICE, STR_ORDER_SERVICE_TOOLTIP), SetResize(1, 0),
1557 EndContainer(),
1558 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_O_SEL_TOP_RIGHT),
1559 NWidget(WWT_TEXTBTN, COLOUR_GREY, WID_O_EMPTY), SetMinimalSize(93, 12), SetFill(1, 0),
1560 SetDataTip(STR_ORDER_REFIT, STR_ORDER_REFIT_TOOLTIP), SetResize(1, 0),
1561 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_REFIT_DROPDOWN), SetMinimalSize(93, 12), SetFill(1, 0),
1562 SetDataTip(STR_ORDER_REFIT_AUTO, STR_ORDER_REFIT_AUTO_TOOLTIP), SetResize(1, 0),
1563 EndContainer(),
1564 EndContainer(),
1565 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1566 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_O_COND_VARIABLE), SetMinimalSize(124, 12), SetFill(1, 0),
1567 SetDataTip(STR_NULL, STR_ORDER_CONDITIONAL_VARIABLE_TOOLTIP), SetResize(1, 0),
1568 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_O_COND_COMPARATOR), SetMinimalSize(124, 12), SetFill(1, 0),
1569 SetDataTip(STR_NULL, STR_ORDER_CONDITIONAL_COMPARATOR_TOOLTIP), SetResize(1, 0),
1570 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_COND_VALUE), SetMinimalSize(124, 12), SetFill(1, 0),
1571 SetDataTip(STR_BLACK_COMMA, STR_ORDER_CONDITIONAL_VALUE_TOOLTIP), SetResize(1, 0),
1572 EndContainer(),
1573 EndContainer(),
1574 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_O_SHARED_ORDER_LIST), SetMinimalSize(12, 12), SetDataTip(SPR_SHARED_ORDERS_ICON, STR_ORDERS_VEH_WITH_SHARED_ORDERS_LIST_TOOLTIP),
1575 EndContainer(),
1577 /* Second button row. */
1578 NWidget(NWID_HORIZONTAL),
1579 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1580 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_SKIP), SetMinimalSize(124, 12), SetFill(1, 0),
1581 SetDataTip(STR_ORDERS_SKIP_BUTTON, STR_ORDERS_SKIP_TOOLTIP), SetResize(1, 0),
1582 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_O_SEL_BOTTOM_MIDDLE),
1583 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_DELETE), SetMinimalSize(124, 12), SetFill(1, 0),
1584 SetDataTip(STR_ORDERS_DELETE_BUTTON, STR_ORDERS_DELETE_TOOLTIP), SetResize(1, 0),
1585 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_STOP_SHARING), SetMinimalSize(124, 12), SetFill(1, 0),
1586 SetDataTip(STR_ORDERS_STOP_SHARING_BUTTON, STR_ORDERS_STOP_SHARING_TOOLTIP), SetResize(1, 0),
1587 EndContainer(),
1588 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_GOTO), SetMinimalSize(124, 12), SetFill(1, 0),
1589 SetDataTip(STR_ORDERS_GO_TO_BUTTON, STR_ORDERS_GO_TO_TOOLTIP), SetResize(1, 0),
1590 EndContainer(),
1591 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1592 EndContainer(),
1595 static WindowDesc _orders_train_desc(
1596 WDP_AUTO, "view_vehicle_orders_train", 384, 100,
1597 WC_VEHICLE_ORDERS, WC_VEHICLE_VIEW,
1598 WDF_CONSTRUCTION,
1599 _nested_orders_train_widgets, lengthof(_nested_orders_train_widgets),
1600 &OrdersWindow::hotkeys
1603 /** Nested widget definition for "your" orders (non-train). */
1604 static const NWidgetPart _nested_orders_widgets[] = {
1605 NWidget(NWID_HORIZONTAL),
1606 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1607 NWidget(WWT_CAPTION, COLOUR_GREY, WID_O_CAPTION), SetDataTip(STR_ORDERS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1608 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_TIMETABLE_VIEW), SetMinimalSize(61, 14), SetDataTip(STR_ORDERS_TIMETABLE_VIEW, STR_ORDERS_TIMETABLE_VIEW_TOOLTIP),
1609 NWidget(WWT_SHADEBOX, COLOUR_GREY),
1610 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1611 NWidget(WWT_STICKYBOX, COLOUR_GREY),
1612 EndContainer(),
1613 NWidget(NWID_HORIZONTAL),
1614 NWidget(WWT_PANEL, COLOUR_GREY, WID_O_ORDER_LIST), SetMinimalSize(372, 62), SetDataTip(0x0, STR_ORDERS_LIST_TOOLTIP), SetResize(1, 1), SetScrollbar(WID_O_SCROLLBAR), EndContainer(),
1615 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_O_SCROLLBAR),
1616 EndContainer(),
1618 /* First button row. */
1619 NWidget(NWID_HORIZONTAL),
1620 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_O_SEL_TOP_ROW),
1621 /* Load + unload + refit buttons. */
1622 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1623 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_FULL_LOAD), SetMinimalSize(124, 12), SetFill(1, 0),
1624 SetDataTip(STR_ORDER_TOGGLE_FULL_LOAD, STR_ORDER_TOOLTIP_FULL_LOAD), SetResize(1, 0),
1625 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_UNLOAD), SetMinimalSize(124, 12), SetFill(1, 0),
1626 SetDataTip(STR_ORDER_TOGGLE_UNLOAD, STR_ORDER_TOOLTIP_UNLOAD), SetResize(1, 0),
1627 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_REFIT_DROPDOWN), SetMinimalSize(124, 12), SetFill(1, 0),
1628 SetDataTip(STR_ORDER_REFIT_AUTO, STR_ORDER_REFIT_AUTO_TOOLTIP), SetResize(1, 0),
1629 EndContainer(),
1630 /* Refit + service buttons. */
1631 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1632 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_REFIT), SetMinimalSize(186, 12), SetFill(1, 0),
1633 SetDataTip(STR_ORDER_REFIT, STR_ORDER_REFIT_TOOLTIP), SetResize(1, 0),
1634 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_SERVICE), SetMinimalSize(124, 12), SetFill(1, 0),
1635 SetDataTip(STR_ORDER_SERVICE, STR_ORDER_SERVICE_TOOLTIP), SetResize(1, 0),
1636 EndContainer(),
1638 /* Buttons for setting a condition. */
1639 NWidget(NWID_HORIZONTAL, NC_EQUALSIZE),
1640 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_O_COND_VARIABLE), SetMinimalSize(124, 12), SetFill(1, 0),
1641 SetDataTip(STR_NULL, STR_ORDER_CONDITIONAL_VARIABLE_TOOLTIP), SetResize(1, 0),
1642 NWidget(WWT_DROPDOWN, COLOUR_GREY, WID_O_COND_COMPARATOR), SetMinimalSize(124, 12), SetFill(1, 0),
1643 SetDataTip(STR_NULL, STR_ORDER_CONDITIONAL_COMPARATOR_TOOLTIP), SetResize(1, 0),
1644 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_COND_VALUE), SetMinimalSize(124, 12), SetFill(1, 0),
1645 SetDataTip(STR_BLACK_COMMA, STR_ORDER_CONDITIONAL_VALUE_TOOLTIP), SetResize(1, 0),
1646 EndContainer(),
1647 EndContainer(),
1649 NWidget(WWT_PUSHIMGBTN, COLOUR_GREY, WID_O_SHARED_ORDER_LIST), SetMinimalSize(12, 12), SetDataTip(SPR_SHARED_ORDERS_ICON, STR_ORDERS_VEH_WITH_SHARED_ORDERS_LIST_TOOLTIP),
1650 EndContainer(),
1652 /* Second button row. */
1653 NWidget(NWID_HORIZONTAL),
1654 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_SKIP), SetMinimalSize(124, 12), SetFill(1, 0),
1655 SetDataTip(STR_ORDERS_SKIP_BUTTON, STR_ORDERS_SKIP_TOOLTIP), SetResize(1, 0),
1656 NWidget(NWID_SELECTION, INVALID_COLOUR, WID_O_SEL_BOTTOM_MIDDLE),
1657 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_DELETE), SetMinimalSize(124, 12), SetFill(1, 0),
1658 SetDataTip(STR_ORDERS_DELETE_BUTTON, STR_ORDERS_DELETE_TOOLTIP), SetResize(1, 0),
1659 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_STOP_SHARING), SetMinimalSize(124, 12), SetFill(1, 0),
1660 SetDataTip(STR_ORDERS_STOP_SHARING_BUTTON, STR_ORDERS_STOP_SHARING_TOOLTIP), SetResize(1, 0),
1661 EndContainer(),
1662 NWidget(NWID_BUTTON_DROPDOWN, COLOUR_GREY, WID_O_GOTO), SetMinimalSize(124, 12), SetFill(1, 0),
1663 SetDataTip(STR_ORDERS_GO_TO_BUTTON, STR_ORDERS_GO_TO_TOOLTIP), SetResize(1, 0),
1664 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1665 EndContainer(),
1668 static WindowDesc _orders_desc(
1669 WDP_AUTO, "view_vehicle_orders", 384, 100,
1670 WC_VEHICLE_ORDERS, WC_VEHICLE_VIEW,
1671 WDF_CONSTRUCTION,
1672 _nested_orders_widgets, lengthof(_nested_orders_widgets),
1673 &OrdersWindow::hotkeys
1676 /** Nested widget definition for competitor orders. */
1677 static const NWidgetPart _nested_other_orders_widgets[] = {
1678 NWidget(NWID_HORIZONTAL),
1679 NWidget(WWT_CLOSEBOX, COLOUR_GREY),
1680 NWidget(WWT_CAPTION, COLOUR_GREY, WID_O_CAPTION), SetDataTip(STR_ORDERS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1681 NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_TIMETABLE_VIEW), SetMinimalSize(61, 14), SetDataTip(STR_ORDERS_TIMETABLE_VIEW, STR_ORDERS_TIMETABLE_VIEW_TOOLTIP),
1682 NWidget(WWT_SHADEBOX, COLOUR_GREY),
1683 NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
1684 NWidget(WWT_STICKYBOX, COLOUR_GREY),
1685 EndContainer(),
1686 NWidget(NWID_HORIZONTAL),
1687 NWidget(WWT_PANEL, COLOUR_GREY, WID_O_ORDER_LIST), SetMinimalSize(372, 72), SetDataTip(0x0, STR_ORDERS_LIST_TOOLTIP), SetResize(1, 1), SetScrollbar(WID_O_SCROLLBAR), EndContainer(),
1688 NWidget(NWID_VERTICAL),
1689 NWidget(NWID_VSCROLLBAR, COLOUR_GREY, WID_O_SCROLLBAR),
1690 NWidget(WWT_RESIZEBOX, COLOUR_GREY),
1691 EndContainer(),
1692 EndContainer(),
1695 static WindowDesc _other_orders_desc(
1696 WDP_AUTO, "view_vehicle_orders_competitor", 384, 86,
1697 WC_VEHICLE_ORDERS, WC_VEHICLE_VIEW,
1698 WDF_CONSTRUCTION,
1699 _nested_other_orders_widgets, lengthof(_nested_other_orders_widgets),
1700 &OrdersWindow::hotkeys
1703 void ShowOrdersWindow(const Vehicle *v)
1705 CloseWindowById(WC_VEHICLE_DETAILS, v->index, false);
1706 CloseWindowById(WC_VEHICLE_TIMETABLE, v->index, false);
1707 if (BringWindowToFrontById(WC_VEHICLE_ORDERS, v->index) != nullptr) return;
1709 /* Using a different WindowDescs for _local_company causes problems.
1710 * Due to this we have to close order windows in ChangeWindowOwner/CloseCompanyWindows,
1711 * because we cannot change switch the WindowDescs and keeping the old WindowDesc results
1712 * in crashed due to missing widges.
1713 * TODO Rewrite the order GUI to not use different WindowDescs.
1715 if (v->owner != _local_company) {
1716 new OrdersWindow(&_other_orders_desc, v);
1717 } else {
1718 new OrdersWindow(v->IsGroundVehicle() ? &_orders_train_desc : &_orders_desc, v);