src/scripting/functions.hpp

   1 //  $Id$
   2 //
   3 //  SuperTux
   4 //  Copyright (C) 2006 Matthias Braun <matze@braunis.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20 #ifndef __FUNCTIONS_H__
  21 #define __FUNCTIONS_H__
  22
  23 #ifndef SCRIPTING_API
  24 #define __suspend
  25 #define __custom
  26 #include <string>
  27 #include "player_status.hpp"
  28 #endif
  29
  30 namespace Scripting
  31 {
  32
  33 //TODO: Get this from PlayerStatus (update MiniSwig!)
  34 static const int KEY_BRASS  = 0x001;
  35 static const int KEY_IRON   = 0x002;
  36 static const int KEY_BRONZE = 0x004;
  37 static const int KEY_SILVER = 0x008;
  38 static const int KEY_GOLD   = 0x010;
  39
  40 /**
  41  * Display the value of the argument. This is usefull for inspecting tables.
  42  */
  43 int display(HSQUIRRELVM vm) __custom;
  44
  45 /**
  46  * Display a text file and scrolls it over the screen (on next screenswitch)
  47  */
  48 void display_text_file(const std::string& filename);
  49
  50 /**
  51  * Load and display a worldmap (on next screenswitch)
  52  */
  53 void load_worldmap(const std::string& filename);
  54
  55 /**
  56  * Load and display a level (on next screenswitch)
  57  */
  58 void load_level(const std::string& filename);
  59
  60 /**
  61  * Suspend the script execution for the specified number of seconds
  62  */
  63 void wait(HSQUIRRELVM vm, float seconds) __suspend;
  64
  65 /**
  66  * Suspend the script execution until the current screen has been changed
  67  */
  68 void wait_for_screenswitch(HSQUIRRELVM vm) __suspend;
  69
  70 /**
  71  * Exits the currently running screen (force exit from worldmap or scrolling
  72  * text for example)
  73  */
  74 void exit_screen();
  75
  76 /**
  77  * Does a fadeout for the specified number of seconds before next screenchange
  78  */
  79 void fadeout_screen(float seconds);
  80
  81 /**
  82  * Does a shrinking fade towards the destposition for the specified number of
  83  * seconds before next screenchange
  84  */
  85 void shrink_screen(float dest_x, float dest_y, float seconds);
  86
  87 /**
  88  * Translate a text into the users language (by looking it up in the .po
  89  * files)
  90  */
  91 std::string translate(const std::string& text);
  92
  93 /**
  94  * Load a script file and executes it. This is typically used to import
  95  * functions from external files.
  96  */
  97 void import(HSQUIRRELVM v, const std::string& filename);
  98
  99 /**
 100  * Save world state to savegame
 101  */
 102 void save_state();
 103
 104 /**
 105  * Add a key to the inventory
 106  */
 107 void add_key(int new_key);
 108
 109 /**
 110  * enable/disable drawing of collision rectangles
 111  */
 112 void debug_collrects(bool enable);
 113
 114 /**
 115  * enable/disable drawing of fps
 116  */
 117 void debug_draw_fps(bool enable);
 118
 119 /**
 120  * enable/disable drawing of non-solid layers
 121  */
 122 void debug_draw_solids_only(bool enable);
 123
 124 /**
 125  * speeds Tux up
 126  */
 127 void grease();
 128
 129 /**
 130  * makes Tux invincible for 10000 units of time
 131  */
 132 void invincible();
 133
 134 /**
 135  * recall Tux's invincibility
 136  */
 137 void mortal();
 138
 139 /**
 140  * hurt Tux (kill when Small Tux, otherwise lose powerup or shrink)
 141  */
 142 void shrink();
 143
 144 /**
 145  * kill Tux
 146  */
 147 void kill();
 148
 149 /**
 150  * reinitialise and respawn Tux at the beginning of the current level
 151  */
 152 void restart();
 153
 154 /**
 155  * print Tux's current coordinates in a level
 156  */
 157 void whereami();
 158
 159 /**
 160  * move Tux near the end of the level
 161  */
 162 void gotoend();
 163
 164 /**
 165  * show the camera's coordinates
 166  */
 167 void camera();
 168
 169 /**
 170  * exit the game
 171  */
 172 void quit();
 173 }
 174
 175 #endif
 176