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  * Translate a text into the users language (by looking it up in the .po
  78  * files)
  79  */
  80 std::string translate(const std::string& text);
  81
  82 /**
  83  * Load a script file and executes it. This is typically used to import
  84  * functions from external files.
  85  */
  86 void import(HSQUIRRELVM v, const std::string& filename);
  87
  88 /**
  89  * Save world state to savegame
  90  */
  91 void save_state();
  92
  93 /**
  94  * Add a key to the inventory
  95  */
  96 void add_key(int new_key);
  97
  98 /**
  99  * enable/disable drawing of collision rectangles
 100  */
 101 void debug_collrects(bool enable);
 102
 103 /**
 104  * enable/disable drawing of non-solid layers
 105  */
 106 void draw_solids_only(bool enable);
 107
 108 /**
 109  * speeds Tux up
 110  */
 111 void grease();
 112
 113 /**
 114  * makes Tux invincible for 10000 units of time
 115  */
 116 void invincible();
 117
 118 /**
 119  * recall Tux's invincibility
 120  */
 121 void mortal();
 122
 123 /**
 124  * hurt Tux (kill when Small Tux, otherwise lose powerup or shrink)
 125  */
 126 void shrink();
 127
 128 /**
 129  * kill Tux
 130  */
 131 void kill();
 132
 133 /**
 134  * reinitialise and respawn Tux at the beginning of the current level
 135  */
 136 void restart();
 137
 138 /**
 139  * print Tux's current coordinates in a level
 140  */
 141 void whereami();
 142
 143 /**
 144  * move Tux near the end of the level
 145  */
 146 void gotoend();
 147
 148 /**
 149  * flip the level vertically
 150  */
 151 void flip();
 152
 153 /**
 154  * quit the level, marking it as solved
 155  */
 156 void finish();
 157
 158 /**
 159  * show the camera's coordinates
 160  */
 161 void camera();
 162
 163 /**
 164  * exit the game
 165  */
 166 void quit();
 167 }
 168
 169 #endif
 170