ScriptInterface Class Reference

Objects that want to expose themself to the scripting environment should implement this interface. More...

#include <script_interface.hpp>

Inherited by AmbientSound, Camera, Candle, DisplayEffect, LevelTime, Platform, Player, ScriptedObject, TextObject, Thunderstorm, TileMap, WillOWisp, and Wind.

List of all members.

Public Member Functions
virtual	~ScriptInterface ()
virtual void	expose (HSQUIRRELVM vm, SQInteger table_idx)=0
virtual void	unexpose (HSQUIRRELVM vm, SQInteger table_idx)=0

---

Detailed Description

Objects that want to expose themself to the scripting environment should implement this interface.

Definition at line 26 of file script_interface.hpp.

---

Constructor & Destructor Documentation

virtual ScriptInterface::~ScriptInterface

(

)

[inline, virtual]

Definition at line 29 of file script_interface.hpp.

  {}

---

Member Function Documentation

virtual void ScriptInterface::expose	(	HSQUIRRELVM	vm,
		SQInteger	table_idx
	)			[pure virtual]

Implemented in WillOWisp, AmbientSound, Camera, Candle, DisplayEffect, LevelTime, Platform, Player, ScriptedObject, TextObject, Thunderstorm, TileMap, and Wind.

Referenced by worldmap::WorldMap::try_expose(), and Sector::try_expose().

virtual void ScriptInterface::unexpose	(	HSQUIRRELVM	vm,
		SQInteger	table_idx
	)			[pure virtual]

Implemented in WillOWisp, AmbientSound, Camera, Candle, DisplayEffect, LevelTime, Platform, Player, ScriptedObject, TextObject, Thunderstorm, TileMap, and Wind.

Referenced by worldmap::WorldMap::try_unexpose(), and Sector::try_unexpose().

---

The documentation for this class was generated from the following file:

• src/supertux/script_interface.hpp

---