DtLuaScriptInterfaceExtension Class Reference

Subclass this class in order to provide extensions to the LUA interface. More...

Inheritance diagram for DtLuaScriptInterfaceExtension:

Public Types
typedef DtLuaScriptInterfaceExtension *(*	CreatorFcn )(void *usr)
	Prototype for DtLuaScriptInterfaceExtension creator function.
typedef std::pair < DtLuaScriptInterfaceExtension::CreatorFcn, void * >	CreatorUserPair

Public Member Functions
virtual	~DtLuaScriptInterfaceExtension ()
virtual void	bindLuaFunctions (DtVrfObject *, const DtString &scriptId, lua_State *)=0
	Bind any methods that are part of this class to the lua_state.
virtual void	cleanup ()
	Called to cleanup any state.

Detailed Description

Subclass this class in order to provide extensions to the LUA interface.

In order to be considered a valid extension it must implement bindLuaFunctions() and have a static creator function. This class will be created for each script implementation and methods bound to the lua_state provided. Use the DtLuaScriptInterfaceImpl::addExtension method to add a new extension for all lua task environments. Use DtVrfObject::addScriptExtension() to add an extension for a specific entity only.

Member Typedef Documentation

typedef DtLuaScriptInterfaceExtension*(* DtLuaScriptInterfaceExtension::CreatorFcn)(void *usr)

Prototype for DtLuaScriptInterfaceExtension creator function.

typedef std::pair<DtLuaScriptInterfaceExtension::CreatorFcn, void*> DtLuaScriptInterfaceExtension::CreatorUserPair

Constructor & Destructor Documentation

virtual DtLuaScriptInterfaceExtension::~DtLuaScriptInterfaceExtension ( )

inlinevirtual

Member Function Documentation

virtual void DtLuaScriptInterfaceExtension::bindLuaFunctions ( DtVrfObject *  , const DtString &  scriptId, lua_State *    )

pure virtual

Bind any methods that are part of this class to the lua_state.

The object supplied is the entity that is used for this bound script

Implemented in DtBindableLuaComponentExtension, and DtBhaveLuaExtension.

virtual void DtLuaScriptInterfaceExtension::cleanup ( )

inlinevirtual

Called to cleanup any state.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfobjcore/luaScriptInterfaceExtension.h