org.keplerproject.luajava

类 JavaFunction

java.lang.Object

org.keplerproject.luajava.JavaFunction

public abstract class JavaFunction
extends java.lang.Object

JavaFunction is a class that can be used to implement a Lua function in Java. JavaFunction is an abstract class, so in order to use it you must extend this class and implement the execute method. This execute method is the method that will be called when you call the function from Lua. To register the JavaFunction in Lua use the method register(String name).

字段概要

字段

限定符和类型	字段和说明
protected LuaState	L This is the state in which this function will exist.

构造器概要

构造器

构造器和说明
JavaFunction(LuaState L) Constructor that receives a LuaState.

方法概要

限定符和类型	方法和说明
abstract int	execute() This method is called from Lua.
LuaObject	getParam(int idx) Returns a parameter received from Lua.
void	register(java.lang.String name) Register a JavaFunction with a given name.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

L

protected LuaState L

This is the state in which this function will exist.

构造器详细资料

JavaFunction

public JavaFunction(LuaState L)

Constructor that receives a LuaState.

参数:

L - LuaState object associated with this JavaFunction object

方法详细资料

execute

public abstract int execute()
                     throws LuaException

This method is called from Lua. Any parameters can be taken with getParam. A reference to the JavaFunctionWrapper itself is always the first parameter received. Values passed back as results of the function must be pushed onto the stack.

返回:

The number of values pushed onto the stack.

抛出:

LuaException

getParam

public LuaObject getParam(int idx)

Returns a parameter received from Lua. Parameters are numbered from 1. A reference to the JavaFunction itself is always the first parameter received (the same as this).

参数:

idx - Index of the parameter.

返回:

Reference to parameter.

另请参阅:

LuaObject

register

public void register(java.lang.String name)
              throws LuaException

Register a JavaFunction with a given name. This method registers in a global variable the JavaFunction specified.

参数:

name - name of the function.

抛出:

LuaException