GetTime - Revision history

EK: Redirected page to Global Command: getTime

2023-05-19T11:22:54Z

Redirected page to Global Command: getTime

Vis apiuser at 20:27, 30 September 2014

2014-09-30T20:27:45Z

Vis apiuser at 13:56, 26 November 2013

2013-11-26T13:56:22Z

Vis apiuser at 16:11, 22 November 2013

2013-11-22T16:11:41Z

AFRLme at 18:13, 2 April 2013

2013-04-02T18:13:58Z

AFRLme at 15:05, 2 April 2013

2013-04-02T15:05:37Z

AFRLme: Created page with "
Command History

2013-03-11T17:26:44Z

Created page with "<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"> <b>Command History</b> <div class="mw-collapsible-co..."

New page
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
<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!
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
<b>Additional Info</b>
<div class="mw-collapsible-content">
<div>This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!</div>
</div></div>

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}}

← Older revision		Revision as of 11:22, 19 May 2023
Line 1:		Line 1:
−	~~==getTime==~~	+	#REDIRECT [[Global Command: getTime]]
−	Returns the number of milli seconds since the command was called the first time (or the timer was reset). Use this command for relative time measurements. E.g. call this command twice at different locations and calculate the time differential to see the time passed.
−	~~<div class="command-min-version-info">Available since: <span class="command-min-version">v3.0</span></div>~~
−
−	~~Lua Syntax:~~
−	~~<pre class="command-syntax">getTime({flags=1,~~
−	~~reset = true\|false})</pre>~~
−	~~===Arguments===~~
−	~~===Flags===~~
−	~~====r/reset====~~
−
−	:~~If true the timer will be reset and the next call(s) will return the time passed since this call.~~
−	~~===Return Values===~~
−	~~;time~~
−	~~:Milli seconds~~
−	~~===Examples===~~
−	~~Example 1:~~
−	~~<syntaxhighlight>~~
−	~~-- we'll use this function to check current time elapsed & decide what action to perform~~
−	~~function checkTime()~~
−	~~if getTime() > 3000 then -- if time elapsed is more than 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>~~

← Older revision		Revision as of 20:27, 30 September 2014
Line 27:		Line 27:
	-- the checkTime() function would be most effective if included in a mainLoop event handler		-- the checkTime() function would be most effective if included in a mainLoop event handler
	</syntaxhighlight>		</syntaxhighlight>
−	~~[[Category:Player Commands]]~~

← Older revision		Revision as of 13:56, 26 November 2013
Line 27:		Line 27:
	-- the checkTime() function would be most effective if included in a mainLoop event handler		-- the checkTime() function would be most effective if included in a mainLoop event handler
	</syntaxhighlight>		</syntaxhighlight>
		+	[[Category:Player Commands]]

← Older revision		Revision as of 15:05, 2 April 2013
Line 8:		Line 8:
	Returns the number of milliseconds since the command was first called - or since the timer was reset! <br/>		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!		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!
−	~~<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">~~
−	~~<b>Additional Info</b>~~
−	~~<div class="mw-collapsible-content">~~
−	~~<div>This command will only work if the steam_api library was included (& successfully loaded) & if a steam account for your game exists!</div>~~
−	~~</div></div>~~

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==getTime==
-<span class="bold">Command History</span>
+Returns the number of milli seconds since the command was called the first time (or the timer was reset). Use this command for relative time measurements. E.g. call this command twice at different locations and calculate the time differential to see the time passed.
-<div class="mw-collapsible-content">
+<div class="command-min-version-info">Available since: <span class="command-min-version">v3.0</span></div>
-Returns the number of milliseconds since the command was first called - or since the timer was reset! <br/>
+:If true the timer will be reset and the next call(s) will return the time passed since this call.
-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!
+===Return Values===
+;time
+:Milli seconds
-Syntax:
+===Examples===
 <syntaxhighlight>
-getTime({flags=1, reset})
+-- we'll use this function to check current time elapsed & decide what action to perform
 function checkTime()
- if getTime() >= initialTime + 3000 then -- if current time more than equals initial time + 3 seconds then ...
+  if getTime() > 3000 then -- if time elapsed is more than 3 seconds then ...
-  -- do some action!
+    -- do some action
-  getTime({flags=1, reset=true}) -- let's reset timer back to zero!
+    getTime({flags=1, reset=true}) -- let's reset timer back to zero
- end
+  end
 end
--- the checkTime() function would be most effective, if included in a mainLoop event handler!
+-- the checkTime() function would be most effective if included in a mainLoop event handler
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
-<b>Command History</b>
+<span class="bold">Command History</span>
 <div class="mw-collapsible-content">
-<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
+<div class="alt-bg">Available since v3.7</div>
 </div></div>
@@ Line 34: / Line 34: @@
-<b><u>Arguments</u></b>
+<span class="bold underline">Arguments</span>
 none
-<b><u>Flags</u></b>
+<span class="bold underline">Flags</span>
-<b>r/reset</b> <br/>
+<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)
-<b><u>Return</u></b>
+<span class="bold underline">Return</span>
-<b>time</b> <br/>
+<span class="bold">time</span> <br/>
 The integer value of the current time (in ms)
 {{i18n|GetTime}}