Difference between revisions of "love.system.getPowerInfo"

(Created page)
 
m (Added example)
 
(One intermediate revision by one other user not shown)
Line 11: Line 11:
 
=== Returns ===
 
=== Returns ===
 
{{param|PowerState|state|The basic state of the power supply.}}
 
{{param|PowerState|state|The basic state of the power supply.}}
{{param|number|percent (-1)|Percentage of battery life left, between 0 and 100. -1 if the value can't be determined or there's no battery.}}
+
{{param|number|percent (nil)|Percentage of battery life left, between 0 and 100. nil if the value can't be determined or there's no battery.}}
{{param|number|seconds (-1)|Seconds of battery life left. -1 if the value can't be determined or there's no battery.}}
+
{{param|number|seconds (nil)|Seconds of battery life left. nil if the value can't be determined or there's no battery.}}
 +
 
 +
== Examples ==
 +
Print to console battery state, percent battery remaining, and seconds of battery life remaining. Note that percent and seconds remaining will be nil if no battery is present.
 +
<source lang="lua">
 +
function love.load()
 +
    print(love.system.getPowerInfo())
 +
end
 +
</source>
  
 
== See Also ==
 
== See Also ==

Latest revision as of 00:16, 18 December 2013

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

Gets information about the system's power supply.

Function

Synopsis

state, percent, seconds = love.system.getPowerInfo( )

Arguments

None.

Returns

PowerState state
The basic state of the power supply.
number percent (nil)
Percentage of battery life left, between 0 and 100. nil if the value can't be determined or there's no battery.
number seconds (nil)
Seconds of battery life left. nil if the value can't be determined or there's no battery.

Examples

Print to console battery state, percent battery remaining, and seconds of battery life remaining. Note that percent and seconds remaining will be nil if no battery is present.

function love.load()
    print(love.system.getPowerInfo())
end

See Also

Other Languages