ClientSoundHandle Class Reference

#include <l_client_sound.h>

Inheritance diagram for ClientSoundHandle:

Collaboration diagram for ClientSoundHandle:

Public Member Functions
	~ClientSoundHandle ()=default

Static Public Member Functions
static void	create (lua_State *L, sound_handle_t handle)
static void	Register (lua_State *L)
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 EmergeThread *	getEmergeThread (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 void	registerClass (lua_State *L, const char *name, const luaL_Reg *methods, const luaL_Reg *metamethods)
template<typename T >
static T *	checkObject (lua_State *L, int narg)
static int	l_deprecated_function (lua_State *L, const char *good, const char *bad, lua_CFunction func)
	A wrapper for deprecated functions.

Private Member Functions
	ClientSoundHandle (sound_handle_t handle)

Static Private Member Functions
static ClientSoundHandle *	checkobject (lua_State *L, int narg)
static int	gc_object (lua_State *L)
static int	l_stop (lua_State *L)
static int	l_fade (lua_State *L)

Private Attributes
sound_handle_t	m_handle

Static Private Attributes
static const char	className [] = "ClientSoundHandle"
static const luaL_Reg	methods []

Additional Inherited Members
Protected Member Functions inherited from LuaHelper
template<>
bool	readParam (lua_State *L, int index)
template<>
s16	readParam (lua_State *L, int index)
template<>
int	readParam (lua_State *L, int index)
template<>
float	readParam (lua_State *L, int index)
template<>
v2s16	readParam (lua_State *L, int index)
template<>
v2f	readParam (lua_State *L, int index)
template<>
v3f	readParam (lua_State *L, int index)
template<>
std::string_view	readParam (lua_State *L, int index)
template<>
std::string	readParam (lua_State *L, int index)
template<>
std::string_view	readParam (lua_State *L, int index)
	Read a string from Lua state L at index without copying it.
Static Protected Member Functions inherited from LuaHelper
template<typename T >
static T	readParam (lua_State *L, int index)
	Read a value using a template type T from Lua state L at index.
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 at index.

Constructor & Destructor Documentation

ClientSoundHandle()

ClientSoundHandle::ClientSoundHandle ( sound_handle_t handle )

inlineprivate

Referenced by create().

Here is the caller graph for this function:

~ClientSoundHandle()

ClientSoundHandle::~ClientSoundHandle ( )

default

Member Function Documentation

checkobject()

ClientSoundHandle * ClientSoundHandle::checkobject ( lua_State * L, int narg )

staticprivate

References className.

Referenced by l_fade(), and l_stop().

Here is the caller graph for this function:

create()

void ClientSoundHandle::create ( lua_State * L, sound_handle_t handle )

static

References ClientSoundHandle(), and className.

Referenced by ModApiClientSound::l_sound_play().

Here is the call graph for this function:

Here is the caller graph for this function:

gc_object()

int ClientSoundHandle::gc_object ( lua_State * L )

staticprivate

References ISoundManager::freeId(), ModApiBase::getClient(), Client::getSoundManager(), and m_handle.

Referenced by Register().

Here is the call graph for this function:

Here is the caller graph for this function:

l_fade()

int ClientSoundHandle::l_fade ( lua_State * L )

staticprivate

References checkobject(), ISoundManager::fadeSound(), ModApiBase::getClient(), Client::getSoundManager(), m_handle, and LuaHelper::readParam().

Here is the call graph for this function:

l_stop()

int ClientSoundHandle::l_stop ( lua_State * L )

staticprivate

References checkobject(), ModApiBase::getClient(), Client::getSoundManager(), m_handle, and ISoundManager::stopSound().

Here is the call graph for this function:

Register()

void ClientSoundHandle::Register ( lua_State * L )

static

References className, gc_object(), and methods.

Referenced by ClientScripting::InitializeModApi().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

className

const char ClientSoundHandle::className = "ClientSoundHandle"

staticprivate

Referenced by checkobject(), create(), and Register().

m_handle

sound_handle_t ClientSoundHandle::m_handle

private

Referenced by gc_object(), l_fade(), and l_stop().

methods

const luaL_Reg ClientSoundHandle::methods

staticprivate

Initial value:

= {
        luamethod(ClientSoundHandle, stop),
        luamethod(ClientSoundHandle, fade),
        {0,0}
}

Referenced by Register().

---

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

• script/lua_api/l_client_sound.h
• script/lua_api/l_client_sound.cpp