(svn r19708) -Add: NewGRF "debugging" window and data tables; should be a useful tool for NewGRF developers to get some insights into the value of some variables

1 files changed, 60 insertions, 0 deletions

diff --git a/src/newgrf_debug.h b/src/newgrf_debug.h
new file mode 100644
index 000000000..91f504a93
--- /dev/null
+++ b/src/newgrf_debug.h
@@ -0,0 +1,60 @@
+/* $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 newgrf_debug.h Functions/types related to NewGRF debugging. */
+
+#ifndef NEWGRF_DEBUG_H
+#define NEWGRF_DEBUG_H
+
+#include "newgrf.h"
+
+/**
+ * Can we inspect the data given a certain feature and index.
+ * The index is normally an in-game location/identifier, such
+ * as a TileIndex or an IndustryID depending on the feature
+ * we want to inspect.
+ * @param feature The feature we want to inspect.
+ * @param index   The index/identifier of the feature to inspect.
+ * @return true if there is something to show.
+ */
+bool IsNewGRFInspectable(GrfSpecFeature feature, uint index);
+
+/**
+ * Show the inspect window for a given feature and index.
+ * The index is normally an in-game location/identifier, such
+ * as a TileIndex or an IndustryID depending on the feature
+ * we want to inspect.
+ * @param feature The feature we want to inspect.
+ * @param index   The index/identifier of the feature to inspect.
+ */
+void ShowNewGRFInspectWindow(GrfSpecFeature feature, uint index);
+
+/**
+ * Delete inspect window for a given feature and index.
+ * The index is normally an in-game location/identifier, such
+ * as a TileIndex or an IndustryID depending on the feature
+ * we want to inspect.
+ * @param feature The feature we want to delete the window for.
+ * @param index   The index/identifier of the feature to delete.
+ */
+void DeleteNewGRFInspectWindow(GrfSpecFeature feature, uint index);
+
+/**
+ * Get the GrfSpecFeature associated with the tile.
+ * @return the GrfSpecFeature.
+ */
+GrfSpecFeature GetGrfSpecFeature(TileIndex tile);
+
+/**
+ * Get the GrfSpecFeature associated with the vehicle.
+ * @return the GrfSpecFeature.
+ */
+GrfSpecFeature GetGrfSpecFeature(VehicleType type);
+
+#endif /* NEWGRF_DEBUG_H */