OpenTTD
|
Declarations for savegames operations. More...
#include "gfx_type.h"
#include "company_base.h"
#include "newgrf_config.h"
#include "network/core/tcp_content.h"
Go to the source code of this file.
Data Structures | |
struct | LoadCheckData |
Container for loading in mode SL_LOAD_CHECK. More... | |
struct | FiosItem |
Deals with finding savegames. More... | |
struct | SmallFiosItem |
Deals with the type of the savegame, independent of extension. More... |
Typedefs | |
typedef SmallMap< uint, CompanyProperties * > | CompanyPropertiesMap |
Enumerations | |
enum | FileSlots { CONFIG_SLOT = 0, SOUND_SLOT = 1, FIRST_GRF_SLOT = 2, LAST_GRF_SLOT = 63, MAX_FILE_SLOTS = 64 } |
enum | SaveLoadDialogMode { SLD_LOAD_GAME, SLD_LOAD_SCENARIO, SLD_SAVE_GAME, SLD_SAVE_SCENARIO, SLD_LOAD_HEIGHTMAP, SLD_SAVE_HEIGHTMAP } |
Mode of the file dialogue window. More... | |
enum | FileType { FT_NONE, FT_SAVEGAME, FT_SCENARIO, FT_HEIGHTMAP } |
The different types of files that the system knows about. More... | |
enum | FiosType { FIOS_TYPE_DRIVE, FIOS_TYPE_PARENT, FIOS_TYPE_DIR, FIOS_TYPE_FILE, FIOS_TYPE_OLDFILE, FIOS_TYPE_SCENARIO, FIOS_TYPE_OLD_SCENARIO, FIOS_TYPE_DIRECT, FIOS_TYPE_PNG, FIOS_TYPE_BMP, FIOS_TYPE_INVALID = 255 } |
enum | SortingBits { SORT_ASCENDING = 0, SORT_DESCENDING = 1, SORT_BY_DATE = 0, SORT_BY_NAME = 2 } |
Functions | |
void | ShowSaveLoadDialog (SaveLoadDialogMode mode) |
Launch save/load dialog in the given mode. | |
void | FiosGetSavegameList (SaveLoadDialogMode mode) |
Get a list of savegames. | |
void | FiosGetScenarioList (SaveLoadDialogMode mode) |
Get a list of scenarios. | |
void | FiosGetHeightmapList (SaveLoadDialogMode mode) |
Get a list of heightmaps. | |
void | FiosFreeSavegameList () |
Free the list of savegames. | |
const char * | FiosBrowseTo (const FiosItem *item) |
Browse to a new path based on the passed item, starting at #_fios_path. | |
StringID | FiosGetDescText (const char **path, uint64 *total_free) |
Get descriptive texts. | |
bool | FiosDelete (const char *name) |
Delete a file. | |
void | FiosMakeHeightmapName (char *buf, const char *name, const char *last) |
Construct a filename for a height map. | |
void | FiosMakeSavegameName (char *buf, const char *name, const char *last) |
Make a save game or scenario filename from a name. | |
FiosType | FiosGetSavegameListCallback (SaveLoadDialogMode mode, const char *file, const char *ext, char *title, const char *last) |
Callback for FiosGetFileList. | |
int CDECL | CompareFiosItems (const FiosItem *a, const FiosItem *b) |
Compare two FiosItem's. | |
void | BuildFileList () |
void | SetFiosType (const byte fiostype) |
Variables | |
LoadCheckData | _load_check_data |
Data loaded from save during SL_LOAD_CHECK. | |
SmallVector< FiosItem, 32 > | _fios_items |
SmallFiosItem | _file_to_saveload |
SaveLoadDialogMode | _saveload_mode |
SortingBits | _savegame_sort_order |
const TextColour | _fios_colours [] |
Colours for fios types, indexed by #FiosType. |
Declarations for savegames operations.
Definition in file fios.h.
enum FileSlots |
enum FileType |
enum SaveLoadDialogMode |
Compare two FiosItem's.
Used with sort when sorting the file list.
da | A pointer to the first FiosItem to compare. |
db | A pointer to the second FiosItem to compare. |
Definition at line 54 of file fios.cpp.
Referenced by FiosGetFileList().
const char* FiosBrowseTo | ( | const FiosItem * | item | ) |
Browse to a new path based on the passed item, starting at #_fios_path.
*item | Item telling us what to do. |
NULL
. Definition at line 93 of file fios.cpp.
References seprintf(), and strecat().
Referenced by SaveLoadWindow::OnClick().
bool FiosDelete | ( | const char * | name | ) |
Delete a file.
name | Filename to delete. |
Definition at line 210 of file fios.cpp.
References FiosMakeSavegameName(), and lastof.
Referenced by SaveLoadWindow::OnTimeout().
void FiosFreeSavegameList | ( | ) |
Free the list of savegames.
Definition at line 69 of file fios.cpp.
References SmallVector< T, S >::Clear(), and SmallVector< T, S >::Compact().
StringID FiosGetDescText | ( | const char ** | path, |
uint64 * | total_free | ||
) |
Get descriptive texts.
Returns the path and free space left on the device
path | string describing the path |
total_free | total free space in megabytes, optional (can be NULL) |
Definition at line 82 of file fios.cpp.
Referenced by SaveLoadWindow::DrawWidget().
void FiosGetHeightmapList | ( | SaveLoadDialogMode | mode | ) |
Get a list of heightmaps.
mode | Save/load mode. |
Definition at line 553 of file fios.cpp.
References FiosGetFileList(), HEIGHTMAP_DIR, lastof, and NO_DIRECTORY.
void FiosGetSavegameList | ( | SaveLoadDialogMode | mode | ) |
Get a list of savegames.
mode | Save/load mode. |
Definition at line 430 of file fios.cpp.
References FiosGetFileList(), FiosGetSavegameListCallback(), NO_DIRECTORY, and SAVE_DIR.
FiosType FiosGetSavegameListCallback | ( | SaveLoadDialogMode | mode, |
const char * | file, | ||
const char * | ext, | ||
char * | title, | ||
const char * | last | ||
) |
Callback for FiosGetFileList.
It tells if a file is a savegame or not.
mode | Save/load mode. |
file | Name of the file to check. |
ext | A pointer to the extension identifier inside file |
title | Buffer if a callback wants to lookup the title of the file; NULL to skip the lookup |
last | Last available byte in buffer (to prevent buffer overflows); not used when title == NULL |
Definition at line 398 of file fios.cpp.
References GetFileTitle(), SAVE_DIR, SLD_LOAD_GAME, and SLD_LOAD_SCENARIO.
Referenced by FiosGetSavegameList(), and openttd_main().
void FiosGetScenarioList | ( | SaveLoadDialogMode | mode | ) |
Get a list of scenarios.
mode | Save/load mode. |
Definition at line 484 of file fios.cpp.
References FiosGetFileList(), FiosGetScenarioListCallback(), lastof, NO_DIRECTORY, SCENARIO_DIR, and SLD_LOAD_SCENARIO.
void FiosMakeHeightmapName | ( | char * | buf, |
const char * | name, | ||
const char * | last | ||
) |
Construct a filename for a height map.
buf | Destination buffer. |
name | Filename. |
last | Last element of buffer buf. |
Definition at line 196 of file fios.cpp.
References FiosMakeFilename(), GetCurrentScreenshotExtension(), lastof, and strecpy().
Referenced by SaveLoadWindow::OnTimeout().
void FiosMakeSavegameName | ( | char * | buf, |
const char * | name, | ||
const char * | last | ||
) |
Make a save game or scenario filename from a name.
buf | Destination buffer for saving the filename. |
name | Name of the file. |
last | Last element of buffer buf. |
Definition at line 183 of file fios.cpp.
References FiosMakeFilename().
Referenced by FiosDelete(), and SaveLoadWindow::OnTimeout().
void ShowSaveLoadDialog | ( | SaveLoadDialogMode | mode | ) |
Launch save/load dialog in the given mode.
mode | Save/load mode. |
Definition at line 754 of file fios_gui.cpp.
References _load_dialog_desc, _load_heightmap_dialog_desc, _save_dialog_desc, DeleteWindowById(), SmallFiosItem::filetype, SLD_LOAD_HEIGHTMAP, SLD_SAVE_GAME, SLD_SAVE_HEIGHTMAP, SLD_SAVE_SCENARIO, and WC_SAVELOAD.
Referenced by MenuClickSaveLoad(), SelectGameWindow::OnClick(), NetworkStartServerWindow::OnClick(), and MainToolbarWindow::OnHotkey().
const TextColour _fios_colours[] |
Colours for fios types, indexed by #FiosType.
Definition at line 191 of file fios_gui.cpp.
Referenced by SaveLoadWindow::DrawWidget().