OpenTTD Source 20241224-master-gf74b0cf984
Public Member Functions | Static Public Attributes
WaypointPickerCallbacks Class Reference
Inheritance diagram for WaypointPickerCallbacks:
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?
 
void Close (int) override
 
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)
 

Static Public Attributes

static WaypointPickerCallbacks 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 1779 of file rail_gui.cpp.

Constructor & Destructor Documentation

◆ WaypointPickerCallbacks()

WaypointPickerCallbacks::WaypointPickerCallbacks ( )
inline

Definition at line 1781 of file rail_gui.cpp.

Member Function Documentation

◆ Close()

void WaypointPickerCallbacks::Close ( int  )
inlineoverridevirtual

Reimplemented from PickerCallbacks.

Definition at line 1802 of file rail_gui.cpp.

◆ DrawType()

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

Draw preview image of an item.

Implements PickerCallbacks.

Definition at line 1827 of file rail_gui.cpp.

References _cur_railtype, and DrawWaypointSprite().

◆ FillUsedItems()

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

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

Implements PickerCallbacks.

Definition at line 1832 of file rail_gui.cpp.

References _local_company, HasBit(), SpecializedStation< Waypoint, true >::Iterate(), STAT_CLASS_WAYP, StationUsesDefaultType(), and WPF_ROAD.

◆ GetClassName()

StringID WaypointPickerCallbacks::GetClassName ( int  id) const
inlineoverridevirtual

Get the name of a class.

Implements PickerCallbacks.

Definition at line 1806 of file rail_gui.cpp.

References INVALID_STRING_ID, and IsWaypointClass().

◆ GetClassTooltip()

StringID WaypointPickerCallbacks::GetClassTooltip ( ) const
inlineoverridevirtual

Get the tooltip string for the class list.

Implements PickerCallbacks.

Definition at line 1783 of file rail_gui.cpp.

◆ GetSelectedClass()

int WaypointPickerCallbacks::GetSelectedClass ( ) const
inlineoverridevirtual

Get the index of the selected class.

Implements PickerCallbacks.

Definition at line 1803 of file rail_gui.cpp.

References _waypoint_gui, and WaypointPickerSelection::sel_class.

◆ GetSelectedType()

int WaypointPickerCallbacks::GetSelectedType ( ) const
inlineoverridevirtual

Get the selected type.

Implements PickerCallbacks.

Definition at line 1813 of file rail_gui.cpp.

References _waypoint_gui, and WaypointPickerSelection::sel_type.

◆ GetTypeName()

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

Get the item of a type.

Implements PickerCallbacks.

Definition at line 1816 of file rail_gui.cpp.

◆ GetTypeTooltip()

StringID WaypointPickerCallbacks::GetTypeTooltip ( ) const
inlineoverridevirtual

Get the tooltip string for the type grid.

Implements PickerCallbacks.

Definition at line 1784 of file rail_gui.cpp.

◆ HasClassChoice()

bool WaypointPickerCallbacks::HasClassChoice ( ) const
inlineoverridevirtual

Are there multiple classes to chose from?

Reimplemented from PickerCallbacksNewGRFClass< StationClass >.

Definition at line 1797 of file rail_gui.cpp.

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

◆ IsActive()

bool WaypointPickerCallbacks::IsActive ( ) const
inlineoverridevirtual

Should picker class/type selection be enabled?

Implements PickerCallbacks.

Definition at line 1786 of file rail_gui.cpp.

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

◆ IsTypeAvailable()

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

Test if an item is currently buildable.

Implements PickerCallbacks.

Definition at line 1822 of file rail_gui.cpp.

References IsStationAvailable().

◆ SetSelectedClass()

void WaypointPickerCallbacks::SetSelectedClass ( int  id) const
inlineoverridevirtual

Set the selected class.

Implements PickerCallbacks.

Definition at line 1804 of file rail_gui.cpp.

References _waypoint_gui, and WaypointPickerSelection::sel_class.

◆ SetSelectedType()

void WaypointPickerCallbacks::SetSelectedType ( int  id) const
inlineoverridevirtual

Set the selected type.

Implements PickerCallbacks.

Definition at line 1814 of file rail_gui.cpp.

References _waypoint_gui, and WaypointPickerSelection::sel_type.

Field Documentation

◆ instance

WaypointPickerCallbacks WaypointPickerCallbacks::instance
static

Definition at line 1848 of file rail_gui.cpp.

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