ModApiSound Class Reference

#include <l_sound.h>

Inheritance diagram for ModApiSound:

Collaboration diagram for ModApiSound:

Static Public Member Functions
static void	Initialize (lua_State *L, int top)
Static Public Member Functions inherited from ModApiBase
static ScriptApiBase *	getScriptApiBase (lua_State *L)
static Server *	getServer (lua_State *L)
static ServerInventoryManager *	getServerInventoryMgr (lua_State *L)
static Client *	getClient (lua_State *L)
static GUIEngine *	getGuiEngine (lua_State *L)
static IGameDef *	getGameDef (lua_State *L)
static Environment *	getEnv (lua_State *L)
static std::string	getCurrentModPath (lua_State *L)
template<typename T >
static T *	getScriptApi (lua_State *L)
static bool	registerFunction (lua_State *L, const char *name, lua_CFunction func, int top)
static int	l_deprecated_function (lua_State *L, const char *good, const char *bad, lua_CFunction func)
	A wrapper for deprecated functions. More...

Static Private Member Functions
static int	l_sound_play (lua_State *L)
static int	l_sound_stop (lua_State *L)

Additional Inherited Members
Protected Member Functions inherited from LuaHelper
template<>
bool	readParam (lua_State *L, int index)
Static Protected Member Functions inherited from LuaHelper
static bool	isNaN (lua_State *L, int idx)
template<typename T >
static T	readParam (lua_State *L, int index)
	Read a value using a template type T from Lua State L and index. More...
template<typename T >
static T	readParam (lua_State *L, int index, const T &default_value)
	Read a value using a template type T from Lua State L and index. More...

Member Function Documentation

Initialize()

void ModApiSound::Initialize ( lua_State *  L, int  top  )

static

References API_FCT.

Referenced by MainMenuScripting::initializeModApi().

Here is the caller graph for this function:

l_sound_play()

int ModApiSound::l_sound_play ( lua_State *  L )

staticprivate

References ModApiBase::getGuiEngine(), GUIEngine::playSound(), and read_soundspec().

Here is the call graph for this function:

l_sound_stop()

int ModApiSound::l_sound_stop ( lua_State *  L )

staticprivate

References ModApiBase::getGuiEngine(), and GUIEngine::stopSound().

Here is the call graph for this function:

---

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

• script/lua_api/l_sound.h
• script/lua_api/l_sound.cpp