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__
33 * Display the value of the argument. This is useful for inspecting tables.
35 SQInteger display(HSQUIRRELVM vm) __custom("t.");
38 * Displays contents of the current stack
40 void print_stacktrace(HSQUIRRELVM vm);
43 * returns the currently running thread
45 SQInteger get_current_thread(HSQUIRRELVM vm) __custom("t");
48 * Display a text file and scrolls it over the screen (on next screenswitch)
50 void display_text_file(const std::string& filename);
53 * Load and display a worldmap (on next screenswitch)
55 void load_worldmap(const std::string& filename);
58 * Load and display a level (on next screenswitch)
60 void load_level(const std::string& filename);
63 * Suspend the script execution for the specified number of seconds
65 void wait(HSQUIRRELVM vm, float seconds) __suspend;
68 * Suspend the script execution until the current screen has been changed
70 void wait_for_screenswitch(HSQUIRRELVM vm) __suspend;
73 * Exits the currently running screen (force exit from worldmap or scrolling
79 * Does a fadeout for the specified number of seconds before next screenchange
81 void fadeout_screen(float seconds);
84 * Does a shrinking fade towards the destposition for the specified number of
85 * seconds before next screenchange
87 void shrink_screen(float dest_x, float dest_y, float seconds);
90 * Aborts any kind of previous screen fade; the screenchange will happen
93 void abort_screenfade();
96 * Translate a text into the users language (by looking it up in the .po
99 std::string translate(const std::string& text);
102 * Load a script file and executes it. This is typically used to import
103 * functions from external files.
105 void import(HSQUIRRELVM v, const std::string& filename);
108 * Save world state to savegame
113 * Update worldmap from worldmap state (state.world variable)
115 void update_worldmap();
118 * enable/disable drawing of collision rectangles
120 void debug_collrects(bool enable);
123 * enable/disable drawing of fps
125 void debug_show_fps(bool enable);
128 * enable/disable drawing of non-solid layers
130 void debug_draw_solids_only(bool enable);
133 * Changes music to musicfile
135 void play_music(const std::string& musicfile);
140 void play_sound(const std::string& soundfile);
145 void set_game_speed(float speed);
153 * makes Tux invincible for 10000 units of time
158 * makes Tux a ghost, i.e. lets him float around and through solid objects
163 * recall Tux's invincibility and ghost status
168 * reinitialise and respawn Tux at the beginning of the current level
173 * print Tux's current coordinates in a level
178 * move Tux near the end of the level
183 * show the camera's coordinates
190 void set_gamma(float gamma);
198 * Returns a random integer