API Time

Time-Number

Time is represented as a Number between 0 and 1440.

Number	Time
0 / 1440	Midnight ( 0:00 / 24:00 )
360	Sunrise ( 6:00 )
720	Midday ( 12:00 )
1080	Sunset ( 18:00 )

Note: Visually; sunrise and sunset might change depending on settings. Consider using StormFox2.Sky.GetStamp() or StormFox2.Sun.IsUp() instead.

Hooks	Description
StormFox2.Time.Set	Gets called when the time gets set.
StormFox2.Time.NextDay( Number DaysPast )	Gets called when the day changes. DaysPast is usually 1.

Functions	Returns	Description
StormFox2.Time.Set( Time-Number / String Time )		Sets the time.
StormFox2.Time.SetSpeed( Number Speed )		Sets the timespeed. 1 being RL-time. 60 being 60x RL-time.
StormFox2.Time.Get( Bool NearestSecond )	Time-Number	Returns the current time.
StormFox2.Time.GetDisplay( Time-Number Time = CurrentTime )	String	Returns the time using the client-settings. Useful for displays.
StormFox2.Time.GetSpeed()	Number	Returns the timespeed.1 being RL-time. 60 being 60x RL-time.
StormFox2.Time.GetSeconds( Time-Number Time = CurrentTime )	Number	Returns the second.
StormFox2.Time.GetMinutes( Time-Number Time = CurrentTime )	Number	Returns the minute.
StormFox2.Time.GetHours( Time-Number Time = CurrentTime, Bool Use12Hour )	Number	Returns the hour.
StormFox2.Time.GetAMPM( Time-Number Time = CurrentTime )	String	Returns "AM" or "PM".
StormFox2.Time.DeltaTime( Number Time = CurrentTime, Number Time2 )	Number	Returns the time between two Time-Number's.
StormFox2.Time.IsBetween( Time-Number FromTime, Time-Number ToTime, Time-Number Time = CurrentTime )	Bool	Returns true if the time is between the two numbers.
StormFox2.Time.IsDay( Time-Number Time = CurrentTime )	Bool	Returns true if time is between 6:00 and 18:00.
StormFox2.Time.IsNight( Number Time = CurrentTime )	Bool	Returns true if time is between 18:00 and 6:00.
StormFox2.Time.StringToTime( String Time )	Time-Number	Takes a string input and tries to convert it to a number.
StormFox2.Time.TimeToString( Time-Number Time = CurrentTime, Bool Use12Hour )	String	Returns the time as a string.