Global Command: getTime - Revision history

EK at 09:53, 22 May 2023

2023-05-22T09:53:37Z

EK: EK moved page GetTime (CMS) to Global Command: getTime

2023-05-02T18:07:38Z

EK moved page GetTime (CMS) to Global Command: getTime

EK at 18:07, 2 May 2023

2023-05-02T18:07:14Z

AFRLme at 14:07, 6 October 2017

2017-10-06T14:07:54Z

AFRLme at 14:46, 23 March 2014

2014-03-23T14:46:35Z

AFRLme: Created page with "
Function History

Available since..."

2014-03-23T14:45:06Z

Created page with "<div class="toccolours mw-collapsible mw-collapsed tbl-ds"> <span class="bold">Function History</span> <div class="mw-collapsible-content"> <div class="alt-bg">Available since..."

New page

<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
<span class="bold">Function History</span>
<div class="mw-collapsible-content">
<div class="alt-bg">Available since v3.0</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>

<span class="bold underline">Arguments</span>

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)

<span class="bold underline">Return</span>

<span class="bold">time</span> <br/>
The integer value of the current time (in ms)

@@ Line 6: / Line 6: @@
 == Syntax ==
 <syntaxhighlight lang="lua">
-getTime(flags)
+getTime([flags])
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
-{| class="ts" style="width:100%"
+Returns the number of milliseconds since the "getTime()" function was first called or since the timer was reset.
+== Syntax ==
-Syntax:
+<syntaxhighlight lang="lua">
-<syntaxhighlight>
+getTime(flags)
 </syntaxhighlight>
-Example:
+== Parameters ==
--- we'll use this function to check current time elapsed & decided what action to perform!
+{| class="ts"
-function checkTime()
+|-
- if getTime() >= initialTime + 3000 then -- if current time more than equals initial time + 3 seconds then ...
+! style="width:15%" | Parameter
-  -- do some action!
+! style="width:15%" colspan="2" | Type/Structure
-  getTime({flags=1, reset=true}) -- let's reset timer back to zero!
+! Description
- end
+|-
-end
+| rowspan="2" | flags
-none
+== Examples ==
-<span class="bold underline">Flags</span>
+-- If more than 3 seconds elapsed, do something and reset the timer to start counting from zero again;
+</syntaxhighlight>
-<span class="bold underline">Return</span>
+{{toc}}

← Older revision	Revision as of 18:07, 2 May 2023
(No difference)

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+{| class="ts" style="width:100%"
-<span class="bold">Function History</span>
+|-
-<div class="mw-collapsible-content">
+! style="text-align:left" | Function History
-<div class="alt-bg">Available since v3.0</div>
+|-
-</div></div>
+| Available since v3.0

@@ Line 29: / Line 29: @@
 end
--- the checkTime() function would be most effective, if included in a mainLoop event handler!
+-- the checkTime() function would be most effective, if included inside a mainLoop event handler function
 </syntaxhighlight>