diff options
| author | Johannes Schickel | 2016-02-25 17:16:25 +0100 |
|---|---|---|
| committer | Johannes Schickel | 2016-02-25 21:51:53 +0100 |
| commit | 8c5931bca4b85c8779bf69aeb04bad5ed4191b79 (patch) | |
| tree | a2d8091f3405dc23b3e9f0ddd9b0a53966c9422e /common/savefile.h | |
| parent | e7e7aa0558f14edd0ddc3057f8ecfec22863e9ea (diff) | |
| download | scummvm-rg350-8c5931bca4b85c8779bf69aeb04bad5ed4191b79.tar.gz scummvm-rg350-8c5931bca4b85c8779bf69aeb04bad5ed4191b79.tar.bz2 scummvm-rg350-8c5931bca4b85c8779bf69aeb04bad5ed4191b79.zip | |
COMMON: Add documentation about savefile names.
Diffstat (limited to 'common/savefile.h')
| -rw-r--r-- | common/savefile.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/common/savefile.h b/common/savefile.h index f2205e2f4f..9fca07f9d5 100644 --- a/common/savefile.h +++ b/common/savefile.h @@ -56,6 +56,12 @@ typedef WriteStream OutSaveFile; * i.e. typically save states, but also configuration files and similar * things. * + * Savefile names represent SaveFiles. These names are case insensitive, that + * means a name of "Kq1.000" represents the same savefile as "kq1.000". In + * addition, SaveFileManager does not allow for names which contain path + * separators like '/' or '\'. This is because we do not support directories + * in SaveFileManager. + * * While not declared as a singleton, it is effectively used as such, * with OSystem::getSavefileManager returning a pointer to the single * SaveFileManager instances to be used. |