Difference between revisions of "GetSecondsPassed"
Jump to navigation
Jump to search
imported>Haama (As per discussion, note removed) |
imported>SnakeChomp (Create using function template) |
||
| Line 1: | Line 1: | ||
{{Function | |||
|origin = GECK1 | |||
|name = GetSecondsPassed | |||
|summary = Returns the number of real life seconds that have passed since this function was last called by the calling script. | |||
|returnVal = seconds | |||
|returnType = float | |||
|example = <pre>float timer | |||
begin gamemode | |||
if timer < 5 | |||
set timer to timer + GetSecondsPassed | |||
else | |||
;5 seconds have passed, do something special | |||
set timer to 0 | |||
endif | |||
end</pre> | |||
}} | |||
==Notes== | |||
*[[SetGlobalTimeMultiplier]] will affect the return value of this function in the same way it affects the speed of the game. | |||
*Each script has it's own independent tracking of when GetSecondsPassed was last called. | |||
*Calling this function multiple times in th same script in the same frame will return the same values for each call. | |||
*This function is unreliable in a ScriptEffect during sleep/wait/fast travel. Use [[ScriptEffectElapsedSeconds]] instead. | |||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:Time Functions]] | [[Category:Time Functions]] | ||
Revision as of 12:10, 24 January 2009
< [[::Category:Functions|Category:Functions]]
A function included in the GECK version 1.1.0.36.
Description
Returns the number of real life seconds that have passed since this function was last called by the calling script.
Syntax
(seconds:float) GetSecondsPassed
Example
float timer
begin gamemode
if timer < 5
set timer to timer + GetSecondsPassed
else
;5 seconds have passed, do something special
set timer to 0
endif
end
Notes
- SetGlobalTimeMultiplier will affect the return value of this function in the same way it affects the speed of the game.
- Each script has it's own independent tracking of when GetSecondsPassed was last called.
- Calling this function multiple times in th same script in the same frame will return the same values for each call.
- This function is unreliable in a ScriptEffect during sleep/wait/fast travel. Use ScriptEffectElapsedSeconds instead.