(svn r23623) -Add: allow bi-directional communication with the AdminPort and GameScript

1 files changed, 53 insertions, 0 deletions

diff --git a/src/script/api/script_admin.hpp b/src/script/api/script_admin.hpp
new file mode 100644
index 000000000..9733e5b9e
--- /dev/null
+++ b/src/script/api/script_admin.hpp
@@ -0,0 +1,53 @@
+/* $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 script_admin.hpp Everything to communicate with the AdminPort. */
+
+#ifndef SCRIPT_ADMIN_HPP
+#define SCRIPT_ADMIN_HPP
+
+#include <string>
+#include "script_object.hpp"
+
+/**
+ * Class that handles communication with the AdminPort.
+ * @api game
+ */
+class ScriptAdmin : public ScriptObject {
+public:
+#ifndef DOXYGEN_API
+	/**
+	 * Internal representation of the Send function.
+	 */
+	static SQInteger Send(HSQUIRRELVM vm);
+#else
+	/**
+	 * Send information to the AdminPort. The information can be anything
+	 *  as long as it isn't a class or instance thereof.
+	 * @param table The information to send, in a table. For example: { param = "param" }.
+	 * @return True if and only if the data was successfully converted to JSON
+	 *  and send to the AdminPort.
+	 * @note If the resulting JSON of your table is larger than 1450 bytes,
+	 *   nothing will be sent (and false will be returned).
+	 */
+	static bool Send(table);
+#endif /* DOXYGEN_API */
+
+private:
+	/**
+	 * Convert a Squirrel structure into a JSON string.
+	 * @param vm The VM to operate on.
+	 * @param index The index we are currently working for.
+	 * @param max_depth The maximal depth to follow the squirrel struct.
+	 * @param data The resulting json string.
+	 */
+	static bool MakeJSON(HSQUIRRELVM vm, SQInteger index, int max_depth, std::string &data);
+};
+
+#endif /* SCRIPT_ADMIN_HPP */