/
imapstatereader.h
60 lines (51 loc) · 1.85 KB
/
imapstatereader.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/** @file imapstatereader.h Interface for a serialized game map state reader.
*
* @authors Copyright © 2014 Daniel Swanson <danij@dengine.net>
*
* @par License
* LGPL: http://www.gnu.org/licenses/lgpl.html
*
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 3 of the License, or (at your
* option) any later version. This program is distributed in the hope that it
* will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
* General Public License for more details. You should have received a copy of
* the GNU Lesser General Public License along with this program; if not, see:
* http://www.gnu.org/licenses</small>
*/
#ifndef LIBDENG2_IMAPSTATEREADER_H
#define LIBDENG2_IMAPSTATEREADER_H
#include <de/Error>
#include <de/Path>
#include <de/Record>
#include <de/game/SavedSession>
namespace de {
namespace game {
/**
* Interface for serialized game map state (savegame) readers.
*
* @ingroup game
*/
class DENG2_PUBLIC IMapStateReader
{
public:
/// An error occurred attempting to open the input file. @ingroup errors
DENG2_ERROR(FileAccessError);
/// Base class for read errors. @ingroup errors
DENG2_ERROR(ReadError);
public:
virtual ~IMapStateReader() {}
/**
* Attempt to load (read/interpret) the serialized game map state.
*
* @param filePath Path to the map state file to be read/interpreted.
*
* @param metadata Deserialized save session metadata for the game state (FYI).
*/
virtual void read(Path const &mapStateFilePath, SavedSession::Metadata const &metadata) = 0;
};
} // namespace game
} // namespace de
#endif // LIBDENG2_IMAPSTATEREADER_H