summaryrefslogtreecommitdiff
path: root/src/game/game_scanner.hpp
diff options
context:
space:
mode:
authortruebrain <truebrain@openttd.org>2011-12-19 20:55:56 +0000
committertruebrain <truebrain@openttd.org>2011-12-19 20:55:56 +0000
commitc99950c21537f9c890e4eac6d077c0ec6f31b7aa (patch)
treec130b8aa9cf12c7c3a1c9ef014bb35df3f53035f /src/game/game_scanner.hpp
parentb4f832f29f44dcd48e8f0806d47ce78b1963d639 (diff)
downloadopenttd-c99950c21537f9c890e4eac6d077c0ec6f31b7aa.tar.xz
(svn r23606) -Add: GameScanner, to auto-detect game scripts, and wire it in the console
Diffstat (limited to 'src/game/game_scanner.hpp')
-rw-r--r--src/game/game_scanner.hpp40
1 files changed, 40 insertions, 0 deletions
diff --git a/src/game/game_scanner.hpp b/src/game/game_scanner.hpp
new file mode 100644
index 000000000..bf6701221
--- /dev/null
+++ b/src/game/game_scanner.hpp
@@ -0,0 +1,40 @@
+/* $Id$ */
+
+/*
+ * This file is part of OpenTTD.
+ * 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.
+ * 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.
+ * 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/>.
+ */
+
+/** @file game_scanner.hpp declarations of the class for Game scanner */
+
+#ifndef GAME_SCANNER_HPP
+#define GAME_SCANNER_HPP
+
+#include "../script/script_scanner.hpp"
+
+class GameScannerInfo : public ScriptScanner {
+public:
+ GameScannerInfo();
+
+ /* virtual */ void Initialize();
+
+ /**
+ * Check if we have a game by name and version available in our list.
+ * @param nameParam The name of the game script.
+ * @param versionParam The versionof the game script, or -1 if you want the latest.
+ * @param force_exact_match Only match name+version, never latest.
+ * @return NULL if no match found, otherwise the game script that matched.
+ */
+ class GameInfo *FindInfo(const char *nameParam, int versionParam, bool force_exact_match);
+
+protected:
+ /* virtual */ void GetScriptName(ScriptInfo *info, char *name, int len);
+ /* virtual */ const char *GetFileName() const { return PATHSEP "info.nut"; }
+ /* virtual */ Subdirectory GetDirectory() const { return GAME_DIR; }
+ /* virtual */ const char *GetScannerName() const { return "Game Scripts"; }
+ /* virtual */ void RegisterAPI(class Squirrel *engine);
+};
+
+#endif /* GAME_SCANNER_HPP */