mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 18:37:44 +02:00
110 lines
4.3 KiB
Lua
110 lines
4.3 KiB
Lua
--[[
|
|
Generated with github.com/astrochili/defold-annotations
|
|
Defold 1.8.0
|
|
|
|
Window API documentation
|
|
|
|
Functions and constants to access the window, window event listeners
|
|
and screen dimming.
|
|
--]]
|
|
|
|
---@diagnostic disable: lowercase-global
|
|
---@diagnostic disable: missing-return
|
|
---@diagnostic disable: duplicate-doc-param
|
|
---@diagnostic disable: duplicate-set-field
|
|
|
|
---@class defold_api.window
|
|
window = {}
|
|
|
|
---Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
|
|
window.DIMMING_OFF = nil
|
|
|
|
---Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
|
|
window.DIMMING_ON = nil
|
|
|
|
---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.
|
|
window.DIMMING_UNKNOWN = nil
|
|
|
|
--- This event is sent to a window event listener when the game window or app screen is
|
|
---restored after being iconified.
|
|
window.WINDOW_EVENT_DEICONIFIED = nil
|
|
|
|
---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.
|
|
window.WINDOW_EVENT_FOCUS_GAINED = nil
|
|
|
|
---This event is sent to a window event listener when the game window or app screen has lost focus.
|
|
window.WINDOW_EVENT_FOCUS_LOST = nil
|
|
|
|
--- 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).
|
|
window.WINDOW_EVENT_ICONFIED = nil
|
|
|
|
---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.
|
|
window.WINDOW_EVENT_RESIZED = nil
|
|
|
|
--- 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.
|
|
---@return constant mode The mode for screen dimming
|
|
---
|
|
---window.DIMMING_UNKNOWN
|
|
---window.DIMMING_ON
|
|
---window.DIMMING_OFF
|
|
---
|
|
function window.get_dim_mode() end
|
|
|
|
---This returns the current lock state of the mouse cursor
|
|
---@return boolean state The lock state
|
|
function window.get_mouse_lock() end
|
|
|
|
---This returns the current window size (width and height).
|
|
---@return number width The window width
|
|
---@return number height The window height
|
|
function window.get_size() end
|
|
|
|
--- 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.
|
|
---@param mode constant The mode for screen dimming
|
|
---
|
|
---window.DIMMING_ON
|
|
---window.DIMMING_OFF
|
|
---
|
|
function window.set_dim_mode(mode) end
|
|
|
|
---Sets a window event listener.
|
|
---@param callback fun(self, event, data)|nil A callback which receives info about window events. Pass an empty function or nil if you no longer wish to receive callbacks.
|
|
---
|
|
---self
|
|
---object The calling script
|
|
---event
|
|
---constant The type of event. Can be one of these:
|
|
---
|
|
---
|
|
---window.WINDOW_EVENT_FOCUS_LOST
|
|
---window.WINDOW_EVENT_FOCUS_GAINED
|
|
---window.WINDOW_EVENT_RESIZED
|
|
---window.WINDOW_EVENT_ICONIFIED
|
|
---window.WINDOW_EVENT_DEICONIFIED
|
|
---
|
|
---
|
|
---data
|
|
---table The callback value data is a table which currently holds these values
|
|
---
|
|
---
|
|
---number width: The width of a resize event. nil otherwise.
|
|
---number height: The height of a resize event. nil otherwise.
|
|
---
|
|
function window.set_listener(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.
|
|
---@param flag boolean The lock state for the mouse cursor
|
|
function window.set_mouse_lock(flag) end
|
|
|
|
return window |