OpenTTD Source 20250205-master-gfd85ab1e2c
Public Member Functions | Static Public Attributes
StationPickerCallbacks Class Reference
Inheritance diagram for StationPickerCallbacks:
PickerCallbacksNewGRFClass< StationClass > PickerCallbacks

Public Member Functions

StringID GetClassTooltip () const override
 Get the tooltip string for the class list.
 
StringID GetTypeTooltip () const override
 Get the tooltip string for the type grid.
 
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.
 
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 StationClass * GetClass (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::set< PickerItem > UpdateSavedItems (const 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)
 

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.
 
const std::string ini_group
 Ini Group for saving favourites.
 
uint8_t mode = 0
 Bitmask of PickerFilterModes.
 
std::set< PickerItem > used
 Set of items used in the current game by the current company.
 
std::set< PickerItem > saved
 Set of saved favourite items.
 

Detailed Description

Definition at line 968 of file rail_gui.cpp.

Constructor & Destructor Documentation

◆ StationPickerCallbacks()

StationPickerCallbacks::StationPickerCallbacks ( )
inline

Definition at line 970 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 1015 of file rail_gui.cpp.

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

◆ 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 1022 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 994 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 972 of file rail_gui.cpp.

◆ GetSelectedClass()

int StationPickerCallbacks::GetSelectedClass ( ) const
inlineoverridevirtual

Get the index of the selected class.

Implements PickerCallbacks.

Definition at line 991 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 1001 of file rail_gui.cpp.

References _station_gui, and StationPickerSelection::sel_type.

◆ GetTypeName()

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

Get the item of a type.

Implements PickerCallbacks.

Definition at line 1004 of file rail_gui.cpp.

◆ GetTypeTooltip()

StringID StationPickerCallbacks::GetTypeTooltip ( ) const
inlineoverridevirtual

Get the tooltip string for the type grid.

Implements PickerCallbacks.

Definition at line 973 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 986 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 975 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 1010 of file rail_gui.cpp.

References IsStationAvailable().

◆ SetSelectedClass()

void StationPickerCallbacks::SetSelectedClass ( int  id) const
inlineoverridevirtual

Set the selected class.

Implements PickerCallbacks.

Definition at line 992 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 1002 of file rail_gui.cpp.

References _station_gui, and StationPickerSelection::sel_type.

Field Documentation

◆ instance

StationPickerCallbacks StationPickerCallbacks::instance
static

Definition at line 1038 of file rail_gui.cpp.

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