com.ansca.corona

Class CoronaLua

java.lang.Object

com.ansca.corona.CoronaLua

public class CoronaLua
extends Object

Provides a set of convenience functions for use with the LuaState.

You should call these methods inside a CoronaRuntimeTask to ensure that modifications to the LuaState happen on the Corona thread.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOREF Used to mark a references as invalid.
static int	REFNIL Returned when LuaState.ref(int) is called on a nil value.

Constructor Summary

Constructors

Constructor and Description
CoronaLua()

Method Summary

Methods

Modifier and Type	Method and Description
static void	deleteRef(LuaState L, int ref) Release the Java-side reference to a Lua value, which would otherwise prevent the Lua value from being garbage collected.
static void	dispatchEvent(LuaState L, int listenerRef, int nresults) Dispatches an event by invoking the listener corresponding to listenerRef passing the value at the top of the stack as the Corona event table.
static void	dispatchRuntimeEvent(LuaState L, int nResults) Dispatches the event at the top of the lua stack to the global Runtime object.
static boolean	isListener(LuaState L, int index, String eventName) Returns whether the function at index is a Corona listener.
static void	newEvent(LuaState L, String eventName) Creates a Corona event with the name property set to eventName.
static int	newRef(LuaState L, int index) Creates a Java-side reference to a Lua object on the Lua stack at index.
static int	normalize(LuaState L, int index) Returns an absolute index location on the Lua stack for the passed index.
static void	pushHashtable(LuaState L, Hashtable<Object,Object> hashtable) Pushes a lua table with the values in the Hashtable onto the top of the lua stack.
static void	pushValue(LuaState L, Object object) Pushes the Object onto the top of the lua stack.
static Hashtable<Object,Object>	toHashtable(LuaState L, int index) Creates a Hashtable from a lua table at the specified index on the lua stack.
static Object	toValue(LuaState L, int index) Returns an Object for the item at the specified index.

Methods inherited from class java.lang.Object

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

Field Detail

REFNIL

public static final int REFNIL

Returned when LuaState.ref(int) is called on a nil value.

See Also:

Constant Field Values

NOREF

public static final int NOREF

Used to mark a references as invalid.

Added in daily build 2013.1227.

See Also:

Constant Field Values

Constructor Detail

CoronaLua

public CoronaLua()

Method Detail

normalize

public static int normalize(LuaState L,
            int index)

Returns an absolute index location on the Lua stack for the passed index. This is useful if you have negative stack indices, as these are relative to the top of the stack.

Parameters:

L - The LuaState to operate on.

index - The index on the lua stack that we want a normalized value for.

Returns:

An absolute index location on the Lua stack for the passed index.

newRef

public static int newRef(LuaState L,
         int index)

Creates a Java-side reference to a Lua object on the Lua stack at index. You can use this to store and access Lua objects from native Java code. Typically you use this when you want to store a reference to a Lua listener.

Parameters:

L - The LuaState to operate on.

index - The index on the lua stack holding the object we want a Java-side reference for.

Returns:

Returns a reference identifier.

deleteRef

public static void deleteRef(LuaState L,
             int ref)

Release the Java-side reference to a Lua value, which would otherwise prevent the Lua value from being garbage collected.

Parameters:

L - The LuaState to operate on.

ref - The Java-side reference to release.

newEvent

public static void newEvent(LuaState L,
            String eventName)

Creates a Corona event with the name property set to eventName.

This function pushes the created event table to the top of the Lua stack!

Parameters:

L - The LuaState to operate on.

eventName - The name to assign to this Corona event.

dispatchEvent

public static void dispatchEvent(LuaState L,
                 int listenerRef,
                 int nresults)
                          throws Exception

Dispatches an event by invoking the listener corresponding to listenerRef passing the value at the top of the stack as the Corona event table. You should use newEvent() to create this event.

This function pops the value from the top of the Lua stack!

Parameters:

L - The LuaState to operate on.

listenerRef - A reference identifier returned by CoronaLua.newRef().

nresults - The number of results to be dispatched to the event.

Throws:

Exception

isListener

public static boolean isListener(LuaState L,
                 int index,
                 String eventName)

Returns whether the function at index is a Corona listener.

Parameters:

L - The LuaState to operate on.

index - The index on the lua stack holding the function in question.

eventName - The name of the function at index.

toValue

public static Object toValue(LuaState L,
             int index)

Returns an Object for the item at the specified index. Supports Lua Strings, Numbers, Booleans, and Tables.

Added in daily build 2014.2125.

Parameters:

L - The LuaState where the object is located.

index - The index on the lua stack where the object is located.

Returns:

An Object with the value of the lua object at the designated index on the lua stack.

toHashtable

public static Hashtable<Object,Object> toHashtable(LuaState L,
                                   int index)

Creates a Hashtable from a lua table at the specified index on the lua stack.

Added in daily build 2014.2125.

Parameters:

L - The LuaState where the table is located.

index - The index on the lua stack where the lua table is located.

Returns:

A Hashtable with the values of the lua table.

pushValue

public static void pushValue(LuaState L,
             Object object)

Pushes the Object onto the top of the lua stack. Supports String, Integer, Double, Boolean, and Hashtable objects.

This function pushes the desired object to the top of the Lua stack!

Added in daily build 2014.2125.

Parameters:

L - The LuaState to operate on.

object - The Object to be pushed onto the top of the lua stack.

pushHashtable

public static void pushHashtable(LuaState L,
                 Hashtable<Object,Object> hashtable)

Pushes a lua table with the values in the Hashtable onto the top of the lua stack.

This function pushes a lua table to the top of the Lua stack!

Added in daily build 2014.2125.

Parameters:

L - The LuaState where the table should be pushed to.

hashtable - The Hashtable which contains the values to be pushed onto the lua stack as a lua table.

dispatchRuntimeEvent

public static void dispatchRuntimeEvent(LuaState L,
                        int nResults)

Dispatches the event at the top of the lua stack to the global Runtime object.

Added in daily build 2014.2125.

Parameters:

L - The LuaState of the Runtime object.

nResults - The number of results returned from the Lua side.