#303: Typo fixes from mathnerd314
[supertux.git] / src / scripting / functions.hpp
index 4793cdb..34e5df9 100644 (file)
 namespace Scripting
 {
 
-//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;
+/**
+ * Display the value of the argument. This is useful for inspecting tables.
+ */
+SQInteger display(HSQUIRRELVM vm) __custom;
+
+/**
+ * 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;
 
 /**
  * Display a text file and scrolls it over the screen (on next screenswitch)
@@ -74,6 +77,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 +111,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
@@ -103,7 +123,7 @@ void debug_collrects(bool enable);
 /**
  * enable/disable drawing of fps
  */
-void debug_draw_fps(bool enable);
+void debug_show_fps(bool enable);
 
 /**
  * enable/disable drawing of non-solid layers
@@ -111,6 +131,21 @@ void debug_draw_fps(bool enable);
 void debug_draw_solids_only(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
  */
 void grease();
@@ -121,19 +156,14 @@ void grease();
 void invincible();
 
 /**
- * recall Tux's invincibility
- */
-void mortal();
-
-/**
- * hurt Tux (kill when Small Tux, otherwise lose powerup or shrink)
+ * makes Tux a ghost, i.e. lets him float around and through solid objects
  */
-void shrink();
+void ghost();
 
 /**
- * kill Tux
+ * recall Tux's invincibility and ghost status
  */
-void kill();
+void mortal();
 
 /**
  * reinitialise and respawn Tux at the beginning of the current level
@@ -159,7 +189,12 @@ void camera();
  * exit the game
  */
 void quit();
+
+/**
+ * Returns a random integer
+ */
+int rand();
+
 }
 
 #endif
-