Renamed namespaces to all lowercase

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

diff --git a/src/scripting/functions.hpp b/src/scripting/functions.hpp
index c374d44..6eb8074 100644 (file)
--- a/src/scripting/functions.hpp
+++ b/src/scripting/functions.hpp
@@ -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
@@ -14,33 +12,35 @@
 //  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 useful for inspecting tables.
+ */
+SQInteger display(HSQUIRRELVM vm) __custom("t.");
 
-//TODO: Get this from PlayerStatus (update MiniSwig!)
-static const int KEY_BRASS  = 0x001;
-static const int KEY_IRON   = 0x002;
-static const int KEY_BRONZE = 0x004;
-static const int KEY_SILVER = 0x008;
-static const int KEY_GOLD   = 0x010;
+/**
+ * Displays contents of the current stack
+ */
+void print_stacktrace(HSQUIRRELVM vm);
 
 /**
- * Display the value of the argument. This is usefull for inspecting tables.
+ * returns the currently running thread
  */
-int display(HSQUIRRELVM vm) __custom;
+SQInteger get_current_thread(HSQUIRRELVM vm) __custom("t");
 
 /**
  * Display a text file and scrolls it over the screen (on next screenswitch)
@@ -74,6 +74,23 @@ void wait_for_screenswitch(HSQUIRRELVM vm) __suspend;
 void exit_screen();
 
 /**
+ * Does a fadeout for the specified number of seconds before next screenchange
+ */
+void fadeout_screen(float seconds);
+
+/**
+ * Does a shrinking fade towards the destposition for the specified number of
+ * seconds before next screenchange
+ */
+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)
  */
@@ -91,9 +108,9 @@ void import(HSQUIRRELVM v, const std::string& filename);
 void save_state();
 
 /**
- * Add a key to the inventory
+ * Update worldmap from worldmap state (state.world variable)
  */
-void add_key(int new_key);
+void update_worldmap();
 
 /**
  * enable/disable drawing of collision rectangles
@@ -101,9 +118,34 @@ void add_key(int new_key);
 void debug_collrects(bool enable);
 
 /**
+ * enable/disable drawing of fps
+ */
+void debug_show_fps(bool enable);
+
+/**
  * enable/disable drawing of non-solid layers
  */
-void draw_solids_only(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);
+
+/**
+ * Plays a soundfile
+ */
+void play_sound(const std::string& soundfile);
+
+/**
+ *  Set the game_speed
+ */
+void set_game_speed(float speed);
 
 /**
  * speeds Tux up
@@ -116,19 +158,14 @@ void grease();
 void invincible();
 
 /**
- * recall Tux's invincibility
+ * makes Tux a ghost, i.e. lets him float around and through solid objects
  */
-void mortal();
+void ghost();
 
 /**
- * hurt Tux (kill when Small Tux, otherwise lose powerup or shrink)
+ * recall Tux's invincibility and ghost status
  */
-void shrink();
-
-/**
- * kill Tux
- */
-void kill();
+void mortal();
 
 /**
  * reinitialise and respawn Tux at the beginning of the current level
@@ -146,25 +183,37 @@ void whereami();
 void gotoend();
 
 /**
- * flip the level vertically
+ * show the camera's coordinates
+ */
+void camera();
+
+/**
+ * adjust gamma
  */
-void flip();
+void set_gamma(float gamma);
 
 /**
- * quit the level, marking it as solved
+ * exit the game
  */
-void finish();
+void quit();
 
 /**
- * show the camera's coordinates
+ * Returns a random integer
  */
-void camera();
+int rand();
 
 /**
- * exit the game
+ * Record a demo to the given file.
  */
-void quit();
-}
+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 */