| CoronaRuntimeEnvironment Class |
Inheritance HierarchyNamespace: CoronaLabs.Corona.WinRT
Assembly: CoronaLabs (in CoronaLabs.dll) Version: 255.255.255.255
SyntaxThe CoronaRuntimeEnvironment type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddEventListener | Subscribes an event handler to be invoked when the given Corona event name gets dispatched. It is okay to call this method before the runtime has started. Once started, the runtime will automatically subscribe the given handler to the event. |
| DispatchEvent | Dispatches the given Corona event to Lua to be received by a Lua function. Lua functions can subscribe to the given event via the Lua Runtime:addEventListener() function. |
| Equals | (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| RemoveEventListener | Unsubscribes the given event handler from the specified Corona event. This method is expected to be called with the same event name and handler arguments passed into the AddEventListener(String, CoronaLuaEventHandler) method. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Properties| Name | Description | |
|---|---|---|
 | CachesDirectoryPath | Gets the path that Corona's "system.CachesDirectory" property maps to in Lua. This directory's files will be automatically deleted if the system is running low on storage space. |
| CoronaControlAdapter |
Gets the control that hosts the rendering surface and child controls created via Lua's native APIs.
|
 | DefaultCachesDirectoryPath | Gets the default path that Corona will use for the "system.CachesDirectory" property in Lua. This directory's files will be automatically deleted if the system is running low on storage space. |
| DefaultDocumentsDirectoryPath | Gets the default path that Corona will use for the "system.DocumentsDirectory" property in Lua. |
| DefaultInternalDirectoryPath | Gets the default path that Corona will use to store files for its internal features, such as analytics. This directory is not made available in Lua. |
| DefaultResourceDirectoryPath | Gets the default path that Corona will use for the "system.ResourceDirectory" property in Lua. |
| DefaultTemporaryDirectoryPath | Gets the default path that Corona will use for the "system.TemporaryDirectory" property in Lua. This directory's files will be automatically deleted if the system is running low on storage space. |
| DocumentsDirectoryPath | Gets the path that Corona's "system.DocumentsDirectory" property maps to in Lua. |
| InternalDirectoryPath | Gets the directory path that Corona uses to store files for its internal features, such as analytics. This directory is not made available in Lua. |
| InteropServices | Provides cross-platform and cross-language access to features to the C/C++ side of Corona. This property is not intended for public use. |
| LaunchFilePath | Gets the path to the file that the Corona runtime began execution on. Typically set to a "resource.car" "main.lua" or "resource.car" file. |
| ResourceDirectoryPath | Gets the path that Corona's "system.ResourceDirectory" property maps to in Lua. |
| RuntimeState | Gets the current state of the Corona runtime such as Running, Suspended, Terminated, etc. |
| TemporaryDirectoryPath | Gets the path that Corona's "system.TemporaryDirectory" property maps to in Lua. This directory's files will be automatically deleted if the system is running low on storage space. |
Events| Name | Description | |
|---|---|---|
 | Resumed | Raised when the Corona runtime has been resumed after a suspend. |
| Suspended | Raised when the Corona runtime has been suspended which pauses all rendering, audio, timers and other Corona related operations. This is typically raised when the end-user navigates to another app or when the power button has been pressed. |
| Terminating | Raised just before the Corona runtime environment is about to be terminated. This typically happens when the end-user backs out of the app, the Corona XAML control has been unloaded from the page, or when the runtime's Terminate() method has been called. |
See Also