OpenTTD Source  20241108-master-g80f628063a
FileList Class Reference

List of file information. More...

#include <fios.h>

Inheritance diagram for FileList:
ConsoleFileList

Public Member Functions

void BuildFileList (AbstractFileType abstract_filetype, SaveLoadOperation fop, bool show_dirs)
 Construct a file list with the given kind of files, for the stated purpose. More...
 
const FiosItemFindItem (const std::string_view file)
 Find file information of a file by its name from the file list. More...
 

Detailed Description

List of file information.

Definition at line 88 of file fios.h.

Member Function Documentation

◆ BuildFileList()

void FileList::BuildFileList ( AbstractFileType  abstract_filetype,
SaveLoadOperation  fop,
bool  show_dirs 
)

Construct a file list with the given kind of files, for the stated purpose.

Parameters
abstract_filetypeKind of files to collect.
fopPurpose of the collection, either SLO_LOAD or SLO_SAVE.
show_dirsWhether to show directories.

Definition at line 66 of file fios.cpp.

References FiosGetHeightmapList(), FiosGetSavegameList(), FiosGetScenarioList(), FiosGetTownDataList(), FT_HEIGHTMAP, FT_NONE, FT_SAVEGAME, FT_SCENARIO, FT_TOWN_DATA, SLO_LOAD, and SLO_SAVE.

Referenced by ConsoleFileList::ValidateFileList().

◆ FindItem()

const FiosItem * FileList::FindItem ( const std::string_view  file)

Find file information of a file by its name from the file list.

Parameters
fileThe filename to return information about. Can be the actual name or a numbered entry into the filename list.
Returns
The information on the file, or nullptr if the file is not available.

Definition at line 102 of file fios.cpp.

References IsInsideMM().


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