uLua v3.0.0
A Lua Modding Framework for Unity.
uLua.Core.ILuaObject Interface Reference

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

Public Member Functions

void Expose ()
 Exposes the object to Lua.
 

Properties

DynValue this[DynValue key] [get, set]
 Returns a dynamic value indexed by a dynamic value Key. More...
 
DynValue this[string key] [get, set]
 Returns a dynamic value indexed by a string key. More...
 
LuaMonoBehaviour LuaParent [get, set]
 Use to access/set the parent of an object. More...
 
bool IsExposed [get]
 Tracks if an object has been exposed to Lua. More...
 
string LuaHandle [get]
 Returns a unique handle of a Lua object.
 
string LuaName [get]
 Use to access the name of an object. More...
 

Detailed Description

Interface used to implement a fully indexed Lua object.

Defines various properties and methods which a LuaObject must implement.

Property Documentation

◆ IsExposed

bool uLua.Core.ILuaObject.IsExposed
get

Tracks if an object has been exposed to Lua.

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

Implemented in uLua.LuaMonoBehaviour.

◆ LuaName

string uLua.Core.ILuaObject.LuaName
get

Use 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.LuaMonoBehaviour.

◆ LuaParent

LuaMonoBehaviour uLua.Core.ILuaObject.LuaParent
getset

Use to access/set the parent of an object.

The parent of an object in Lua. If LuaParent is null, this object will be a global in Lua. Must be of type uLua.LuaMonoBehaviour.

Implemented in uLua.LuaMonoBehaviour.

◆ this[DynValue key]

DynValue uLua.Core.ILuaObject.this[DynValue key]
getset

Returns a dynamic value indexed by a dynamic value Key.

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

Implemented in uLua.LuaMonoBehaviour.

◆ this[string key]

DynValue uLua.Core.ILuaObject.this[string key]
getset

Returns a dynamic value indexed by a string key.

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

Implemented in uLua.LuaMonoBehaviour.