Difference between revisions of "GetTime"
From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 1: | Line 1: | ||
− | <div class="toccolours mw-collapsible mw-collapsed" | + | <div class="toccolours mw-collapsible mw-collapsed tbl-ds"> |
− | + | <span class="bold">Command History</span> | |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
− | <div | + | <div class="alt-bg">Available since v3.7</div> |
</div></div> | </div></div> | ||
Line 34: | Line 34: | ||
− | < | + | <span class="bold underline">Arguments</span> |
none | none | ||
− | < | + | <span class="bold underline">Flags</span> |
− | < | + | <span class="bold">r/reset</span> <br/> |
True resets timer back to zero; false does nothing (if no flags are set then reset will be false by default) | True resets timer back to zero; false does nothing (if no flags are set then reset will be false by default) | ||
− | < | + | <span class="bold underline">Return</span> |
− | < | + | <span class="bold">time</span> <br/> |
The integer value of the current time (in ms) | The integer value of the current time (in ms) | ||
{{i18n|GetTime}} | {{i18n|GetTime}} |
Revision as of 19:13, 2 April 2013
Command History
Available since v3.7
Returns the number of milliseconds since the command was first called - or since the timer was reset!
Use this command for relative time measurements; for example: call getTime() at the beginning of an action & then again when the action has finished to get the time taken to perform said action!
Syntax:
getTime({flags=1, reset})
Example:
-- let's store the current time in a variable & then check it against current time!
local initialTime = getTime()
-- we'll use this function to check current time elapsed & decided what action to perform!
function checkTime()
if getTime() >= initialTime + 3000 then -- if current time more than equals initial time + 3 seconds then ...
-- do some action!
getTime({flags=1, reset=true}) -- let's reset timer back to zero!
end
end
-- the checkTime() function would be most effective, if included in a mainLoop event handler!
Arguments
none
Flags
r/reset
True resets timer back to zero; false does nothing (if no flags are set then reset will be false by default)
Return
time
The integer value of the current time (in ms)