Referencia de la Clase Yukino::Script

Clase que gestiona el sistema de scripts. Más...

#include <Script.h>

Lista de todos los miembros.

Métodos públicos

UINT Init (void)
 Función para inicializar el objeto Script.
void Release (void)
 Función para finalizar el objeto Script.
int GetTop (void)
 Función para obtener la cima de la pila.
int Type (int index)
 Función para obtener el tipo de una posición de la pila.
int IsNil (int index)
 Función para obtener si es un NULL una posición de la pila.
int IsBool (int index)
 Función para obtener si es un booleano una posición de la pila.
int IsNumber (int index)
 Función para obtener si es un número una posición de la pila.
int IsString (int index)
 Función para obtener si es una cadena una posición de la pila.
int IsTable (int index)
 Función para obtener si es una tabla una posición de la pila.
int IsFunction (int index)
 Función para obtener si es una función una posición de la pila.
int IsCFunction (int index)
 Función para obtener si es una función de C una posición de la pila.
int IsUserData (int index)
 Función para obtener si es un UserData una posición de la pila.
int IsLightUserData (int index)
 Función para obtener si es un UserData una posición de la pila.
const char * TypeName (int type)
 Función para obtener un tipo de dato en una cadena.
int GetBool (int index)
 Función para obtener un booleano de una posición de la pila.
lua_Number GetNumber (int index)
 Función para obtener un número de una posición de la pila.
const char * GetString (int index)
 Función para obtener una cadena de una posición de la pila.
size_t GetStrLen (int index)
 Función para obtener el tamaño de una cadena de una posición de la pila.
lua_CFunction GetCFunction (int index)
 Función para obtener una función de C de una posición de la pila.
void * GetUserData (int index)
 Función para obtener un UserData de una posición de la pila.
lua_State * GetThread (int index)
 Función para obtener un hilo de una posición de la pila.
const void * GetPointer (int index)
 Función para obtener un puntero de una posición de la pila.
void PushBool (int val)
 Función para meter un booleano en la pila.
void PushNumber (lua_Number val)
 Función para meter un número en la pila.
void PushString (const char *val, size_t len)
 Función para meter una cadena en la pila.
void PushString (const char *val)
 Función para meter una cadena en la pila.
void PushNil (void)
 Función para meter un NULL en la pila.
void PushCFunction (lua_CFunction val)
 Función para meter una función de C en la pila.
void PushLightUserData (void *val)
 Función para meter un UserData en la pila.
void ExecFile (const char *file)
 Función para ejecutar un fichero de Lua.
void ExecFile (const string &file)
 Función para ejecutar un fichero de Lua.
void ExecString (const char *str)
 Función para ejecutar una cadena de texto de Lua.
void ExecString (const string &str)
 Función para ejecutar una cadena de texto de Lua.
void Register (const char *name, lua_CFunction func)
 Función para registrar una función de C en Lua.
void Register (const string &name, lua_CFunction func)
 Función para registrar una función de C en Lua.
int GetTop (lua_State *L)
 Función para obtener la cima de la pila.
int Type (lua_State *L, int index)
 Función para obtener el tipo de una posición de la pila.
int IsNil (lua_State *L, int index)
 Función para obtener si es un NULL una posición de la pila.
int IsBool (lua_State *L, int index)
 Función para obtener si es un booleano una posición de la pila.
int IsNumber (lua_State *L, int index)
 Función para obtener si es un número una posición de la pila.
int IsString (lua_State *L, int index)
 Función para obtener si es una cadena una posición de la pila.
int IsTable (lua_State *L, int index)
 Función para obtener si es una tabla una posición de la pila.
int IsFunction (lua_State *L, int index)
 Función para obtener si es una función una posición de la pila.
int IsCFunction (lua_State *L, int index)
 Función para obtener si es una función de C una posición de la pila.
int IsUserData (lua_State *L, int index)
 Función para obtener si es un UserData una posición de la pila.
int IsLightUserData (lua_State *L, int index)
 Función para obtener si es un UserData una posición de la pila.
int GetBool (lua_State *L, int index)
 Función para obtener un booleano de una posición de la pila.
lua_Number GetNumber (lua_State *L, int index)
 Función para obtener un número de una posición de la pila.
const char * GetString (lua_State *L, int index)
 Función para obtener una cadena de una posición de la pila.
size_t GetStrLen (lua_State *L, int index)
 Función para obtener el tamaño de una cadena de una posición de la pila.
lua_CFunction GetCFunction (lua_State *L, int index)
 Función para obtener una función de C de una posición de la pila.
void * GetUserData (lua_State *L, int index)
 Función para obtener un UserData de una posición de la pila.
lua_State * GetThread (lua_State *L, int index)
 Función para obtener un hilo de una posición de la pila.
const void * GetPointer (lua_State *L, int index)
 Función para obtener un puntero de una posición de la pila.
void PushBool (lua_State *L, int val)
 Función para meter un booleano en la pila.
void PushNumber (lua_State *L, lua_Number val)
 Función para meter un número en la pila.
void PushString (lua_State *L, const char *val, size_t len)
 Función para meter una cadena en la pila.
void PushString (lua_State *L, const char *val)
 Función para meter una cadena en la pila.
void PushNil (lua_State *L)
 Función para meter un NULL en la pila.
void PushCFunction (lua_State *L, lua_CFunction val)
 Función para meter una función de C en la pila.
void PushLightUserData (lua_State *L, void *val)
 Función para meter un UserData en la pila.
void ExecFile (lua_State *L, const char *file)
 Función para ejecutar un fichero de Lua.
void ExecFile (lua_State *L, const string &file)
 Función para ejecutar un fichero de Lua.
void ExecString (lua_State *L, const char *str)
 Función para ejecutar una cadena de texto de Lua.
void ExecString (lua_State *L, const string &str)
 Función para ejecutar una cadena de texto de Lua.
void Register (lua_State *L, const char *name, lua_CFunction func)
 Función para registrar una función de C en Lua.
void Register (lua_State *L, const string &name, lua_CFunction func)
 Función para registrar una función de C en Lua.
lua_State * GetLuaState (void)
 Función para obtener el estado de Lua.

Métodos públicos estáticos

static ScriptGetInstance (void)
 Función para obtener la instancia de Script.


Descripción detallada

Clase que gestiona el sistema de scripts.

La clase Input gestiona los temas relacionados con el sistema de scripts con Lua.


Documentación de las funciones miembro

void Yukino::Script::ExecFile ( lua_State *  L,
const string &  file 
) [inline]

Función para ejecutar un fichero de Lua.

Parámetros:
L Estado de Lua.
file Ruta del fichero.

void Yukino::Script::ExecFile ( lua_State *  L,
const char *  file 
) [inline]

Función para ejecutar un fichero de Lua.

Parámetros:
L Estado de Lua.
file Ruta del fichero.

void Yukino::Script::ExecFile ( const string &  file  )  [inline]

Función para ejecutar un fichero de Lua.

Parámetros:
file Ruta del fichero.

void Yukino::Script::ExecFile ( const char *  file  )  [inline]

Función para ejecutar un fichero de Lua.

Parámetros:
file Ruta del fichero.

void Yukino::Script::ExecString ( lua_State *  L,
const string &  str 
) [inline]

Función para ejecutar una cadena de texto de Lua.

Parámetros:
L Estado de Lua.
str Cadena de texto.

void Yukino::Script::ExecString ( lua_State *  L,
const char *  str 
) [inline]

Función para ejecutar una cadena de texto de Lua.

Parámetros:
L Estado de Lua.
str Cadena de texto.

void Yukino::Script::ExecString ( const string &  str  )  [inline]

Función para ejecutar una cadena de texto de Lua.

Parámetros:
str Cadena de texto.

void Yukino::Script::ExecString ( const char *  str  )  [inline]

Función para ejecutar una cadena de texto de Lua.

Parámetros:
str Cadena de texto.

int Yukino::Script::GetBool ( lua_State *  L,
int  index 
) [inline]

Función para obtener un booleano de una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
El valor del dato.

int Yukino::Script::GetBool ( int  index  )  [inline]

Función para obtener un booleano de una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
El valor del dato.

lua_CFunction Yukino::Script::GetCFunction ( lua_State *  L,
int  index 
) [inline]

Función para obtener una función de C de una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
El valor del dato.

lua_CFunction Yukino::Script::GetCFunction ( int  index  )  [inline]

Función para obtener una función de C de una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
El valor del dato.

Script * Yukino::Script::GetInstance ( void   )  [static]

Función para obtener la instancia de Script.

Esta función crea una instancia de Script, en caso de no estar creada, y devuelve un puntero a esta si tiene exito pidiendo memoria.

Devuelve:
Devuelve un puntero al objeto Script si todo ha ido bien, en caso de no haber memoria para el objeto devuelve NULL.

lua_State* Yukino::Script::GetLuaState ( void   )  [inline]

Función para obtener el estado de Lua.

Devuelve:
Un puntero al estado de Lua.

lua_Number Yukino::Script::GetNumber ( lua_State *  L,
int  index 
) [inline]

Función para obtener un número de una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
El valor del dato.

lua_Number Yukino::Script::GetNumber ( int  index  )  [inline]

Función para obtener un número de una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
El valor del dato.

const void* Yukino::Script::GetPointer ( lua_State *  L,
int  index 
) [inline]

Función para obtener un puntero de una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
El valor del dato.

const void* Yukino::Script::GetPointer ( int  index  )  [inline]

Función para obtener un puntero de una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
El valor del dato.

const char* Yukino::Script::GetString ( lua_State *  L,
int  index 
) [inline]

Función para obtener una cadena de una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
El valor del dato.

const char* Yukino::Script::GetString ( int  index  )  [inline]

Función para obtener una cadena de una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
El valor del dato.

size_t Yukino::Script::GetStrLen ( lua_State *  L,
int  index 
) [inline]

Función para obtener el tamaño de una cadena de una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
El tamaño de una cadena.

size_t Yukino::Script::GetStrLen ( int  index  )  [inline]

Función para obtener el tamaño de una cadena de una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
El tamaño de una cadena.

lua_State* Yukino::Script::GetThread ( lua_State *  L,
int  index 
) [inline]

Función para obtener un hilo de una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
El valor del dato.

lua_State* Yukino::Script::GetThread ( int  index  )  [inline]

Función para obtener un hilo de una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
El valor del dato.

int Yukino::Script::GetTop ( lua_State *  L  )  [inline]

Función para obtener la cima de la pila.

Parámetros:
L Estado de Lua.
Devuelve:
La cima de la pila.

int Yukino::Script::GetTop ( void   )  [inline]

Función para obtener la cima de la pila.

Devuelve:
La cima de la pila.

void* Yukino::Script::GetUserData ( lua_State *  L,
int  index 
) [inline]

Función para obtener un UserData de una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
El valor del dato.

void* Yukino::Script::GetUserData ( int  index  )  [inline]

Función para obtener un UserData de una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
El valor del dato.

UINT Yukino::Script::Init ( void   ) 

Función para inicializar el objeto Script.

Esta función sirve para inicializar el objeto Script.

Ver también:
Release().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SCRIPT_ERROR_LUAOPEN.

int Yukino::Script::IsBool ( lua_State *  L,
int  index 
) [inline]

Función para obtener si es un booleano una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsBool ( int  index  )  [inline]

Función para obtener si es un booleano una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsCFunction ( lua_State *  L,
int  index 
) [inline]

Función para obtener si es una función de C una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsCFunction ( int  index  )  [inline]

Función para obtener si es una función de C una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsFunction ( lua_State *  L,
int  index 
) [inline]

Función para obtener si es una función una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsFunction ( int  index  )  [inline]

Función para obtener si es una función una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsLightUserData ( lua_State *  L,
int  index 
) [inline]

Función para obtener si es un UserData una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsLightUserData ( int  index  )  [inline]

Función para obtener si es un UserData una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsNil ( lua_State *  L,
int  index 
) [inline]

Función para obtener si es un NULL una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsNil ( int  index  )  [inline]

Función para obtener si es un NULL una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsNumber ( lua_State *  L,
int  index 
) [inline]

Función para obtener si es un número una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsNumber ( int  index  )  [inline]

Función para obtener si es un número una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsString ( lua_State *  L,
int  index 
) [inline]

Función para obtener si es una cadena una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsString ( int  index  )  [inline]

Función para obtener si es una cadena una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsTable ( lua_State *  L,
int  index 
) [inline]

Función para obtener si es una tabla una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsTable ( int  index  )  [inline]

Función para obtener si es una tabla una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsUserData ( lua_State *  L,
int  index 
) [inline]

Función para obtener si es un UserData una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

int Yukino::Script::IsUserData ( int  index  )  [inline]

Función para obtener si es un UserData una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
Si es verdad devuelve 1, sino devuelve 0.

void Yukino::Script::PushBool ( lua_State *  L,
int  val 
) [inline]

Función para meter un booleano en la pila.

Parámetros:
L Estado de Lua.
val El valor del dato.

void Yukino::Script::PushBool ( int  val  )  [inline]

Función para meter un booleano en la pila.

Parámetros:
val El valor del dato.

void Yukino::Script::PushCFunction ( lua_State *  L,
lua_CFunction  val 
) [inline]

Función para meter una función de C en la pila.

Parámetros:
L Estado de Lua.
val El valor del dato.

void Yukino::Script::PushCFunction ( lua_CFunction  val  )  [inline]

Función para meter una función de C en la pila.

Parámetros:
val El valor del dato.

void Yukino::Script::PushLightUserData ( lua_State *  L,
void *  val 
) [inline]

Función para meter un UserData en la pila.

Parámetros:
L Estado de Lua.
val El valor del dato.

void Yukino::Script::PushLightUserData ( void *  val  )  [inline]

Función para meter un UserData en la pila.

Parámetros:
val El valor del dato.

void Yukino::Script::PushNil ( lua_State *  L  )  [inline]

Función para meter un NULL en la pila.

Parámetros:
L Estado de Lua.

void Yukino::Script::PushNumber ( lua_State *  L,
lua_Number  val 
) [inline]

Función para meter un número en la pila.

Parámetros:
L Estado de Lua.
val El valor del dato.

void Yukino::Script::PushNumber ( lua_Number  val  )  [inline]

Función para meter un número en la pila.

Parámetros:
val El valor del dato.

void Yukino::Script::PushString ( lua_State *  L,
const char *  val 
) [inline]

Función para meter una cadena en la pila.

Parámetros:
L Estado de Lua.
val El valor del dato.

void Yukino::Script::PushString ( lua_State *  L,
const char *  val,
size_t  len 
) [inline]

Función para meter una cadena en la pila.

Parámetros:
L Estado de Lua.
val El valor del dato.
len Tamaño de la cadena.

void Yukino::Script::PushString ( const char *  val  )  [inline]

Función para meter una cadena en la pila.

Parámetros:
val El valor del dato.

void Yukino::Script::PushString ( const char *  val,
size_t  len 
) [inline]

Función para meter una cadena en la pila.

Parámetros:
val El valor del dato.
len Tamaño de la cadena.

void Yukino::Script::Register ( lua_State *  L,
const string &  name,
lua_CFunction  func 
) [inline]

Función para registrar una función de C en Lua.

Parámetros:
L Estado de Lua.
name Nombre en Lua de la función.
func Puntero a la función en C.

void Yukino::Script::Register ( lua_State *  L,
const char *  name,
lua_CFunction  func 
) [inline]

Función para registrar una función de C en Lua.

Parámetros:
L Estado de Lua.
name Nombre en Lua de la función.
func Puntero a la función en C.

void Yukino::Script::Register ( const string &  name,
lua_CFunction  func 
) [inline]

Función para registrar una función de C en Lua.

Parámetros:
name Nombre en Lua de la función.
func Puntero a la función en C.

void Yukino::Script::Register ( const char *  name,
lua_CFunction  func 
) [inline]

Función para registrar una función de C en Lua.

Parámetros:
name Nombre en Lua de la función.
func Puntero a la función en C.

void Yukino::Script::Release ( void   ) 

Función para finalizar el objeto Script.

Esta función sirve para finalizar el objeto Script.

Ver también:
Init().

int Yukino::Script::Type ( lua_State *  L,
int  index 
) [inline]

Función para obtener el tipo de una posición de la pila.

Parámetros:
L Estado de Lua.
index Posición dentro de la pila.
Devuelve:
LUA_TNIL, LUA_TNUMBER, LUA_TBOOLEAN, LUA_TSTRING, LUA_TTABLE, LUA_TFUNCTION, LUA_TUSERDATA, LUA_TTHREAD, LUA_TLIGHTUSERDATA.

int Yukino::Script::Type ( int  index  )  [inline]

Función para obtener el tipo de una posición de la pila.

Parámetros:
index Posición dentro de la pila.
Devuelve:
LUA_TNIL, LUA_TNUMBER, LUA_TBOOLEAN, LUA_TSTRING, LUA_TTABLE, LUA_TFUNCTION, LUA_TUSERDATA, LUA_TTHREAD, LUA_TLIGHTUSERDATA.

const char* Yukino::Script::TypeName ( int  type  )  [inline]

Función para obtener un tipo de dato en una cadena.

Parámetros:
type Tipo de dato.
Devuelve:
Una cadena con el tipo de dato en texto.


La documentación para esta clase fué generada a partir de los siguientes archivos:
Generado el Sun Jun 25 03:44:44 2006 para Yukino por  doxygen 1.4.7