LuaState (luajava 1.0 API)

java.lang.Object
- org.keplerproject.luajava.LuaState

```
public class LuaState
extends Object
```
LuaState if the main class of LuaJava for the Java developer. LuaState is a mapping of most of Lua's C API functions. LuaState also provides many other functions that will be used to manipulate objects between Lua and Java.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`LUA_ERRERR`
`static int`	`LUA_ERRGCMM`
`static int`	`LUA_ERRMEM`
`static int`	`LUA_ERRRUN`
`static int`	`LUA_ERRSYNTAX`
`static Integer`	`LUA_GCCOLLECT`
`static Integer`	`LUA_GCCOUNT`
`static Integer`	`LUA_GCCOUNTB`
`static Integer`	`LUA_GCRESTART`
`static Integer`	`LUA_GCSETPAUSE`
`static Integer`	`LUA_GCSETSTEPMUL`
`static Integer`	`LUA_GCSTEP`
`static Integer`	`LUA_GCSTOP`
`static int`	`LUA_MINSTACK` minimum Lua stack available to a C function
`static int`	`LUA_MULTRET` Specifies that an unspecified (multiple) number of return arguments will be returned by a call.
`static int`	`LUA_NUMTAGS`
`static int`	`LUA_OK`
`static int`	`LUA_REGISTRYINDEX`
`static int`	`LUA_TBOOLEAN`
`static int`	`LUA_TFUNCTION`
`static int`	`LUA_TLIGHTUSERDATA`
`static int`	`LUA_TNIL`
`static int`	`LUA_TNONE`
`static int`	`LUA_TNUMBER`
`static int`	`LUA_TSTRING`
`static int`	`LUA_TTABLE`
`static int`	`LUA_TTHREAD`
`static int`	`LUA_TUSERDATA`
`static int`	`LUA_YIELD`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`LuaState(CPtr luaState)` Receives a existing state and initializes it
`protected`	`LuaState(int stateId)` Constructor to instance a new LuaState and initialize it with LuaJava's functions

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`call(int nArgs, int nResults)`
`int`	`checkStack(int sz)`
`void`	`close()` Closes state and removes the object from the LuaStateFactory
`void`	`concat(int n)`
`static Number`	`convertLuaNumber(Double db, Class retType)` When you call a function in lua, it may return a number, and the number will be interpreted as a `Double`. This function converts the number into a type specified by `retType`
`void`	`createTable(int narr, int nrec)`
`String`	`dumpStack()`
`int`	`equal(int idx1, int idx2)`
`int`	`error()`
`int`	`gc(int what, int data)`
`long`	`getCPtrPeer()` Return the long representing the LuaState pointer
`void`	`getField(int idx, String k)`
`void`	`getGlobal(String global)`
`LuaObject`	`getLuaObject(int index)` Creates a reference to an object in the `index` position of the stack
`LuaObject`	`getLuaObject(LuaObject parent, LuaObject name)` This constructor creates a LuaObject from a table that is indexed by any LuaObject.
`LuaObject`	`getLuaObject(LuaObject parent, Number name)` This constructor creates a LuaObject from a table that is indexed by a number.
`LuaObject`	`getLuaObject(LuaObject parent, String name)` Creates a reference to an object inside another object
`LuaObject`	`getLuaObject(String globalName)` Creates a reference to an object in the variable globalName
`int`	`getMetaTable(int idx)`
`Object`	`getObjectFromUserdata(int idx)` Gets a Object from Lua
`void`	`getTable(int idx)`
`int`	`getTop()`
`void`	`insert(int idx)`
`boolean`	`isBoolean(int idx)`
`boolean`	`isCFunction(int idx)`
`boolean`	`isClosed()` Returns `true` if state is closed.
`boolean`	`isFunction(int idx)`
`boolean`	`isJavaFunction(int idx)` Returns whether a userdata contains a Java Function
`boolean`	`isNil(int idx)`
`boolean`	`isNone(int idx)`
`boolean`	`isNoneOrNil(int idx)`
`boolean`	`isNumber(int idx)`
`boolean`	`isObject(int idx)` Tells whether a lua index contains a java Object
`boolean`	`isString(int idx)`
`boolean`	`isTable(int idx)`
`boolean`	`isThread(int idx)`
`boolean`	`isUserdata(int idx)`
`int`	`LargError(int numArg, String extraMsg)`
`int`	`LcallMeta(int obj, String e)`
`void`	`LcheckAny(int nArg)`
`int`	`LcheckInteger(int numArg)`
`double`	`LcheckNumber(int numArg)`
`void`	`LcheckStack(int sz, String msg)`
`String`	`LcheckString(int numArg)`
`void`	`LcheckType(int nArg, int t)`
`int`	`LdoFile(String fileName)`
`int`	`LdoString(String str)`
`int`	`lessthan(int idx1, int idx2)`
`int`	`LgetMetaField(int obj, String e)`
`void`	`LgetMetatable(String tName)`
`String`	`Lgsub(String s, String p, String r)`
`int`	`LloadBuffer(byte[] buff, String name)`
`int`	`LloadFile(String fileName)`
`int`	`LloadString(String s)`
`int`	`LnewMetatable(String tName)`
`int`	`LoptInteger(int numArg, int def)`
`double`	`LoptNumber(int numArg, double def)`
`String`	`LoptString(int numArg, String def)`
`int`	`Lref(int t)`
`void`	`LunRef(int t, int ref)`
`void`	`Lwhere(int lvl)`
`void`	`newTable()`
`LuaState`	`newThread()`
`int`	`next(int idx)`
`int`	`objLen(int idx)`
`void`	`openBase()`
`void`	`openDebug()`
`void`	`openIo()`
`void`	`openLibs()`
`void`	`openMath()`
`void`	`openOs()`
`void`	`openPackage()`
`void`	`openString()`
`void`	`openTable()`
`int`	`pcall(int nArgs, int nResults, int errFunc)`
`void`	`pop(int n)`
`void`	`pushBoolean(boolean bool)`
`void`	`pushInteger(int integer)`
`void`	`pushJavaFunction(JavaFunction func)` Pushes a JavaFunction into the state stack
`void`	`pushJavaObject(Object obj)` Pushes a Java Object into the lua stack. This function does not check if the object is from a class that could be represented by a lua type.
`void`	`pushNil()`
`void`	`pushNumber(double db)`
`void`	`pushObjectValue(Object obj)` Pushes into the stack any object value. This function checks if the object could be pushed as a lua type, if not pushes the java object.
`void`	`pushString(byte[] bytes)`
`void`	`pushString(String str)`
`void`	`pushValue(int idx)`
`int`	`rawequal(int idx1, int idx2)`
`void`	`rawGet(int idx)`
`void`	`rawGetI(int idx, int n)`
`void`	`rawSet(int idx)`
`void`	`rawSetI(int idx, int n)`
`void`	`remove(int idx)`
`void`	`replace(int idx)`
`int`	`resume(CPtr from, int nArgs)`
`void`	`setField(int idx, String k)`
`void`	`setGlobal(String name)`
`int`	`setMetaTable(int idx)`
`void`	`setTable(int idx)`
`void`	`setTop(int idx)`
`int`	`status()`
`int`	`strLen(int idx)`
`boolean`	`toBoolean(int idx)`
`int`	`toInteger(int idx)`
`Object`	`toJavaObject(int idx)` Function that returns a Java Object equivalent to the one in the given position of the Lua Stack.
`double`	`toNumber(int idx)`
`String`	`toString(int idx)`
`LuaState`	`toThread(int idx)`
`int`	`type(int idx)`
`String`	`typeName(int tp)`
`void`	`xmove(LuaState to, int n)`
`int`	`yield(int nResults)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LUA_REGISTRYINDEX

public static final int LUA_REGISTRYINDEX

LUA_TNONE
```
public static final int LUA_TNONE
```
See Also:

Constant Field Values

LUA_TNIL
```
public static final int LUA_TNIL
```
See Also:

Constant Field Values

LUA_TBOOLEAN
```
public static final int LUA_TBOOLEAN
```
See Also:

Constant Field Values

LUA_TLIGHTUSERDATA
```
public static final int LUA_TLIGHTUSERDATA
```
See Also:

Constant Field Values

LUA_TNUMBER
```
public static final int LUA_TNUMBER
```
See Also:

Constant Field Values

LUA_TSTRING
```
public static final int LUA_TSTRING
```
See Also:

Constant Field Values

LUA_TTABLE
```
public static final int LUA_TTABLE
```
See Also:

Constant Field Values

LUA_TFUNCTION
```
public static final int LUA_TFUNCTION
```
See Also:

Constant Field Values

LUA_TUSERDATA
```
public static final int LUA_TUSERDATA
```
See Also:

Constant Field Values

LUA_TTHREAD
```
public static final int LUA_TTHREAD
```
See Also:

Constant Field Values

LUA_NUMTAGS
```
public static final int LUA_NUMTAGS
```
See Also:

Constant Field Values

LUA_MINSTACK
```
public static final int LUA_MINSTACK
```
minimum Lua stack available to a C function

See Also:

Constant Field Values

LUA_MULTRET
```
public static final int LUA_MULTRET
```
Specifies that an unspecified (multiple) number of return arguments will be returned by a call.

See Also:

Constant Field Values

LUA_OK
```
public static final int LUA_OK
```
See Also:

Constant Field Values

LUA_YIELD
```
public static final int LUA_YIELD
```
See Also:

Constant Field Values

LUA_ERRRUN
```
public static final int LUA_ERRRUN
```
See Also:

Constant Field Values

LUA_ERRSYNTAX
```
public static final int LUA_ERRSYNTAX
```
See Also:

Constant Field Values

LUA_ERRMEM
```
public static final int LUA_ERRMEM
```
See Also:

Constant Field Values

LUA_ERRGCMM
```
public static final int LUA_ERRGCMM
```
See Also:

Constant Field Values

LUA_ERRERR
```
public static final int LUA_ERRERR
```
See Also:

Constant Field Values

LUA_GCSTOP
```
public static final Integer LUA_GCSTOP
```

LUA_GCRESTART

public static final Integer LUA_GCRESTART

LUA_GCCOLLECT

public static final Integer LUA_GCCOLLECT

LUA_GCCOUNT

public static final Integer LUA_GCCOUNT

LUA_GCCOUNTB

public static final Integer LUA_GCCOUNTB

LUA_GCSTEP
```
public static final Integer LUA_GCSTEP
```

LUA_GCSETPAUSE

public static final Integer LUA_GCSETPAUSE

LUA_GCSETSTEPMUL

public static final Integer LUA_GCSETSTEPMUL

Constructor Detail
- LuaState
```
protected LuaState(int stateId)
```
  Constructor to instance a new LuaState and initialize it with LuaJava's functions
  
  Parameters:
  
  stateId -
- LuaState
```
protected LuaState(CPtr luaState)
```
  Receives a existing state and initializes it
  
  Parameters:
  
  luaState -

Method Detail

close
```
public void close()
```
Closes state and removes the object from the LuaStateFactory

isClosed
```
public boolean isClosed()
```
Returns true if state is closed.

getCPtrPeer
```
public long getCPtrPeer()
```
Return the long representing the LuaState pointer

Returns:

long

newThread
```
public LuaState newThread()
```

getTop
```
public int getTop()
```

setTop
```
public void setTop(int idx)
```

pushValue
```
public void pushValue(int idx)
```

remove
```
public void remove(int idx)
```

insert
```
public void insert(int idx)
```

replace
```
public void replace(int idx)
```

checkStack
```
public int checkStack(int sz)
```

xmove

public void xmove(LuaState to,
                  int n)

isNumber
```
public boolean isNumber(int idx)
```

isString
```
public boolean isString(int idx)
```

isFunction
```
public boolean isFunction(int idx)
```

isCFunction
```
public boolean isCFunction(int idx)
```

isUserdata
```
public boolean isUserdata(int idx)
```

isTable
```
public boolean isTable(int idx)
```

isBoolean
```
public boolean isBoolean(int idx)
```

isNil
```
public boolean isNil(int idx)
```

isThread
```
public boolean isThread(int idx)
```

isNone
```
public boolean isNone(int idx)
```

isNoneOrNil
```
public boolean isNoneOrNil(int idx)
```

type
```
public int type(int idx)
```

typeName
```
public String typeName(int tp)
```

equal

public int equal(int idx1,
                 int idx2)

rawequal

public int rawequal(int idx1,
                    int idx2)

lessthan

public int lessthan(int idx1,
                    int idx2)

toNumber
```
public double toNumber(int idx)
```

toInteger
```
public int toInteger(int idx)
```

toBoolean
```
public boolean toBoolean(int idx)
```

toString
```
public String toString(int idx)
```

strLen
```
public int strLen(int idx)
```

objLen
```
public int objLen(int idx)
```

toThread
```
public LuaState toThread(int idx)
```

pushNil
```
public void pushNil()
```

pushNumber
```
public void pushNumber(double db)
```

pushInteger
```
public void pushInteger(int integer)
```

pushString
```
public void pushString(String str)
```

pushString
```
public void pushString(byte[] bytes)
```

pushBoolean

public void pushBoolean(boolean bool)

getTable
```
public void getTable(int idx)
```

getField

public void getField(int idx,
                     String k)

rawGet
```
public void rawGet(int idx)
```

rawGetI

public void rawGetI(int idx,
                    int n)

createTable

public void createTable(int narr,
                        int nrec)

newTable
```
public void newTable()
```

getMetaTable
```
public int getMetaTable(int idx)
```

setTable
```
public void setTable(int idx)
```

setField

public void setField(int idx,
                     String k)

rawSet
```
public void rawSet(int idx)
```

rawSetI

public void rawSetI(int idx,
                    int n)

setMetaTable
```
public int setMetaTable(int idx)
```

call

public void call(int nArgs,
                 int nResults)

pcall

public int pcall(int nArgs,
                 int nResults,
                 int errFunc)

yield
```
public int yield(int nResults)
```

resume

public int resume(CPtr from,
                  int nArgs)

status
```
public int status()
```

gc

public int gc(int what,
              int data)

next
```
public int next(int idx)
```

error
```
public int error()
```

concat
```
public void concat(int n)
```

LdoFile
```
public int LdoFile(String fileName)
```

LdoString
```
public int LdoString(String str)
```

LgetMetaField

public int LgetMetaField(int obj,
                         String e)

LcallMeta

public int LcallMeta(int obj,
                     String e)

LargError

public int LargError(int numArg,
                     String extraMsg)

LcheckString

public String LcheckString(int numArg)

LoptString

public String LoptString(int numArg,
                         String def)

LcheckNumber

public double LcheckNumber(int numArg)

LoptNumber

public double LoptNumber(int numArg,
                         double def)

LcheckInteger
```
public int LcheckInteger(int numArg)
```

LoptInteger

public int LoptInteger(int numArg,
                       int def)

LcheckStack

public void LcheckStack(int sz,
                        String msg)

LcheckType

public void LcheckType(int nArg,
                       int t)

LcheckAny
```
public void LcheckAny(int nArg)
```

LnewMetatable

public int LnewMetatable(String tName)

LgetMetatable

public void LgetMetatable(String tName)

Lwhere
```
public void Lwhere(int lvl)
```

Lref
```
public int Lref(int t)
```

LunRef

public void LunRef(int t,
                   int ref)

LloadFile

public int LloadFile(String fileName)

LloadString
```
public int LloadString(String s)
```

LloadBuffer

public int LloadBuffer(byte[] buff,
                       String name)

Lgsub

public String Lgsub(String s,
                    String p,
                    String r)

pop
```
public void pop(int n)
```

getGlobal
```
public void getGlobal(String global)
```

setGlobal
```
public void setGlobal(String name)
```

openBase
```
public void openBase()
```

openTable
```
public void openTable()
```

openIo
```
public void openIo()
```

openOs
```
public void openOs()
```

openString
```
public void openString()
```

openMath
```
public void openMath()
```

openDebug
```
public void openDebug()
```

openPackage
```
public void openPackage()
```

openLibs
```
public void openLibs()
```

getObjectFromUserdata
```
public Object getObjectFromUserdata(int idx)
                             throws LuaException
```
Gets a Object from Lua

Parameters:

idx - index of the lua stack

Returns:

Object

Throws:

LuaException - if the lua object does not represent a java object.

isObject
```
public boolean isObject(int idx)
```
Tells whether a lua index contains a java Object

Parameters:

idx - index of the lua stack

Returns:

boolean

pushJavaObject
```
public void pushJavaObject(Object obj)
```
Pushes a Java Object into the lua stack.
This function does not check if the object is from a class that could be represented by a lua type. Eg: java.lang.String could be a lua string.

Parameters:

obj - Object to be pushed into lua

pushJavaFunction

public void pushJavaFunction(JavaFunction func)
                      throws LuaException

Pushes a JavaFunction into the state stack

Parameters:: func -
Throws:: LuaException

isJavaFunction
```
public boolean isJavaFunction(int idx)
```
Returns whether a userdata contains a Java Function

Parameters:

idx - index of the lua stack

Returns:

boolean

pushObjectValue
```
public void pushObjectValue(Object obj)
                     throws LuaException
```
Pushes into the stack any object value.
This function checks if the object could be pushed as a lua type, if not pushes the java object.

Parameters:

obj -

Throws:

LuaException

toJavaObject
```
public Object toJavaObject(int idx)
                    throws LuaException
```
Function that returns a Java Object equivalent to the one in the given position of the Lua Stack.

Parameters:

idx - Index in the Lua Stack

Returns:

Java object equivalent to the Lua one

Throws:

LuaException

getLuaObject
```
public LuaObject getLuaObject(String globalName)
```
Creates a reference to an object in the variable globalName

Parameters:

globalName -

Returns:

LuaObject

getLuaObject
```
public LuaObject getLuaObject(LuaObject parent,
                              String name)
                       throws LuaException
```
Creates a reference to an object inside another object

Parameters:

parent - The Lua Table or Userdata that contains the Field.

name - The name that index the field

Returns:

LuaObject

Throws:

LuaException - if parent is not a table or userdata

getLuaObject
```
public LuaObject getLuaObject(LuaObject parent,
                              Number name)
                       throws LuaException
```
This constructor creates a LuaObject from a table that is indexed by a number.

Parameters:

parent - The Lua Table or Userdata that contains the Field.

name - The name (number) that index the field

Returns:

LuaObject

Throws:

LuaException - When the parent object isn't a Table or Userdata

getLuaObject
```
public LuaObject getLuaObject(LuaObject parent,
                              LuaObject name)
                       throws LuaException
```
This constructor creates a LuaObject from a table that is indexed by any LuaObject.

Parameters:

parent - The Lua Table or Userdata that contains the Field.

name - The name (LuaObject) that index the field

Returns:

LuaObject

Throws:

LuaException - When the parent object isn't a Table or Userdata

getLuaObject
```
public LuaObject getLuaObject(int index)
```
Creates a reference to an object in the index position of the stack

Parameters:

index - position on the stack

Returns:

LuaObject

convertLuaNumber
```
public static Number convertLuaNumber(Double db,
                                      Class retType)
```
When you call a function in lua, it may return a number, and the number will be interpreted as a Double.
This function converts the number into a type specified by retType

Parameters:

db - lua number to be converted

retType - type to convert to

Returns:

The converted number

dumpStack
```
public String dumpStack()
```

Class LuaState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LUA_REGISTRYINDEX

LUA_TNONE

LUA_TNIL

LUA_TBOOLEAN

LUA_TLIGHTUSERDATA

LUA_TNUMBER

LUA_TSTRING

LUA_TTABLE

LUA_TFUNCTION

LUA_TUSERDATA

LUA_TTHREAD

LUA_NUMTAGS

LUA_MINSTACK

LUA_MULTRET

LUA_OK

LUA_YIELD

LUA_ERRRUN

LUA_ERRSYNTAX

LUA_ERRMEM

LUA_ERRGCMM

LUA_ERRERR

LUA_GCSTOP

LUA_GCRESTART

LUA_GCCOLLECT

LUA_GCCOUNT

LUA_GCCOUNTB

LUA_GCSTEP

LUA_GCSETPAUSE

LUA_GCSETSTEPMUL

Constructor Detail

LuaState

LuaState

Method Detail

close

isClosed

getCPtrPeer

newThread

getTop

setTop

pushValue

remove

insert

replace

checkStack

xmove

isNumber

isString

isFunction

isCFunction

isUserdata

isTable

isBoolean

isNil

isThread

isNone

isNoneOrNil

type

typeName

equal

rawequal

lessthan

toNumber

toInteger

toBoolean

toString

strLen

objLen

toThread

pushNil

pushNumber

pushInteger

pushString

pushString

pushBoolean