scripting Namespace Reference

WARNING: This file is automatically generated from: 'src/scripting/wrapper.interface.hpp' DO NOT CHANGE. More...

Classes
class	AmbientSound
class	Background
class	Camera
class	Candle
class	Dispenser
class	DisplayEffect
class	FloatingImage
class	GameObject
class	Gradient
class	LevelTime
class	ParticleSystem
class	Platform
class	Player
class	Rock
class	ScriptedObject
class	Sector
class	Text
class	TextArray
	A text array intended for scripts with narration. More...
class	Thunderstorm
class	TileMap
class	Torch
class	WillOWisp
class	Wind

Functions
SQInteger	display (HSQUIRRELVM vm) __custom("t.")
	Display the value of the argument. More...
void	print_stacktrace (HSQUIRRELVM vm)
	Displays contents of the current stack.
SQInteger	get_current_thread (HSQUIRRELVM vm) __custom("t")
	returns the currently running thread
bool	is_christmas ()
	Should use christmas mode.
void	wait (HSQUIRRELVM vm, float seconds) __suspend
	Suspend the script execution for the specified number of seconds.
void	wait_for_screenswitch (HSQUIRRELVM vm) __suspend
	Suspend the script execution until the current screen has been changed.
void	exit_screen ()
	Exits the currently running screen (force exit from worldmap or scrolling text for example)
std::string	translate (const std::string &text)
	Translate a text into the users language (by looking it up in the .po files)
std::string	_ (const std::string &text)
std::string	translate_plural (const std::string &text, const std::string &text_plural, int num)
std::string	__ (const std::string &text, const std::string &text_plural, int num)
void	display_text_file (const std::string &filename)
	Display a text file and scrolls it over the screen (on next screenswitch)
void	load_worldmap (const std::string &filename)
	Load and display a worldmap (on next screenswitch)
void	set_next_worldmap (const std::string &dirname, const std::string &spawnpoint)
	Switch to a different worldmap after unloading current one, after exit_screen() is called.
void	load_level (const std::string &filename)
	Load and display a level (on next screenswitch)
void	import (HSQUIRRELVM v, const std::string &filename)
	Load a script file and executes it. More...
void	debug_collrects (bool enable)
	enable/disable drawing of collision rectangles
void	debug_show_fps (bool enable)
	enable/disable drawing of fps
void	debug_draw_solids_only (bool enable)
	enable/disable drawing of non-solid layers
void	debug_draw_editor_images (bool enable)
	enable/disable drawing of editor images
void	debug_worldmap_ghost (bool enable)
	enable/disable worldmap ghost mode
void	save_state ()
	Save world state to scripting table.
void	load_state ()
	Load world state from scripting table.
void	play_music (const std::string &musicfile)
	Changes music to musicfile.
void	play_sound (const std::string &soundfile)
	Plays a soundfile.
void	grease ()
	speeds Tux up
void	invincible ()
	makes Tux invincible for 10000 units of time
void	ghost ()
	makes Tux a ghost, i.e. More...
void	mortal ()
	recall Tux's invincibility and ghost status
void	restart ()
	reinitialise and respawn Tux at the beginning of the current level
void	whereami ()
	print Tux's current coordinates in a level
void	gotoend ()
	move Tux near the end of the level
void	warp (float offset_x, float offset_y)
	move Tux to the X and Y blocks relative to his position
void	camera ()
	show the camera's coordinates
void	set_gamma (float gamma)
	adjust gamma
void	quit ()
	exit the game
int	rand ()
	Returns a random integer.
void	set_game_speed (float speed)
	Set the game_speed.
void	record_demo (const std::string &filename)
	Record a demo to the given file. More...
void	play_demo (const std::string &filename)
	Play back a demo from the given file. More...
GameObjectManager &	get_game_object_manager ()
void	Level_finish (bool win)
	Instantly finish the currently played level.
void	Level_spawn (const std::string &sector, const std::string &spawnpoint)
	spawn tux at specified sector and spawnpoint
void	Level_flip_vertically ()
	Flip level vertically.
void	Level_toggle_pause ()
	toggle pause
void	Level_edit (bool edit_mode)
	Switch to and from edit mode.
void	create_squirrel_instance (HSQUIRRELVM v, scripting::AmbientSound *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Background *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Camera *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Candle *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Dispenser *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::DisplayEffect *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::FloatingImage *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Gradient *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::LevelTime *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::ParticleSystem *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Platform *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Player *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Rock *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::ScriptedObject *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Sector *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Text *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::TextArray *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Thunderstorm *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::TileMap *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Torch *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::WillOWisp *object, bool setup_releasehook)
void	create_squirrel_instance (HSQUIRRELVM v, scripting::Wind *object, bool setup_releasehook)
void	register_supertux_wrapper (HSQUIRRELVM v)

Detailed Description

WARNING: This file is automatically generated from: 'src/scripting/wrapper.interface.hpp' DO NOT CHANGE.

Function Documentation

display()

SQInteger scripting::display

(

HSQUIRRELVM

vm

)

Display the value of the argument.

This is useful for inspecting tables.

ghost()

void scripting::ghost

(

)

makes Tux a ghost, i.e.

lets him float around and through solid objects

import()

void scripting::import	(	HSQUIRRELVM	v,
		const std::string &	filename
	)

Load a script file and executes it.

This is typically used to import functions from external files.

play_demo()

void scripting::play_demo

(

const std::string &

filename

)

Play back a demo from the given file.

record_demo()

void scripting::record_demo

(

const std::string &

filename

)

Record a demo to the given file.