Functions and constants to access the window, window event listeners and screen dimming.
Sets a window event listener.
callback - A callback which receives info about window events. Pass an empty function or nil
if you no longer wish to receive callbacks.
self
event
window.WINDOW_EVENT_FOCUS_LOST
window.WINDOW_EVENT_FOCUS_GAINED
window.WINDOW_EVENT_RESIZED
window.WINDOW_EVENT_ICONIFIED
window.WINDOW_EVENT_DEICONIFIED
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_ICONFIED then
print("window.WINDOW_EVENT_ICONFIED")
elseif event == window.WINDOW_EVENT_DEICONIFIED then
print("window.WINDOW_EVENT_DEICONIFIED")
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
Set the locking state for current mouse cursor on a PC platform. This function locks or unlocks the mouse cursor to the center point of the window. While the cursor is locked, mouse position updates will still be sent to the scripts as usual.
flag - The lock state for the mouse cursor
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 - The mode for screen dimming
window.DIMMING_ON
window.DIMMING_OFF
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 - The mode for screen dimming
window.DIMMING_UNKNOWN
window.DIMMING_ON
window.DIMMING_OFF
This returns the current window size (width and height).
width - The window width
height - The window height
This returns the current lock state of the mouse cursor
state - The lock state
This event is sent to a window event listener when the game window or app screen has lost focus.
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.
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.
This event is sent to a window event listener when the game window or app screen is iconified (reduced to an application icon in a toolbar, application tray or similar).
This event is sent to a window event listener when the game window or app screen is restored after being iconified.
Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
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.