NLua Namespace Reference

Namespaces

namespace  Event
 
namespace  Exceptions
 
namespace  Extensions
 
namespace  Method
 

Classes

class  CheckType
 
class  ClassGenerator
 
class  CodeGeneration
 
class  DelegateGenerator
 
interface  ILuaGeneratedType
 
class  Lua
 
class  LuaBase
 Base class to provide consistent disposal flow across lua objects. More...
 
struct  LuaClassType
 
class  LuaFunction
 
class  LuaGlobalAttribute
 Marks a method for global usage in Lua scripts More...
 
class  LuaHideAttribute
 Marks a method, field or property to be hidden from Lua auto-completion More...
 
class  LuaIndexes
 
class  LuaLib
 
class  LuaRegistrationHelper
 
class  LuaTable
 
class  LuaUserData
 
class  MetaFunctions
 
class  ObjectTranslator
 
class  ObjectTranslatorPool
 
class  ProxyType
 Summary description for ProxyType. More...
 

Typedefs

using LuaCore = KeraLua.Lua
 
using LuaState = KeraLua.LuaState
 
using LuaHook = KeraLua.LuaHook
 
using LuaDebug = KeraLua.LuaDebug
 
using LuaNativeFunction = KeraLua.LuaNativeFunction
 
using LuaTag = KeraLua.LuaTag
 

Enumerations

enum  GCOptions : int {
  GCOptions.Stop = 0, GCOptions.Restart = 1, GCOptions.Collect = 2, GCOptions.Count = 3,
  GCOptions.CountB = 4, GCOptions.Step = 5, GCOptions.SetPause = 6, GCOptions.SetStepMul = 7
}
 
enum  LuaEnums : int {
  LuaEnums.MultiRet = -1, LuaEnums.Ok = 0, LuaEnums.Yield = 1, LuaEnums.ErrorRun = 2,
  LuaEnums.ErrorSyntax = 3, LuaEnums.ErrorMemory = 4, LuaEnums.ErrorError = 5, LuaEnums.ErrorFile = 6
}
 Enumeration of basic lua globals. More...
 
enum  LuaTypes : int {
  LuaTypes.None = -1, LuaTypes.Nil = 0, LuaTypes.Boolean = 1, LuaTypes.LightUserdata = 2,
  LuaTypes.Number = 3, LuaTypes.String = 4, LuaTypes.Table = 5, LuaTypes.Function = 6,
  LuaTypes.UserData = 7, LuaTypes.Thread = 8
}
 
enum  References : int { References.RefNil = -1, References.NoRef = -2 }
 

Typedef Documentation

◆ LuaCore

typedef KeraLua Lua NLua.LuaCore

◆ LuaDebug

◆ LuaHook

using NLua.LuaHook = typedef KeraLua.LuaHook

◆ LuaNativeFunction

◆ LuaState

typedef KeraLua LuaState NLua.LuaState

◆ LuaTag

using NLua.LuaTag = typedef KeraLua.LuaTag

Enumeration Type Documentation

◆ GCOptions

enum NLua.GCOptions : int
strong
Enumerator
Stop 

Stops the garbage collector.

Restart 

Restarts the garbage collector.

Collect 

Performs a full garbage-collection cycle.

Count 

Returns the current amount of memory (in Kbytes) in use by KopiLua.Lua.

CountB 

Returns the remainder of dividing the current amount of bytes of memory in use by Lua by 1024.

Step 

Performs an incremental step of garbage collection.

The step "size" is controlled by data (larger values mean more steps) in a non-specified way. ifyou want to control the step size you must experimentally tune the value of data. The function returns 1 ifthe step finished a garbage-collection cycle.

SetPause 

Sets data as the new value for the pause (Controls how long the collector waits before starting a new cycle) of the collector (see ยง2.10).

The function returns the previous value of the pause.

SetStepMul 

Sets data as the new value for the step multiplier of the collector (Controls the relative speed of the collector relative to memory allocation.).

The function returns the previous value of the step multiplier.

◆ LuaEnums

enum NLua.LuaEnums : int
strong

Enumeration of basic lua globals.

Enumerator
MultiRet 

Option for multiple returns in ‘lua_pcall’ and ‘lua_call’

Ok 

Everything is OK.

Yield 

Thread status, Ok or Yield

ErrorRun 

A Runtime error.

ErrorSyntax 

A syntax error.

ErrorMemory 

A memory allocation error.

For such errors, Lua does not call the error handler function.

ErrorError 

An error in the error handling function.

ErrorFile 

An extra error for file load errors when using luaL_loadfile.

◆ LuaTypes

enum NLua.LuaTypes : int
strong
Enumerator
None 
Nil 
Boolean 
LightUserdata 
Number 
String 
Table 
Function 
UserData 
Thread 

◆ References

enum NLua.References : int
strong
Enumerator
RefNil 
NoRef