com.ansca.corona

Class CoronaRuntime

java.lang.Object

com.ansca.corona.CoronaRuntime

public class CoronaRuntime
extends Object

Provides access to a running Corona project and its LuaState.

Method Summary

Methods

Modifier and Type	Method and Description
LuaState	getLuaState() Gets the LuaState object that the Corona project's code runs in.
CoronaRuntimeTaskDispatcher	getTaskDispatcher() Returns the CoronaRuntimeTaskDispatcher used by this CoronaRuntime.
boolean	isRunning() Determines if the CoronaRuntime is currently running its project.
boolean	wasDisposed() Determines if the CoronaRuntime has been disposed of, meaning it was destroyed and can no longer be used.
boolean	wasNotDisposed() Determines if the CoronaRuntime is still available and has not been destroyed yet, which occurs on exit.

Methods inherited from class java.lang.Object

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

Method Detail

getTaskDispatcher

public CoronaRuntimeTaskDispatcher getTaskDispatcher()

Returns the CoronaRuntimeTaskDispatcher used by this CoronaRuntime.

Added in daily build 2014.2148.

wasDisposed

public boolean wasDisposed()

Determines if the CoronaRuntime has been disposed of, meaning it was destroyed and can no longer be used. This happens when the CoronaRuntime exits, which occurs when the CoronaActivity has been destroyed.

Returns:

Returns true if this object was disposed of, meaning it can no longer be used. Returns false if this object is still usable.

wasNotDisposed

public boolean wasNotDisposed()

Determines if the CoronaRuntime is still available and has not been destroyed yet, which occurs on exit.

Returns:

Returns true if this object is still usable. Returns false if the object was disposed of.

isRunning

public boolean isRunning()

Determines if the CoronaRuntime is currently running its project.

Returns:

Returns true if the CoronaRuntime is currently running its project. Returns false if the CoronaRuntime has been suspended or stopped.

getLuaState

public LuaState getLuaState()

Gets the LuaState object that the Corona project's code runs in. Provides access to all modules, functions, and variables declared in the Corona project's code. This LuaState can be used to add new APIs to the project at run time.

Returns:

Returns a reference to the LuaState object. Returns null if it has not been created yet, which can happen if Corona is currently loading a project.