GetCurrentRealTime - Utility
Revision as of 07:48, 6 June 2018 by imported>Scrivener07 (→Examples: added example to get the current time of the day.)
Member of: Utility Script
Gets the number of real-world seconds that have elapsed since the game has launched. This time does not count time the game has been alt-tabbed, or other cases where the game has been frozen (i.e. during a save or load, time in a menu is counted). This function is most useful for timing a long operation.
Syntax
float Function GetCurrentRealTime() native
Parameters
None.
Return Value
The number of seconds since the game has been launched.
Examples
; How long does our operation take?
float ftimeStart = Utility.GetCurrentRealTime()
; Long operation here
float ftimeEnd = Utility.GetCurrentRealTime()
Debug.Trace("We took " + (ftimeEnd - ftimeStart) + " seconds to run")
Float Function GetCurrentTimeOfDay()
; Returns the current time in hours. Fractional part is seconds.
; This can be furthered to get minutes, milliseconds, etc.
Float daysPassed = Utility.GetCurrentGameTime()
; remove the days passed and return the current time of the day.
return (daysPassed - daysPassed as int) * 24.0
EndFunction