ugdk::script::lua::DataGear Class Reference

#include <ugdk/script/languages/lua/datagear.h>

Inheritance diagram for ugdk::script::lua::DataGear:

Collaboration diagram for ugdk::script::lua::DataGear:

Public Member Functions
	DataGear (lua_State *L)
	~DataGear ()
bool	GetData (DataID id)
bool	SetData (DataID id)
bool	HasValue (DataID id)
Public Member Functions inherited from ugdk::script::lua::BaseGear
InternalSafeCall	SafeCall (lua_CFunction func)
State *	operator-> ()
const Constant	TracedCall (int nargs, int nres)
	Makes a traced call to a function. More...
const Constant	Report (const Constant &c)

Static Public Member Functions
static int	GenerateID (lua_State *L)
	Generates a data ID. [-1,+1,-]. More...
static int	DestroyID (lua_State *L)
	Safely destroys a data ID. [-2,+0,-]. More...
static int	WrapData (lua_State *L)
	Safely wraps typed data to a data ID. [-4,+0,-]. More...
template<class T >
static int	WrapPrimitive (lua_State *L)
	Safely wraps primitive data to a data ID. [-3,+0,-]. More...
static int	UnwrapData (lua_State *L)
	Safely unwraps typed data from a data ID. [-3,+1,-]. More...
template<class T >
static int	UnwrapPrimitive (lua_State *L)
	Safely unwraps a primitive value from a data ID. [-2,+1,-]. More...
static int	UnwrapList (lua_State *L)
static int	UnwrapTable (lua_State *L)
static int	Execute (lua_State *L)
	Safely executes the object mapped by a data ID. [-4,+0,?]. More...
static int	GetField (lua_State *L)
	Safely gets the field of an object mapped by a data ID. [-4,+0,?]. More...
static int	SetField (lua_State *L)
	Safely sets the field of an object mapped by a data ID> [-4,+1,-]. More...
static int	DoFile (lua_State *L)
static int	DoString (lua_State *L)

Additional Inherited Members
Protected Member Functions inherited from ugdk::script::lua::BaseGear
	BaseGear (lua_State *L)
	~BaseGear ()
State &	L ()
Protected Attributes inherited from ugdk::script::lua::BaseGear
State	L_

Constructor & Destructor Documentation

ugdk::script::lua::DataGear::DataGear ( lua_State *  L )

inline

ugdk::script::lua::DataGear::~DataGear ( )

inline

Member Function Documentation

static int ugdk::script::lua::DataGear::DestroyID ( lua_State *  L )

static

Safely destroys a data ID. [-2,+0,-].

static int ugdk::script::lua::DataGear::DoFile ( lua_State *  L )

static

static int ugdk::script::lua::DataGear::DoString ( lua_State *  L )

static

static int ugdk::script::lua::DataGear::Execute ( lua_State *  L )

static

Safely executes the object mapped by a data ID. [-4,+0,?].

Lua arguments: [1] DataGear* - Data gear holding the data table. [2] DataID - ID of the lua function object. [3] DataBuffer* - Buffer of the arguments' IDs. [4] DataID - ID of a lua object to store the result.

static int ugdk::script::lua::DataGear::GenerateID ( lua_State *  L )

static

Generates a data ID. [-1,+1,-].

bool ugdk::script::lua::DataGear::GetData

(

DataID

id

)

static int ugdk::script::lua::DataGear::GetField ( lua_State *  L )

static

Safely gets the field of an object mapped by a data ID. [-4,+0,?].

Lua arguments: [1] DataGear* - Data gear holding the data table. [2] DataID - ID of the lua container object. [3] DataBuffer* - buffer with the ID of the field's key. [4] DataID - ID of a lua object to store the field value.

bool ugdk::script::lua::DataGear::HasValue

(

DataID

id

)

bool ugdk::script::lua::DataGear::SetData

(

DataID

id

)

static int ugdk::script::lua::DataGear::SetField ( lua_State *  L )

static

Safely sets the field of an object mapped by a data ID> [-4,+1,-].

Lua arguments: [1] DataGear* - Data gear holding the data table. [2] DataID - ID of the lua container object. [3] DataBuffer* - buffer with the ID of the filed's key followed by the ID of its new value. [4] DataID - ID of a lua object to store the final field value.

static int ugdk::script::lua::DataGear::UnwrapData ( lua_State *  L )

static

Safely unwraps typed data from a data ID. [-3,+1,-].

static int ugdk::script::lua::DataGear::UnwrapList ( lua_State *  L )

static

template<class T >

int ugdk::script::lua::DataGear::UnwrapPrimitive ( lua_State *  L )

static

Safely unwraps a primitive value from a data ID. [-2,+1,-].

static int ugdk::script::lua::DataGear::UnwrapTable ( lua_State *  L )

static

static int ugdk::script::lua::DataGear::WrapData ( lua_State *  L )

static

Safely wraps typed data to a data ID. [-4,+0,-].

template<class T >

int ugdk::script::lua::DataGear::WrapPrimitive ( lua_State *  L )

static

Safely wraps primitive data to a data ID. [-3,+0,-].

---

The documentation for this class was generated from the following file:

• modules/ugdk-script/include/ugdk/script/languages/lua/datagear.h