Difference between revisions of "GetTime"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Redirected page to Global Command: getTime)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+
#REDIRECT [[Global Command: getTime]]
<b>Command History</b>
 
<div class="mw-collapsible-content">
 
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
 
</div></div>
 
 
 
 
 
Returns the number of milliseconds since the command was first called - or since the timer was reset! <br/>
 
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:
 
<syntaxhighlight>
 
getTime({flags=1, reset})
 
</syntaxhighlight>
 
 
 
 
 
Example:
 
<syntaxhighlight>
 
-- 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!
 
</syntaxhighlight>
 
 
 
 
 
 
 
<b><u>Arguments</u></b>
 
 
 
none
 
 
 
 
 
<b><u>Flags</u></b>
 
 
 
<b>r/reset</b> <br/>
 
True resets timer back to zero; false does nothing (if no flags are set then reset will be false by default)
 
 
 
 
 
<b><u>Return</u></b>
 
 
 
<b>time</b> <br/>
 
The integer value of the current time (in ms)
 
{{i18n|GetTime}}
 

Latest revision as of 12:22, 19 May 2023