4 // Copyright (C) 2006 Matthias Braun <matze@braunis.de>
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.
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.
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.
20 #ifndef __FUNCTIONS_H__
21 #define __FUNCTIONS_H__
27 #include "player_status.hpp"
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;
41 * Display the value of the argument. This is usefull for inspecting tables.
43 int display(HSQUIRRELVM vm) __custom;
46 * Display a text file and scrolls it over the screen (on next screenswitch)
48 void display_text_file(const std::string& filename);
51 * Load and display a worldmap (on next screenswitch)
53 void load_worldmap(const std::string& filename);
56 * Load and display a level (on next screenswitch)
58 void load_level(const std::string& filename);
61 * Suspend the script execution for the specified number of seconds
63 void wait(HSQUIRRELVM vm, float seconds) __suspend;
66 * Suspend the script execution until the current screen has been changed
68 void wait_for_screenswitch(HSQUIRRELVM vm) __suspend;
71 * Exits the currently running screen (force exit from worldmap or scrolling
77 * Does a fadeout for the specified number of seconds before next screenchange
79 void fadeout_screen(float seconds);
82 * Does a shrinking fade towards the destposition for the specified number of
83 * seconds before next screenchange
85 void shrink_screen(float dest_x, float dest_y, float seconds);
88 * Translate a text into the users language (by looking it up in the .po
91 std::string translate(const std::string& text);
94 * Load a script file and executes it. This is typically used to import
95 * functions from external files.
97 void import(HSQUIRRELVM v, const std::string& filename);
100 * Save world state to savegame
105 * Add a key to the inventory
107 void add_key(int new_key);
110 * enable/disable drawing of collision rectangles
112 void debug_collrects(bool enable);
115 * enable/disable drawing of fps
117 void debug_draw_fps(bool enable);
120 * enable/disable drawing of non-solid layers
122 void debug_draw_solids_only(bool enable);
130 * makes Tux invincible for 10000 units of time
135 * recall Tux's invincibility
140 * hurt Tux (kill when Small Tux, otherwise lose powerup or shrink)
150 * reinitialise and respawn Tux at the beginning of the current level
155 * print Tux's current coordinates in a level
160 * move Tux near the end of the level
165 * show the camera's coordinates