Referencia de la Clase moScript

#include <moScript.h>

Diagrama de herencias de moScript


Métodos públicos
	moScript ()
virtual	~moScript (void)
void	InitScript ()
void	FinishScript ()
bool	IsInitialized ()
bool	CompileFile (const char *strFilename)
bool	CompileBuffer (unsigned char *pbBuffer, size_t szLen)
int	RegisterFunction (const char *strFuncName)
int	RegisterBaseFunction (const char *strFuncName)
bool	SelectScriptFunction (const char *strFuncName)
void	AddFunctionParam (int iInt)
void	AddFunctionParam (float fFloat)
void	AddFunctionParam (char *string)
bool	RunSelectedFunction (int nReturns=0)
bool	ScriptHasFunction (const char *strScriptName)
int	methods (void)
virtual int	ScriptCalling (moLuaVirtualMachine &vm, int iFunctionNumber)=0
virtual int	ResetScriptCalling ()
virtual int	NextScriptCalling ()
virtual void	HandleReturns (moLuaVirtualMachine &vm, const char *strFunc)=0
moLuaVirtualMachine &	vm (void)
Atributos protegidos
bool	m_initialized
int	m_nMethods
int	m_iThisRef
int	m_nArgs
const char *	m_strFunctionName
int	m_iMethodBase
int	m_iMethodBaseIterator
	actual class index method base
int	m_iMethodBaseAncestors
	actual class iterator index method base
int	m_MethodBases [256]
	increment on each call to RegisterFunctions
Atributos protegidos estáticos
static moLuaVirtualMachine	m_vm
static moLuaDebugger	m_dbg

Descripción detallada

Esta clase implementa la funcionalidad necesaria para crear clases scripteables con LUA. Una clase que descienda de moScript puede ser asociada a un script de LUA, y desde el mismo pueden ser llamados métodos de la clase (siempre y cuando sean registrados en la máquina virtual).

Documentación del constructor y destructor

moScript::moScript ( )

El constructor por defecto.

virtual moScript::~moScript ( void ) [virtual]

El destructor por defecto.

Documentación de las funciones miembro

void moScript::AddFunctionParam ( char * string )

Agrega un parámetro de texto a la lista de parámetros para pasar a la función del script seleccionada actualmente.
Parámetros:

string valor del parámetro de texto.

void moScript::AddFunctionParam ( float fFloat )

Agrega un parámetro flotante a la lista de parámetros para pasar a la función del script seleccionada actualmente.
Parámetros:

fFloat valor del parámetro flotante.

void moScript::AddFunctionParam ( int iInt )

Agrega un parámetro entero a la lista de parámetros para pasar a la función del script seleccionada actualmente.
Parámetros:

iInt valor del parámetro entero.

bool moScript::CompileBuffer ( unsigned char * pbBuffer,

size_t szLen

)

Compila el búfer pbBuffer.
Parámetros:

pbBuffer búfer a compilar.

szLen tamaño del búfer.

Devuelve:
el resultado de la operación: true o false.

bool moScript::CompileFile ( const char * strFilename )

Compila el archivo strFilename.
Parámetros:

strFilename nombre del archivo de script.

Devuelve:
el resultado de la operación: true o false.

void moScript::FinishScript ( )

Finaliza el script.

virtual void moScript::HandleReturns ( moLuaVirtualMachine & vm,

const char * strFunc

) [pure virtual]

Esta función es llamada cuando termina la ejecución de una función del script, de manera que da la oportunidad de utilizar los valores devueltos por dicha función.
Parámetros:

vm referencia a la máquina virtual.

strFunc nombre de la función en el script.

Implementado en moMoldeoObject.

void moScript::InitScript ( )

Inicializa el script con la máquina virtual .

bool moScript::IsInitialized ( ) [inline]

int moScript::methods ( void ) [inline]

Devuelve cuantos métodos de la clase han sido registrados en la máquina virtual con RegisterFunction.
Devuelve:
número de métodos.

Ver también:
RegisterFunction

virtual int moScript::NextScriptCalling ( ) [inline, virtual]

int moScript::RegisterBaseFunction ( const char * strFuncName )

Registra la primera función (método) de la clase en la máquina virtual de LUA. Se debe llamar primero esta función para registrar los métodos dentro e la instancia de una clase Además esta función guarda un registro de la cantidad de veces que se llamo a RegisterFunctions para heredar los métodos de las clases de las que se deriva el objeto
Parámetros:

strFuncName nombre de la función.

Devuelve:
regresa el índice de la función den la tabla de LUA, -1 si la operación no es exitosa.

int moScript::RegisterFunction ( const char * strFuncName )

Registra una función (método) de la clase en la máquina virtual de LUA.
Parámetros:

strFuncName nombre de la función.

Devuelve:
regresa el índice de la función den la tabla de LUA, -1 si la operación no es exitosa.

virtual int moScript::ResetScriptCalling ( ) [inline, virtual]

Esta función es llamada cuando se quiere reiniciar el indice iterativo de métodos una vez encontrada la función para que de esta manera la siguiente búsqueda
Parámetros:

vm referencia a la máquina virtual.

iFunctionNumber índice del método siendo llamado.

Devuelve:
número valores que el método de la clase agrega a la pila de LUA. Estos valores son los que en el script son interpretados como los valores que retorna el método. Pueden ser más de 1.

bool moScript::RunSelectedFunction ( int nReturns = 0 )

Ejecuta la función del script LUA seleccionada con SelectScriptFunction.
Parámetros:

nReturns número esperado de valores a devolver por la función.

Devuelve:
el resultado de la operación: true o false.

Ver también:
SelectScriptFunction

virtual int moScript::ScriptCalling ( moLuaVirtualMachine & vm,

int iFunctionNumber

) [pure virtual]

Esta función es llamada cuando en el LUA script un método registrado de la clase es ejecutado.
Parámetros:

vm referencia a la máquina virtual.

iFunctionNumber índice del método siendo llamado.

Devuelve:
número valores que el método de la clase agrega a la pila de LUA. Estos valores son los que en el script son interpretados como los valores que retorna el método. Pueden ser más de 1.

Implementado en moConsole, y moMoldeoObject.

bool moScript::ScriptHasFunction ( const char * strScriptName )

Revisa que el script tenga la función especificada.
Parámetros:

strFuncName nombre de la función.

Devuelve:
true si la función existe, false en caso contrario.

bool moScript::SelectScriptFunction ( const char * strFuncName )

Selecciona una función del script LUA para ejecutar con RunSelectedFunction.
Parámetros:

strFuncName nombre de la función a seleccionar.

Devuelve:
el resultado de la operación: true o false.

Ver también:
RunSelectedFunction

moLuaVirtualMachine& moScript::vm ( void ) [inline]

Devuelve una referencia a la máquina virtual utilizada por este script.
Devuelve:
referencia a la máquina virtual.