OpenTTD Source  20241121-master-g67a0fccfad
order_gui.cpp File Reference

GUI related to orders. More...

#include "stdafx.h"
#include "command_func.h"
#include "viewport_func.h"
#include "depot_map.h"
#include "roadveh.h"
#include "timetable.h"
#include "strings_func.h"
#include "company_func.h"
#include "dropdown_type.h"
#include "dropdown_func.h"
#include "textbuf_gui.h"
#include "string_func.h"
#include "tilehighlight_func.h"
#include "network/network.h"
#include "station_base.h"
#include "industry.h"
#include "waypoint_base.h"
#include "core/geometry_func.hpp"
#include "hotkeys.h"
#include "aircraft.h"
#include "engine_func.h"
#include "vehicle_func.h"
#include "vehiclelist.h"
#include "error.h"
#include "order_cmd.h"
#include "company_cmd.h"
#include "widgets/order_widget.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures

struct  OrdersWindow
 Order window code for all vehicles. More...
 

Enumerations

enum  {
  OHK_SKIP , OHK_DELETE , OHK_GOTO , OHK_NONSTOP ,
  OHK_FULLLOAD , OHK_UNLOAD , OHK_NEAREST_DEPOT , OHK_ALWAYS_SERVICE ,
  OHK_TRANSFER , OHK_NO_UNLOAD , OHK_NO_LOAD
}
 Hotkeys for order window.
 

Functions

uint ConvertSpeedToDisplaySpeed (uint speed, VehicleType type)
 Convert the given (internal) speed to the display speed. More...
 
uint ConvertDisplaySpeedToSpeed (uint speed, VehicleType type)
 Convert the given display speed to the (internal) speed. More...
 
static int DepotActionStringIndex (const Order *order)
 
void DrawOrderString (const Vehicle *v, const Order *order, int order_index, int y, bool selected, bool timetable, int left, int middle, int right)
 Draws an order in order or timetable GUI. More...
 
static Order GetOrderCmdFromTile (const Vehicle *v, TileIndex tile)
 Get the order command a vehicle can do in a given tile. More...
 
void ShowOrdersWindow (const Vehicle *v)
 

Variables

static const StringID _station_load_types [][5][5]
 Order load types that could be given to station orders.
 
static const StringID _order_non_stop_drowdown []
 
static const StringID _order_full_load_drowdown []
 
static const StringID _order_unload_drowdown []
 
static const StringID _order_goto_dropdown []
 
static const StringID _order_goto_dropdown_aircraft []
 
static const OrderConditionVariable _order_conditional_variable []
 Variables for conditional orders; this defines the order of appearance in the dropdown box. More...
 
static const StringID _order_conditional_condition []
 
static const StringID _order_depot_action_dropdown []
 
static const StringID _order_refit_action_dropdown []
 
static constexpr NWidgetPart _nested_orders_train_widgets []
 Nested widget definition for "your" train orders.
 
static WindowDesc _orders_train_desc (WDP_AUTO, "view_vehicle_orders_train", 384, 100, WC_VEHICLE_ORDERS, WC_VEHICLE_VIEW, WDF_CONSTRUCTION, _nested_orders_train_widgets, &OrdersWindow::hotkeys)
 
static constexpr NWidgetPart _nested_orders_widgets []
 Nested widget definition for "your" orders (non-train).
 
static WindowDesc _orders_desc (WDP_AUTO, "view_vehicle_orders", 384, 100, WC_VEHICLE_ORDERS, WC_VEHICLE_VIEW, WDF_CONSTRUCTION, _nested_orders_widgets, &OrdersWindow::hotkeys)
 
static constexpr NWidgetPart _nested_other_orders_widgets []
 Nested widget definition for competitor orders. More...
 
static WindowDesc _other_orders_desc (WDP_AUTO, "view_vehicle_orders_competitor", 384, 86, WC_VEHICLE_ORDERS, WC_VEHICLE_VIEW, WDF_CONSTRUCTION, _nested_other_orders_widgets, &OrdersWindow::hotkeys)
 

Detailed Description

GUI related to orders.

Definition in file order_gui.cpp.

Function Documentation

◆ ConvertDisplaySpeedToSpeed()

uint ConvertDisplaySpeedToSpeed ( uint  speed,
VehicleType  type 
)

Convert the given display speed to the (internal) speed.

Parameters
speedthe speed to convert
Returns
the converted speed.

Definition at line 882 of file strings.cpp.

References Units::c, UnitConversion::FromDisplay(), and GetVelocityUnits().

◆ ConvertSpeedToDisplaySpeed()

uint ConvertSpeedToDisplaySpeed ( uint  speed,
VehicleType  type 
)

Convert the given (internal) speed to the display speed.

Parameters
speedthe speed to convert
Returns
the converted speed.

Definition at line 869 of file strings.cpp.

References Units::c, GetVelocityUnits(), and UnitConversion::ToDisplay().

◆ DrawOrderString()

void DrawOrderString ( const Vehicle v,
const Order order,
int  order_index,
int  y,
bool  selected,
bool  timetable,
int  left,
int  middle,
int  right 
)

Draws an order in order or timetable GUI.

Parameters
vVehicle the order belongs to
orderThe order to draw
order_indexIndex of the order in the orders of the vehicle
yY position for drawing
selectedTrue, if the order is selected
timetableTrue, when drawing in the timetable GUI
leftLeft border for text drawing
middleX position between order index and order text
rightRight border for text drawing

Definition at line 214 of file order_gui.cpp.

◆ GetOrderCmdFromTile()

Variable Documentation

◆ _nested_other_orders_widgets

constexpr NWidgetPart _nested_other_orders_widgets[]
staticconstexpr
Initial value:
= {
NWidget(WWT_CLOSEBOX, COLOUR_GREY),
NWidget(WWT_CAPTION, COLOUR_GREY, WID_O_CAPTION), SetDataTip(STR_ORDERS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_O_TIMETABLE_VIEW), SetMinimalSize(61, 14), SetDataTip(STR_ORDERS_TIMETABLE_VIEW, STR_ORDERS_TIMETABLE_VIEW_TOOLTIP),
NWidget(WWT_SHADEBOX, COLOUR_GREY),
NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
NWidget(WWT_STICKYBOX, COLOUR_GREY),
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(),
NWidget(WWT_RESIZEBOX, COLOUR_GREY),
}
constexpr NWidgetPart SetScrollbar(WidgetID index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1284
constexpr NWidgetPart SetDataTip(uint32_t data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1202
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1137
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1309
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1191
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
Definition: widget_type.h:1126
@ WID_O_TIMETABLE_VIEW
Toggle timetable view.
Definition: order_widget.h:16
@ WID_O_SCROLLBAR
Order list scrollbar.
Definition: order_widget.h:18
@ WID_O_ORDER_LIST
Order list panel.
Definition: order_widget.h:17
@ WID_O_CAPTION
Caption of the window.
Definition: order_widget.h:15
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:112
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:75
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:50
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:66
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:64
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:84
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:77
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:69
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:68
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:65

Nested widget definition for competitor orders.

Definition at line 1767 of file order_gui.cpp.

◆ _order_conditional_condition

const StringID _order_conditional_condition[]
static
Initial value:
= {
STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS,
STR_ORDER_CONDITIONAL_COMPARATOR_NOT_EQUALS,
STR_ORDER_CONDITIONAL_COMPARATOR_LESS_THAN,
STR_ORDER_CONDITIONAL_COMPARATOR_LESS_EQUALS,
STR_ORDER_CONDITIONAL_COMPARATOR_MORE_THAN,
STR_ORDER_CONDITIONAL_COMPARATOR_MORE_EQUALS,
STR_ORDER_CONDITIONAL_COMPARATOR_IS_TRUE,
STR_ORDER_CONDITIONAL_COMPARATOR_IS_FALSE,
}

Definition at line 163 of file order_gui.cpp.

◆ _order_conditional_variable

const OrderConditionVariable _order_conditional_variable[]
static
Initial value:
= {
}
@ OCV_AGE
Skip based on the age.
Definition: order_type.h:117
@ OCV_UNCONDITIONALLY
Always skip.
Definition: order_type.h:119
@ OCV_MAX_SPEED
Skip based on the maximum speed.
Definition: order_type.h:116
@ OCV_LOAD_PERCENTAGE
Skip based on the amount of load.
Definition: order_type.h:114
@ OCV_REQUIRES_SERVICE
Skip when the vehicle requires service.
Definition: order_type.h:118
@ OCV_RELIABILITY
Skip based on the reliability.
Definition: order_type.h:115
@ OCV_REMAINING_LIFETIME
Skip based on the remaining lifetime.
Definition: order_type.h:120
@ OCV_MAX_RELIABILITY
Skip based on the maximum reliability.
Definition: order_type.h:121

Variables for conditional orders; this defines the order of appearance in the dropdown box.

Definition at line 152 of file order_gui.cpp.

◆ _order_depot_action_dropdown

const StringID _order_depot_action_dropdown[]
static
Initial value:
= {
STR_ORDER_DROP_GO_ALWAYS_DEPOT,
STR_ORDER_DROP_SERVICE_DEPOT,
STR_ORDER_DROP_HALT_DEPOT,
STR_ORDER_DROP_UNBUNCH,
}

Definition at line 177 of file order_gui.cpp.

◆ _order_full_load_drowdown

const StringID _order_full_load_drowdown[]
static
Initial value:
= {
STR_ORDER_DROP_LOAD_IF_POSSIBLE,
STR_EMPTY,
STR_ORDER_DROP_FULL_LOAD_ALL,
STR_ORDER_DROP_FULL_LOAD_ANY,
STR_ORDER_DROP_NO_LOADING,
}

Definition at line 121 of file order_gui.cpp.

◆ _order_goto_dropdown

const StringID _order_goto_dropdown[]
static
Initial value:
= {
STR_ORDER_GO_TO,
STR_ORDER_GO_TO_NEAREST_DEPOT,
STR_ORDER_CONDITIONAL,
STR_ORDER_SHARE,
}

Definition at line 137 of file order_gui.cpp.

◆ _order_goto_dropdown_aircraft

const StringID _order_goto_dropdown_aircraft[]
static
Initial value:
= {
STR_ORDER_GO_TO,
STR_ORDER_GO_TO_NEAREST_HANGAR,
STR_ORDER_CONDITIONAL,
STR_ORDER_SHARE,
}

Definition at line 144 of file order_gui.cpp.

◆ _order_non_stop_drowdown

const StringID _order_non_stop_drowdown[]
static
Initial value:
= {
STR_ORDER_GO_TO,
STR_ORDER_GO_NON_STOP_TO,
STR_ORDER_GO_VIA,
STR_ORDER_GO_NON_STOP_VIA,
}

Definition at line 114 of file order_gui.cpp.

◆ _order_refit_action_dropdown

const StringID _order_refit_action_dropdown[]
static
Initial value:
= {
STR_ORDER_DROP_REFIT_AUTO,
STR_ORDER_DROP_REFIT_AUTO_ANY,
}

Definition at line 197 of file order_gui.cpp.

◆ _order_unload_drowdown

const StringID _order_unload_drowdown[]
static
Initial value:
= {
STR_ORDER_DROP_UNLOAD_IF_ACCEPTED,
STR_ORDER_DROP_UNLOAD,
STR_ORDER_DROP_TRANSFER,
STR_EMPTY,
STR_ORDER_DROP_NO_UNLOADING,
}

Definition at line 129 of file order_gui.cpp.