OpenTTD Source 20260129-master-g2bb01bd0e4
StationPickerCallbacks Class Reference
Inheritance diagram for StationPickerCallbacks:
PickerCallbacksNewGRFClass< StationClass > PickerCallbacks

Public Member Functions

GrfSpecFeature GetFeature () const override
 
StringID GetClassTooltip () const override
 Get the tooltip string for the class list.
 
StringID GetTypeTooltip () const override
 Get the tooltip string for the type grid.
 
StringID GetCollectionTooltip () const override
 Get the tooltip string for the collection list.
 
bool IsActive () const override
 Should picker class/type selection be enabled?
 
bool HasClassChoice () const override
 Are there multiple classes to chose from?
 
int GetSelectedClass () const override
 Get the index of the selected class.
 
void SetSelectedClass (int id) const override
 Set the selected class.
 
StringID GetClassName (int id) const override
 Get the name of a class.
 
int GetSelectedType () const override
 Get the selected type.
 
void SetSelectedType (int id) const override
 Set the selected type.
 
StringID GetTypeName (int cls_id, int id) const override
 Get the item of a type.
 
std::span< const BadgeIDGetTypeBadges (int cls_id, int id) const override
 Get the item of a type.
 
bool IsTypeAvailable (int cls_id, int id) const override
 Test if an item is currently buildable.
 
void DrawType (int x, int y, int cls_id, int id) const override
 Draw preview image of an item.
 
void FillUsedItems (std::set< PickerItem > &items) override
 Fill a set with all items that are used by the current player.
 
- Public Member Functions inherited from PickerCallbacksNewGRFClass< StationClass >
 PickerCallbacksNewGRFClass (const std::string &ini_group)
 
T::index_type GetClassIndex (int cls_id) const
 
const StationClassGetClass (int cls_id) const
 
const T::spec_type * GetSpec (int cls_id, int id) const
 
int GetClassCount () const override
 Get the number of classes.
 
int GetTypeCount (int cls_id) const override
 Get the number of types in a class.
 
PickerItem GetPickerItem (const typename T::spec_type *spec, int cls_id=-1, int id=-1) const
 
PickerItem GetPickerItem (int cls_id, int id) const override
 Get data about an item.
 
std::map< std::string, std::set< PickerItem > > UpdateSavedItems (const std::map< std::string, std::set< PickerItem > > &src) override
 Update link between grfid/localidx and class_index/index in saved items.
 
- Public Member Functions inherited from PickerCallbacks
 PickerCallbacks (const std::string &ini_group)
 
virtual void Close (int)
 
std::set< std::string > InitializeInactiveCollections (const std::map< std::string, std::set< PickerItem > > collections)
 Initialize the list of active collections for sorting purposes.
 

Static Public Attributes

static StationPickerCallbacks instance
 

Additional Inherited Members

- Data Fields inherited from PickerCallbacks
Listing class_last_sorting = { false, 0 }
 Default sorting of PickerClassList.
 
Filtering class_last_filtering = { false, 0 }
 Default filtering of PickerClassList.
 
Listing type_last_sorting = { false, 0 }
 Default sorting of PickerTypeList.
 
Filtering type_last_filtering = { false, 0 }
 Default filtering of PickerTypeList.
 
Listing collection_last_sorting = { false, 0 }
 Default sorting of PickerCollectionList.
 
const std::string ini_group
 Ini Group for saving favourites.
 
uint8_t mode = 0
 Bitmask of PickerFilterModes.
 
bool rename_collection = false
 Are we renaming a collection?
 
std::string sel_collection
 Currently selected collection of saved items.
 
std::string edit_collection
 Collection to rename or delete.
 
std::set< std::string > rm_collections
 Set of removed or renamed collections for updating ini file.
 
int preview_height = 0
 Previously adjusted height.
 
std::set< PickerItemused
 Set of items used in the current game by the current company.
 
std::map< std::string, std::set< PickerItem > > saved
 Set of saved collections of items.
 

Detailed Description

Definition at line 973 of file rail_gui.cpp.

Constructor & Destructor Documentation

◆ StationPickerCallbacks()

StationPickerCallbacks::StationPickerCallbacks ( )
inline

Definition at line 975 of file rail_gui.cpp.

Member Function Documentation

◆ DrawType()

void StationPickerCallbacks::DrawType ( int  x,
int  y,
int  cls_id,
int  id 
) const
inlineoverridevirtual

Draw preview image of an item.

Implements PickerCallbacks.

Definition at line 1030 of file rail_gui.cpp.

References _cur_railtype, _station_gui, StationPickerSelection::axis, DrawStationTile(), INVALID_ROADTYPE, and Rail.

◆ FillUsedItems()

void StationPickerCallbacks::FillUsedItems ( std::set< PickerItem > &  items)
inlineoverridevirtual

Fill a set with all items that are used by the current player.

Implements PickerCallbacks.

Definition at line 1037 of file rail_gui.cpp.

References _local_company, SpecializedStation< Station, false >::Iterate(), STAT_CLASS_DFLT, and StationUsesDefaultType().

◆ GetClassName()

StringID StationPickerCallbacks::GetClassName ( int  id) const
inlineoverridevirtual

Get the name of a class.

Implements PickerCallbacks.

Definition at line 1002 of file rail_gui.cpp.

References INVALID_STRING_ID, and IsWaypointClass().

◆ GetClassTooltip()

StringID StationPickerCallbacks::GetClassTooltip ( ) const
inlineoverridevirtual

Get the tooltip string for the class list.

Implements PickerCallbacks.

Definition at line 979 of file rail_gui.cpp.

◆ GetCollectionTooltip()

StringID StationPickerCallbacks::GetCollectionTooltip ( ) const
inlineoverridevirtual

Get the tooltip string for the collection list.

Implements PickerCallbacks.

Definition at line 981 of file rail_gui.cpp.

◆ GetFeature()

GrfSpecFeature StationPickerCallbacks::GetFeature ( ) const
inlineoverridevirtual

Implements PickerCallbacks.

Definition at line 977 of file rail_gui.cpp.

◆ GetSelectedClass()

int StationPickerCallbacks::GetSelectedClass ( ) const
inlineoverridevirtual

Get the index of the selected class.

Implements PickerCallbacks.

Definition at line 999 of file rail_gui.cpp.

References _station_gui, and StationPickerSelection::sel_class.

◆ GetSelectedType()

int StationPickerCallbacks::GetSelectedType ( ) const
inlineoverridevirtual

Get the selected type.

Implements PickerCallbacks.

Definition at line 1009 of file rail_gui.cpp.

References _station_gui, and StationPickerSelection::sel_type.

◆ GetTypeBadges()

std::span< const BadgeID > StationPickerCallbacks::GetTypeBadges ( int  cls_id,
int  id 
) const
inlineoverridevirtual

Get the item of a type.

Implements PickerCallbacks.

Definition at line 1018 of file rail_gui.cpp.

◆ GetTypeName()

StringID StationPickerCallbacks::GetTypeName ( int  cls_id,
int  id 
) const
inlineoverridevirtual

Get the item of a type.

Implements PickerCallbacks.

Definition at line 1012 of file rail_gui.cpp.

◆ GetTypeTooltip()

StringID StationPickerCallbacks::GetTypeTooltip ( ) const
inlineoverridevirtual

Get the tooltip string for the type grid.

Implements PickerCallbacks.

Definition at line 980 of file rail_gui.cpp.

◆ HasClassChoice()

bool StationPickerCallbacks::HasClassChoice ( ) const
inlineoverridevirtual

Are there multiple classes to chose from?

Reimplemented from PickerCallbacksNewGRFClass< StationClass >.

Definition at line 994 of file rail_gui.cpp.

References NewGRFClass< Tspec, Tindex, Tmax >::Classes(), and IsWaypointClass().

◆ IsActive()

bool StationPickerCallbacks::IsActive ( ) const
inlineoverridevirtual

Should picker class/type selection be enabled?

Implements PickerCallbacks.

Definition at line 983 of file rail_gui.cpp.

References NewGRFClass< Tspec, Tindex, Tmax >::Classes(), and IsWaypointClass().

◆ IsTypeAvailable()

bool StationPickerCallbacks::IsTypeAvailable ( int  cls_id,
int  id 
) const
inlineoverridevirtual

Test if an item is currently buildable.

Implements PickerCallbacks.

Definition at line 1025 of file rail_gui.cpp.

References IsStationAvailable().

◆ SetSelectedClass()

void StationPickerCallbacks::SetSelectedClass ( int  id) const
inlineoverridevirtual

Set the selected class.

Implements PickerCallbacks.

Definition at line 1000 of file rail_gui.cpp.

References _station_gui, and StationPickerSelection::sel_class.

◆ SetSelectedType()

void StationPickerCallbacks::SetSelectedType ( int  id) const
inlineoverridevirtual

Set the selected type.

Implements PickerCallbacks.

Definition at line 1010 of file rail_gui.cpp.

References _station_gui, and StationPickerSelection::sel_type.

Field Documentation

◆ instance

StationPickerCallbacks StationPickerCallbacks::instance
static

Definition at line 1053 of file rail_gui.cpp.


The documentation for this class was generated from the following file: