diff options
author | 最萌小汐 <sumneko@hotmail.com> | 2021-07-20 16:40:27 +0800 |
---|---|---|
committer | 最萌小汐 <sumneko@hotmail.com> | 2021-07-20 16:40:27 +0800 |
commit | 4bad35e608179e74c9ce186fa2038573055e574b (patch) | |
tree | b820b8f34ab9e8a92cb6093defaab7f65ee13cbd /meta/3rd/love2d/library/love.system.lua | |
parent | ee83c8939fdb9547bba993132e71a0638949abe9 (diff) | |
download | lua-language-server-4bad35e608179e74c9ce186fa2038573055e574b.zip |
first step of love2d-api
Diffstat (limited to 'meta/3rd/love2d/library/love.system.lua')
-rw-r--r-- | meta/3rd/love2d/library/love.system.lua | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/meta/3rd/love2d/library/love.system.lua b/meta/3rd/love2d/library/love.system.lua new file mode 100644 index 00000000..dfb79734 --- /dev/null +++ b/meta/3rd/love2d/library/love.system.lua @@ -0,0 +1,55 @@ +---@class love.system +love.system = {} + +--- +---Gets text from the clipboard. +--- +---@return string text # The text currently held in the system's clipboard. +function love.system.getClipboardText() end + +--- +---Gets the current operating system. In general, LÖVE abstracts away the need to know the current operating system, but there are a few cases where it can be useful (especially in combination with os.execute.) +--- +---@return string osString # The current operating system. 'OS X', 'Windows', 'Linux', 'Android' or 'iOS'. +function love.system.getOS() end + +--- +---Gets information about the system's power supply. +--- +---@return PowerState state # The basic state of the power supply. +---@return number percent # Percentage of battery life left, between 0 and 100. nil if the value can't be determined or there's no battery. +---@return number seconds # Seconds of battery life left. nil if the value can't be determined or there's no battery. +function love.system.getPowerInfo() end + +--- +---Gets the amount of logical processor in the system. +--- +---@return number processorCount # Amount of logical processors. +function love.system.getProcessorCount() end + +--- +---Gets whether another application on the system is playing music in the background. +--- +---Currently this is implemented on iOS and Android, and will always return false on other operating systems. The t.audio.mixwithsystem flag in love.conf can be used to configure whether background audio / music from other apps should play while LÖVE is open. +--- +---@return boolean backgroundmusic # True if the user is playing music in the background via another app, false otherwise. +function love.system.hasBackgroundMusic() end + +--- +---Opens a URL with the user's web or file browser. +--- +---@param url string # The URL to open. Must be formatted as a proper URL. +---@return boolean success # Whether the URL was opened successfully. +function love.system.openURL(url) end + +--- +---Puts text in the clipboard. +--- +---@param text string # The new text to hold in the system's clipboard. +function love.system.setClipboardText(text) end + +--- +---Causes the device to vibrate, if possible. Currently this will only work on Android and iOS devices that have a built-in vibration motor. +--- +---@param seconds number # The duration to vibrate for. If called on an iOS device, it will always vibrate for 0.5 seconds due to limitations in the iOS system APIs. +function love.system.vibrate(seconds) end |