gronod/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2025-03-06 14:27:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

(svn r26803) -Doc: Document some fields in the build vehicle gui, and the rail definition struct.

Browse Source
This commit is contained in:
alberth 2014-09-07 16:13:29 +00:00
parent f72ad87540
commit dcc67681ad
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/build_vehicle_gui.cpp
View File

@ -951,16 +951,16 @@ void DisplayVehicleSortDropDown(Window *w, VehicleType vehicle_type, int selecte
/** GUI for building vehicles. */ /** GUI for building vehicles. */
struct BuildVehicleWindow : Window { struct BuildVehicleWindow : Window {
VehicleType vehicle_type; VehicleType vehicle_type; ///< Type of vehicles shown in the window.
union { union {
RailTypeByte railtype; RailTypeByte railtype; ///< Rail type to show, or #RAILTYPE_END.
RoadTypes roadtypes; RoadTypes roadtypes; ///< Road type to show, or #ROADTYPES_ALL.
} filter; } filter; ///< Filter to apply.
bool descending_sort_order; bool descending_sort_order; ///< Sort direction, @see _engine_sort_direction
byte sort_criteria; byte sort_criteria; ///< Current sort criterium.
bool listview_mode; bool listview_mode; ///< If set, only display the available vehicles and do not show a 'build' button.
EngineID sel_engine; EngineID sel_engine; ///< Currently selected engine, or #INVALID_ENGINE
EngineID rename_engine; EngineID rename_engine; ///< Engine being renamed.
GUIEngineList eng_list; GUIEngineList eng_list;
CargoID cargo_filter[NUM_CARGO + 2]; ///< Available cargo filters; CargoID or CF_ANY or CF_NONE CargoID cargo_filter[NUM_CARGO + 2]; ///< Available cargo filters; CargoID or CF_ANY or CF_NONE
StringID cargo_filter_texts[NUM_CARGO + 3]; ///< Texts for filter_cargo, terminated by INVALID_STRING_ID StringID cargo_filter_texts[NUM_CARGO + 3]; ///< Texts for filter_cargo, terminated by INVALID_STRING_ID

16
src/rail.h
View File

@ -150,16 +150,16 @@ struct RailtypeInfo {
CursorID depot; ///< Cursor for building a depot CursorID depot; ///< Cursor for building a depot
CursorID tunnel; ///< Cursor for building a tunnel CursorID tunnel; ///< Cursor for building a tunnel
CursorID convert; ///< Cursor for converting track CursorID convert; ///< Cursor for converting track
} cursor; } cursor; ///< Cursors associated with the rail type.
struct { struct {
StringID name; StringID name; ///< Name of this rail type.
StringID toolbar_caption; StringID toolbar_caption; ///< Caption in the construction toolbar GUI for this rail type.
StringID menu_text; StringID menu_text; ///< Name of this rail type in the main toolbar dropdown.
StringID build_caption; StringID build_caption; ///< Caption of the build vehicle GUI for this rail type.
StringID replace_text; StringID replace_text; ///< Text used in the autoreplace GUI.
StringID new_loco; StringID new_loco; ///< Name of an engine for this type of rail in the engine preview GUI.
} strings; } strings; ///< Strings associated with the rail type.
/** sprite number difference between a piece of track on a snowy ground and the corresponding one on normal ground */ /** sprite number difference between a piece of track on a snowy ground and the corresponding one on normal ground */
SpriteID snow_offset; SpriteID snow_offset;