aboutsummaryrefslogtreecommitdiff
path: root/libs/game_bethesda/src/gamebryo/gamebryomoddatachecker.h
blob: e0b0733511ad63680ccb8fb16f16f0d91d580035 (plain)
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
#ifndef GAMEBRYO_MODATACHECKER_H
#define GAMEBRYO_MODATACHECKER_H

#include <ifiletree.h>
#include <moddatachecker.h>

class GameGamebryo;

/**
 * @brief ModDataChecker for GameBryo games that look at folder and files in the "data"
 *     directory.
 *
 * The default implementation is game-agnostic and uses the list of folders and file
 * extensions that were used before the ModDataChecker feature was added. It is possible
 * to inherit the class to provide custom list of folders or filenames.
 */
class GamebryoModDataChecker : public MOBase::ModDataChecker
{
public:
  /**
   * @brief Construct a new mod-data checker for GameBryo games.
   */
  GamebryoModDataChecker(const GameGamebryo* game);

  virtual CheckReturn
  dataLooksValid(std::shared_ptr<const MOBase::IFileTree> fileTree) const override;

protected:
  GameGamebryo const* const m_Game;

  using FileNameSet = std::set<QString, MOBase::FileNameComparator>;

  const GameGamebryo* game() const { return m_Game; }

  /**
   * @return the list of possible folder names in data.
   */
  virtual const FileNameSet& possibleFolderNames() const;

  /**
   * @return the extensions of possible files in data.
   */
  virtual const FileNameSet& possibleFileExtensions() const;
};

#endif  // GAMEBRYO_MODATACHECKER_H