Difference between revisions of "GetSecondsPassed"
See also
imported>Slserpent |
imported>ZuTheSkunk (See also) |
||
| (12 intermediate revisions by 10 users not shown) | |||
| Line 1: | Line 1: | ||
'''Syntax:''' | '''Syntax:''' | ||
GetSecondsPassed | (seconds:float) GetSecondsPassed | ||
Returns the number of seconds passed since the last | Returns the number of seconds passed since the last frame in which the current script was processed (in float). Extremely useful for running a timer within a script. Each script has its own counter for GetSecondsPassed. All calls within the same frame and script will return the same value. | ||
| Line 10: | Line 10: | ||
begin gamemode | begin gamemode | ||
if timer > | if timer > 0 | ||
set timer to timer | set timer to timer - GetSecondsPassed | ||
else | else | ||
; time's up! Do something. | ; time's up! Do something. | ||
| Line 17: | Line 17: | ||
end | end | ||
If ''timer'' is set to any positive value (representing seconds to count down), it will be decremented fractionally with every frame, until it reaches 0, at which point the ''else'' clause will be executed. | |||
The ''else'' clause should probably contain some kind of "DoOnce" catch, unless it is supposed to be executed every frame, once the timer runs down. | |||
'''Example Two:''' | |||
float timer1 | |||
float timer2 | |||
begin gamemode | |||
set timer1 to getsecondspassed ;This returns the time passed since the last frame | |||
set timer2 to getsecondspassed ;This returns the same value | |||
end | |||
== Notes == | |||
* GetSecondsPassed is unreliable in a ScriptEffect during sleep/wait/fast travel. Use [[ScriptEffectElapsedSeconds]] instead. | |||
== See also == | |||
* [[Scripting Tutorial: Creating a Simple Timer]] | |||
[[Category: Functions]] | [[Category: Functions]] | ||
[[Category:Functions (CS)]] | |||
[[Category: Functions (CS 1.0)]] | |||
[[Category: Time Functions]] | [[Category: Time Functions]] | ||
[[Category: Time Functions (CS 1.0)]] | |||
<!-- Begin Search Terms | |||
Get | |||
Seconds | |||
Passed | |||
End Search Terms --> | |||