Referencia de la Clase GDT::Script::Lua

Sistema de Scripting LUA. Más...

Lista de todos los miembros.

Métodos públicos
_GDT_EXPORT_ void	CambiarCadena (char *strCadenaTabla, const char *strCadenaTexto)
	Cambia el texto de una variable global o de una variable dentro de una tabla.
_GDT_EXPORT_ void	CambiarNumero (char *strCadenaTabla, lua_Number lnNumero)
	Cambia el valor número de una variable global o de una variable dentro de una tabla.
_GDT_EXPORT_ void	Cerrar (void)
	Cierra el sistema Lua.
_GDT_EXPORT_ int	EjecutarArchivo (char *strArchivo)
	Carga y ejecuta un archivo Lua.
_GDT_EXPORT_ int	EjecutarCadena (char *strCadenaLua)
	Ejecuta una cadena Lua.
_GDT_EXPORT_ void	Inicializar (void)
_GDT_EXPORT_ void	LimpiarParametros (void)
	En una función GDT añadida a Lua, borra los parámetros de la memoria.
_GDT_EXPORT_ void	LimpiarResultados (void)
	Borra de la menoría todos los resultados devueltos por una función Lua.
_GDT_EXPORT_ int	LlamarFuncion (int nArgumentos, int nResultados)
	Llama a una función Lua previamente preparada.
_GDT_EXPORT_	Lua (lua_State *L)
_GDT_EXPORT_	Lua ()
_GDT_EXPORT_ void	MostrarError ()
	Muestra, en la consola, información sobre un error Lua que se ha producido.
_GDT_EXPORT_ void	MostrarErroresAutomaticamente (bool bMostrar)
	Activa o desactiva que los errores encontrados durante el procesamiento de Lua se muestran automáticamente.
_GDT_EXPORT_ int	NumeroParametros (void)
	En una función GDT añadida a Lua, retorna el número de parámetros que ha recibido la función.
_GDT_EXPORT_ void	PonerParametroCadena (char *strCadena)
	Pone un parámetro de cadena de texto a la función Lua que va a ser llamada.
_GDT_EXPORT_ void	PonerParametroNumero (lua_Number lNumero)
	Pone un parámetro número a la función Lua que va a ser llamada.
_GDT_EXPORT_ void	PonerResultadoCadena (const char *strCadena)
	En una función GDT añadida a Lua, pone una cadena de texto como resultado (valor devuelto) de la función.
_GDT_EXPORT_ void	PonerResultadoNumero (lua_Number lNumero)
	En una función GDT añadida a Lua, pone un número como resultado (valor devuelto) de la función.
_GDT_EXPORT_ void	PrepararFuncion (char *strFuncion)
	Prepara una función, que esté en un script Lua, para ser llamada desde GDT.
_GDT_EXPORT_ void	RegistrarFuncion (const char *strNombre, lua_CFunction fFuncion)
	El primer parámetro es el nombre que tendrá la función en Lua.
_GDT_EXPORT_ const char *	RetornarCadena (char *strCadenaTabla)
	Obtiene una cadena de texto de una variable global o de una variable dentro de una tabla.
_GDT_EXPORT_ lua_State *	RetornarEstado (void)
	Obtiene la máquina virtual Lua.
_GDT_EXPORT_ lua_Number	RetornarNumero (char *strCadenaTabla)
	Obtiene un número de una variable global o de una variable que de una tabla.
_GDT_EXPORT_ const char *	RetornarParametroCadena (int nParametro)
	En una función GDT añadida a Lua, retorna la cadena de texto del parámetro indicado.
_GDT_EXPORT_ lua_Number	RetornarParametroNumero (int nParametro)
	En una función GDT añadida a Lua, retorna el valor número del parámetro indicado,.
_GDT_EXPORT_ const char *	RetornarResultadoCadena (void)
	Obtiene el resultado cadena de texto de una función Lua llamada.
_GDT_EXPORT_ lua_Number	RetornarResultadoNumero (void)
	Obtiene el resultado número de una función Lua llamada.
_GDT_EXPORT_	~Lua ()

---

Descripción detallada

Sistema de Scripting LUA.

Provee una capa de Scripting externa, en Lenguaje Lua.

---

Documentación del constructor y destructor

GDT::Script::Lua::Lua

(

)

GDT::Script::Lua::Lua

(

lua_State *

L

)

GDT::Script::Lua::~Lua

(

)

---

Documentación de las funciones miembro

void GDT::Script::Lua::CambiarCadena	(	char *	strCadenaTabla,
		const char *	strCadenaTexto
	)

Cambia el texto de una variable global o de una variable dentro de una tabla.

Ejemplo:

 Lua.CambiarTexto("mitexto", "Un texto");
 Lua.CambiarTexto("mitabla->mitexto", "Otro texto");

void GDT::Script::Lua::CambiarNumero	(	char *	strCadenaTabla,
		lua_Number	lnNumero
	)

Cambia el valor número de una variable global o de una variable dentro de una tabla.

Ejemplo:

 Lua.CambiarNumero("minumero", 53);
 Lua.CambiarNumero("mitabla->minumero", 53);

void GDT::Script::Lua::Cerrar

(

void

)

Cierra el sistema Lua.

Cuando el sistema se cierra, se borran todas las variables y tablas que este contenga. También se descargan los archivos scripts, incluyendo las funciones que estos contengan, y las que hayamos registrado nosotros.

Es muy recomendable cerrar el sistema Lua cuando ya no lo necesitemos y así ahorrar memoria.

Ejemplo:

 Lua.Cerrar();

int GDT::Script::Lua::EjecutarArchivo

(

char *

strArchivo

)

Carga y ejecuta un archivo Lua.

Devuelve:

0 si no se producen errores.

Ejemplo:

 int error = Lua.EjecutarArchivo("script.lua");

int GDT::Script::Lua::EjecutarCadena

(

char *

strCadenaLua

)

Ejecuta una cadena Lua.

Devuelve:

0 si no se producen errores.

Ejemplo:

 int error = Lua.EjecutarCadena("a = 5; print(a);");

void GDT::Script::Lua::Inicializar

(

void

)

Desaprobado:

El constructor ya hace lo mismo.

void GDT::Script::Lua::LimpiarParametros

(

void

)

En una función GDT añadida a Lua, borra los parámetros de la memoria.

Los parámetros deben ser limpiados antes de realizar cualquier otra operación de Lua diferente a retornar parámetros.

Ejemplo:

 Lua.LimparParametros();

void GDT::Script::Lua::LimpiarResultados

(

void

)

Borra de la menoría todos los resultados devueltos por una función Lua.

Los resultados deben ser limpiados antes de realizar cualquier otra operación de Lua diferente a retornar.

Ejemplo:

 Lua.LimparResultados();

int GDT::Script::Lua::LlamarFuncion	(	int	nArgumentos,
		int	nResultados
	)

Llama a una función Lua previamente preparada.

Devuelve:

0 si no se producen errores.

Se indicarán el número de parámetros que se le ha pasado y el número de resultados que retornará la función.

Ejemplo:

 int error = Lua.LlamarFuncion(4,3);

void GDT::Script::Lua::MostrarError

(

void

)

Muestra, en la consola, información sobre un error Lua que se ha producido.

Debe ser llamado sólo cuando se sepa que se ha producido un error y cuando esté desactivado que se muestren errores automáticamente.

Ejemplo:

 Lua.MostrarError();

void GDT::Script::Lua::MostrarErroresAutomaticamente

(

bool

bMostrar

)

Activa o desactiva que los errores encontrados durante el procesamiento de Lua se muestran automáticamente.

Por defecto, cuando se inicializa el sistema se activa que los errores se muestren automáticamente.

Ejemplo:

 Lua.MostrarErroresAutomaticamente( false );

int GDT::Script::Lua::NumeroParametros

(

void

)

En una función GDT añadida a Lua, retorna el número de parámetros que ha recibido la función.

Ejemplo:

 parametros = Lua.NumeroParametros();

void GDT::Script::Lua::PonerParametroCadena

(

char *

strCadena

)

Pone un parámetro de cadena de texto a la función Lua que va a ser llamada.

Ejemplo:

 Lua.PonerParametroCadena("hola");

void GDT::Script::Lua::PonerParametroNumero

(

lua_Number

lNumero

)

Pone un parámetro número a la función Lua que va a ser llamada.

Ejemplo:

 Lua.PonerParametroNumero(65);

void GDT::Script::Lua::PonerResultadoCadena

(

const char *

strCadena

)

En una función GDT añadida a Lua, pone una cadena de texto como resultado (valor devuelto) de la función.

Ejemplo:

 Lua.PonerResultadoCadena("Adios");

void GDT::Script::Lua::PonerResultadoNumero

(

lua_Number

lNumero

)

En una función GDT añadida a Lua, pone un número como resultado (valor devuelto) de la función.

Ejemplo:

 Lua.PonerResultadoNumero(43);

void GDT::Script::Lua::PrepararFuncion

(

char *

strFuncion

)

Prepara una función, que esté en un script Lua, para ser llamada desde GDT.

Ejemplo:

 Lua.PrepararFuncion("Funcion");

void GDT::Script::Lua::RegistrarFuncion	(	const char *	strNombre,
		lua_CFunction	fFuncion
	)

El primer parámetro es el nombre que tendrá la función en Lua.

Registra una función, programada en nuestro código GDT, para ser usada como una función de Lua.

Parámetros:

	strNombre	es el nombre que tendrá la función en Lua.
	fFuncion	es el la función en nuestro código GDT.

Ejemplo:

 Lua.RegistrarFuncion("HacerSumas", LUA_Hacer_Sumas);

const char * GDT::Script::Lua::RetornarCadena

(

char *

strCadenaTabla

)

Obtiene una cadena de texto de una variable global o de una variable dentro de una tabla.

Ejemplo:

 texto = Lua.RetornarCadena("micadena");
 texto = Lua.RetornarNumero("mitabla->micadena");

lua_State * GDT::Script::Lua::RetornarEstado

(

void

)

Obtiene la máquina virtual Lua.

Devuelve:

la Máquina Virtual Lua.

Ejemplo: L = Lua.RetornarEstado();

lua_Number GDT::Script::Lua::RetornarNumero

(

char *

strCadenaTabla

)

Obtiene un número de una variable global o de una variable que de una tabla.

Ejemplo:

 numero = Lua.RetornarNumero("minumero");
 numero = Lua.RetornarNumero("mitabla->minumero");

const char * GDT::Script::Lua::RetornarParametroCadena

(

int

nParametro

)

En una función GDT añadida a Lua, retorna la cadena de texto del parámetro indicado.

Ejemplo:

 texto = Lua.RetornarParametroCadena(2);

lua_Number GDT::Script::Lua::RetornarParametroNumero

(

int

nParametro

)

En una función GDT añadida a Lua, retorna el valor número del parámetro indicado,.

Ejemplo:

 numero = Lua.RetornarParametroNumero(1);

const char * GDT::Script::Lua::RetornarResultadoCadena

(

void

)

Obtiene el resultado cadena de texto de una función Lua llamada.

Ejemplo:

 int texto = Lua.RetornarResultadoCadena();

lua_Number GDT::Script::Lua::RetornarResultadoNumero

(

void

)

Obtiene el resultado número de una función Lua llamada.

Ejemplo:

 numero = Lua.RetornarResultadoNumero();

---