OpenTTD Source  20241121-master-g67a0fccfad
game_scanner.hpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD 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.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef GAME_SCANNER_HPP
11 #define GAME_SCANNER_HPP
12 
13 #include "../script/script_scanner.hpp"
14 
16 public:
17  void Initialize() override;
18 
26  class GameInfo *FindInfo(const std::string &name, int version, bool force_exact_match);
27 
28 protected:
29  std::string GetScriptName(ScriptInfo *info) override;
30  const char *GetFileName() const override { return PATHSEP "info.nut"; }
31  Subdirectory GetDirectory() const override { return GAME_DIR; }
32  const char *GetScannerName() const override { return "Game Scripts"; }
33  void RegisterAPI(class Squirrel *engine) override;
34 };
35 
36 
38 public:
39  void Initialize() override;
40 
47  class GameLibrary *FindLibrary(const std::string &library, int version);
48 
49 protected:
50  std::string GetScriptName(ScriptInfo *info) override;
51  const char *GetFileName() const override { return PATHSEP "library.nut"; }
52  Subdirectory GetDirectory() const override { return GAME_LIBRARY_DIR; }
53  const char *GetScannerName() const override { return "GS Libraries"; }
54  void RegisterAPI(class Squirrel *engine) override;
55 };
56 
57 #endif /* GAME_SCANNER_HPP */
All static information from an Game like name, version, etc.
Definition: game_info.hpp:16
All static information from an Game library like name, version, etc.
Definition: game_info.hpp:49
void RegisterAPI(class Squirrel *engine) override
Register the API for this ScriptInfo.
std::string GetScriptName(ScriptInfo *info) override
Get the script name how to store the script in memory.
const char * GetFileName() const override
Get the filename to scan for this type of script.
const char * GetScannerName() const override
Get the type of the script, in plural.
Subdirectory GetDirectory() const override
Get the directory to scan in.
class GameInfo * FindInfo(const std::string &name, int version, bool force_exact_match)
Check if we have a game by name and version available in our list.
const char * GetFileName() const override
Get the filename to scan for this type of script.
class GameLibrary * FindLibrary(const std::string &library, int version)
Find a library in the pool.
void RegisterAPI(class Squirrel *engine) override
Register the API for this ScriptInfo.
Subdirectory GetDirectory() const override
Get the directory to scan in.
std::string GetScriptName(ScriptInfo *info) override
Get the script name how to store the script in memory.
const char * GetScannerName() const override
Get the type of the script, in plural.
All static information from an Script like name, version, etc.
Definition: script_info.hpp:30
int version
Version of the script.
std::string name
Full name of the script.
Scanner to help finding scripts.
class Squirrel * engine
The engine we're scanning with.
Subdirectory
The different kinds of subdirectories OpenTTD uses.
Definition: fileio_type.h:115
@ GAME_LIBRARY_DIR
Subdirectory for all GS libraries.
Definition: fileio_type.h:129
@ GAME_DIR
Subdirectory for all game scripts.
Definition: fileio_type.h:128