Componente de Lua. Permite ejecutar codigo de Lua. Más...

#include <LuaComponent.h>

Diagrama de herencia de Tapioca::LuaComponent

Métodos públicos
	LuaComponent (luabridge::LuaRef *objectTable, const std::string &name)
	Constructor del componente. Para crear un componente, usar addComponent en los GameObject con la id.

	~LuaComponent ()
	Destructor del componente. Para borrar un componente, usar Component::die()

bool	initComponent (const CompMap &variables) override
	Funcion para inicializar un componente. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

void	awake () override
	Funcion para inicializar un componente. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

void	start () override
	Funcion para inicializar un componente. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

void	update (const uint64_t deltaTime) override
	Funcion para actualizar el estado de un componente. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

void	fixedUpdate () override
	Funcion para actualizar el estado de un componente. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

void	handleEvent (std::string const &id, void *info) override
	Funcion para recibir eventos. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

luabridge::LuaRef *	getTable () const
	Devuelve la tabla del objeto de Lua. Para usarla hay que incluir lua.hpp y LuaBridge.h.

std::vector< CompValue >	callFunction (const std::string &name, const std::vector< CompValue > &parameters={}, bool *success=nullptr) const
	Llama a una funcion del objeto de Lua. Para comprobar si ha producido un error usar el parametro success.

Métodos públicos heredados de Tapioca::Component
	Component ()
	Constructor de la clase Component.

virtual	~Component ()
	Destructor de la clase Component.

virtual void	render () const
	Renderizado de un componente.

virtual void	updateUI ()
	Actualiza la interfaz de usuario.

void	pushEvent (std::string const &id, void *info, const bool global=true, const bool delay=false)
	Envia un evento.

template<typename T >
bool	setValueFromMap (T &var, std::string const &varName, const CompMap &map)
	Da valor a una variable declarada en un CompMap.

GameObject *	getObject () const
	Devuelve el objeto al que esta adjunto este componente.

bool	isAlive () const
	Devuelve si el componente esta "vivo" (si se actualizan update, handleEvents, ...)

bool	isActive () const
	Devuelve si el componente esta activo (si es 'false' no se llama a ningun metodo excepto 'receiveEvent')

void	die ()
	Borra el componente.

virtual void	setActive (const bool b)
	Activa o desactiva el componente (si es 'false' no se llama a ningun metodo excepto 'receiveEvent')

Otros miembros heredados
Atributos protegidos heredados de Tapioca::Component
GameObject *	object

bool	alive

bool	active

Descripción detallada

Componente de Lua. Permite ejecutar codigo de Lua.

Documentación de constructores y destructores

◆ LuaComponent()

Tapioca::LuaComponent::LuaComponent	(	luabridge::LuaRef *	objectTable,
		const std::string &	name )

Constructor del componente. Para crear un componente, usar addComponent en los GameObject con la id.

Este componente no usa la macro COMPONENT_ID para que no sea capaz de meterse en las templates de addComponent y getComponent

Parámetros

objectTable	Tabla del objeto de Lua
name	Nombre del componente

◆ ~LuaComponent()

Tapioca::LuaComponent::~LuaComponent ( )

Destructor del componente. Para borrar un componente, usar Component::die()

Documentación de funciones miembro

◆ awake()

void Tapioca::LuaComponent::awake ( )

overridevirtual

Funcion para inicializar un componente. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

Reimplementado de Tapioca::Component.

◆ callFunction()

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

Llama a una funcion del objeto de Lua. 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

◆ fixedUpdate()

void Tapioca::LuaComponent::fixedUpdate ( )

overridevirtual

Funcion para actualizar el estado de un componente. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

Reimplementado de Tapioca::Component.

◆ getTable()

luabridge::LuaRef * Tapioca::LuaComponent::getTable ( ) const

inline

Devuelve la tabla del objeto de Lua. Para usarla hay que incluir lua.hpp y LuaBridge.h.

Devuelve: Tabla del objeto de Lua

◆ handleEvent()

void Tapioca::LuaComponent::handleEvent	(	std::string const &	id,
		void *	info )

overridevirtual

Funcion para recibir eventos. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

Parámetros

id	Identificador del evento
info	Informacion adicional del evento

Reimplementado de Tapioca::Component.

◆ initComponent()

bool Tapioca::LuaComponent::initComponent ( const CompMap & variables )

overridevirtual

Funcion para inicializar un componente. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

Parámetros

variables unordered_map con los parametros iniciales

Reimplementado de Tapioca::Component.

◆ start()

void Tapioca::LuaComponent::start ( )

overridevirtual

Funcion para inicializar un componente. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

Reimplementado de Tapioca::Component.

◆ update()

void Tapioca::LuaComponent::update ( const uint64_t deltaTime )

overridevirtual

Funcion para actualizar el estado de un componente. Se llama solo, no llamar manualmente. Para saber como se implementa, revisar la clase Component.

Parámetros

deltaTime Tiempo transcurrido desde el ultimo frame

Reimplementado de Tapioca::Component.

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

src/Bridge/Components/LuaComponent.h
src/Bridge/Components/LuaComponent.cpp

Métodos públicos

Otros miembros heredados

Descripción detallada

Documentación de constructores y destructores

◆ LuaComponent()

◆ ~LuaComponent()

Documentación de funciones miembro

◆ awake()

◆ callFunction()

◆ fixedUpdate()

◆ getTable()

◆ handleEvent()

◆ initComponent()

◆ start()

◆ update()