Referencia de la Clase moScript

#include <moScript.h>

Diagrama de herencias de moScript

Diagrama de colaboración para moScript:

Tipos públicos
typedef int(*	Function) (moLuaVirtualMachine &vm)

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, moScript::Function &fun)
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 &	mvm (void)

Atributos públicos
Function	Functions [255]

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 Más...
int	m_iMethodBaseAncestors
	actual class iterator index method base Más...
int	m_MethodBases [256]
	increment on each call to RegisterFunctions Más...

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).

Definición en la línea 48 del archivo moScript.h.

Documentación de los 'Typedef' miembros de la clase

Function

typedef int(* moScript::Function) (moLuaVirtualMachine &vm)

Definición en la línea 52 del archivo moScript.h.

Documentación del constructor y destructor

moScript()

moScript::moScript

(

)

El constructor por defecto.

Definición en la línea 137 del archivo moScript.cpp.

~moScript()

moScript::~moScript ( void  )

virtual

El destructor por defecto.

Definición en la línea 164 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

Documentación de las funciones miembro

AddFunctionParam() [1/3]

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.

Definición en la línea 481 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

AddFunctionParam() [2/3]

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.

Definición en la línea 505 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

AddFunctionParam() [3/3]

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.

Definición en la línea 456 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

CompileBuffer()

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.

Definición en la línea 235 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

CompileFile()

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.

Definición en la línea 261 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

FinishScript()

void moScript::FinishScript

(

)

Finaliza el script.

Definición en la línea 204 del archivo moScript.cpp.

Gráfico de llamadas a esta función:

HandleReturns()

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.

Gráfico de llamadas a esta función:

InitScript()

void moScript::InitScript

(

)

Inicializa el script con la máquina virtual .

Inicializamos el moLuaVirtualMachine con la funcion estatica del moScriptManager

Definición en la línea 183 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

IsInitialized()

bool moScript::IsInitialized ( )

inline

Definición en la línea 74 del archivo moScript.h.

Gráfico de llamadas a esta función:

methods()

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

Definición en la línea 153 del archivo moScript.h.

Gráfico de llamadas a esta función:

mvm()

moLuaVirtualMachine& moScript::mvm ( void  )

inline

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

Devuelve

referencia a la máquina virtual.

Definición en la línea 195 del archivo moScript.h.

Gráfico de llamadas a esta función:

NextScriptCalling()

virtual int moScript::NextScriptCalling ( )

inlinevirtual

Definición en la línea 178 del archivo moScript.h.

Gráfico de llamadas a esta función:

RegisterBaseFunction()

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.

Function was correctly registered so beginning new MethodBase for this derivation

Definición en la línea 340 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

Gráfico de llamadas a esta función:

RegisterFunction() [1/2]

int moScript::RegisterFunction	(	const char *	strFuncName,
		moScript::Function &	fun
	)

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.

Definición en la línea 286 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

Gráfico de llamadas a esta función:

RegisterFunction() [2/2]

int moScript::RegisterFunction

(

const char *

strFuncName

)

Definición en la línea 313 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

ResetScriptCalling()

virtual int moScript::ResetScriptCalling ( )

inlinevirtual

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.

Definición en la línea 172 del archivo moScript.h.

Gráfico de llamadas a esta función:

RunSelectedFunction()

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

Definición en la línea 529 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

Gráfico de llamadas a esta función:

ScriptCalling()

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 moMoldeoObject, moConsole y moEffect.

Gráfico de llamadas a esta función:

ScriptHasFunction()

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.

Definición en la línea 417 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

Gráfico de llamadas a esta función:

SelectScriptFunction()

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

Definición en la línea 370 del archivo moScript.cpp.

Gráfico de llamadas para esta función:

Gráfico de llamadas a esta función:

Documentación de los datos miembro

Functions

Function moScript::Functions[255]

Definición en la línea 54 del archivo moScript.h.

m_dbg

moLuaDebugger moScript::m_dbg

staticprotected

Definición en la línea 200 del archivo moScript.h.

m_iMethodBase

int moScript::m_iMethodBase

protected

Definición en la línea 206 del archivo moScript.h.

m_iMethodBaseAncestors

int moScript::m_iMethodBaseAncestors

protected

actual class iterator index method base

Definición en la línea 209 del archivo moScript.h.

m_iMethodBaseIterator

int moScript::m_iMethodBaseIterator

protected

actual class index method base

Definición en la línea 207 del archivo moScript.h.

m_initialized

bool moScript::m_initialized

protected

Definición en la línea 197 del archivo moScript.h.

m_iThisRef

int moScript::m_iThisRef

protected

Definición en la línea 201 del archivo moScript.h.

m_MethodBases

int moScript::m_MethodBases[256]

protected

increment on each call to RegisterFunctions

Definición en la línea 210 del archivo moScript.h.

m_nArgs

int moScript::m_nArgs

protected

Definición en la línea 202 del archivo moScript.h.

m_nMethods

int moScript::m_nMethods

protected

Definición en la línea 198 del archivo moScript.h.

m_strFunctionName

const char* moScript::m_strFunctionName

protected

Definición en la línea 203 del archivo moScript.h.

m_vm

moLuaVirtualMachine moScript::m_vm

staticprotected

Definición en la línea 199 del archivo moScript.h.

---

La documentación para esta clase fue generada a partir de los siguientes ficheros:

• libmoldeo/moScript.h
• libmoldeo/moScript.cpp