Functions and constants to access the window, window event listeners and screen dimming.
dimming mode off
Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
dimming mode on
Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
dimming mode unknown
Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction. This mode indicates that the dim mode can't be determined, or that the platform doesn't support dimming.
focus gained window event
This event is sent to a window event listener when the game window or app screen has gained focus. This event is also sent at game startup and the engine gives focus to the game.
focus lost window event
This event is sent to a window event listener when the game window or app screen has lost focus.
resized window event
This event is sent to a window event listener when the game window or app screen is resized. The new size is passed along in the data field to the event listener.
get the mode for screen dimming
Returns the current dimming mode set on a mobile device.
The dimming mode specifies whether or not a mobile device should dim the screen after a period without user interaction.
On platforms that does not support dimming, window.DIMMING_UNKNOWN
is always returned.
mode -
constant The mode for screen dimming
window.DIMMING_UNKNOWN
window.DIMMING_ON
window.DIMMING_OFF
set the mode for screen dimming
Sets the dimming mode on a mobile device.
The dimming mode specifies whether or not a mobile device should dim the screen after a period without user interaction. The dimming mode will only affect the mobile device while the game is in focus on the device, but not when the game is running in the background.
This function has no effect on platforms that does not support dimming.
mode -
constant The mode for screen dimming
window.DIMMING_ON
window.DIMMING_OFF
sets a window event listener
Sets a window event listener.
callback -
function(self, event, data) A callback which receives info about window events. Pass an empty function if you no longer wish to receive callbacks.
self
event
window.WINDOW_EVENT_FOCUS_LOST
window.WINDOW_EVENT_FOCUS_GAINED
window.WINDOW_EVENT_RESIZED
data
data
is a table which currently holds these valueswidth
: The width of a resize event. nil otherwise.height
: The height of a resize event. nil otherwise.function window_callback(self, event, data) if event == window.WINDOW_EVENT_FOCUS_LOST then print("window.WINDOW_EVENT_FOCUS_LOST") elseif event == window.WINDOW_EVENT_FOCUS_GAINED then print("window.WINDOW_EVENT_FOCUS_GAINED") elseif event == window.WINDOW_EVENT_RESIZED then print("Window resized: ", data.width, data.height) end end function init(self) window.set_listener(window_callback) end