Referencia de la clase Tapioca::LuaManager

Clase que se encarga de gestionar el scripting en Lua. Más...

#include <LuaManager.h>

Diagrama de herencia de Tapioca::LuaManager

Métodos públicos
	LuaManager (LuaManager &)=delete
	LuaManager (LuaManager &&)=delete
LuaManager &	operator= (LuaManager &)=delete
LuaManager &	operator= (LuaManager &&)=delete
	~LuaManager ()
	Destructor del manager. No borrar el manager.
lua_State *	getLuaState () const
	Devuelve un puntero al estado de Lua usado para scripting.
std::vector< CompValue >	callLuaFunction (const std::string &name, const std::vector< CompValue > &parameters={}, bool *success=nullptr)
	Llama a una funcion de Lua global. Para comprobar si ha producido un error usar el parametro success.
bool	addLuaFunction (const std::string &name, std::function< void()> f)
	Anade una funcion sin parametros y sin devolver nada a la tabla global.
CompValue	getValueFromLua (const std::string &name)
	Recoge una variable valida (mirar al principio del archivo) global.
bool	setValueOnLua (const std::string &name, CompValue value)
	Crea una variable valida (mirar al principio del archivo) global.
LuaRegistry *	getRegistry () const
	Devuelve el registro de variables de Lua.
Métodos públicos heredados de Tapioca::Module
	Module ()
virtual	~Module ()
virtual bool	initConfig ()
	Inicializa la configuracion especificada por el juego.
virtual void	start ()
	Inicializa las variables.
virtual void	update (const uint64_t deltaTime)
	Actualiza el modulo.
virtual void	fixedUpdate ()
	Actualiza el modulo a una velocidad fija.
virtual void	render ()
	Renderiza el modulo.
virtual void	refresh ()
	Refresca el modulo.
Métodos públicos heredados de Tapioca::Singleton< LuaManager >
	Singleton (const Singleton< LuaManager > &s)=delete
Singleton< LuaManager > &	operator= (const Singleton< LuaManager > &s)=delete
virtual	~Singleton ()
	Destructor vacio.

Amigas
class	Singleton< LuaManager >

Otros miembros heredados
Métodos públicos estáticos heredados de Tapioca::Singleton< LuaManager >
static LuaManager *	create (T_args &&... args)
	Inicializa la instancia con los parametros deseados (... args)
static LuaManager *	instance ()
	Obtener el puntero a la instancia.
Métodos protegidos heredados de Tapioca::Singleton< LuaManager >
	Singleton ()
	Constructor vacio.

Descripción detallada

Clase que se encarga de gestionar el scripting en Lua.

Documentación de constructores y destructores

LuaManager() [1/2]

Tapioca::LuaManager::LuaManager ( LuaManager & )

delete

LuaManager() [2/2]

Tapioca::LuaManager::LuaManager ( LuaManager && )

delete

~LuaManager()

Tapioca::LuaManager::~LuaManager

(

)

Destructor del manager. No borrar el manager.

Documentación de funciones miembro

addLuaFunction()

bool Tapioca::LuaManager::addLuaFunction	(	const std::string &	name,
		std::function< void()>	f )

Anade una funcion sin parametros y sin devolver nada a la tabla global.

Parámetros

name	Nombre de la funcion en Lua
f	Funcion

Devuelve

Si se ha podido anadir

callLuaFunction()

std::vector< CompValue > Tapioca::LuaManager::callLuaFunction	(	const std::string &	name,
		const std::vector< CompValue > &	parameters = {},
		bool *	success = nullptr )

Llama a una funcion de Lua global. Para comprobar si ha producido un error usar el parametro success.

Parámetros

name	Nombre de la funcion a llamar
parameters	Parametros validos (mirar al principio del archivo) a pasar en la funcion
success	Puntero a booleano (ya debe haberse reservado espacio) que escribe en el si todo ha ido bien. Si se pasa nullptr, no ocurre nada

Devuelve

Parametros devueltos por la funcion. Si un parametro no se puede recoger con CompValue, se convertira en nullptr. Si la funcion produce un error, devuelve un vector vacio

getLuaState()

lua_State * Tapioca::LuaManager::getLuaState ( ) const

inline

Devuelve un puntero al estado de Lua usado para scripting.

Devuelve

Puntero al estado de Lua usado para scripting

getRegistry()

LuaRegistry * Tapioca::LuaManager::getRegistry ( ) const

inline

Devuelve el registro de variables de Lua.

Devuelve

Registro de variables de Lua

getValueFromLua()

CompValue Tapioca::LuaManager::getValueFromLua

(

const std::string &

name

)

Recoge una variable valida (mirar al principio del archivo) global.

Parámetros

name	Nombre de la variable

Devuelve

Valor de la variable recogida

operator=() [1/2]

LuaManager & Tapioca::LuaManager::operator= ( LuaManager && )

delete

operator=() [2/2]

LuaManager & Tapioca::LuaManager::operator= ( LuaManager & )

delete

setValueOnLua()

bool Tapioca::LuaManager::setValueOnLua	(	const std::string &	name,
		CompValue	value )

Crea una variable valida (mirar al principio del archivo) global.

Parámetros

name	Nombre de la variable
value	Valor de la variable

Devuelve

Si se ha asignado correctamente

Documentación de símbolos amigos y relacionados

Singleton< LuaManager >

friend class Singleton< LuaManager >

friend

---

La documentación de esta clase está generada de los siguientes archivos:

• src/Bridge/LuaManager.h
• src/Bridge/LuaManager.cpp