Renamed namespaces to all lowercase
[supertux.git] / src / scripting / functions.hpp
index 94fa88c..6eb8074 100644 (file)
@@ -1,12 +1,10 @@
-//  $Id$
-//
 //  SuperTux
 //  Copyright (C) 2006 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 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 3 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
 //  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.
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-#ifndef __FUNCTIONS_H__
-#define __FUNCTIONS_H__
+#ifndef HEADER_SUPERTUX_SCRIPTING_FUNCTIONS_HPP
+#define HEADER_SUPERTUX_SCRIPTING_FUNCTIONS_HPP
 
 #ifndef SCRIPTING_API
-#define __suspend
-#define __custom
+#include <squirrel.h>
 #include <string>
-#include "player_status.hpp"
+
+#define __suspend
+#define __custom(x)
 #endif
 
-namespace Scripting
-{
+namespace scripting {
 
 /**
- * Display the value of the argument. This is usefull for inspecting tables.
+ * Display the value of the argument. This is useful for inspecting tables.
  */
-SQInteger display(HSQUIRRELVM vm) __custom;
+SQInteger display(HSQUIRRELVM vm) __custom("t.");
 
 /**
  * Displays contents of the current stack
@@ -43,7 +40,7 @@ void print_stacktrace(HSQUIRRELVM vm);
 /**
  * returns the currently running thread
  */
-SQInteger get_current_thread(HSQUIRRELVM vm) __custom;
+SQInteger get_current_thread(HSQUIRRELVM vm) __custom("t");
 
 /**
  * Display a text file and scrolls it over the screen (on next screenswitch)
@@ -88,6 +85,12 @@ void fadeout_screen(float seconds);
 void shrink_screen(float dest_x, float dest_y, float seconds);
 
 /**
+ * Aborts any kind of previous screen fade; the screenchange will happen
+ * anyway.
+ */
+void abort_screenfade();
+
+/**
  * Translate a text into the users language (by looking it up in the .po
  * files)
  */
@@ -105,6 +108,11 @@ void import(HSQUIRRELVM v, const std::string& filename);
 void save_state();
 
 /**
+ * Update worldmap from worldmap state (state.world variable)
+ */
+void update_worldmap();
+
+/**
  * enable/disable drawing of collision rectangles
  */
 void debug_collrects(bool enable);
@@ -120,6 +128,11 @@ void debug_show_fps(bool enable);
 void debug_draw_solids_only(bool enable);
 
 /**
+ * enable/disable worldmap ghost mode
+ */
+void debug_worldmap_ghost(bool enable);
+
+/**
  * Changes music to musicfile
  */
 void play_music(const std::string& musicfile);
@@ -130,6 +143,11 @@ void play_music(const std::string& musicfile);
 void play_sound(const std::string& soundfile);
 
 /**
+ *  Set the game_speed
+ */
+void set_game_speed(float speed);
+
+/**
  * speeds Tux up
  */
 void grease();
@@ -170,6 +188,11 @@ void gotoend();
 void camera();
 
 /**
+ * adjust gamma
+ */
+void set_gamma(float gamma);
+
+/**
  * exit the game
  */
 void quit();
@@ -179,6 +202,18 @@ void quit();
  */
 int rand();
 
-}
+/**
+ * Record a demo to the given file.
+ */
+void record_demo(const std::string& filename);
+
+/**
+ * Play back a demo from the given file.
+ */
+void play_demo(const std::string& filename);
+
+} // namespace scripting
 
 #endif
+
+/* EOF */