blob: a336ee9185a43a9a47c17aa2eac0e11ae75d2a1f [file] [log] [blame]
/*
* $Id: JavaFunction.java,v 1.1 2008/10/28 16:36:48 anaef Exp $
* See LICENSE.txt for license terms.
*/
package com.naef.jnlua;
/**
* Provides a Lua function implemented in Java.
*/
public interface JavaFunction {
/**
* Invokes this Java function. The function arguments are on the stack. The
* method returns the number of values on the stack which constitute the
* return values of this function.
*
* <p>
* Java functions should indicate application errors by returning
* appropriate error codes to the caller. Programming errors should be
* indicated by throwing a runtime exception.
* </p>
*
* @param luaState
* the Lua state this function has been invoked on
* @return the number of return values
*/
public int invoke(LuaState luaState);
}