lime.app.Application - Lime API Reference

The Application class forms the foundation for most Lime projects. It is common to extend this class in a main class. It is then possible to override "on" functions in the class in order to handle standard events that are relevant.

Static variables

`staticread onlycurrent:Application`

The current Application instance that is executing

Constructor

`new()`

Creates a new Application instance

Variables

`read onlydeviceOrientation:Orientation`

The device's orientation.

`read onlymodules:Array<IModule>`

A list of currently attached Module instances

`@:value(new Event<Window>())onCreateWindow:_Event_lime_ui_Window_Void<Window ‑> Void> = new Event<Window>()`

Dispatched when a new window has been created by this application

`@:value(new Event<Orientation>())onDeviceOrientationChange:_Event_lime_system_Orientation_Void<Orientation ‑> Void> = new Event<Orientation>()`

Dispatched when the orientation of the device has changed. Typically, the display and device orientation values are the same. However, if the display orientation is locked to portrait or landscape, the display and device orientations may be different.

`@:value(new Event<Int -> Orientation>())onDisplayOrientationChange:_Event_Int_lime_system_Orientation_Void<(Int, Orientation) ‑> Void> = new Event<Int -> Orientation>()`

Dispatched when the orientation of the display has changed.

`@:value(new Event<Int>())onUpdate:_Event_Int_Void<Int ‑> Void> = new Event<Int>()`

Update events are dispatched each frame (usually just before rendering)

`read onlypreloader:Preloader`

The Preloader for the current Application

`read onlywindow:Window`

The Window associated with this Application, or the first Window if there are multiple Windows active

`read onlywindows:Array<Window>`

A list of active Window instances associated with this Application

Methods

`addModule(module:IModule):Void`

Adds a new module to the Application

Parameters:

`module`	A module to add

`createWindow(attributes:WindowAttributes):Window`

Creates a new Window and adds it to the Application

Parameters:

`attributes`	A set of parameters to initialize the window

`exec():Int`

Execute the Application. On native platforms, this method blocks until the application is finished running. On other platforms, it will return immediately

Returns:

An exit code, 0 if there was no error

`onGamepadAxisMove(gamepad:Gamepad, axis:GamepadAxis, value:Float):Void`

Called when a gamepad axis move event is fired

Parameters:

`gamepad`	The current gamepad
`axis`	The axis that was moved
`value`	The axis value (between 0 and 1)

`onGamepadButtonDown(gamepad:Gamepad, button:GamepadButton):Void`

Called when a gamepad button down event is fired

Parameters:

`gamepad`	The current gamepad
`button`	The button that was pressed

`onGamepadButtonUp(gamepad:Gamepad, button:GamepadButton):Void`

Called when a gamepad button up event is fired

Parameters:

`gamepad`	The current gamepad
`button`	The button that was released

`onGamepadConnect(gamepad:Gamepad):Void`

Called when a gamepad is connected

Parameters:

`gamepad`	The gamepad that was connected

`onGamepadDisconnect(gamepad:Gamepad):Void`

Called when a gamepad is disconnected

Parameters:

`gamepad`	The gamepad that was disconnected

`onJoystickAxisMove(joystick:Joystick, axis:Int, value:Float):Void`

Called when a joystick axis move event is fired

Parameters:

`joystick`	The current joystick
`axis`	The axis that was moved
`value`	The axis value (between 0 and 1)

`onJoystickButtonDown(joystick:Joystick, button:Int):Void`

Called when a joystick button down event is fired

Parameters:

`joystick`	The current joystick
`button`	The button that was pressed

`onJoystickButtonUp(joystick:Joystick, button:Int):Void`

Called when a joystick button up event is fired

Parameters:

`joystick`	The current joystick
`button`	The button that was released

`onJoystickConnect(joystick:Joystick):Void`

Called when a joystick is connected

Parameters:

`joystick`	The joystick that was connected

`onJoystickDisconnect(joystick:Joystick):Void`

Called when a joystick is disconnected

Parameters:

`joystick`	The joystick that was disconnected

`onJoystickHatMove(joystick:Joystick, hat:Int, position:JoystickHatPosition):Void`

Called when a joystick hat move event is fired

Parameters:

`joystick`	The current joystick
`hat`	The hat that was moved
`position`	The current hat position

`onKeyDown(keyCode:KeyCode, modifier:KeyModifier):Void`

Called when a key down event is fired on the primary window

Parameters:

`keyCode`	The code of the key that was pressed
`modifier`	The modifier of the key that was pressed

`onKeyUp(keyCode:KeyCode, modifier:KeyModifier):Void`

Called when a key up event is fired on the primary window

Parameters:

`keyCode`	The code of the key that was released
`modifier`	The modifier of the key that was released

`onModuleExit(code:Int):Void`

Called when the module is exiting

`onMouseDown(x:Float, y:Float, button:MouseButton):Void`

Called when a mouse down event is fired on the primary window

Parameters:

`x`	The current x coordinate of the mouse
`y`	The current y coordinate of the mouse
`button`	The ID of the mouse button that was pressed

`onMouseMove(x:Float, y:Float):Void`

Called when a mouse move event is fired on the primary window

Parameters:

`x`	The current x coordinate of the mouse
`y`	The current y coordinate of the mouse

`onMouseMoveRelative(x:Float, y:Float):Void`

Called when a mouse move relative event is fired on the primary window

Parameters:

`x`	The x movement of the mouse
`y`	The y movement of the mouse

`onMouseUp(x:Float, y:Float, button:MouseButton):Void`

Called when a mouse up event is fired on the primary window

Parameters:

`x`	The current x coordinate of the mouse
`y`	The current y coordinate of the mouse
`button`	The ID of the button that was released

`onMouseWheel(deltaX:Float, deltaY:Float, deltaMode:MouseWheelMode):Void`

Called when a mouse wheel event is fired on the primary window

Parameters:

`deltaX`	The amount of horizontal scrolling (if applicable)
`deltaY`	The amount of vertical scrolling (if applicable)
`deltaMode`	The units of measurement used

`onPreloadComplete():Void`

Called when a preload complete event is fired

`onPreloadProgress(loaded:Int, total:Int):Void`

Called when a preload progress event is fired

Parameters:

`loaded`	The number of items that are loaded
`total`	The total number of items will be loaded

`onRenderContextLost():Void`

Called when a render context is lost on the primary window

`onRenderContextRestored(context:RenderContext):Void`

Called when a render context is restored on the primary window

Parameters:

`context`	The render context relevant to the event

`onTextEdit(text:String, start:Int, length:Int):Void`

Called when a text edit event is fired on the primary window

Parameters:

`text`	The current replacement text
`start`	The starting index for the edit
`length`	The length of the edit

`onTextInput(text:String):Void`

Called when a text input event is fired on the primary window

Parameters:

`text`	The current input text

`onTouchCancel(touch:Touch):Void`

Called when a touch cancel event is fired

Parameters:

`touch`	The current touch object

`onTouchEnd(touch:Touch):Void`

Called when a touch end event is fired

Parameters:

`touch`	The current touch object

`onTouchMove(touch:Touch):Void`

Called when a touch move event is fired

Parameters:

`touch`	The current touch object

`onTouchStart(touch:Touch):Void`

Called when a touch start event is fired

Parameters:

`touch`	The current touch object

`onWindowActivate():Void`

Called when a window activate event is fired on the primary window

`onWindowClose():Void`

Called when a window close event is fired on the primary window

`onWindowCreate():Void`

Called when the primary window is created

`onWindowDeactivate():Void`

Called when a window deactivate event is fired on the primary window

`onWindowDropFile(file:String):Void`

Called when a window drop file event is fired on the primary window

`onWindowEnter():Void`

Called when a window enter event is fired on the primary window

`onWindowExpose():Void`

Called when a window expose event is fired on the primary window

`onWindowFocusIn():Void`

Called when a window focus in event is fired on the primary window

`onWindowFocusOut():Void`

Called when a window focus out event is fired on the primary window

`onWindowFullscreen():Void`

Called when the primary window enters fullscreen

`onWindowLeave():Void`

Called when a window leave event is fired on the primary window

`onWindowMinimize():Void`

Called when the primary window is minimized

`onWindowMove(x:Float, y:Float):Void`

Called when a window move event is fired on the primary window

Parameters:

`x`	The x position of the window in desktop coordinates
`y`	The y position of the window in desktop coordinates

`onWindowResize(width:Int, height:Int):Void`

Called when a window resize event is fired on the primary window

Parameters:

`width`	The width of the window
`height`	The height of the window

`onWindowRestore():Void`

Called when the primary window is restored from being minimized or fullscreen

`removeModule(module:IModule):Void`

Removes a module from the Application

Parameters:

`module`	A module to remove

`render(context:RenderContext):Void`

Called when a render event is fired on the primary window

Parameters:

`context`	The render context ready to be rendered

`update(deltaTime:Int):Void`

Called when an update event is fired on the primary window

Parameters:

`deltaTime`	The amount of time in milliseconds that has elapsed since the last update

class Application

package lime.app

extends Module

Static variables

staticread onlycurrent:Application

Constructor

new()

Variables

read onlydeviceOrientation:Orientation

read onlymodules:Array<IModule>

@:value(new Event<Window>())onCreateWindow:_Event_lime_ui_Window_Void<Window ‑> Void> = new Event<Window>()

@:value(new Event<Orientation>())onDeviceOrientationChange:_Event_lime_system_Orientation_Void<Orientation ‑> Void> = new Event<Orientation>()

@:value(new Event<Int -> Orientation>())onDisplayOrientationChange:_Event_Int_lime_system_Orientation_Void<(Int, Orientation) ‑> Void> = new Event<Int -> Orientation>()

@:value(new Event<Int>())onUpdate:_Event_Int_Void<Int ‑> Void> = new Event<Int>()

read onlypreloader:Preloader

read onlywindow:Window

read onlywindows:Array<Window>

Methods

addModule(module:IModule):Void

createWindow(attributes:WindowAttributes):Window

exec():Int

onGamepadAxisMove(gamepad:Gamepad, axis:GamepadAxis, value:Float):Void

onGamepadButtonDown(gamepad:Gamepad, button:GamepadButton):Void

onGamepadButtonUp(gamepad:Gamepad, button:GamepadButton):Void

onGamepadConnect(gamepad:Gamepad):Void

onGamepadDisconnect(gamepad:Gamepad):Void

onJoystickAxisMove(joystick:Joystick, axis:Int, value:Float):Void

onJoystickButtonDown(joystick:Joystick, button:Int):Void

onJoystickButtonUp(joystick:Joystick, button:Int):Void

onJoystickConnect(joystick:Joystick):Void

onJoystickDisconnect(joystick:Joystick):Void

onJoystickHatMove(joystick:Joystick, hat:Int, position:JoystickHatPosition):Void

onKeyDown(keyCode:KeyCode, modifier:KeyModifier):Void

onKeyUp(keyCode:KeyCode, modifier:KeyModifier):Void

onModuleExit(code:Int):Void

onMouseDown(x:Float, y:Float, button:MouseButton):Void

onMouseMove(x:Float, y:Float):Void

onMouseMoveRelative(x:Float, y:Float):Void

onMouseUp(x:Float, y:Float, button:MouseButton):Void

onMouseWheel(deltaX:Float, deltaY:Float, deltaMode:MouseWheelMode):Void

onPreloadComplete():Void

onPreloadProgress(loaded:Int, total:Int):Void

onRenderContextLost():Void

onRenderContextRestored(context:RenderContext):Void

onTextEdit(text:String, start:Int, length:Int):Void

onTextInput(text:String):Void

onTouchCancel(touch:Touch):Void

onTouchEnd(touch:Touch):Void

onTouchMove(touch:Touch):Void

onTouchStart(touch:Touch):Void

onWindowActivate():Void

onWindowClose():Void

onWindowCreate():Void

onWindowDeactivate():Void

onWindowDropFile(file:String):Void

onWindowEnter():Void

onWindowExpose():Void

onWindowFocusIn():Void

onWindowFocusOut():Void

onWindowFullscreen():Void

onWindowLeave():Void

onWindowMinimize():Void

onWindowMove(x:Float, y:Float):Void

onWindowResize(width:Int, height:Int):Void

onWindowRestore():Void

removeModule(module:IModule):Void

render(context:RenderContext):Void

update(deltaTime:Int):Void

Inherited Variables

Defined by Module

@:value(new Event<Int>())onExit:_Event_Int_Void<Int ‑> Void> = new Event<Int>()

Inherited Methods

`staticread onlycurrent:Application`

`new()`

`read onlydeviceOrientation:Orientation`

`read onlymodules:Array<IModule>`

`@:value(new Event<Window>())onCreateWindow:_Event_lime_ui_Window_Void<Window ‑> Void> = new Event<Window>()`

`@:value(new Event<Orientation>())onDeviceOrientationChange:_Event_lime_system_Orientation_Void<Orientation ‑> Void> = new Event<Orientation>()`

`@:value(new Event<Int -> Orientation>())onDisplayOrientationChange:_Event_Int_lime_system_Orientation_Void<(Int, Orientation) ‑> Void> = new Event<Int -> Orientation>()`

`@:value(new Event<Int>())onUpdate:_Event_Int_Void<Int ‑> Void> = new Event<Int>()`

`read onlypreloader:Preloader`

`read onlywindow:Window`

`read onlywindows:Array<Window>`

`addModule(module:IModule):Void`

`createWindow(attributes:WindowAttributes):Window`

`exec():Int`

`onGamepadAxisMove(gamepad:Gamepad, axis:GamepadAxis, value:Float):Void`

`onGamepadButtonDown(gamepad:Gamepad, button:GamepadButton):Void`

`onGamepadButtonUp(gamepad:Gamepad, button:GamepadButton):Void`

`onGamepadConnect(gamepad:Gamepad):Void`

`onGamepadDisconnect(gamepad:Gamepad):Void`

`onJoystickAxisMove(joystick:Joystick, axis:Int, value:Float):Void`

`onJoystickButtonDown(joystick:Joystick, button:Int):Void`

`onJoystickButtonUp(joystick:Joystick, button:Int):Void`

`onJoystickConnect(joystick:Joystick):Void`

`onJoystickDisconnect(joystick:Joystick):Void`

`onJoystickHatMove(joystick:Joystick, hat:Int, position:JoystickHatPosition):Void`

`onKeyDown(keyCode:KeyCode, modifier:KeyModifier):Void`

`onKeyUp(keyCode:KeyCode, modifier:KeyModifier):Void`

`onModuleExit(code:Int):Void`

`onMouseDown(x:Float, y:Float, button:MouseButton):Void`

`onMouseMove(x:Float, y:Float):Void`

`onMouseMoveRelative(x:Float, y:Float):Void`

`onMouseUp(x:Float, y:Float, button:MouseButton):Void`

`onMouseWheel(deltaX:Float, deltaY:Float, deltaMode:MouseWheelMode):Void`

`onPreloadComplete():Void`

`onPreloadProgress(loaded:Int, total:Int):Void`

`onRenderContextLost():Void`

`onRenderContextRestored(context:RenderContext):Void`

`onTextEdit(text:String, start:Int, length:Int):Void`

`onTextInput(text:String):Void`

`onTouchCancel(touch:Touch):Void`

`onTouchEnd(touch:Touch):Void`

`onTouchMove(touch:Touch):Void`

`onTouchStart(touch:Touch):Void`

`onWindowActivate():Void`

`onWindowClose():Void`

`onWindowCreate():Void`

`onWindowDeactivate():Void`

`onWindowDropFile(file:String):Void`

`onWindowEnter():Void`

`onWindowExpose():Void`

`onWindowFocusIn():Void`

`onWindowFocusOut():Void`

`onWindowFullscreen():Void`

`onWindowLeave():Void`

`onWindowMinimize():Void`

`onWindowMove(x:Float, y:Float):Void`

`onWindowResize(width:Int, height:Int):Void`

`onWindowRestore():Void`

`removeModule(module:IModule):Void`

`render(context:RenderContext):Void`

`update(deltaTime:Int):Void`

`@:value(new Event<Int>())onExit:_Event_Int_Void<Int ‑> Void> = new Event<Int>()`