diff options
| author | Filippos Karapetis | 2012-06-25 22:32:00 +0300 |
|---|---|---|
| committer | Filippos Karapetis | 2012-06-25 22:32:00 +0300 |
| commit | 16adcb5145ce293af120b7cc828a08166da310e2 (patch) | |
| tree | aa4cf9a67990111d2459f21dfae10c2b546fe325 /common/savefile.h | |
| parent | eb8230988a413ffff3458f0cfade5a94c95940b1 (diff) | |
| download | scummvm-rg350-16adcb5145ce293af120b7cc828a08166da310e2.tar.gz scummvm-rg350-16adcb5145ce293af120b7cc828a08166da310e2.tar.bz2 scummvm-rg350-16adcb5145ce293af120b7cc828a08166da310e2.zip | |
COMMON: Simplify the documentation in openForSaving()
The new more concise description is courtesy of wjp.
Diffstat (limited to 'common/savefile.h')
| -rw-r--r-- | common/savefile.h | 26 |
1 files changed, 7 insertions, 19 deletions
diff --git a/common/savefile.h b/common/savefile.h index abe0df2758..da787289ee 100644 --- a/common/savefile.h +++ b/common/savefile.h @@ -107,25 +107,13 @@ public: * Open the savefile with the specified name in the given directory for * saving. * - * Saved games are always compressed using ZIP compression on platforms - * where the zlib library is included (i.e. almost all platforms except the - * NDS). Engines are expected to always create compressed saved games. - * A notable exception is when the created saved games are compatible with - * the ones that the original interpreters create, and they are then used - * with later game versions in a game series which are not supported by - * ScummVM. An example is the characters exported in the Quest for Glory - * games: these saved states actually contain simple text strings with - * character attributes, which can then be used with later games in the - * Quest for Glory Series. Currently, ScummVM supports Quest for Glory - * 1, 2 and 3. These exported heroes can also be read by the AGS VGA fan - * made version of Quest for Glory 2 and the SCI32 game Quest for Glory IV, - * none of which is supported by ScummVM yet. Moreover, these heroes can - * also be imported into Quest for Glory V, which is a 3D game and thus - * outside of ScummVM's scope. For these reasons, in such cases engines can - * create uncompressed saved games to help users import them in other games - * not supported by ScummVM. Users only need to know that such saved games - * exported by ScummVM are compatible with later unsupported games, without - * needing to explain how to uncompress them. + * Saved games are compressed by default, and engines are expected to + * always write compressed saves. + * + * A notable exception is if uncompressed files are needed for + * compatibility with games not supported by ScummVM, such as character + * exports from the Quest for Glory series. QfG5 is a 3D game and won't be + * supported by ScummVM. * * @param name the name of the savefile * @param compress toggles whether to compress the resulting save file |