add code to debug collision rectangles

[supertux.git] / src / scripting / functions.hpp

diff --git a/src/scripting/functions.hpp b/src/scripting/functions.hpp
index ba0d36a..eacb469 100644 (file)
--- a/src/scripting/functions.hpp
+++ b/src/scripting/functions.hpp
@@ -1,8 +1,29 @@
+//  $Id: main.cpp 3275 2006-04-09 00:32:34Z sommer $
+// 
+//  SuperTux
+//  Copyright (C) 2005 Matthias Braun <matze@braunis.de>
+//
+//  This program 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; either version 2
+//  of the License, or (at your option) any later version.
+//
+//  This program 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 this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+//  02111-1307, USA.
 #ifndef __FUNCTIONS_H__
 #define __FUNCTIONS_H__
 
 #ifndef SCRIPTING_API
 #define __suspend
+#define __custom
+#include <string>
 #include "player_status.hpp"
 #endif
 
@@ -16,24 +37,69 @@ static const int KEY_BRONZE = 0x004;
 static const int KEY_SILVER = 0x008;
 static const int KEY_GOLD   = 0x010;
 
-/** displays a text file and scrolls it over the screen */
+/**
+ * Display the value of the argument. This is usefull for inspecting tables.
+ */
+int display(HSQUIRRELVM vm) __custom;
+
+/**
+ * Display a text file and scrolls it over the screen (on next screenswitch)
+ */
 void display_text_file(const std::string& filename);
+
+/**
+ * Load and display a worldmap (on next screenswitch)
+ */
+void load_worldmap(const std::string& filename);
+
+/**
+ * Load and display a level (on next screenswitch)
+ */
+void load_level(const std::string& filename);
+
+/**
+ * Suspend the script execution for the specified number of seconds
+ */
+void wait(HSQUIRRELVM vm, float seconds) __suspend;
+
 /**
- * Suspends the script execution for the specified number of seconds
+ * Suspend the script execution until the current screen has been changed
  */
-void wait(float seconds) __suspend;
-/** translates a give text into the users language (by looking it up in the .po
+void wait_for_screenswitch(HSQUIRRELVM vm) __suspend;
+
+/**
+ * Exits the currently running screen (force exit from worldmap or scrolling
+ * text for example)
+ */
+void exit_screen();
+
+/**
+ * Translate a text into the users language (by looking it up in the .po
  * files)
  */
 std::string translate(const std::string& text);
-/** load a script file and executes it 
- * This is typically used to import functions from external files.
+
+/**
+ * Load a script file and executes it. This is typically used to import
+ * functions from external files.
  */
 void import(HSQUIRRELVM v, const std::string& filename);
-/** add a key to the inventory
+
+/**
+ * Save world state to savegame
+ */
+void save_state();
+
+/**
+ * Add a key to the inventory
  */
 void add_key(int new_key);
 
+/**
+ * enable/disable drawing of collision rectangles
+ */
+void debug_collrects(bool enable);
+
 }
 
 #endif