uLua.ILuaObject Interface Reference

Interface used to implement a fully indexed Lua object. More...

Properties
DynValue	this[DynValue Key] [get, set]
	Returns a Lua value indexed by the DynValue Key. More...
DynValue	this[string Key] [get, set]
	Returns a Lua value indexed by the string key. More...
LuaMonoBehaviour	Context [get, set]
	Used to access/set the context of an object. More...
string	Handle [get]
	Used to access the unique Handle of a Lua object. More...
bool	IsExposed [get]
	Used to track if an object has been exposed to Lua. More...
string	Name [get]
	Used to access the name of an object. More...

Detailed Description

Interface used to implement a fully indexed Lua object.

Defines various properties (Context, Name, Handle, etc.) which are implemented in LuaClass and LuaMonoBehaviour.

Property Documentation

Context

LuaMonoBehaviour uLua.ILuaObject.Context

getset

Used to access/set the context of an object.

The Context object represents the parent of an object in Lua. If the Context is null, the object will be global in Lua. Must be of type uLua.LuaMonoBehaviour.

Implemented in uLua.LuaClass, and uLua.LuaMonoBehaviour.

Handle

string uLua.ILuaObject.Handle

get

Used to access the unique Handle of a Lua object.

The unique Handle of a Lua object is defined as: Context.Name. If an object's context is null, its unique handle is simply its name.

Implemented in uLua.LuaClass, and uLua.LuaMonoBehaviour.

IsExposed

bool uLua.ILuaObject.IsExposed

get

Used to track if an object has been exposed to Lua.

Objects may be marked as exposed by calling the Expose() method.

Implemented in uLua.LuaClass, and uLua.LuaMonoBehaviour.

Name

string uLua.ILuaObject.Name

get

Used to access the name of an object.

The name of an object cannot be changed after it has been exposed to Lua.

Implemented in uLua.LuaClass, and uLua.LuaMonoBehaviour.

this[DynValue Key]

DynValue uLua.ILuaObject.this[DynValue Key]

getset

Returns a Lua value indexed by the DynValue Key.

This indexer may be used in Lua or within C# to access any member of a Lua object.

Implemented in uLua.LuaClass, and uLua.LuaMonoBehaviour.

this[string Key]

DynValue uLua.ILuaObject.this[string Key]

getset

Returns a Lua value indexed by the string key.

This indexer may be used in Lua or within C# to access any member of a Lua object.

Implemented in uLua.LuaClass, and uLua.LuaMonoBehaviour.