Warhorse ScripBind documentation
ContentsIndexHome
PreviousUpNext
C_ScriptBindCalendar Methods

The methods of the C_ScriptBindCalendar class are listed here.

 
Name 
Description 
 
Syntax: Calendar.GetGameTime()
Returns game time (whole seconds from start of level)
 
 
Syntax: Calendar.GetWorldDay()
Returns number of whole days from start of level.
 
 
Syntax: Calendar.GetWorldDayOfWeek()
Returns ordinal number of day in current week. Range is <0,6> monday is 0
 
 
Syntax: Calendar.GetWorldHourOfDay()
Returns hour of current day. Range is <0,24) The number is float.
 
 
Syntax: Calendar.GetWorldTime()
Returns world time (whole seconds from start of level)
 
 
Syntax: Calendar.GetWorldTimeRatio()
Returns ratio of world time.
 
 
Syntax: Calendar.IsFakedTimeOfDay()
Returns true in case fake time of day is on.
 
 
Syntax: Calendar.IsNightTimeOfDay()
Returns true in night, false in day. Uses time from TimeOfDay.
 
 
Syntax: Calendar.IsWorldTimePaused()
Returns true if world time is paused.
 
 
Syntax: Calendar.SetFakeTimeOfDay(10)
Forces CryEngine to believe there is time different from our world time. The fake time is static. It is not used for RPG systems, only in TimeOfDay.
 
 
Syntax: Calendar.SetWorldTime(3000)
Sets ratio of world time.
 
 
Syntax: Calendar.SetWorldTimePaused(true)
Pauses/unpauses world time.
 
 
Syntax: Calendar.SetWorldTimeRatio(30)
Sets ratio of world time.
 
 
Syntax: Calendar.UnfakeTimeOfDay()
Switches CryEngine back to our world time
 
Copyright (c) 2012. All rights reserved.