com.ansca.corona

Class CoronaEnvironment

java.lang.Object

com.ansca.corona.CoronaEnvironment

public final class CoronaEnvironment
extends Object

Provides simple methods for launching and accessing a CoronaActivity as well as setting up listeners for receiving events from the CoronaRuntime.

All methods in this class are thread safe and can be called from any thread.

You cannot make instances of this class. Access is provided via static methods.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addRuntimeListener(CoronaRuntimeListener listener) Adds a listener for receiving events from the CoronaRuntime.
static android.content.Context	getApplicationContext() Provides easy access to this application's context.
static String	getApplicationName() Provides easy access to the application's name that is displayed to the end user.
static File	getCachesDirectory(android.content.Context context) Gets the path to Corona's caches directory.
static CoronaActivity	getCoronaActivity() Gets a reference to the currently active CoronaActivity.
static File	getDocumentsDirectory(android.content.Context context) Gets the path to Corona's documents directory.
static JavaFunction	getLuaErrorHandler() Gets the custom Lua error handler that was given to the CoronaEnvironment.setLuaErrorHandler() method.
static File	getTemporaryDirectory(android.content.Context context) Gets the path to Corona's temporary directory.
static void	removeRuntimeListener(CoronaRuntimeListener listener) Removes the given listener that was added via the addRuntimeListener() method.
static void	setLuaErrorHandler(JavaFunction handler) Sets a custom handler for Lua errors, such as syntax or runtime errors.
static void	showCoronaActivity(android.content.Context context) Displays the CoronaActivity window on screen.

Methods inherited from class java.lang.Object

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

Method Detail

getDocumentsDirectory

public static File getDocumentsDirectory(android.content.Context context)

Gets the path to Corona's documents directory.

This is the directory that Lua property "system.DocumentsDirectory" maps to.

This directory is located in internal storage.

Parameters:

context - Context needed to access this application's directories. Cannot be null.

Returns:

Returns a File object set to the specified directory.

getTemporaryDirectory

public static File getTemporaryDirectory(android.content.Context context)

Gets the path to Corona's temporary directory.

This is the directory that Lua property "system.TemporaryDirectory" maps to.

This directory is located in internal storage. Its files will be automatically deleted by the operating system if internal storage is low on space.

Parameters:

context - Context needed to access this application's directories. Cannot be null.

Returns:

Returns a File object set to the specified directory.

getCachesDirectory

public static File getCachesDirectory(android.content.Context context)

Gets the path to Corona's caches directory.

This is the directory that Lua property "system.CachesDirectory" maps to.

This directory is located in internal storage. Its files will be automatically deleted by the operating system if internal storage is low on space.

Parameters:

context - Context needed to access this application's directories. Cannot be null.

Returns:

Returns a File object set to the specified directory.

showCoronaActivity

public static void showCoronaActivity(android.content.Context context)

Displays the CoronaActivity window on screen. If the CoronaActivity is currently suspended in the background, then this method will bring it to the foreground.

DO NOT USE THIS API IN A CORONACARDS FOR ANDROID PROJECT! There's no CoronaActivity in CoronaCards for Android so invoking this API will crash your app!

Parameters:

context - The context derived object needed to display the CoronaActivity via intents. Cannot be null.

getCoronaActivity

public static CoronaActivity getCoronaActivity()

Gets a reference to the currently active CoronaActivity.

Returns:

Returns a reference to the currently active CoronaActivity object. Returns null if the CoronaActivity was never created, has been destroyed, or we're using CoronaCards for Android.

getApplicationContext

public static android.content.Context getApplicationContext()

Provides easy access to this application's context.

Returns:

Returns an instance of the application context object. Returns null if this application has not been fully initialized yet.

getApplicationName

public static String getApplicationName()

Provides easy access to the application's name that is displayed to the end user. Is the same name returned by system.getInfo("appName") in Corona SDK.

Added in daily build 2016.2869.

Returns:

Returns the application's name that is displayed to the end user.

Returns an empty String if CoronaEnvironment.getApplicationContext() is null.

getLuaErrorHandler

public static JavaFunction getLuaErrorHandler()

Gets the custom Lua error handler that was given to the CoronaEnvironment.setLuaErrorHandler() method.

Returns:

Returns a reference to a custom Lua error handler. This is a Lua function that is implemented in Java.

Returns null if a custom error handler was not set. In this case, Corona will use its default error handling.

setLuaErrorHandler

public static void setLuaErrorHandler(JavaFunction handler)

Sets a custom handler for Lua errors, such as syntax or runtime errors.

Parameters:

handler - Reference to the custom Lua error handler. This is a Lua function that is implemented in Java.

Set to null to use Corona's default error handler.

addRuntimeListener

public static void addRuntimeListener(CoronaRuntimeListener listener)

Adds a listener for receiving events from the CoronaRuntime.

Parameters:

listener - The listener that will receive events. Cannot be null.

See Also:

CoronaRuntimeListener

removeRuntimeListener

public static void removeRuntimeListener(CoronaRuntimeListener listener)

Removes the given listener that was added via the addRuntimeListener() method.

Parameters:

listener - The listener object to be removed by reference.

See Also:

CoronaRuntimeListener