Jive

API documentation

class lime.app.Module

Interfaces
IModule
IModule
Sub classes
Application
Application

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.

Instance Fields

var onExit:Event_Int_Void<Int ->Void>

Exit events are dispatched when the application is exiting

function new(): Void

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

Called when a gamepad axis move event is fired

gamepad

The current gamepad

axis

The axis that was moved

value

The axis value (between 0 and 1)

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

Called when a gamepad button down event is fired

gamepad

The current gamepad

button

The button that was pressed

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

Called when a gamepad button up event is fired

gamepad

The current gamepad

button

The button that was released

function onGamepadConnect(gamepad:Gamepad): Void

Called when a gamepad is connected

gamepad

The gamepad that was connected

function onGamepadDisconnect(gamepad:Gamepad): Void

Called when a gamepad is disconnected

gamepad

The gamepad that was disconnected

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

Called when a joystick axis move event is fired

joystick

The current joystick

axis

The axis that was moved

value

The axis value (between 0 and 1)

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

Called when a joystick button down event is fired

joystick

The current joystick

button

The button that was pressed

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

Called when a joystick button up event is fired

joystick

The current joystick

button

The button that was released

function onJoystickConnect(joystick:Joystick): Void

Called when a joystick is connected

joystick

The joystick that was connected

function onJoystickDisconnect(joystick:Joystick): Void

Called when a joystick is disconnected

joystick

The joystick that was disconnected

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

Called when a joystick hat move event is fired

joystick

The current joystick

hat

The hat that was moved

position

The current hat position

function onJoystickTrackballMove(joystick:Joystick, trackball:Int, value:Float): Void

Called when a joystick axis move event is fired

joystick

The current joystick

trackball

The trackball that was moved

value

The trackball value (between 0 and 1)

function onKeyDown(window:Window, keyCode:KeyCode, modifier:KeyModifier): Void

Called when a key down event is fired

window

The window dispatching the event

keyCode

The code of the key that was pressed

modifier

The modifier of the key that was pressed

function onKeyUp(window:Window, keyCode:KeyCode, modifier:KeyModifier): Void

Called when a key up event is fired

window

The window dispatching the event

keyCode

The code of the key that was released

modifier

The modifier of the key that was released

function onModuleExit(code:Int): Void

Called when the module is exiting

function onMouseDown(window:Window, x:Float, y:Float, button:Int): Void

Called when a mouse down event is fired

window

The window dispatching the event

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

function onMouseMove(window:Window, x:Float, y:Float): Void

Called when a mouse move event is fired

window

The window dispatching the event

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

function onMouseMoveRelative(window:Window, x:Float, y:Float): Void

Called when a mouse move relative event is fired

window

The window dispatching the event

x

The x movement of the mouse

y

The y movement of the mouse

button

The ID of the mouse button that was pressed

function onMouseUp(window:Window, x:Float, y:Float, button:Int): Void

Called when a mouse up event is fired

window

The window dispatching the event

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

function onMouseWheel(window:Window, deltaX:Float, deltaY:Float): Void

Called when a mouse wheel event is fired

window

The window dispatching the event

deltaX

The amount of horizontal scrolling (if applicable)

deltaY

The amount of vertical scrolling (if applicable)

function onPreloadComplete(): Void

Called when a preload complete event is fired

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

Called when a preload progress event is fired

loaded

The number of items that are loaded

total

The total number of items will be loaded

function onRenderContextLost(renderer:Renderer): Void

Called when a render context is lost

renderer

The renderer dispatching the event

function onRenderContextRestored(renderer:Renderer, context:RenderContext): Void

Called when a render context is restored

renderer

The renderer dispatching the event

context

The current render context

function onTextEdit(window:Window, text:String, start:Int, length:Int): Void

Called when a text edit event is fired

window

The window dispatching the event

text

The current replacement text

start

The starting index for the edit

length

The length of the edit

function onTextInput(window:Window, text:String): Void

Called when a text input event is fired

window

The window dispatching the event

text

The current input text

function onTouchEnd(touch:Touch): Void

Called when a touch end event is fired

touch

The current touch object

function onTouchMove(touch:Touch): Void

Called when a touch move event is fired

touch

The current touch object

function onTouchStart(touch:Touch): Void

Called when a touch start event is fired

touch

The current touch object

function onWindowActivate(window:Window): Void

Called when a window activate event is fired

window

The window dispatching the event

function onWindowClose(window:Window): Void

Called when a window close event is fired

window

The window dispatching the event

function onWindowCreate(window:Window): Void

Called when a window create event is fired

window

The window dispatching the event

function onWindowDeactivate(window:Window): Void

Called when a window deactivate event is fired

window

The window dispatching the event

function onWindowDropFile(window:Window, file:String): Void

Called when a window drop file event is fired

window

The window dispatching the event

function onWindowEnter(window:Window): Void

Called when a window enter event is fired

window

The window dispatching the event

function onWindowFocusIn(window:Window): Void

Called when a window focus in event is fired

window

The window dispatching the event

function onWindowFocusOut(window:Window): Void

Called when a window focus out event is fired

window

The window dispatching the event

function onWindowFullscreen(window:Window): Void

Called when a window enters fullscreen

window

The window dispatching the event

function onWindowLeave(window:Window): Void

Called when a window leave event is fired

window

The window dispatching the event

function onWindowMinimize(window:Window): Void

Called when a window is minimized

window

The window dispatching the event

function onWindowMove(window:Window, x:Float, y:Float): Void

Called when a window move event is fired

window

The window dispatching the event

x

The x position of the window in desktop coordinates

y

The y position of the window in desktop coordinates

function onWindowResize(window:Window, width:Int, height:Int): Void

Called when a window resize event is fired

window

The window dispatching the event

width

The width of the window

height

The height of the window

function onWindowRestore(window:Window): Void

Called when a window is restored from being minimized or fullscreen

window

The window dispatching the event

function render(renderer:Renderer): Void

Called when a render event is fired

renderer

The renderer dispatching the event

function update(deltaTime:Int): Void

Called when an update event is fired

deltaTime

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